~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpthumb/html/GimpThumbnail.html

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpThumbnail</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIMP Thumbnail Library Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GIMP Thumbnail Library Reference Manual">
8
8
<link rel="up" href="libgimpthumb.html" title="Part I. GIMP Thumbnail Library">
9
9
<link rel="prev" href="libgimpthumb.html" title="Part I. GIMP Thumbnail Library">
10
10
<link rel="next" href="libgimpthumb-gimpthumb-utils.html" title="gimpthumb-utils">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpthumb.html" title="Part I. GIMP Thumbnail Library">
14
14
<link rel="index" href="libgimpthumb-index.html" title="Index">
26
26
<th width="100%" align="center">GIMP Thumbnail Library Reference Manual</th>
27
27
<td><a accesskey="n" href="libgimpthumb-gimpthumb-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
28
28
</tr>
29
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpThumbnail.synopsis" class="shortcut">Top</a>
30
 
                   | 
31
 
                  <a href="#GimpThumbnail.description" class="shortcut">Description</a>
32
 
                   | 
33
 
                  <a href="#GimpThumbnail.object-hierarchy" class="shortcut">Object Hierarchy</a>
34
 
                   | 
35
 
                  <a href="#GimpThumbnail.properties" class="shortcut">Properties</a></nobr></td></tr>
 
29
<tr><td colspan="5" class="shortcuts">
 
30
<a href="#GimpThumbnail.synopsis" class="shortcut">Top</a>
 
31
                 | 
 
32
                <a href="#GimpThumbnail.description" class="shortcut">Description</a>
 
33
                 | 
 
34
                <a href="#GimpThumbnail.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
35
                 | 
 
36
                <a href="#GimpThumbnail.properties" class="shortcut">Properties</a>
 
37
</td></tr>
36
38
</table>
37
 
<div class="refentry" lang="en">
 
39
<div class="refentry" title="GimpThumbnail">
38
40
<a name="GimpThumbnail"></a><div class="titlepage"></div>
39
41
<div class="refnamediv"><table width="100%"><tr>
40
42
<td valign="top">
43
45
</td>
44
46
<td valign="top" align="right"></td>
45
47
</tr></table></div>
46
 
<div class="refsynopsisdiv">
 
48
<div class="refsynopsisdiv" title="Synopsis">
47
49
<a name="GimpThumbnail.synopsis"></a><h2>Synopsis</h2>
48
50
<pre class="synopsis">
49
51
                    <a class="link" href="GimpThumbnail.html#GimpThumbnail-struct" title="GimpThumbnail">GimpThumbnail</a>;
50
 
<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a>*      <a class="link" href="GimpThumbnail.html#gimp-thumbnail-new" title="gimp_thumbnail_new ()">gimp_thumbnail_new</a>                  (void);
 
