← Back to branch summary

~ubuntu-branches/ubuntu/natty/libgdata/natty-updates

« back to all changes in this revision

Viewing changes to docs/reference/html/GDataDocumentsFolder.html

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2011-01-05 11:09:00 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20110105110900-gkjnbslnr18s45us
Tags: 0.8.0-0ubuntu1
* New upstream release
* debian/control:
  - Use gir1.2 packages
  - Use standards version 3.9.1
  - Add Vcs-Bzr link
  - Rename libgdata10 to libgdata11
* debian/rules:
  - Drop simple-patchsys.mk
* debian/source:
  - Use source version 3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/GDataDocumentsFolder.html
50
50
 
51
51
                    <a class="link" href="GDataDocumentsFolder.html#GDataDocumentsFolder-struct" title="GDataDocumentsFolder">GDataDocumentsFolder</a>;
52
52
                    <a class="link" href="GDataDocumentsFolder.html#GDataDocumentsFolderClass" title="GDataDocumentsFolderClass">GDataDocumentsFolderClass</a>;
53
 
<a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="returnvalue">GDataDocumentsFolder</span></a> * <a class="link" href="GDataDocumentsFolder.html#gdata-documents-folder-new" title="gdata_documents_folder_new ()">gdata_documents_folder_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>);
 
53
<a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="returnvalue">GDataDocumentsFolder</span></a> * <a class="link" href="GDataDocumentsFolder.html#gdata-documents-folder-new" title="gdata_documents_folder_new ()">gdata_documents_folder_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>);
54
54
</pre>
55
55
</div>
56
56
<div class="refsect1">
57
57
<a name="GDataDocumentsFolder.object-hierarchy"></a><h2>Object Hierarchy</h2>
58
58
<pre class="synopsis">
59
 
  <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
59
  <a href="/opt/gnome3/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
60
60
   +----<a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
61
61
         +----<a class="link" href="GDataEntry.html" title="GDataEntry">GDataEntry</a>
62
62
               +----<a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry">GDataDocumentsEntry</a>
78
78
For more details of Google Documents' GData API, see the
79
79
<a class="ulink" href="http://code.google.com/apis/document/docs/2.0/developers_guide_protocol.html" target="_top">online documentation</a>.
80
80
</p>
 
81
<p>
 
82
</p>
 
83
<div class="example">
 
84
<a name="id560724"></a><p class="title"><b>Example 27. Adding a Folder</b></p>
 
85
<div class="example-contents">
 
86
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
87
    <tbody>
 
88
      <tr>
 
89
        <td class="listing_lines" align="right"><pre>1
 
90
2
 
91
3
 
92
4
 
93
5
 
94
6
 
95
7
 
96
8
 
97
9
 
98
10
 
99
11
 
100
12
 
101
13
 
102
14
 
103
15
 
104
16
 
105
17
 
106
18
 
107
19
 
108
20
 
109
21
 
110
22
 
111
23
 
112
24
 
113
25
 
114
26
 
115
27
 
116
28
 
117
29</pre></td>
 
118
        <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>
 
119
<span class="usertype">GDataDocumentsFolder</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">folder</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">new_folder</span><span class="symbol">;</span>
 
120
<span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">upload_uri</span><span class="symbol">;</span>
 
121
<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>
 
122
 
 
123
<span class="comment">/* Create a service */</span>
 
124
<span class="normal">service </span><span class="symbol">=</span><span class="normal"> </span><span class="function">create_documents_service</span><span class="normal"> </span><span class="symbol">();</span>
 
125
 
 
126
<span class="comment">/* Create the new folder */</span>
 
127
<span class="normal">folder </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataDocumentsFolder.html#gdata-documents-folder-new">gdata_documents_folder_new</a></span><span class="normal"> </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>
 
128
<span class="function"><a href="GDataEntry.html#gdata-entry-set-title">gdata_entry_set_title</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GDATA_ENTRY</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">folder</span><span class="symbol">),</span><span class="normal"> </span><span class="string">"Folder Name"</span><span class="symbol">);</span>
 
129
 
 
130
<span class="comment">/* Insert the folder */</span>
 
131
<span class="normal">upload_uri </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataDocumentsService.html#gdata-documents-service-get-upload-uri">gdata_documents_service_get_upload_uri</a></span><span class="normal"> </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>
 
132
<span class="normal">new_folder </span><span class="symbol">=</span><span class="normal"> </span><span class="function">GDATA_DOCUMENTS_FOLDER</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="GDataService.html#gdata-service-insert-entry">gdata_service_insert_entry</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GDATA_SERVICE</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">),</span><span class="normal"> upload_uri</span><span class="symbol">,</span><span class="normal"> </span><span class="function">GDATA_ENTRY</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">folder</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">&amp;</span><span class="normal">error</span><span class="symbol">));</span>
 
133
<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">upload_uri</span><span class="symbol">);</span>
 
134
 
 
135
<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">folder</span><span class="symbol">);</span>
 
136
<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>
 
137
 
 
138
<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>
 
139
<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 inserting new folder: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
 
140
<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>
 
141
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
 
142
<span class="cbracket">}</span>
 
143
 
 
144
<span class="comment">/* Do something with the new folder, such as store its ID for future use */</span>
 
145
 
 
146
<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">new_folder</span><span class="symbol">);</span></pre></td>
 
147
      </tr>
 
148
    </tbody>
 
149
  </table>
 
150
</div>
 
151
 
 
152
</div>
 
153
<p><br class="example-break">
 
154
</p>
81
155
</div>
82
156
<div class="refsect1">
83
157
<a name="GDataDocumentsFolder.details"></a><h2>Details</h2>
103
177
<hr>
104
178
<div class="refsect2">
105
179
<a name="gdata-documents-folder-new"></a><h3>gdata_documents_folder_new ()</h3>
106
 
<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="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
 
180
<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="/opt/gnome3/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
107
181
<p>
108
182
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>).
109
183
</p>
112
186
<tbody>
113
187
<tr>
114
188
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
115
 
<td>the entry's ID (not the document ID of the folder), or <a href="/opt/gnome2/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>
 
189
<td>the entry's ID (not the document ID of the folder), 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>
116
190
</td>
117
191
</tr>
118
192
<tr>
119
193
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
120
 
<td>a new <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</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>
 
194
<td>a new <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder"><span class="type">GDataDocumentsFolder</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>
121
195
</td>
122
196
</tr>
123
197
</tbody>