1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataDocumentsSpreadsheet</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch11.html" title="Google Documents API">
<link rel="prev" href="GDataDocumentsPresentation.html" title="GDataDocumentsPresentation">
<link rel="next" href="GDataDocumentsText.html" title="GDataDocumentsText">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GDataDocumentsPresentation.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch11.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GData Reference Manual</th>
<td><a accesskey="n" href="GDataDocumentsText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GDataDocumentsSpreadsheet.synopsis" class="shortcut">Top</a>
|
<a href="#GDataDocumentsSpreadsheet.description" class="shortcut">Description</a>
|
<a href="#GDataDocumentsSpreadsheet.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GDataDocumentsSpreadsheet.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry" title="GDataDocumentsSpreadsheet">
<a name="GDataDocumentsSpreadsheet"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataDocumentsSpreadsheet.top_of_page"></a>GDataDocumentsSpreadsheet</span></h2>
<p>GDataDocumentsSpreadsheet — GData Documents spreadsheet object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="GDataDocumentsSpreadsheet.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GDataDocumentsSpreadsheet.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gdata/services/documents/gdata-documents-spreadsheet.h>
<a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheet-struct" title="GDataDocumentsSpreadsheet">GDataDocumentsSpreadsheet</a>;
<a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheetClass" title="GDataDocumentsSpreadsheetClass">GDataDocumentsSpreadsheetClass</a>;
enum <a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheetFormat" title="enum GDataDocumentsSpreadsheetFormat">GDataDocumentsSpreadsheetFormat</a>;
<a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="returnvalue">GDataDocumentsSpreadsheet</span></a> * <a class="link" href="GDataDocumentsSpreadsheet.html#gdata-documents-spreadsheet-new" title="gdata_documents_spreadsheet_new ()">gdata_documents_spreadsheet_new</a>
(<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);
<a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html"><span class="returnvalue">GFile</span></a> * <a class="link" href="GDataDocumentsSpreadsheet.html#gdata-documents-spreadsheet-download-document" title="gdata_documents_spreadsheet_download_document ()">gdata_documents_spreadsheet_download_document</a>
(<em class="parameter"><code><a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *service</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **content_type</code></em>,
<em class="parameter"><code><a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheetFormat" title="enum GDataDocumentsSpreadsheetFormat"><span class="type">GDataDocumentsSpreadsheetFormat</span></a> export_format</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> gid</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *destination_file</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> replace_file_if_exists</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GDataDocumentsSpreadsheet.html#gdata-documents-spreadsheet-get-download-uri" title="gdata_documents_spreadsheet_get_download_uri ()">gdata_documents_spreadsheet_get_download_uri</a>
(<em class="parameter"><code><a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheetFormat" title="enum GDataDocumentsSpreadsheetFormat"><span class="type">GDataDocumentsSpreadsheetFormat</span></a> export_format</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> gid</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GDataDocumentsSpreadsheet.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
+----<a class="link" href="GDataEntry.html" title="GDataEntry">GDataEntry</a>
+----<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry">GDataDocumentsEntry</a>
+----GDataDocumentsSpreadsheet
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="GDataDocumentsSpreadsheet.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GDataDocumentsSpreadsheet implements
<a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler">GDataAccessHandler</a>.</p>
</div>
<div class="refsect1" title="Description">
<a name="GDataDocumentsSpreadsheet.description"></a><h2>Description</h2>
<p>
<a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a> is a subclass of <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> to represent a spreadsheet from Google Documents.
</p>
<p>
For more details of Google Documents' GData API, see the <a class="ulink" href="" target="_top">
online documentation</a>.
</p>
</div>
<div class="refsect1" title="Details">
<a name="GDataDocumentsSpreadsheet.details"></a><h2>Details</h2>
<div class="refsect2" title="GDataDocumentsSpreadsheet">
<a name="GDataDocumentsSpreadsheet-struct"></a><h3>GDataDocumentsSpreadsheet</h3>
<pre class="programlisting">typedef struct _GDataDocumentsSpreadsheet GDataDocumentsSpreadsheet;</pre>
<p>
All the fields in the <a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a> structure are private and should never be accessed directly.
</p>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title="GDataDocumentsSpreadsheetClass">
<a name="GDataDocumentsSpreadsheetClass"></a><h3>GDataDocumentsSpreadsheetClass</h3>
<pre class="programlisting">typedef struct {
} GDataDocumentsSpreadsheetClass;
</pre>
<p>
All the fields in the <a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheetClass" title="GDataDocumentsSpreadsheetClass"><span class="type">GDataDocumentsSpreadsheetClass</span></a> structure are private and should never be accessed directly.
</p>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title="enum GDataDocumentsSpreadsheetFormat">
<a name="GDataDocumentsSpreadsheetFormat"></a><h3>enum GDataDocumentsSpreadsheetFormat</h3>
<pre class="programlisting">typedef enum {
GDATA_DOCUMENTS_SPREADSHEET_XLS = 0,
GDATA_DOCUMENTS_SPREADSHEET_CSV,
GDATA_DOCUMENTS_SPREADSHEET_PDF,
GDATA_DOCUMENTS_SPREADSHEET_ODS,
GDATA_DOCUMENTS_SPREADSHEET_TSV,
GDATA_DOCUMENTS_SPREADSHEET_HTML
} GDataDocumentsSpreadsheetFormat;
</pre>
<p>
The different available download formats for spreadsheets.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GDATA-DOCUMENTS-SPREADSHEET-XLS:CAPS"></a><span class="term"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_XLS</code></span></p></td>
<td>Microsoft Excel spreadsheet (XLS) format
</td>
</tr>
<tr>
<td><p><a name="GDATA-DOCUMENTS-SPREADSHEET-CSV:CAPS"></a><span class="term"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_CSV</code></span></p></td>
<td>Comma-Separated Values (CSV) format
</td>
</tr>
<tr>
<td><p><a name="GDATA-DOCUMENTS-SPREADSHEET-PDF:CAPS"></a><span class="term"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_PDF</code></span></p></td>
<td>Portable Document Format (PDF)
</td>
</tr>
<tr>
<td><p><a name="GDATA-DOCUMENTS-SPREADSHEET-ODS:CAPS"></a><span class="term"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_ODS</code></span></p></td>
<td>OpenDocument Spreadsheet (ODS) format
</td>
</tr>
<tr>
<td><p><a name="GDATA-DOCUMENTS-SPREADSHEET-TSV:CAPS"></a><span class="term"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_TSV</code></span></p></td>
<td>Tab-Separated Values (TSV) format
</td>
</tr>
<tr>
<td><p><a name="GDATA-DOCUMENTS-SPREADSHEET-HTML:CAPS"></a><span class="term"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_HTML</code></span></p></td>
<td>HyperText Markup Language (HTML) format
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_documents_spreadsheet_new ()">
<a name="gdata-documents-spreadsheet-new"></a><h3>gdata_documents_spreadsheet_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="returnvalue">GDataDocumentsSpreadsheet</span></a> * gdata_documents_spreadsheet_new
(<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
<p>
Creates a new <a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a> with the given entry ID (<a class="link" href="GDataEntry.html#GDataEntry--id" title='The "id" property'><span class="type">"id"</span></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>the entry's ID (not the document ID of the spreadsheet), or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_documents_spreadsheet_download_document ()">
<a name="gdata-documents-spreadsheet-download-document"></a><h3>gdata_documents_spreadsheet_download_document ()</h3>
<pre class="programlisting"><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html"><span class="returnvalue">GFile</span></a> * gdata_documents_spreadsheet_download_document
(<em class="parameter"><code><a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a> *service</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **content_type</code></em>,
<em class="parameter"><code><a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheetFormat" title="enum GDataDocumentsSpreadsheetFormat"><span class="type">GDataDocumentsSpreadsheetFormat</span></a> export_format</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> gid</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *destination_file</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> replace_file_if_exists</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Downloads and returns the spreadsheet file represented by the <a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a>. If the document doesn't exist,
<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned, but no error is set in <em class="parameter"><code>error</code></em>. TODO: What?
</p>
<p>
If <em class="parameter"><code>cancellable</code></em> is not <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by triggering the <em class="parameter"><code>cancellable</code></em> object from another thread.
If the operation was cancelled, the error <a href="/opt/gnome2/build/share/gtk-doc/html/gio/gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.
</p>
<p>
When requesting a <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-CSV:CAPS"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_CSV</code></a> or <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-TSV:CAPS"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_TSV</code></a> file you must specify an additional
parameter called <em class="parameter"><code>gid</code></em> which indicates which grid, or sheet, you wish to get (the index is <code class="code">0</code>-based, so
GID <code class="code">1</code> actually refers to the second sheet on a given spreadsheet).
</p>
<p>
If <em class="parameter"><code>destination_file</code></em> is a directory, then the file will be downloaded in this directory with the <a class="link" href="GDataEntry.html#GDataEntry--title" title='The "title" property'><span class="type">"title"</span></a> with
the apropriate extension as name.
</p>
<p>
If there is an error getting the document, a <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-PROTOCOL-ERROR:CAPS"><code class="literal">GDATA_SERVICE_ERROR_PROTOCOL_ERROR</code></a> error will be returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>content_type</code></em> :</span></p></td>
<td>return location for the document's content type, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; free with <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>export_format</code></em> :</span></p></td>
<td>the format in which the spreadsheet should be exported
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gid</code></em> :</span></p></td>
<td>the <code class="code">0</code>-based sheet ID to download, or <code class="code">-1</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destination_file</code></em> :</span></p></td>
<td>the <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> into which the spreadsheet file should be saved
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>replace_file_if_exists</code></em> :</span></p></td>
<td>
<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file should be replaced if it already exists, <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the document's data, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_documents_spreadsheet_get_download_uri ()">
<a name="gdata-documents-spreadsheet-get-download-uri"></a><h3>gdata_documents_spreadsheet_get_download_uri ()</h3>
<pre class="programlisting"><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gdata_documents_spreadsheet_get_download_uri
(<em class="parameter"><code><a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheetFormat" title="enum GDataDocumentsSpreadsheetFormat"><span class="type">GDataDocumentsSpreadsheetFormat</span></a> export_format</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> gid</code></em>);</pre>
<p>
Builds and returns the download URI for the given <a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a> in the desired format. Note that directly downloading
the document using this URI isn't possible, as authentication is required. You should instead use <a class="link" href="GDataDownloadStream.html#gdata-download-stream-new" title="gdata_download_stream_new ()"><code class="function">gdata_download_stream_new()</code></a> with
the URI, and use the resulting <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GInputStream.html"><span class="type">GInputStream</span></a>.
</p>
<p>
When requesting a <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-CSV:CAPS"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_CSV</code></a> or <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-TSV:CAPS"><code class="literal">GDATA_DOCUMENTS_SPREADSHEET_TSV</code></a> file you must specify an additional
parameter called <em class="parameter"><code>gid</code></em> which indicates which grid, or sheet, you wish to get (the index is <code class="code">0</code>-based, so
GID <code class="code">1</code> actually refers to the second sheet on a given spreadsheet).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet"><span class="type">GDataDocumentsSpreadsheet</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>export_format</code></em> :</span></p></td>
<td>the format in which the spreadsheet should be exported when downloaded
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gid</code></em> :</span></p></td>
<td>the <code class="code">0</code>-based sheet ID to download, or <code class="code">-1</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the download URI; free with <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