52
<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *     <a class="link" href="GimpThumbnail.html#gimp-thumbnail-new" title="gimp_thumbnail_new ()">gimp_thumbnail_new</a>                  (void);
51
53
void                <a class="link" href="GimpThumbnail.html#gimp-thumbnail-set-uri" title="gimp_thumbnail_set_uri ()">gimp_thumbnail_set_uri</a>              (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
52
54
                                                         const <a
53
55
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
76
78
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbState" title="enum GimpThumbState">GimpThumbState</a>      <a class="link" href="GimpThumbnail.html#gimp-thumbnail-check-thumb" title="gimp_thumbnail_check_thumb ()">gimp_thumbnail_check_thumb</a>          (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
77
79
                                                         <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize" title="enum GimpThumbSize">GimpThumbSize</a> size);
78
80
<a
79
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
80
 
>GdkPixbuf</a>*          <a class="link" href="GimpThumbnail.html#gimp-thumbnail-load-thumb" title="gimp_thumbnail_load_thumb ()">gimp_thumbnail_load_thumb</a>           (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
 
81
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
82
>GdkPixbuf</a> *         <a class="link" href="GimpThumbnail.html#gimp-thumbnail-load-thumb" title="gimp_thumbnail_load_thumb ()">gimp_thumbnail_load_thumb</a>           (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
81
83
                                                         <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize" title="enum GimpThumbSize">GimpThumbSize</a> size,
82
84
                                                         <a
83
85
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
86
88
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
87
89
>gboolean</a>            <a class="link" href="GimpThumbnail.html#gimp-thumbnail-save-thumb" title="gimp_thumbnail_save_thumb ()">gimp_thumbnail_save_thumb</a>           (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
88
90
                                                         <a
89
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
91
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
90
92
>GdkPixbuf</a> *pixbuf,
91
93
                                                         const <a
92
94
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
98
100
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
99
101
>gboolean</a>            <a class="link" href="GimpThumbnail.html#gimp-thumbnail-save-thumb-local" title="gimp_thumbnail_save_thumb_local ()">gimp_thumbnail_save_thumb_local</a>     (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
100
102
                                                         <a
101
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
103
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
102
104
>GdkPixbuf</a> *pixbuf,
103
105
                                                         const <a
104
106
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
123
125
>gboolean</a>            <a class="link" href="GimpThumbnail.html#gimp-thumbnail-has-failed" title="gimp_thumbnail_has_failed ()">gimp_thumbnail_has_failed</a>           (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail);
124
126
</pre>
125
127
</div>
126
 
<div class="refsect1" lang="en">
 
128
<div class="refsect1" title="Object Hierarchy">
127
129
<a name="GimpThumbnail.object-hierarchy"></a><h2>Object Hierarchy</h2>
128
130
<pre class="synopsis">
129
131
  <a
132
134
   +----GimpThumbnail
133
135
</pre>
134
136
</div>
135
 
<div class="refsect1" lang="en">
 
137
<div class="refsect1" title="Properties">
136
138
<a name="GimpThumbnail.properties"></a><h2>Properties</h2>
137
139
<pre class="synopsis">
138
 
  "<a class="link" href="GimpThumbnail.html#GimpThumbnail--image-filesize" title='The "image-filesize" property'>image-filesize</a>"           gint64                : Read / Write
 
140
  "<a class="link" href="GimpThumbnail.html#GimpThumbnail--image-filesize" title='The "image-filesize" property'>image-filesize</a>"           <a
 
141
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"
 
142
>gint64</a>                : Read / Write
139
143
  "<a class="link" href="GimpThumbnail.html#GimpThumbnail--image-height" title='The "image-height" property'>image-height</a>"             <a
140
144
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
141
145
>gint</a>                  : Read / Write
142
146
  "<a class="link" href="GimpThumbnail.html#GimpThumbnail--image-mimetype" title='The "image-mimetype" property'>image-mimetype</a>"           <a
143
147
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
144
148
>gchar</a>*                : Read / Write
145
 
  "<a class="link" href="GimpThumbnail.html#GimpThumbnail--image-mtime" title='The "image-mtime" property'>image-mtime</a>"              gint64                : Read / Write
 
149
  "<a class="link" href="GimpThumbnail.html#GimpThumbnail--image-mtime" title='The "image-mtime" property'>image-mtime</a>"              <a
 
150
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"
 
151
>gint64</a>                : Read / Write
146
152
  "<a class="link" href="GimpThumbnail.html#GimpThumbnail--image-num-layers" title='The "image-num-layers" property'>image-num-layers</a>"         <a
147
153
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
148
154
>gint</a>                  : Read / Write
159
165
  "<a class="link" href="GimpThumbnail.html#GimpThumbnail--thumb-state" title='The "thumb-state" property'>thumb-state</a>"              <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbState" title="enum GimpThumbState">GimpThumbState</a>        : Read / Write
160
166
</pre>
161
167
</div>
162
 
<div class="refsect1" lang="en">
 
168
<div class="refsect1" title="Description">
163
169
<a name="GimpThumbnail.description"></a><h2>Description</h2>
164
170
<p>
165
 
 
166
171
</p>
167
172
</div>
168
 
<div class="refsect1" lang="en">
 
173
<div class="refsect1" title="Details">
169
174
<a name="GimpThumbnail.details"></a><h2>Details</h2>
170
 
<div class="refsect2" lang="en">
 
175
<div class="refsect2" title="GimpThumbnail">
171
176
<a name="GimpThumbnail-struct"></a><h3>GimpThumbnail</h3>
172
177
<pre class="programlisting">typedef struct _GimpThumbnail GimpThumbnail;</pre>
173
178
<p>
176
181
</p>
177
182
</div>
178
183
<hr>
179
 
<div class="refsect2" lang="en">
 
184
<div class="refsect2" title="gimp_thumbnail_new ()">
180
185
<a name="gimp-thumbnail-new"></a><h3>gimp_thumbnail_new ()</h3>
181
 
<pre class="programlisting"><a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a>*      gimp_thumbnail_new                  (void);</pre>
 
186
<pre class="programlisting"><a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *     gimp_thumbnail_new                  (void);</pre>
182
187
<p>
183
188
Creates a new <a class="link" href="GimpThumbnail.html" title="GimpThumbnail"><span class="type">GimpThumbnail</span></a> object.</p>
184
189
<p>
185
 
 
186
190
</p>
187
191
<div class="variablelist"><table border="0">
188
192
<col align="left" valign="top">
194
198
</table></div>
195
199
</div>
196
200
<hr>
197
 
<div class="refsect2" lang="en">
 
201
<div class="refsect2" title="gimp_thumbnail_set_uri ()">
198
202
<a name="gimp-thumbnail-set-uri"></a><h3>gimp_thumbnail_set_uri ()</h3>
199
203
<pre class="programlisting">void                gimp_thumbnail_set_uri              (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
200
204
                                                         const <a
206
210
<p>
207
211
All informations stored in the <a class="link" href="GimpThumbnail.html" title="GimpThumbnail"><span class="type">GimpThumbnail</span></a> are reset.</p>
208
212
<p>
209
 
 
210
213
</p>
211
214
<div class="variablelist"><table border="0">
212
215
<col align="left" valign="top">
225
228
</table></div>
226
229
</div>
227
230
<hr>
228
 
<div class="refsect2" lang="en">
 
231
<div class="refsect2" title="gimp_thumbnail_set_filename ()">
229
232
<a name="gimp-thumbnail-set-filename"></a><h3>gimp_thumbnail_set_filename ()</h3>
230
233
<pre class="programlisting"><a
231
234
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
239
242
<p>
240
243
Sets the location of the image file associated with the <span class="type">thumbnail</span>.</p>
241
244
<p>
242
 
 
243
245
</p>
244
246
<div class="variablelist"><table border="0">
245
247
<col align="left" valign="top">
262
264
<tr>
263
265
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
264
266
<td> <a
265
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
267
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
266
268
><code class="literal">TRUE</code></a> if the filename was successfully set,
267
269
              <a
268
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"
 
270
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
269
271
><code class="literal">FALSE</code></a> otherwise
270
272
</td>
271
273
</tr>
273
275
</table></div>
274
276
</div>
275
277
<hr>
276
 
<div class="refsect2" lang="en">
 
278
<div class="refsect2" title="gimp_thumbnail_set_from_thumb ()">
277
279
<a name="gimp-thumbnail-set-from-thumb"></a><h3>gimp_thumbnail_set_from_thumb ()</h3>
278
280
<pre class="programlisting"><a
279
281
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
294
296
This will only work with thumbnails from the global thumbnail
295
297
directory that contain a valid Thumb::URI tag.</p>
296
298
<p>
297
 
 
298
299
</p>
299
300
<div class="variablelist"><table border="0">
300
301
<col align="left" valign="top">
317
318
<tr>
318
319
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
319
320
<td> <a
320
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
321
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
321
322
><code class="literal">TRUE</code></a> if the pixbuf could be loaded, <a
322
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"
 
323
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
323
324
><code class="literal">FALSE</code></a> otherwise
324
325
</td>
325
326
</tr>
327
328
</table></div>
328
329
</div>
329
330
<hr>
330
 
<div class="refsect2" lang="en">
 
331
<div class="refsect2" title="gimp_thumbnail_peek_image ()">
331
332
<a name="gimp-thumbnail-peek-image"></a><h3>gimp_thumbnail_peek_image ()</h3>
332
333
<pre class="programlisting"><a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbState" title="enum GimpThumbState">GimpThumbState</a>      gimp_thumbnail_peek_image           (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail);</pre>
333
334
<p>
334
335
Checks the image file associated with the <em class="parameter"><code>thumbnail</code></em> and updates
335
336
information such as state, filesize and modification time.</p>
336
337
<p>
337
 
 
338
338
</p>
339
339
<div class="variablelist"><table border="0">
340
340
<col align="left" valign="top">
353
353
</table></div>
354
354
</div>
355
355
<hr>
356
 
<div class="refsect2" lang="en">
 
356
<div class="refsect2" title="gimp_thumbnail_peek_thumb ()">
357
357
<a name="gimp-thumbnail-peek-thumb"></a><h3>gimp_thumbnail_peek_thumb ()</h3>
358
358
<pre class="programlisting"><a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbState" title="enum GimpThumbState">GimpThumbState</a>      gimp_thumbnail_peek_thumb           (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
359
359
                                                         <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize" title="enum GimpThumbSize">GimpThumbSize</a> size);</pre>
368
368
<a class="link" href="GimpThumbnail.html#gimp-thumbnail-load-thumb" title="gimp_thumbnail_load_thumb ()"><code class="function">gimp_thumbnail_load_thumb()</code></a>, or, if you don't need the resulting
369
369
thumbnail pixbuf, use <a class="link" href="GimpThumbnail.html#gimp-thumbnail-check-thumb" title="gimp_thumbnail_check_thumb ()"><code class="function">gimp_thumbnail_check_thumb()</code></a>.</p>
370
370
<p>
371
 
 
372
371
</p>
373
372
<div class="variablelist"><table border="0">
374
373
<col align="left" valign="top">
392
391
</table></div>
393
392
</div>
394
393
<hr>
395
 
<div class="refsect2" lang="en">
 
394
<div class="refsect2" title="gimp_thumbnail_check_thumb ()">
396
395
<a name="gimp-thumbnail-check-thumb"></a><h3>gimp_thumbnail_check_thumb ()</h3>
397
396
<pre class="programlisting"><a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbState" title="enum GimpThumbState">GimpThumbState</a>      gimp_thumbnail_check_thumb          (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
398
397
                                                         <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize" title="enum GimpThumbSize">GimpThumbSize</a> size);</pre>
401
400
verifies it is valid and uptodate for the image file asosciated
402
401
with the <em class="parameter"><code>thumbnail</code></em>.</p>
403
402
<p>
404
 
 
405
403
</p>
406
404
<div class="variablelist"><table border="0">
407
405
<col align="left" valign="top">
424
422
</tr>
425
423
</tbody>
426
424
</table></div>
427
 
<p class="since">Since  GIMP 2.2
428
 
</p>
 
425
<p class="since">Since GIMP 2.2</p>
429
426
</div>
430
427
<hr>
431
 
<div class="refsect2" lang="en">
 
428
<div class="refsect2" title="gimp_thumbnail_load_thumb ()">
432
429
<a name="gimp-thumbnail-load-thumb"></a><h3>gimp_thumbnail_load_thumb ()</h3>
433
430
<pre class="programlisting"><a
434
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
435
 
>GdkPixbuf</a>*          gimp_thumbnail_load_thumb           (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
 
431
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
432
>GdkPixbuf</a> *         gimp_thumbnail_load_thumb           (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
436
433
                                                         <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize" title="enum GimpThumbSize">GimpThumbSize</a> size,
437
434
                                                         <a
438
435
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
452
449
In order to verify if the preview is uptodate, you should check the
453
450
"thumb_state" property after calling this function.</p>
454
451
<p>
455
 
 
456
452
</p>
457
453
<div class="variablelist"><table border="0">
458
454
<col align="left" valign="top">
475
471
<tr>
476
472
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
477
473
<td> a preview pixbuf or <a
478
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
 
474
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
479
475
><code class="literal">NULL</code></a> if no thumbnail was found
480
476
</td>
481
477
</tr>
483
479
</table></div>
484
480
</div>
485
481
<hr>
486
 
<div class="refsect2" lang="en">
 
482
<div class="refsect2" title="gimp_thumbnail_save_thumb ()">
487
483
<a name="gimp-thumbnail-save-thumb"></a><h3>gimp_thumbnail_save_thumb ()</h3>
488
484
<pre class="programlisting"><a
489
485
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
490
486
>gboolean</a>            gimp_thumbnail_save_thumb           (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
491
487
                                                         <a
492
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
488
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
493
489
>GdkPixbuf</a> *pixbuf,
494
490
                                                         const <a
495
491
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
513
509
The image format type and the number of layers can optionally be
514
510
set in order to be stored with the preview image.</p>
515
511
<p>
516
 
 
517
512
</p>
518
513
<div class="variablelist"><table border="0">
519
514
<col align="left" valign="top">
526
521
<tr>
527
522
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
528
523
<td> a <a
529
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
524
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
530
525
><span class="type">GdkPixbuf</span></a> representing the preview thumbnail
531
526
</td>
532
527
</tr>
543
538
<tr>
544
539
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
545
540
<td> <a
546
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
541
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
547
542
><code class="literal">TRUE</code></a> if a thumbnail was successfully written,
548
543
              <a
549
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"
 
544
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
550
545
><code class="literal">FALSE</code></a> otherwise
551
546
</td>
552
547
</tr>
554
549
</table></div>
555
550
</div>
556
551
<hr>
557
 
<div class="refsect2" lang="en">
 
552
<div class="refsect2" title="gimp_thumbnail_save_thumb_local ()">
558
553
<a name="gimp-thumbnail-save-thumb-local"></a><h3>gimp_thumbnail_save_thumb_local ()</h3>
559
554
<pre class="programlisting"><a
560
555
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
561
556
>gboolean</a>            gimp_thumbnail_save_thumb_local     (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
562
557
                                                         <a
563
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
558
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
564
559
>GdkPixbuf</a> *pixbuf,
565
560
                                                         const <a
566
561
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
577
572
Please see also <a class="link" href="GimpThumbnail.html#gimp-thumbnail-save-thumb" title="gimp_thumbnail_save_thumb ()"><code class="function">gimp_thumbnail_save_thumb()</code></a>. The notes made there
578
573
apply here as well.</p>
579
574
<p>
580
 
 
581
575
</p>
582
576
<div class="variablelist"><table border="0">
583
577
<col align="left" valign="top">
590
584
<tr>
591
585
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
592
586
<td> a <a
593
 
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
587
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
594
588
><span class="type">GdkPixbuf</span></a> representing the preview thumbnail
595
589
</td>
596
590
</tr>
607
601
<tr>
608
602
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
609
603
<td> <a
610
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
604
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
611
605
><code class="literal">TRUE</code></a> if a thumbnail was successfully written,
612
606
              <a
613
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"
 
607
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
614
608
><code class="literal">FALSE</code></a> otherwise
615
609
 
616
610
</td>
617
611
</tr>
618
612
</tbody>
619
613
</table></div>
620
 
<p class="since">Since  GIMP 2.2
621
 
</p>
 
614
<p class="since">Since GIMP 2.2</p>
622
615
</div>
623
616
<hr>
624
 
<div class="refsect2" lang="en">
 
617
<div class="refsect2" title="gimp_thumbnail_save_failure ()">
625
618
<a name="gimp-thumbnail-save-failure"></a><h3>gimp_thumbnail_save_failure ()</h3>
626
619
<pre class="programlisting"><a
627
620
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
638
631
to create a preview for the image file failed. It should be used to
639
632
prevent the software from further attempts to create this thumbnail.</p>
640
633
<p>
641
 
 
642
634
</p>
643
635
<div class="variablelist"><table border="0">
644
636
<col align="left" valign="top">
661
653
<tr>
662
654
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
663
655
<td> <a
664
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
656
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
665
657
><code class="literal">TRUE</code></a> if a failure thumbnail was successfully written,
666
658
              <a
667
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"
 
659
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
668
660
><code class="literal">FALSE</code></a> otherwise
669
661
</td>
670
662
</tr>
672
664
</table></div>
673
665
</div>
674
666
<hr>
675
 
<div class="refsect2" lang="en">
 
667
<div class="refsect2" title="gimp_thumbnail_delete_failure ()">
676
668
<a name="gimp-thumbnail-delete-failure"></a><h3>gimp_thumbnail_delete_failure ()</h3>
677
669
<pre class="programlisting">void                gimp_thumbnail_delete_failure       (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail);</pre>
678
670
<p>
679
671
Removes a failure thumbnail if one exists. This function should be
680
672
used after a thumbnail has been successfully created.</p>
681
673
<p>
682
 
 
683
674
</p>
684
675
<div class="variablelist"><table border="0">
685
676
<col align="left" valign="top">
689
680
</td>
690
681
</tr></tbody>
691
682
</table></div>
692
 
<p class="since">Since  GIMP 2.2
693
 
</p>
 
683
<p class="since">Since GIMP 2.2</p>
694
684
</div>
695
685
<hr>
696
 
<div class="refsect2" lang="en">
 
686
<div class="refsect2" title="gimp_thumbnail_delete_others ()">
697
687
<a name="gimp-thumbnail-delete-others"></a><h3>gimp_thumbnail_delete_others ()</h3>
698
688
<pre class="programlisting">void                gimp_thumbnail_delete_others        (<a class="link" href="GimpThumbnail.html" title="GimpThumbnail">GimpThumbnail</a> *thumbnail,
699
689
                                                         <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize" title="enum GimpThumbSize">GimpThumbSize</a> size);</pre>
704
694
updated. See the spec for a more detailed description on when to
705
695
delete thumbnails.</p>
706
696
<p>
707
 
 
708
697
</p>
709
698
<div class="variablelist"><table border="0">
710
699
<col align="left" valign="top">
721
710
</tr>
722
711
</tbody>
723
712
</table></div>
724
 
<p class="since">Since  GIMP 2.2
725
 
</p>
 
713
<p class="since">Since GIMP 2.2</p>
726
714
</div>
727
715
<hr>
728
 
<div class="refsect2" lang="en">
 
716
<div class="refsect2" title="gimp_thumbnail_has_failed ()">
729
717
<a name="gimp-thumbnail-has-failed"></a><h3>gimp_thumbnail_has_failed ()</h3>
730
718
<pre class="programlisting"><a
731
719
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
733
721
<p>
734
722
Checks if a valid failure thumbnail for the given thumbnail exists
735
723
in the global thumbnail repository. This may be the case even if
736
 
<a class="link" href="GimpThumbnail.html#gimp-thumbnail-peek-thumb" title="gimp_thumbnail_peek_thumb ()"><code class="function">gimp_thumbnail_peek_thumb()</code></a> doesn't return <a class="link" href="libgimpthumb-gimpthumb-enums.html#GIMP-THUMB-STATE-FAILED:CAPS"><code class="literal">GIMP_THUMB_STATE_FAILED</code></a>
 
724
<a class="link" href="GimpThumbnail.html#gimp-thumbnail-peek-thumb" title="gimp_thumbnail_peek_thumb ()"><code class="function">gimp_thumbnail_peek_thumb()</code></a> doesn't return <a class="link" href="libgimpthumb-gimpthumb-enums.html#GIMP-THUMB-STATE-FAILED--CAPS"><code class="literal">GIMP_THUMB_STATE_FAILED</code></a>
737
725
since there might be a real thumbnail and a failure thumbnail for
738
726
the same image file.
739
727
</p>
741
729
The application should not attempt to create the thumbnail if a
742
730
valid failure thumbnail exists.</p>
743
731
<p>
744
 
 
745
732
</p>
746
733
<div class="variablelist"><table border="0">
747
734
<col align="left" valign="top">
754
741
<tr>
755
742
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
756
743
<td> <a
757
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
744
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
758
745
><code class="literal">TRUE</code></a> if a failure thumbnail exists or
759
746
 
760
747
</td>
761
748
</tr>
762
749
</tbody>
763
750
</table></div>
764
 
<p class="since">Since  GIMP 2.2
765
 
</p>
766
 
</div>
767
 
</div>
768
 
<div class="refsect1" lang="en">
 
751
<p class="since">Since GIMP 2.2</p>
 
752
</div>
 
753
</div>
 
754
<div class="refsect1" title="Property Details">
769
755
<a name="GimpThumbnail.property-details"></a><h2>Property Details</h2>
770
 
<div class="refsect2" lang="en">
 
756
<div class="refsect2" title='The "image-filesize" property'>
771
757
<a name="GimpThumbnail--image-filesize"></a><h3>The <code class="literal">"image-filesize"</code> property</h3>
772
 
<pre class="programlisting">  "image-filesize"           gint64                : Read / Write</pre>
 
758
<pre class="programlisting">  "image-filesize"           <a
 
759
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"
 
760
>gint64</a>                : Read / Write</pre>
773
761
<p>Size of the image file in bytes.</p>
774
762
<p>Allowed values: &gt;= 0</p>
775
763
<p>Default value: 0</p>
776
764
</div>
777
765
<hr>
778
 
<div class="refsect2" lang="en">
 
766
<div class="refsect2" title='The "image-height" property'>
779
767
<a name="GimpThumbnail--image-height"></a><h3>The <code class="literal">"image-height"</code> property</h3>
780
768
<pre class="programlisting">  "image-height"             <a
781
769
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
785
773
<p>Default value: 0</p>
786
774
</div>
787
775
<hr>
788
 
<div class="refsect2" lang="en">
 
776
<div class="refsect2" title='The "image-mimetype" property'>
789
777
<a name="GimpThumbnail--image-mimetype"></a><h3>The <code class="literal">"image-mimetype"</code> property</h3>
790
778
<pre class="programlisting">  "image-mimetype"           <a
791
779
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
794
782
<p>Default value: NULL</p>
795
783
</div>
796
784
<hr>
797
 
<div class="refsect2" lang="en">
 
785
<div class="refsect2" title='The "image-mtime" property'>
798
786
<a name="GimpThumbnail--image-mtime"></a><h3>The <code class="literal">"image-mtime"</code> property</h3>
799
 
<pre class="programlisting">  "image-mtime"              gint64                : Read / Write</pre>
 
787
<pre class="programlisting">  "image-mtime"              <a
 
788
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"
 
789
>gint64</a>                : Read / Write</pre>
800
790
<p>Modification time of the image file in seconds since the Epoch.</p>
801
791
<p>Allowed values: &gt;= 0</p>
802
792
<p>Default value: 0</p>
803
793
</div>
804
794
<hr>
805
 
<div class="refsect2" lang="en">
 
795
<div class="refsect2" title='The "image-num-layers" property'>
806
796
<a name="GimpThumbnail--image-num-layers"></a><h3>The <code class="literal">"image-num-layers"</code> property</h3>
807
797
<pre class="programlisting">  "image-num-layers"         <a
808
798
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
812
802
<p>Default value: 0</p>
813
803
</div>
814
804
<hr>
815
 
<div class="refsect2" lang="en">
 
805
<div class="refsect2" title='The "image-state" property'>
816
806
<a name="GimpThumbnail--image-state"></a><h3>The <code class="literal">"image-state"</code> property</h3>
817
807
<pre class="programlisting">  "image-state"              <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbState" title="enum GimpThumbState">GimpThumbState</a>        : Read / Write</pre>
818
808
<p>State of the image associated to the thumbnail object.</p>
819
809
<p>Default value: GIMP_THUMB_STATE_UNKNOWN</p>
820
810
</div>
821
811
<hr>
822
 
<div class="refsect2" lang="en">
 
812
<div class="refsect2" title='The "image-type" property'>
823
813
<a name="GimpThumbnail--image-type"></a><h3>The <code class="literal">"image-type"</code> property</h3>
824
814
<pre class="programlisting">  "image-type"               <a
825
815
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
828
818
<p>Default value: NULL</p>
829
819
</div>
830
820
<hr>
831
 
<div class="refsect2" lang="en">
 
821
<div class="refsect2" title='The "image-uri" property'>
832
822
<a name="GimpThumbnail--image-uri"></a><h3>The <code class="literal">"image-uri"</code> property</h3>
833
823
<pre class="programlisting">  "image-uri"                <a
834
824
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
837
827
<p>Default value: NULL</p>
838
828
</div>
839
829
<hr>
840
 
<div class="refsect2" lang="en">
 
830
<div class="refsect2" title='The "image-width" property'>
841
831
<a name="GimpThumbnail--image-width"></a><h3>The <code class="literal">"image-width"</code> property</h3>
842
832
<pre class="programlisting">  "image-width"              <a
843
833
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
847
837
<p>Default value: 0</p>
848
838
</div>
849
839
<hr>
850
 
<div class="refsect2" lang="en">
 
840
<div class="refsect2" title='The "thumb-state" property'>
851
841
<a name="GimpThumbnail--thumb-state"></a><h3>The <code class="literal">"thumb-state"</code> property</h3>
852
842
<pre class="programlisting">  "thumb-state"              <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbState" title="enum GimpThumbState">GimpThumbState</a>        : Read / Write</pre>
853
843
<p>State of the thumbnail file.</p>
857
847
</div>
858
848
<div class="footer">
859
849
<hr>
860
 
          Generated by GTK-Doc V1.10</div>
 
850
          Generated by GTK-Doc V1.11</div>
861
851
</body>
862
852
</html>