/usr/share/gtk-doc/html/gdata/GDataDocumentsSpreadsheet.html is in libgdata-doc 0.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | <!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.76.1">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch16.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.18.1 (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="ch16.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">
<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">
<a name="GDataDocumentsSpreadsheet.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="GDataDocumentsSpreadsheet.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gdata/services/documents/gdata-documents-spreadsheet.h>
#define <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-CSV:CAPS" title="GDATA_DOCUMENTS_SPREADSHEET_CSV">GDATA_DOCUMENTS_SPREADSHEET_CSV</a>
#define <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-HTML:CAPS" title="GDATA_DOCUMENTS_SPREADSHEET_HTML">GDATA_DOCUMENTS_SPREADSHEET_HTML</a>
#define <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-ODS:CAPS" title="GDATA_DOCUMENTS_SPREADSHEET_ODS">GDATA_DOCUMENTS_SPREADSHEET_ODS</a>
#define <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-PDF:CAPS" title="GDATA_DOCUMENTS_SPREADSHEET_PDF">GDATA_DOCUMENTS_SPREADSHEET_PDF</a>
#define <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-TSV:CAPS" title="GDATA_DOCUMENTS_SPREADSHEET_TSV">GDATA_DOCUMENTS_SPREADSHEET_TSV</a>
#define <a class="link" href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-XLS:CAPS" title="GDATA_DOCUMENTS_SPREADSHEET_XLS">GDATA_DOCUMENTS_SPREADSHEET_XLS</a>
<a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheet-struct" title="GDataDocumentsSpreadsheet">GDataDocumentsSpreadsheet</a>;
<a class="link" href="GDataDocumentsSpreadsheet.html#GDataDocumentsSpreadsheetClass" title="GDataDocumentsSpreadsheetClass">GDataDocumentsSpreadsheetClass</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/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);
<a href="/opt/gnome3/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>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *export_format</code></em>,
<em class="parameter"><code><a href="/opt/gnome3/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">
<a name="GDataDocumentsSpreadsheet.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/opt/gnome3/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>
+----<a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument">GDataDocumentsDocument</a>
+----GDataDocumentsSpreadsheet
</pre>
</div>
<div class="refsect1">
<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">
<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="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</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="http://code.google.com/apis/document/docs/2.0/developers_guide_protocol.html" target="_top">online documentation</a>.
</p>
<p>
</p>
<div class="example">
<a name="id548276"></a><p class="title"><b>Example 32. Downloading a Specific Sheet of a Spreadsheet</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GDataDocumentsService</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">service</span><span class="symbol">;</span>
<span class="usertype">GDataDocumentsSpreadsheet</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">spreadsheet</span><span class="symbol">;</span>
<span class="usertype">GFile</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">destination_file</span><span class="symbol">;</span>
<span class="usertype">guint</span><span class="normal"> gid</span><span class="symbol">;</span>
<span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">download_uri</span><span class="symbol">;</span>
<span class="usertype">GDataDownloadStream</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">download_stream</span><span class="symbol">;</span>
<span class="usertype">GFileOutputStream</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">output_stream</span><span class="symbol">;</span>
<span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error </span><span class="symbol">=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
<span class="comment">/* Create a service and retrieve the spreadsheet and sheet index (GID) to download and the file to save the download in */</span>
<span class="normal">service </span><span class="symbol">=</span><span class="normal"> </span><span class="function">create_youtube_service</span><span class="normal"> </span><span class="symbol">();</span>
<span class="normal">spreadsheet </span><span class="symbol">=</span><span class="normal"> </span><span class="function">get_document_to_download</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
<span class="normal">destination_file </span><span class="symbol">=</span><span class="normal"> </span><span class="function">query_user_for_destination_file</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">spreadsheet</span><span class="symbol">);</span>
<span class="normal">gid </span><span class="symbol">=</span><span class="normal"> </span><span class="function">query_user_for_gid</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">spreadsheet</span><span class="symbol">);</span>
<span class="comment">/* Create the download stream */</span>
<span class="normal">download_uri </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataDocumentsSpreadsheet.html#gdata-documents-spreadsheet-get-download-uri">gdata_documents_spreadsheet_get_download_uri</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">spreadsheet</span><span class="symbol">,</span><span class="normal"> <a href="GDataDocumentsSpreadsheet.html#GDATA-DOCUMENTS-SPREADSHEET-CSV:CAPS">GDATA_DOCUMENTS_SPREADSHEET_CSV</a></span><span class="symbol">,</span><span class="normal"> gid</span><span class="symbol">);</span>
<span class="normal">download_stream </span><span class="symbol">=</span><span class="normal"> </span><span class="function">GDATA_DOWNLOAD_STREAM</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="GDataDownloadStream.html#gdata-download-stream-new">gdata_download_stream_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">,</span><span class="normal"> </span><span class="function"><a href="GDataDocumentsService.html#gdata-documents-service-get-spreadsheet-authorization-domain">gdata_documents_service_get_spreadsheet_authorization_domain</a></span><span class="normal"> </span><span class="symbol">(),</span>
<span class="normal"> download_uri</span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">));</span>
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free">g_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">download_uri</span><span class="symbol">);</span>
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">spreadsheet</span><span class="symbol">);</span>
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
<span class="comment">/* Create the file output stream */</span>
<span class="normal">output_stream </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFile.html#g-file-replace">g_file_replace</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">destination_file</span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GFile.html#G-FILE-CREATE-REPLACE-DESTINATION:CAPS">G_FILE_CREATE_REPLACE_DESTINATION</a></span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">error</span><span class="symbol">);</span>
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">destination_file</span><span class="symbol">);</span>
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error creating destination file: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-></span><span class="normal">message</span><span class="symbol">);</span>
<span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
<span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">download_stream</span><span class="symbol">);</span>
<span class="normal"> </span><span class="keyword">return</span><span class="symbol">;</span>
<span class="cbracket">}</span>
<span class="comment">/* Download the document. This should almost always be done asynchronously. */</span>
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html#g-output-stream-splice">g_output_stream_splice</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">G_OUTPUT_STREAM</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">output_stream</span><span class="symbol">),</span><span class="normal"> </span><span class="function">G_INPUT_STREAM</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">download_stream</span><span class="symbol">),</span>
<span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html#G-OUTPUT-STREAM-SPLICE-CLOSE-SOURCE:CAPS">G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE</a> </span><span class="symbol">|</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/gio/GOutputStream.html#G-OUTPUT-STREAM-SPLICE-CLOSE-TARGET:CAPS">G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET</a></span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">error</span><span class="symbol">);</span>
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">output_stream</span><span class="symbol">);</span>
<span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">download_stream</span><span class="symbol">);</span>
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error downloading spreadsheet: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-></span><span class="normal">message</span><span class="symbol">);</span>
<span class="normal"> </span><span class="function"><a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
<span class="normal"> </span><span class="keyword">return</span><span class="symbol">;</span>
<span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="GDataDocumentsSpreadsheet.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GDATA-DOCUMENTS-SPREADSHEET-CSV:CAPS"></a><h3>GDATA_DOCUMENTS_SPREADSHEET_CSV</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_SPREADSHEET_CSV "csv"
</pre>
<p>
The export format for Comma-Separated Values (CSV) format.
</p>
<p>
For more information, see the
<a class="ulink" href="http://code.google.com/apis/documents/docs/2.0/developers_guide_protocol.html#DownloadingSpreadsheets" target="_top">
GData protocol specification</a>.
</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-DOCUMENTS-SPREADSHEET-HTML:CAPS"></a><h3>GDATA_DOCUMENTS_SPREADSHEET_HTML</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_SPREADSHEET_HTML "html"
</pre>
<p>
The export format for HyperText Markup Language (HTML) format.
</p>
<p>
For more information, see the
<a class="ulink" href="http://code.google.com/apis/documents/docs/2.0/developers_guide_protocol.html#DownloadingSpreadsheets" target="_top">
GData protocol specification</a>.
</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-DOCUMENTS-SPREADSHEET-ODS:CAPS"></a><h3>GDATA_DOCUMENTS_SPREADSHEET_ODS</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_SPREADSHEET_ODS "ods"
</pre>
<p>
The export format for OpenDocument Spreadsheet (ODS) format.
</p>
<p>
For more information, see the
<a class="ulink" href="http://code.google.com/apis/documents/docs/2.0/developers_guide_protocol.html#DownloadingSpreadsheets" target="_top">
GData protocol specification</a>.
</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-DOCUMENTS-SPREADSHEET-PDF:CAPS"></a><h3>GDATA_DOCUMENTS_SPREADSHEET_PDF</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_SPREADSHEET_PDF "pdf"
</pre>
<p>
The export format for Portable Document Format (PDF).
</p>
<p>
For more information, see the
<a class="ulink" href="http://code.google.com/apis/documents/docs/2.0/developers_guide_protocol.html#DownloadingSpreadsheets" target="_top">
GData protocol specification</a>.
</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-DOCUMENTS-SPREADSHEET-TSV:CAPS"></a><h3>GDATA_DOCUMENTS_SPREADSHEET_TSV</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_SPREADSHEET_TSV "tsv"
</pre>
<p>
The export format for Tab-Separated Values (TSV) format.
</p>
<p>
For more information, see the
<a class="ulink" href="http://code.google.com/apis/documents/docs/2.0/developers_guide_protocol.html#DownloadingSpreadsheets" target="_top">
GData protocol specification</a>.
</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-DOCUMENTS-SPREADSHEET-XLS:CAPS"></a><h3>GDATA_DOCUMENTS_SPREADSHEET_XLS</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_SPREADSHEET_XLS "xls"
</pre>
<p>
The export format for Microsoft Excel spreadsheet (XLS) format.
</p>
<p>
For more information, see the
<a class="ulink" href="http://code.google.com/apis/documents/docs/2.0/developers_guide_protocol.html#DownloadingSpreadsheets" target="_top">
GData protocol specification</a>.
</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<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">
<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">
<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/gnome3/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/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</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/gnome3/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-documents-spreadsheet-get-download-uri"></a><h3>gdata_documents_spreadsheet_get_download_uri ()</h3>
<pre class="programlisting"><a href="/opt/gnome3/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>const <a href="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *export_format</code></em>,
<em class="parameter"><code><a href="/opt/gnome3/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/gnome3/build/share/gtk-doc/html/gio/GInputStream.html"><span class="type">GInputStream</span></a>.
</p>
<p>
When requesting a <code class="code">"csv"</code>, <code class="code">"tsv"</code>, <code class="code">"pdf"</code> or
<code class="code">"html"</code> file you may 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/gnome3/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.18.1</div>
</body>
</html>
|