/usr/share/gtk-doc/html/gdata/GDataDocumentsFolder.html is in libgdata-doc 0.16.1-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GData Reference Manual: GDataDocumentsFolder</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="GDataDocumentsDocument.html" title="GDataDocumentsDocument">
<link rel="next" href="GDataDocumentsDrawing.html" title="GDataDocumentsDrawing">
<meta name="generator" content="GTK-Doc V1.21.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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GDataDocumentsFolder.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GDataDocumentsFolder.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GDataDocumentsFolder.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch16.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataDocumentsDocument.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataDocumentsDrawing.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataDocumentsFolder"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataDocumentsFolder.top_of_page"></a>GDataDocumentsFolder</span></h2>
<p>GDataDocumentsFolder — GData documents folder object</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataDocumentsFolder.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GDataDocumentsFolder.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="returnvalue">GDataDocumentsFolder</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataDocumentsFolder.html#gdata-documents-folder-new" title="gdata_documents_folder_new ()">gdata_documents_folder_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataDocumentsFolder.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataDocumentsFolder.html#GDataDocumentsFolder-struct" title="GDataDocumentsFolder">GDataDocumentsFolder</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataDocumentsFolder.html#GDataDocumentsFolderClass" title="GDataDocumentsFolderClass">GDataDocumentsFolderClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataDocumentsFolder.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> <a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
<span class="lineart">╰──</span> <a class="link" href="GDataEntry.html" title="GDataEntry">GDataEntry</a>
<span class="lineart">╰──</span> <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry">GDataDocumentsEntry</a>
<span class="lineart">╰──</span> GDataDocumentsFolder
</pre>
</div>
<div class="refsect1">
<a name="GDataDocumentsFolder.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GDataDocumentsFolder implements
<a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler">GDataAccessHandler</a>.</p>
</div>
<div class="refsect1">
<a name="GDataDocumentsFolder.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gdata/services/documents/gdata-documents-folder.h>
</pre>
</div>
<div class="refsect1">
<a name="GDataDocumentsFolder.description"></a><h2>Description</h2>
<p><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a> is a subclass of <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry"><span class="type">GDataDocumentsEntry</span></a> to represent a folder from Google Documents.</p>
<p>For more details of Google Documents' GData API, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/" target="_top">online documentation</a>.
<div class="example">
<a name="id-1.5.5.8.9.5"></a><p class="title"><b>Example 36. Adding a Folder</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</pre></td>
<td class="listing_code"><pre class="programlisting">GDataDocumentsService <span class="gtkdoc opt">*</span>service<span class="gtkdoc opt">;</span>
GDataDocumentsFolder <span class="gtkdoc opt">*</span>folder<span class="gtkdoc opt">, *</span>new_folder<span class="gtkdoc opt">;</span>
gchar <span class="gtkdoc opt">*</span>upload_uri<span class="gtkdoc opt">;</span>
GError <span class="gtkdoc opt">*</span>error <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span>
<span class="comment">/* Create a service */</span>
service <span class="gtkdoc opt">=</span> <span class="function">create_documents_service</span> <span class="gtkdoc opt">();</span>
<span class="comment">/* Create the new folder */</span>
folder <span class="gtkdoc opt">=</span> <span class="function"><a href="GDataDocumentsFolder.html#gdata-documents-folder-new">gdata_documents_folder_new</a></span> <span class="gtkdoc opt">(</span>NULL<span class="gtkdoc opt">);</span>
<span class="function"><a href="GDataEntry.html#gdata-entry-set-title">gdata_entry_set_title</a></span> <span class="gtkdoc opt">(</span><span class="function">GDATA_ENTRY</span> <span class="gtkdoc opt">(</span>folder<span class="gtkdoc opt">),</span> <span class="string">"Folder Name"</span><span class="gtkdoc opt">);</span>
<span class="comment">/* Insert the folder */</span>
upload_uri <span class="gtkdoc opt">=</span> <span class="function"><a href="GDataDocumentsService.html#gdata-documents-service-get-upload-uri">gdata_documents_service_get_upload_uri</a></span> <span class="gtkdoc opt">(</span>NULL<span class="gtkdoc opt">);</span>
new_folder <span class="gtkdoc opt">=</span> <span class="function">GDATA_DOCUMENTS_FOLDER</span> <span class="gtkdoc opt">(</span><span class="function"><a href="GDataService.html#gdata-service-insert-entry">gdata_service_insert_entry</a></span> <span class="gtkdoc opt">(</span><span class="function">GDATA_SERVICE</span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">),</span> upload_uri<span class="gtkdoc opt">,</span> <span class="function">GDATA_ENTRY</span> <span class="gtkdoc opt">(</span>folder<span class="gtkdoc opt">),</span> NULL<span class="gtkdoc opt">, &</span>error<span class="gtkdoc opt">));</span>
<span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Memory-Allocation.html#g-free">g_free</a></span> <span class="gtkdoc opt">(</span>upload_uri<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>folder<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(</span>error <span class="gtkdoc opt">!=</span> NULL<span class="gtkdoc opt">) {</span>
<span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Message-Logging.html#g-error">g_error</a></span> <span class="gtkdoc opt">(</span><span class="string">"Error inserting new folder: %s"</span><span class="gtkdoc opt">,</span> error<span class="gtkdoc opt">-></span>message<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#g-error-free">g_error_free</a></span> <span class="gtkdoc opt">(</span>error<span class="gtkdoc opt">);</span>
<span class="keyword">return</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="comment">/* Do something with the new folder, such as store its ID for future use */</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>new_folder<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break">
</div>
<div class="refsect1">
<a name="GDataDocumentsFolder.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-documents-folder-new"></a><h3>gdata_documents_folder_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="returnvalue">GDataDocumentsFolder</span></a> *
gdata_documents_folder_new (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</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="refsect3">
<a name="id-1.5.5.8.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p> the entry's ID (not the document ID of the folder), or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.8.10.2.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
<p></p>
</div>
<p class="since">Since 0.4.0</p>
</div>
</div>
<div class="refsect1">
<a name="GDataDocumentsFolder.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDataDocumentsFolder-struct"></a><h3>GDataDocumentsFolder</h3>
<pre class="programlisting">typedef struct _GDataDocumentsFolder GDataDocumentsFolder;</pre>
<p>All the fields in the <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</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="GDataDocumentsFolderClass"></a><h3>GDataDocumentsFolderClass</h3>
<pre class="programlisting">typedef struct {
} GDataDocumentsFolderClass;
</pre>
<p>All the fields in the <a class="link" href="GDataDocumentsFolder.html#GDataDocumentsFolderClass" title="GDataDocumentsFolderClass"><span class="type">GDataDocumentsFolderClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since 0.4.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21.1</div>
</body>
</html>
|