← Back to branch summary

~nik90/ubuntu/precise/eog/keywords

« back to all changes in this revision

Viewing changes to doc/reference/html/eog-eog-list-store.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2011-07-26 15:28:21 UTC
  • mfrom: (1.14.18 upstream)
  • Revision ID: james.westby@ubuntu.com-20110726152821-aepehu9xcvzuoitl
Tags: 3.1.4-0ubuntu1
https://launchpad.net/bugs/673299
* New upsteam release:
  - if saving an image fails it's done silently (LP: #673299)
* debian/control:
  - set Vcs-Bzr to the ubuntu-desktop team, no gnome3-team

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/eog-eog-list-store.html
45
45
enum                <a class="link" href="eog-eog-list-store.html#EogListStoreColumn" title="enum EogListStoreColumn">EogListStoreColumn</a>;
46
46
struct              <a class="link" href="eog-eog-list-store.html#EogListStore-struct" title="struct EogListStore">EogListStore</a>;
47
47
<span class="returnvalue">GtkListStore</span> *      <a class="link" href="eog-eog-list-store.html#eog-list-store-new" title="eog_list_store_new ()">eog_list_store_new</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
48
 
<span class="returnvalue">GtkListStore</span> *      <a class="link" href="eog-eog-list-store.html#eog-list-store-new-from-glist" title="eog_list_store_new_from_glist ()">eog_list_store_new_from_glist</a>       (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);
 
48
<span class="returnvalue">GtkListStore</span> *      <a class="link" href="eog-eog-list-store.html#eog-list-store-new-from-glist" title="eog_list_store_new_from_glist ()">eog_list_store_new_from_glist</a>       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *list</code></em>);
49
49
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-list-store.html#eog-list-store-append-image" title="eog_list_store_append_image ()">eog_list_store_append_image</a>         (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
50
50
                                                         <em class="parameter"><code><a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a> *image</code></em>);
51
51
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-list-store.html#eog-list-store-add-files" title="eog_list_store_add_files ()">eog_list_store_add_files</a>            (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
52
 
                                                         <em class="parameter"><code><span class="type">GList</span> *file_list</code></em>);
 
52
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *file_list</code></em>);
53
53
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-list-store.html#eog-list-store-remove-image" title="eog_list_store_remove_image ()">eog_list_store_remove_image</a>         (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
54
54
                                                         <em class="parameter"><code><a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a> *image</code></em>);
55
 
