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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpThumbnail">
<refmeta>
<refentrytitle role="top_of_page">GimpThumbnail</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPTHUMB Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpThumbnail</refname>
<refpurpose>The GimpThumbnail object</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpThumbnail-struct">GimpThumbnail</link>;
<link linkend="GimpThumbnail">GimpThumbnail</link>* <link linkend="gimp-thumbnail-new">gimp_thumbnail_new</link> (void);
<link linkend="void">void</link> <link linkend="gimp-thumbnail-set-uri">gimp_thumbnail_set_uri</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
const <link linkend="gchar">gchar</link> *uri);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-thumbnail-set-filename">gimp_thumbnail_set_filename</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-thumbnail-set-from-thumb">gimp_thumbnail_set_from_thumb</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="GError">GError</link> **error);
<link linkend="GimpThumbState">GimpThumbState</link> <link linkend="gimp-thumbnail-peek-image">gimp_thumbnail_peek_image</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail);
<link linkend="GimpThumbState">GimpThumbState</link> <link linkend="gimp-thumbnail-peek-thumb">gimp_thumbnail_peek_thumb</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GimpThumbSize">GimpThumbSize</link> size);
<link linkend="GimpThumbState">GimpThumbState</link> <link linkend="gimp-thumbnail-check-thumb">gimp_thumbnail_check_thumb</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GimpThumbSize">GimpThumbSize</link> size);
<link linkend="GdkPixbuf">GdkPixbuf</link>* <link linkend="gimp-thumbnail-load-thumb">gimp_thumbnail_load_thumb</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GimpThumbSize">GimpThumbSize</link> size,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-thumbnail-save-thumb">gimp_thumbnail_save_thumb</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf,
const <link linkend="gchar">gchar</link> *software,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-thumbnail-save-thumb-local">gimp_thumbnail_save_thumb_local</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf,
const <link linkend="gchar">gchar</link> *software,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-thumbnail-save-failure">gimp_thumbnail_save_failure</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
const <link linkend="gchar">gchar</link> *software,
<link linkend="GError">GError</link> **error);
<link linkend="void">void</link> <link linkend="gimp-thumbnail-delete-failure">gimp_thumbnail_delete_failure</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail);
<link linkend="void">void</link> <link linkend="gimp-thumbnail-delete-others">gimp_thumbnail_delete_others</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GimpThumbSize">GimpThumbSize</link> size);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-thumbnail-has-failed">gimp_thumbnail_has_failed</link> (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GimpThumbnail
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GimpThumbnail--image-filesize">image-filesize</link>" <link linkend="gint64">gint64</link> : Read / Write
"<link linkend="GimpThumbnail--image-height">image-height</link>" <link linkend="gint">gint</link> : Read / Write
"<link linkend="GimpThumbnail--image-mimetype">image-mimetype</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GimpThumbnail--image-mtime">image-mtime</link>" <link linkend="gint64">gint64</link> : Read / Write
"<link linkend="GimpThumbnail--image-num-layers">image-num-layers</link>" <link linkend="gint">gint</link> : Read / Write
"<link linkend="GimpThumbnail--image-state">image-state</link>" <link linkend="GimpThumbState">GimpThumbState</link> : Read / Write
"<link linkend="GimpThumbnail--image-type">image-type</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GimpThumbnail--image-uri">image-uri</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GimpThumbnail--image-width">image-width</link>" <link linkend="gint">gint</link> : Read / Write
"<link linkend="GimpThumbnail--thumb-state">thumb-state</link>" <link linkend="GimpThumbState">GimpThumbState</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GimpThumbnail-struct" role="struct"/>GimpThumbnail</title>
<indexterm><primary>GimpThumbnail</primary></indexterm><programlisting>typedef struct _GimpThumbnail GimpThumbnail;</programlisting>
<para>
All members of <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> are private and should only be accessed
using object properties.
</para></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-new" role="function"/>gimp_thumbnail_new ()</title>
<indexterm><primary>gimp_thumbnail_new</primary></indexterm><programlisting><link linkend="GimpThumbnail">GimpThumbnail</link>* gimp_thumbnail_new (void);</programlisting>
<para>
Creates a new <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated GimpThumbnail object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-set-uri" role="function"/>gimp_thumbnail_set_uri ()</title>
<indexterm><primary>gimp_thumbnail_set_uri</primary></indexterm><programlisting><link linkend="void">void</link> gimp_thumbnail_set_uri (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
const <link linkend="gchar">gchar</link> *uri);</programlisting>
<para>
Sets the location of the image file associated with the <link linkend="thumbnail"><type>thumbnail</type></link>.
</para>
<para>
All informations stored in the <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> are reset.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> an escaped URI
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-set-filename" role="function"/>gimp_thumbnail_set_filename ()</title>
<indexterm><primary>gimp_thumbnail_set_filename</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_thumbnail_set_filename (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Sets the location of the image file associated with the <link linkend="thumbnail"><type>thumbnail</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> a local filename in the encoding of the filesystem
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for possible errors
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the filename was successfully set,
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-set-from-thumb" role="function"/>gimp_thumbnail_set_from_thumb ()</title>
<indexterm><primary>gimp_thumbnail_set_from_thumb</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_thumbnail_set_from_thumb (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
This function tries to load the thumbnail file pointed to by
<parameter>filename</parameter> and retrieves the URI of the original image file from
it. This allows you to find the image file associated with a
thumbnail file.
</para>
<para>
This will only work with thumbnails from the global thumbnail
directory that contain a valid Thumb::URI tag.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> filename of a local thumbnail file
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for possible errors
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the pixbuf could be loaded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-peek-image" role="function"/>gimp_thumbnail_peek_image ()</title>
<indexterm><primary>gimp_thumbnail_peek_image</primary></indexterm><programlisting><link linkend="GimpThumbState">GimpThumbState</link> gimp_thumbnail_peek_image (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail);</programlisting>
<para>
Checks the image file associated with the <parameter>thumbnail</parameter> and updates
information such as state, filesize and modification time.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the image's <link linkend="GimpThumbState"><type>GimpThumbState</type></link> after the update
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-peek-thumb" role="function"/>gimp_thumbnail_peek_thumb ()</title>
<indexterm><primary>gimp_thumbnail_peek_thumb</primary></indexterm><programlisting><link linkend="GimpThumbState">GimpThumbState</link> gimp_thumbnail_peek_thumb (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
<para>
Checks if a thumbnail file for the <parameter>thumbnail</parameter> exists. It doesn't
load the thumbnail image and thus cannot check if the thumbnail is
valid and uptodate for the image file asosciated with the
<parameter>thumbnail</parameter>.
</para>
<para>
If you want to check the thumbnail, either attempt to load it using
<link linkend="gimp-thumbnail-load-thumb"><function>gimp_thumbnail_load_thumb()</function></link>, or, if you don't need the resulting
thumbnail pixbuf, use <link linkend="gimp-thumbnail-check-thumb"><function>gimp_thumbnail_check_thumb()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> the preferred size of the thumbnail image
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the thumbnail's <link linkend="GimpThumbState"><type>GimpThumbState</type></link> after the update
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-check-thumb" role="function" condition="since:GIMP 2.2"/>gimp_thumbnail_check_thumb ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_thumbnail_check_thumb</primary></indexterm><programlisting><link linkend="GimpThumbState">GimpThumbState</link> gimp_thumbnail_check_thumb (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
<para>
Checks if a thumbnail file for the <parameter>thumbnail</parameter> exists, loads it and
verifies it is valid and uptodate for the image file asosciated
with the <parameter>thumbnail</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> the preferred size of the thumbnail image
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the thumbnail's <link linkend="GimpThumbState"><type>GimpThumbState</type></link> after the update
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-load-thumb" role="function"/>gimp_thumbnail_load_thumb ()</title>
<indexterm><primary>gimp_thumbnail_load_thumb</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>* gimp_thumbnail_load_thumb (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GimpThumbSize">GimpThumbSize</link> size,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Attempts to load a thumbnail preview for the image associated with
<parameter>thumbnail</parameter>. Before you use this function you need need to set an
image location using <link linkend="gimp-thumbnail-set-uri"><function>gimp_thumbnail_set_uri()</function></link> or
<link linkend="gimp-thumbnail-set-filename"><function>gimp_thumbnail_set_filename()</function></link>. You can also peek at the thumb
before loading it using gimp_thumbnail_peek_thumb.
</para>
<para>
This function will return the best matching pixbuf for the
specified <parameter>size</parameter>. It returns the pixbuf as loaded from disk. It is
left to the caller to scale it to the desired size. The returned
pixbuf may also represent an outdated preview of the image file.
In order to verify if the preview is uptodate, you should check the
"thumb_state" property after calling this function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> the preferred <link linkend="GimpThumbSize"><type>GimpThumbSize</type></link> for the preview
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for possible errors
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a preview pixbuf or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no thumbnail was found
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-save-thumb" role="function"/>gimp_thumbnail_save_thumb ()</title>
<indexterm><primary>gimp_thumbnail_save_thumb</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_thumbnail_save_thumb (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf,
const <link linkend="gchar">gchar</link> *software,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Saves a preview thumbnail for the image associated with <parameter>thumbnail</parameter>.
to the global thumbnail repository.
</para>
<para>
The caller is responsible for setting the image file location, it's
filesize, modification time. One way to set this info is to is to
call <link linkend="gimp-thumbnail-set-uri"><function>gimp_thumbnail_set_uri()</function></link> followed by <link linkend="gimp-thumbnail-peek-image"><function>gimp_thumbnail_peek_image()</function></link>.
Since this won't work for remote images, it is left to the user of
<link linkend="gimp-thumbnail-save-thumb"><function>gimp_thumbnail_save_thumb()</function></link> to do this or to set the information
using the <parameter>thumbnail</parameter> object properties.
</para>
<para>
The image format type and the number of layers can optionally be
set in order to be stored with the preview image.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixbuf</parameter> :</term>
<listitem><simpara> a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> representing the preview thumbnail
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>software</parameter> :</term>
<listitem><simpara> a string describing the software saving the thumbnail
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for possible errors
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a thumbnail was successfully written,
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-save-thumb-local" role="function" condition="since:GIMP 2.2"/>gimp_thumbnail_save_thumb_local ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_thumbnail_save_thumb_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_thumbnail_save_thumb_local (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf,
const <link linkend="gchar">gchar</link> *software,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Saves a preview thumbnail for the image associated with <parameter>thumbnail</parameter>
to the local thumbnail repository. Local thumbnails have been added
with version 0.7 of the spec.
</para>
<para>
Please see also <link linkend="gimp-thumbnail-save-thumb"><function>gimp_thumbnail_save_thumb()</function></link>. The notes made there
apply here as well.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixbuf</parameter> :</term>
<listitem><simpara> a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> representing the preview thumbnail
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>software</parameter> :</term>
<listitem><simpara> a string describing the software saving the thumbnail
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for possible errors
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a thumbnail was successfully written,
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-save-failure" role="function"/>gimp_thumbnail_save_failure ()</title>
<indexterm><primary>gimp_thumbnail_save_failure</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_thumbnail_save_failure (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
const <link linkend="gchar">gchar</link> *software,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Saves a failure thumbnail for the image associated with
<parameter>thumbnail</parameter>. This is an empty pixbuf that indicates that an attempt
to create a preview for the image file failed. It should be used to
prevent the software from further attempts to create this thumbnail.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>software</parameter> :</term>
<listitem><simpara> a string describing the software saving the thumbnail
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for possible errors
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a failure thumbnail was successfully written,
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-delete-failure" role="function" condition="since:GIMP 2.2"/>gimp_thumbnail_delete_failure ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_thumbnail_delete_failure</primary></indexterm><programlisting><link linkend="void">void</link> gimp_thumbnail_delete_failure (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail);</programlisting>
<para>
Removes a failure thumbnail if one exists. This function should be
used after a thumbnail has been successfully created.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-delete-others" role="function" condition="since:GIMP 2.2"/>gimp_thumbnail_delete_others ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_thumbnail_delete_others</primary></indexterm><programlisting><link linkend="void">void</link> gimp_thumbnail_delete_others (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail,
<link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
<para>
Removes all other thumbnails from the global thumbnail
repository. Only the thumbnail for <parameter>size</parameter> is not deleted. This
function should be used after a thumbnail has been successfully
updated. See the spec for a more detailed description on when to
delete thumbnails.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> the thumbnail size which should not be deleted
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-thumbnail-has-failed" role="function" condition="since:GIMP 2.2"/>gimp_thumbnail_has_failed ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_thumbnail_has_failed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_thumbnail_has_failed (<link linkend="GimpThumbnail">GimpThumbnail</link> *thumbnail);</programlisting>
<para>
Checks if a valid failure thumbnail for the given thumbnail exists
in the global thumbnail repository. This may be the case even if
<link linkend="gimp-thumbnail-peek-thumb"><function>gimp_thumbnail_peek_thumb()</function></link> doesn't return <link linkend="GIMP-THUMB-STATE-FAILED:CAPS"><literal>GIMP_THUMB_STATE_FAILED</literal></link>
since there might be a real thumbnail and a failure thumbnail for
the same image file.
</para>
<para>
The application should not attempt to create the thumbnail if a
valid failure thumbnail exists.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thumbnail</parameter> :</term>
<listitem><simpara> a <link linkend="GimpThumbnail"><type>GimpThumbnail</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a failure thumbnail exists or
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GimpThumbnail--image-filesize"/>The "<literal>image-filesize</literal>" property</title>
<indexterm><primary>GimpThumbnail:image-filesize</primary></indexterm><programlisting> "image-filesize" <link linkend="gint64">gint64</link> : Read / Write</programlisting>
<para>Size of the image file in bytes.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="GimpThumbnail--image-height"/>The "<literal>image-height</literal>" property</title>
<indexterm><primary>GimpThumbnail:image-height</primary></indexterm><programlisting> "image-height" <link linkend="gint">gint</link> : Read / Write</programlisting>
<para>Height of the image in pixels.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="GimpThumbnail--image-mimetype"/>The "<literal>image-mimetype</literal>" property</title>
<indexterm><primary>GimpThumbnail:image-mimetype</primary></indexterm><programlisting> "image-mimetype" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>Image mimetype.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GimpThumbnail--image-mtime"/>The "<literal>image-mtime</literal>" property</title>
<indexterm><primary>GimpThumbnail:image-mtime</primary></indexterm><programlisting> "image-mtime" <link linkend="gint64">gint64</link> : Read / Write</programlisting>
<para>Modification time of the image file in seconds since the Epoch.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="GimpThumbnail--image-num-layers"/>The "<literal>image-num-layers</literal>" property</title>
<indexterm><primary>GimpThumbnail:image-num-layers</primary></indexterm><programlisting> "image-num-layers" <link linkend="gint">gint</link> : Read / Write</programlisting>
<para>The number of layers in the image.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="GimpThumbnail--image-state"/>The "<literal>image-state</literal>" property</title>
<indexterm><primary>GimpThumbnail:image-state</primary></indexterm><programlisting> "image-state" <link linkend="GimpThumbState">GimpThumbState</link> : Read / Write</programlisting>
<para>State of the image associated to the thumbnail object.</para><para>Default value: GIMP_THUMB_STATE_UNKNOWN</para>
</refsect2>
<refsect2><title><anchor id="GimpThumbnail--image-type"/>The "<literal>image-type</literal>" property</title>
<indexterm><primary>GimpThumbnail:image-type</primary></indexterm><programlisting> "image-type" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>String describing the type of the image format.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GimpThumbnail--image-uri"/>The "<literal>image-uri</literal>" property</title>
<indexterm><primary>GimpThumbnail:image-uri</primary></indexterm><programlisting> "image-uri" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>URI of the image file.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GimpThumbnail--image-width"/>The "<literal>image-width</literal>" property</title>
<indexterm><primary>GimpThumbnail:image-width</primary></indexterm><programlisting> "image-width" <link linkend="gint">gint</link> : Read / Write</programlisting>
<para>Width of the image in pixels.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="GimpThumbnail--thumb-state"/>The "<literal>thumb-state</literal>" property</title>
<indexterm><primary>GimpThumbnail:thumb-state</primary></indexterm><programlisting> "thumb-state" <link linkend="GimpThumbState">GimpThumbState</link> : Read / Write</programlisting>
<para>State of the thumbnail file.</para><para>Default value: GIMP_THUMB_STATE_UNKNOWN</para>
</refsect2>
</refsect1>
</refentry>
|