<span class="returnvalue">gint</span>                <a class="link" href="eog-eog-list-store.html#eog-list-store-get-pos-by-image" title="eog_list_store_get_pos_by_image ()">eog_list_store_get_pos_by_image</a>     (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
 
55
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="eog-eog-list-store.html#eog-list-store-get-pos-by-image" title="eog_list_store_get_pos_by_image ()">eog_list_store_get_pos_by_image</a>     (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
56
56
                                                         <em class="parameter"><code><a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a> *image</code></em>);
57
57
<a class="link" href="eog-eog-image.html#EogImage"><span class="returnvalue">EogImage</span></a> *          <a class="link" href="eog-eog-list-store.html#eog-list-store-get-image-by-pos" title="eog_list_store_get_image_by_pos ()">eog_list_store_get_image_by_pos</a>     (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
58
 
                                                         <em class="parameter"><code><span class="type">gint</span> pos</code></em>);
59
 
<span class="returnvalue">gint</span>                <a class="link" href="eog-eog-list-store.html#eog-list-store-get-pos-by-iter" title="eog_list_store_get_pos_by_iter ()">eog_list_store_get_pos_by_iter</a>      (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
 
58
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> pos</code></em>);
 
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="eog-eog-list-store.html#eog-list-store-get-pos-by-iter" title="eog_list_store_get_pos_by_iter ()">eog_list_store_get_pos_by_iter</a>      (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
60
60
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>);
61
 
<span class="returnvalue">gint</span>                <a class="link" href="eog-eog-list-store.html#eog-list-store-length" title="eog_list_store_length ()">eog_list_store_length</a>               (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>);
62
 
<span class="returnvalue">gint</span>                <a class="link" href="eog-eog-list-store.html#eog-list-store-get-initial-pos" title="eog_list_store_get_initial_pos ()">eog_list_store_get_initial_pos</a>      (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>);
 
61
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="eog-eog-list-store.html#eog-list-store-length" title="eog_list_store_length ()">eog_list_store_length</a>               (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>);
 
62
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="eog-eog-list-store.html#eog-list-store-get-initial-pos" title="eog_list_store_get_initial_pos ()">eog_list_store_get_initial_pos</a>      (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>);
63
63
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-list-store.html#eog-list-store-thumbnail-set" title="eog_list_store_thumbnail_set ()">eog_list_store_thumbnail_set</a>        (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
64
64
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>);
65
65
<span class="returnvalue">void</span>                <a class="link" href="eog-eog-list-store.html#eog-list-store-thumbnail-unset" title="eog_list_store_thumbnail_unset ()">eog_list_store_thumbnail_unset</a>      (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
71
71
<div class="refsect1">
72
72
<a name="eog-eog-list-store.object-hierarchy"></a><h2>Object Hierarchy</h2>
73
73
<pre class="synopsis">
74
 
  GObject
 
74
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
75
75
   +----GtkListStore
76
76
         +----EogListStore
77
77
</pre>
135
135
<hr>
136
136
<div class="refsect2">
137
137
<a name="eog-list-store-new-from-glist"></a><h3>eog_list_store_new_from_glist ()</h3>
138
 
<pre class="programlisting"><span class="returnvalue">GtkListStore</span> *      eog_list_store_new_from_glist       (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);</pre>
 
138
<pre class="programlisting"><span class="returnvalue">GtkListStore</span> *      eog_list_store_new_from_glist       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *list</code></em>);</pre>
139
139
<p>
140
140
Creates a new <a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> from a list of <a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a>'s.
141
 
The given list must be <a href="/opt/gnome-3.0/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>-terminated.
 
141
The given list must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated.
142
142
</p>
143
143
<div class="variablelist"><table border="0">
144
144
<col align="left" valign="top">
145
145
<tbody>
146
146
<tr>
147
147
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
148
 
<td>a <a href="/opt/gnome-3.0/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>-terminated list of <a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a>'s.</td>
 
148
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of <a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a>'s.</td>
149
149
</tr>
150
150
<tr>
151
151
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
181
181
<div class="refsect2">
182
182
<a name="eog-list-store-add-files"></a><h3>eog_list_store_add_files ()</h3>
183
183
<pre class="programlisting"><span class="returnvalue">void</span>                eog_list_store_add_files            (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
184
 
                                                         <em class="parameter"><code><span class="type">GList</span> *file_list</code></em>);</pre>
 
184
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *file_list</code></em>);</pre>
185
185
<p>
186
 
Adds a list of <span class="type">GFile</span>'s to <em class="parameter"><code>store</code></em>. The given list
187
 
must be <a href="/opt/gnome-3.0/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>-terminated.
 
186
Adds a list of <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a>'s to <em class="parameter"><code>store</code></em>. The given list
 
187
must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated.
188
188
</p>
189
189
<p>
190
 
If any of the <span class="type">GFile</span>'s in <em class="parameter"><code>file_list</code></em> is a directory, all the images
 
190
If any of the <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a>'s in <em class="parameter"><code>file_list</code></em> is a directory, all the images
191
191
in that directory will be added to <em class="parameter"><code>store</code></em>. If the list of files contains
192
192
only one file and this is a regular file, then all the images in the same
193
193
directory will be added as well to <em class="parameter"><code>store</code></em>.
201
201
</tr>
202
202
<tr>
203
203
<td><p><span class="term"><em class="parameter"><code>file_list</code></em> :</span></p></td>
204
 
<td>A <a href="/opt/gnome-3.0/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>-terminated list of <span class="type">GFile</span>'s.</td>
 
204
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a>'s.</td>
205
205
</tr>
206
206
</tbody>
207
207
</table></div>
231
231
<hr>
232
232
<div class="refsect2">
233
233
<a name="eog-list-store-get-pos-by-image"></a><h3>eog_list_store_get_pos_by_image ()</h3>
234
 
<pre class="programlisting"><span class="returnvalue">gint</span>                eog_list_store_get_pos_by_image     (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
 
234
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                eog_list_store_get_pos_by_image     (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
235
235
                                                         <em class="parameter"><code><a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a> *image</code></em>);</pre>
236
236
<p>
237
237
Gets the position where <em class="parameter"><code>image</code></em> is stored in <em class="parameter"><code>store</code></em>. If <em class="parameter"><code>image</code></em>
259
259
<div class="refsect2">
260
260
<a name="eog-list-store-get-image-by-pos"></a><h3>eog_list_store_get_image_by_pos ()</h3>
261
261
<pre class="programlisting"><a class="link" href="eog-eog-image.html#EogImage"><span class="returnvalue">EogImage</span></a> *          eog_list_store_get_image_by_pos     (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
262
 
                                                         <em class="parameter"><code><span class="type">gint</span> pos</code></em>);</pre>
 
262
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> pos</code></em>);</pre>
263
263
<p>
264
264
Gets the <a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a> in the position <em class="parameter"><code>pos</code></em> of <em class="parameter"><code>store</code></em>. If there is
265
 
no image at position <em class="parameter"><code>pos</code></em>, <a href="/opt/gnome-3.0/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned.
 
265
no image at position <em class="parameter"><code>pos</code></em>, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.
266
266
</p>
267
267
<div class="variablelist"><table border="0">
268
268
<col align="left" valign="top">
277
277
</tr>
278
278
<tr>
279
279
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
280
 
<td>the <a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a> in position <em class="parameter"><code>pos</code></em> or <a href="/opt/gnome-3.0/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
280
<td>the <a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a> in position <em class="parameter"><code>pos</code></em> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
281
281
</td>
282
282
</tr>
283
283
</tbody>
286
286
<hr>
287
287
<div class="refsect2">
288
288
<a name="eog-list-store-get-pos-by-iter"></a><h3>eog_list_store_get_pos_by_iter ()</h3>
289
 
<pre class="programlisting"><span class="returnvalue">gint</span>                eog_list_store_get_pos_by_iter      (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
 
289
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                eog_list_store_get_pos_by_iter      (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>,
290
290
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>);</pre>
291
291
<p>
292
292
Gets the position of the image pointed by <em class="parameter"><code>iter</code></em>.
312
312
<hr>
313
313
<div class="refsect2">
314
314
<a name="eog-list-store-length"></a><h3>eog_list_store_length ()</h3>
315
 
<pre class="programlisting"><span class="returnvalue">gint</span>                eog_list_store_length               (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>);</pre>
 
315
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                eog_list_store_length               (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>);</pre>
316
316
<p>
317
317
Returns the number of images in the store.
318
318
</p>
333
333
<hr>
334
334
<div class="refsect2">
335
335
<a name="eog-list-store-get-initial-pos"></a><h3>eog_list_store_get_initial_pos ()</h3>
336
 
<pre class="programlisting"><span class="returnvalue">gint</span>                eog_list_store_get_initial_pos      (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>);</pre>
 
336
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                eog_list_store_get_initial_pos      (<em class="parameter"><code><a class="link" href="eog-eog-list-store.html#EogListStore"><span class="type">EogListStore</span></a> *store</code></em>);</pre>
337
337
<p>
338
338
Gets the position of the <a class="link" href="eog-eog-image.html#EogImage"><span class="type">EogImage</span></a> that should be loaded first.
339
339
If not set, it returns -1.