← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpthumb/html/libgimpthumb-gimpthumb-utils.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpthumb/html/libgimpthumb-gimpthumb-utils.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpthumb-utils</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Thumbnail Library Reference Manual">
8
8
<link rel="up" href="libgimpthumb.html" title="Part&#160;I.&#160;GIMP Thumbnail Library">
9
9
<link rel="prev" href="GimpThumbnail.html" title="GimpThumbnail">
10
10
<link rel="next" href="libgimpthumb-gimpthumb-enums.html" title="gimpthumb-enums">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpthumb.html" title="Part&#160;I.&#160;GIMP Thumbnail Library">
 
14
<link rel="index" href="libgimpthumb-index.html" title="Index">
 
15
<link rel="index" href="libgimpthumb-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
 
16
<link rel="index" href="libgimpthumb-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
 
17
<link rel="index" href="libgimpthumb-index-deprecated.html" title="Index of deprecated symbols">
14
18
</head>
15
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
20
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
21
25
<th width="100%" align="center">GIMP Thumbnail Library Reference Manual</th>
22
26
<td><a accesskey="n" href="libgimpthumb-gimpthumb-enums.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
27
</tr>
24
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2560338" class="shortcut">Top</a>
 
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2593898" class="shortcut">Top</a>
25
29
                  &#160;|&#160;
26
 
                  <a href="#id2538172" class="shortcut">Description</a></nobr></td></tr>
 
30
                  <a href="#id2581316" class="shortcut">Description</a></nobr></td></tr>
27
31
</table>
28
32
<div class="refentry" lang="en">
29
33
<a name="libgimpthumb-gimpthumb-utils"></a><div class="titlepage"></div>
30
34
<div class="refnamediv"><table width="100%"><tr>
31
35
<td valign="top">
32
36
<h2>
33
 
<a name="id2560338"></a><span class="refentrytitle">gimpthumb-utils</span>
 
37
<a name="id2593898"></a><span class="refentrytitle">gimpthumb-utils</span>
34
38
</h2>
35
39
<p>gimpthumb-utils &#8212; Utility functions provided and used by libgimpthumb</p>
36
40
</td>
42
46
 
43
47
 
44
48
 
45
 
gboolean    <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-init">gimp_thumb_init</a>                 (const gchar *creator,
46
 
                                             const gchar *thumb_basedir);
47
 
gchar*      <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-find-thumb">gimp_thumb_find_thumb</a>           (const gchar *uri,
48
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> *size);
49
 
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbFileType">GimpThumbFileType</a> <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-file-test">gimp_thumb_file_test</a>      (const gchar *filename,
50
 
                                             gint64 *mtime,
51
 
                                             gint64 *size,
52
 
                                             gint *err_no);
53
 
gchar*      <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri">gimp_thumb_name_from_uri</a>        (const gchar *uri,
54
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
55
 
gboolean    <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-ensure-thumb-dir">gimp_thumb_ensure_thumb_dir</a>     (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
56
 
                                             GError **error);
57
 
const gchar* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir">gimp_thumb_get_thumb_dir</a>       (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
58
 
void        <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri">gimp_thumbs_delete_for_uri</a>      (const gchar *uri);
59
 
gchar*      <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri-local">gimp_thumb_name_from_uri_local</a>  (const gchar *uri,
60
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
61
 
gboolean    <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-ensure-thumb-dir-local">gimp_thumb_ensure_thumb_dir_local</a>
62
 
                                            (const gchar *dirname,
63
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
64
 
                                             GError **error);
65
 
gchar*      <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir-local">gimp_thumb_get_thumb_dir_local</a>  (const gchar *dirname,
66
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
67
 
void        <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri-local">gimp_thumbs_delete_for_uri_local</a>
68
 
                                            (const gchar *uri);
 
49
gboolean            <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-init">gimp_thumb_init</a>                     (const gchar *creator,
 
50
                                                         const gchar *thumb_basedir);
 
51
gchar*              <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-find-thumb">gimp_thumb_find_thumb</a>               (const gchar *uri,
 
52
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> *size);
 
53
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbFileType">GimpThumbFileType</a>   <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-file-test">gimp_thumb_file_test</a>                (const gchar *filename,
 
54
                                                         gint64 *mtime,
 
55
                                                         gint64 *size,
 
56
                                                         gint *err_no);
 
57
gchar*              <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri">gimp_thumb_name_from_uri</a>            (const gchar *uri,
 
58
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
 
59
gboolean            <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-ensure-thumb-dir">gimp_thumb_ensure_thumb_dir</a>         (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
 
60
                                                         GError **error);
 
61
const gchar*        <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir">gimp_thumb_get_thumb_dir</a>            (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
 
62
void                <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri">gimp_thumbs_delete_for_uri</a>          (const gchar *uri);
 
63
gchar*              <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri-local">gimp_thumb_name_from_uri_local</a>      (const gchar *uri,
 
64
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
 
65
gboolean            <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-ensure-thumb-dir-local">gimp_thumb_ensure_thumb_dir_local</a>   (const gchar *dirname,
 
66
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
 
67
                                                         GError **error);
 
68
gchar*              <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir-local">gimp_thumb_get_thumb_dir_local</a>      (const gchar *dirname,
 
69
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
 
70
void                <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri-local">gimp_thumbs_delete_for_uri_local</a>    (const gchar *uri);
69
71
</pre>
70
72
</div>
71
73
<div class="refsect1" lang="en">
72
 
<a name="id2538172"></a><h2>Description</h2>
 
74
<a name="id2581316"></a><h2>Description</h2>
73
75
<p>
74
76
 
75
77
</p>
76
78
</div>
77
79
<div class="refsect1" lang="en">
78
 
<a name="id2538188"></a><h2>Details</h2>
 
80
<a name="id2581332"></a><h2>Details</h2>
79
81
<div class="refsect2" lang="en">
80
 
<a name="id2538199"></a><h3>
 
82
<a name="id2581342"></a><h3>
81
83
<a name="gimp-thumb-init"></a>gimp_thumb_init ()</h3>
82
 
<a class="indexterm" name="id2538211"></a><pre class="programlisting">gboolean    gimp_thumb_init                 (const gchar *creator,
83
 
                                             const gchar *thumb_basedir);</pre>
 
84
<a class="indexterm" name="id2581355"></a><pre class="programlisting">gboolean            gimp_thumb_init                     (const gchar *creator,
 
85
                                                         const gchar *thumb_basedir);</pre>
84
86
<p>
85
87
This function initializes the thumbnail system. It must be called
86
88
before any other functions from libgimpthumb are used. You may call
107
109
<col align="left" valign="top">
108
110
<tbody>
109
111
<tr>
110
 
<td>
111
 
<span class="term"><em class="parameter"><code>creator</code></em>&#160;:</span></td>
 
112
<td><span class="term"><em class="parameter"><code>creator</code></em>&#160;:</span></td>
112
113
<td> an ASCII string that identifies the thumbnail creator
113
114
</td>
114
115
</tr>
115
116
<tr>
116
 
<td>
117
 
<span class="term"><em class="parameter"><code>thumb_basedir</code></em>&#160;:</span></td>
 
117
<td><span class="term"><em class="parameter"><code>thumb_basedir</code></em>&#160;:</span></td>
118
118
<td> an absolute path or <code class="literal">NULL</code> to use the default
119
119
</td>
120
120
</tr>
121
121
<tr>
122
 
<td>
123
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
122
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
124
123
<td> <code class="literal">TRUE</code> if the library was successfully initialized.
125
124
</td>
126
125
</tr>
129
128
</div>
130
129
<hr>
131
130
<div class="refsect2" lang="en">
132
 
<a name="id2528242"></a><h3>
 
131
<a name="id2577360"></a><h3>
133
132
<a name="gimp-thumb-find-thumb"></a>gimp_thumb_find_thumb ()</h3>
134
 
<a class="indexterm" name="id2528253"></a><pre class="programlisting">gchar*      gimp_thumb_find_thumb           (const gchar *uri,
135
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> *size);</pre>
 
133
<a class="indexterm" name="id2577371"></a><pre class="programlisting">gchar*              gimp_thumb_find_thumb               (const gchar *uri,
 
134
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> *size);</pre>
136
135
<p>
137
136
This function attempts to locate a thumbnail for the given
138
137
<em class="parameter"><code>uri</code></em>. First it tries the size that is stored at <em class="parameter"><code>size</code></em>. If no
155
154
<col align="left" valign="top">
156
155
<tbody>
157
156
<tr>
158
 
<td>
159
 
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
 
157
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
160
158
<td> an escaped URI
161
159
</td>
162
160
</tr>
163
161
<tr>
164
 
<td>
165
 
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
162
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
166
163
<td> pointer to a <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
167
164
</td>
168
165
</tr>
169
166
<tr>
170
 
<td>
171
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
167
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
172
168
<td> a newly allocated string in the encoding of the
173
169
              filesystem or <code class="literal">NULL</code> if no thumbnail for <em class="parameter"><code>uri</code></em> was found
174
170
</td>
178
174
</div>
179
175
<hr>
180
176
<div class="refsect2" lang="en">
181
 
<a name="id2554834"></a><h3>
 
177
<a name="id2566923"></a><h3>
182
178
<a name="gimp-thumb-file-test"></a>gimp_thumb_file_test ()</h3>
183
 
<a class="indexterm" name="id2554846"></a><pre class="programlisting"><a href="libgimpthumb-gimpthumb-enums.html#GimpThumbFileType">GimpThumbFileType</a> gimp_thumb_file_test      (const gchar *filename,
184
 
                                             gint64 *mtime,
185
 
                                             gint64 *size,
186
 
                                             gint *err_no);</pre>
 
179
<a class="indexterm" name="id2566934"></a><pre class="programlisting"><a href="libgimpthumb-gimpthumb-enums.html#GimpThumbFileType">GimpThumbFileType</a>   gimp_thumb_file_test                (const gchar *filename,
 
180
                                                         gint64 *mtime,
 
181
                                                         gint64 *size,
 
182
                                                         gint *err_no);</pre>
187
183
<p>
188
184
This is a convenience and portability wrapper around <code class="function">stat()</code>. It
189
185
checks if the given <em class="parameter"><code>filename</code></em> exists and returns modification time
195
191
<col align="left" valign="top">
196
192
<tbody>
197
193
<tr>
198
 
<td>
199
 
<span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
 
194
<td><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
200
195
<td> a filename in the encoding of the filesystem
201
196
</td>
202
197
</tr>
203
198
<tr>
204
 
<td>
205
 
<span class="term"><em class="parameter"><code>mtime</code></em>&#160;:</span></td>
 
199
<td><span class="term"><em class="parameter"><code>mtime</code></em>&#160;:</span></td>
206
200
<td> return location for modification time
207
201
</td>
208
202
</tr>
209
203
<tr>
210
 
<td>
211
 
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
204
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
212
205
<td> return location for file size
213
206
</td>
214
207
</tr>
215
208
<tr>
216
 
<td>
217
 
<span class="term"><em class="parameter"><code>err_no</code></em>&#160;:</span></td>
 
209
<td><span class="term"><em class="parameter"><code>err_no</code></em>&#160;:</span></td>
218
210
<td> return location for system "errno"
219
211
</td>
220
212
</tr>
221
213
<tr>
222
 
<td>
223
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
214
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
224
215
<td> The type of the file, or <a href="libgimpthumb-gimpthumb-enums.html#GIMP-THUMB-FILE-TYPE-NONE:CAPS"><span class="type">GIMP_THUMB_FILE_TYPE_NONE</span></a> if
225
216
              the file doesn't exist.
226
217
</td>
230
221
</div>
231
222
<hr>
232
223
<div class="refsect2" lang="en">
233
 
<a name="id2554992"></a><h3>
 
224
<a name="id2567082"></a><h3>
234
225
<a name="gimp-thumb-name-from-uri"></a>gimp_thumb_name_from_uri ()</h3>
235
 
<a class="indexterm" name="id2555004"></a><pre class="programlisting">gchar*      gimp_thumb_name_from_uri        (const gchar *uri,
236
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
 
226
<a class="indexterm" name="id2567093"></a><pre class="programlisting">gchar*              gimp_thumb_name_from_uri            (const gchar *uri,
 
227
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
237
228
<p>
238
229
Creates the name of the thumbnail file of the specified <em class="parameter"><code>size</code></em> that
239
230
belongs to an image file located at the given <em class="parameter"><code>uri</code></em>.</p>
244
235
<col align="left" valign="top">
245
236
<tbody>
246
237
<tr>
247
 
<td>
248
 
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
 
238
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
249
239
<td> an escaped URI
250
240
</td>
251
241
</tr>
252
242
<tr>
253
 
<td>
254
 
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
243
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
255
244
<td> a <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
256
245
</td>
257
246
</tr>
258
247
<tr>
259
 
<td>
260
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
248
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
261
249
<td> a newly allocated filename in the encoding of the
262
250
              filesystem or <code class="literal">NULL</code> if <em class="parameter"><code>uri</code></em> points to the user's
263
251
              thumbnail repository.
268
256
</div>
269
257
<hr>
270
258
<div class="refsect2" lang="en">
271
 
<a name="id2533146"></a><h3>
 
259
<a name="id2561093"></a><h3>
272
260
<a name="gimp-thumb-ensure-thumb-dir"></a>gimp_thumb_ensure_thumb_dir ()</h3>
273
 
<a class="indexterm" name="id2533157"></a><pre class="programlisting">gboolean    gimp_thumb_ensure_thumb_dir     (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
274
 
                                             GError **error);</pre>
 
261
<a class="indexterm" name="id2561105"></a><pre class="programlisting">gboolean            gimp_thumb_ensure_thumb_dir         (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
 
262
                                                         GError **error);</pre>
275
263
<p>
276
264
This function checks if the directory that is required to store
277
265
thumbnails for a particular <em class="parameter"><code>size</code></em> exist and attempts to create it
288
276
<col align="left" valign="top">
289
277
<tbody>
290
278
<tr>
291
 
<td>
292
 
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
279
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
293
280
<td> a GimpThumbSize
294
281
</td>
295
282
</tr>
296
283
<tr>
297
 
<td>
298
 
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
284
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
299
285
<td> return location for possible errors
300
286
</td>
301
287
</tr>
302
288
<tr>
303
 
<td>
304
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
289
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
305
290
<td> <code class="literal">TRUE</code> is the directory exists, <code class="literal">FALSE</code> if it could not
306
291
              be created
307
292
</td>
311
296
</div>
312
297
<hr>
313
298
<div class="refsect2" lang="en">
314
 
<a name="id2533287"></a><h3>
 
299
<a name="id2561236"></a><h3>
315
300
<a name="gimp-thumb-get-thumb-dir"></a>gimp_thumb_get_thumb_dir ()</h3>
316
 
<a class="indexterm" name="id2533298"></a><pre class="programlisting">const gchar* gimp_thumb_get_thumb_dir       (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
 
301
<a class="indexterm" name="id2561248"></a><pre class="programlisting">const gchar*        gimp_thumb_get_thumb_dir            (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
317
302
<p>
318
303
Retrieve the name of the thumbnail folder for a specific size. The
319
304
returned pointer will become invalid if <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-init"><code class="function">gimp_thumb_init()</code></a> is used
325
310
<col align="left" valign="top">
326
311
<tbody>
327
312
<tr>
328
 
<td>
329
 
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
313
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
330
314
<td> a GimpThumbSize
331
315
</td>
332
316
</tr>
333
317
<tr>
334
 
<td>
335
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
318
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
336
319
<td> the thumbnail directory in the encoding of the filesystem
337
320
</td>
338
321
</tr>
341
324
</div>
342
325
<hr>
343
326
<div class="refsect2" lang="en">
344
 
<a name="id2568561"></a><h3>
 
327
<a name="id2561322"></a><h3>
345
328
<a name="gimp-thumbs-delete-for-uri"></a>gimp_thumbs_delete_for_uri ()</h3>
346
 
<a class="indexterm" name="id2568574"></a><pre class="programlisting">void        gimp_thumbs_delete_for_uri      (const gchar *uri);</pre>
 
329
<a class="indexterm" name="id2561336"></a><pre class="programlisting">void                gimp_thumbs_delete_for_uri          (const gchar *uri);</pre>
347
330
<p>
348
331
Deletes all thumbnails for the image file specified by <em class="parameter"><code>uri</code></em> from the
349
332
user's thumbnail repository.</p>
353
336
<div class="variablelist"><table border="0">
354
337
<col align="left" valign="top">
355
338
<tbody><tr>
356
 
<td>
357
 
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
 
339
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
358
340
<td> an escaped URI
359
341
</td>
360
342
</tr></tbody>
361
343
</table></div>
362
 
<p>Since  GIMP 2.2
 
344
<p class="since">Since  GIMP 2.2
363
345
</p>
364
346
</div>
365
347
<hr>
366
348
<div class="refsect2" lang="en">
367
 
<a name="id2568629"></a><h3>
 
349
<a name="id2601719"></a><h3>
368
350
<a name="gimp-thumb-name-from-uri-local"></a>gimp_thumb_name_from_uri_local ()</h3>
369
 
<a class="indexterm" name="id2568643"></a><pre class="programlisting">gchar*      gimp_thumb_name_from_uri_local  (const gchar *uri,
370
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
 
351
<a class="indexterm" name="id2601733"></a><pre class="programlisting">gchar*              gimp_thumb_name_from_uri_local      (const gchar *uri,
 
352
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
371
353
<p>
372
354
Creates the name of a local thumbnail file of the specified <em class="parameter"><code>size</code></em>
373
355
that belongs to an image file located at the given <em class="parameter"><code>uri</code></em>. Local
379
361
<col align="left" valign="top">
380
362
<tbody>
381
363
<tr>
382
 
<td>
383
 
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
 
364
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
384
365
<td> an escaped URI
385
366
</td>
386
367
</tr>
387
368
<tr>
388
 
<td>
389
 
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
369
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
390
370
<td> a <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
391
371
</td>
392
372
</tr>
393
373
<tr>
394
 
<td>
395
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
374
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
396
375
<td> a newly allocated filename in the encoding of the
397
376
              filesystem or <code class="literal">NULL</code> if <em class="parameter"><code>uri</code></em> is a remote file or
398
377
              points to the user's thumbnail repository.
401
380
</tr>
402
381
</tbody>
403
382
</table></div>
404
 
<p>Since  GIMP 2.2
 
383
<p class="since">Since  GIMP 2.2
405
384
</p>
406
385
</div>
407
386
<hr>
408
387
<div class="refsect2" lang="en">
409
 
<a name="id2568767"></a><h3>
 
388
<a name="id2601850"></a><h3>
410
389
<a name="gimp-thumb-ensure-thumb-dir-local"></a>gimp_thumb_ensure_thumb_dir_local ()</h3>
411
 
<a class="indexterm" name="id2568783"></a><pre class="programlisting">gboolean    gimp_thumb_ensure_thumb_dir_local
412
 
                                            (const gchar *dirname,
413
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
414
 
                                             GError **error);</pre>
 
390
<a class="indexterm" name="id2601866"></a><pre class="programlisting">gboolean            gimp_thumb_ensure_thumb_dir_local   (const gchar *dirname,
 
391
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
 
392
                                                         GError **error);</pre>
415
393
<p>
416
394
This function checks if the directory that is required to store
417
395
local thumbnails for a particular <em class="parameter"><code>size</code></em> exist and attempts to
427
405
<col align="left" valign="top">
428
406
<tbody>
429
407
<tr>
430
 
<td>
431
 
<span class="term"><em class="parameter"><code>dirname</code></em>&#160;:</span></td>
 
408
<td><span class="term"><em class="parameter"><code>dirname</code></em>&#160;:</span></td>
432
409
<td>
433
410
</td>
434
411
</tr>
435
412
<tr>
436
 
<td>
437
 
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
413
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
438
414
<td> a GimpThumbSize
439
415
</td>
440
416
</tr>
441
417
<tr>
442
 
<td>
443
 
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
418
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
444
419
<td> return location for possible errors
445
420
</td>
446
421
</tr>
447
422
<tr>
448
 
<td>
449
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
423
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
450
424
<td> <code class="literal">TRUE</code> is the directory exists, <code class="literal">FALSE</code> if it could not
451
425
              be created
452
426
 
454
428
</tr>
455
429
</tbody>
456
430
</table></div>
457
 
<p>Since  GIMP 2.2
 
431
<p class="since">Since  GIMP 2.2
458
432
</p>
459
433
</div>
460
434
<hr>
461
435
<div class="refsect2" lang="en">
462
 
<a name="id2568933"></a><h3>
 
436
<a name="id2602018"></a><h3>
463
437
<a name="gimp-thumb-get-thumb-dir-local"></a>gimp_thumb_get_thumb_dir_local ()</h3>
464
 
<a class="indexterm" name="id2568949"></a><pre class="programlisting">gchar*      gimp_thumb_get_thumb_dir_local  (const gchar *dirname,
465
 
                                             <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
 
438
<a class="indexterm" name="id2602034"></a><pre class="programlisting">gchar*              gimp_thumb_get_thumb_dir_local      (const gchar *dirname,
 
439
                                                         <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
466
440
<p>
467
441
Retrieve the name of the local thumbnail folder for a specific
468
442
size.  Unlike <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir"><code class="function">gimp_thumb_get_thumb_dir()</code></a> the returned string is not
474
448
<col align="left" valign="top">
475
449
<tbody>
476
450
<tr>
477
 
<td>
478
 
<span class="term"><em class="parameter"><code>dirname</code></em>&#160;:</span></td>
 
451
<td><span class="term"><em class="parameter"><code>dirname</code></em>&#160;:</span></td>
479
452
<td>
480
453
</td>
481
454
</tr>
482
455
<tr>
483
 
<td>
484
 
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
456
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
485
457
<td> a GimpThumbSize
486
458
</td>
487
459
</tr>
488
460
<tr>
489
 
<td>
490
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
461
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
491
462
<td> the thumbnail directory in the encoding of the filesystem
492
463
 
493
464
</td>
494
465
</tr>
495
466
</tbody>
496
467
</table></div>
497
 
<p>Since  GIMP 2.2
 
468
<p class="since">Since  GIMP 2.2
498
469
</p>
499
470
</div>
500
471
<hr>
501
472
<div class="refsect2" lang="en">
502
 
<a name="id2569048"></a><h3>
 
473
<a name="id2602136"></a><h3>
503
474
<a name="gimp-thumbs-delete-for-uri-local"></a>gimp_thumbs_delete_for_uri_local ()</h3>
504
 
<a class="indexterm" name="id2569063"></a><pre class="programlisting">void        gimp_thumbs_delete_for_uri_local
505
 
                                            (const gchar *uri);</pre>
 
475
<a class="indexterm" name="id2602151"></a><pre class="programlisting">void                gimp_thumbs_delete_for_uri_local    (const gchar *uri);</pre>
506
476
<p>
507
477
Deletes all thumbnails for the image file specified by <em class="parameter"><code>uri</code></em> from
508
478
the local thumbnail repository.</p>
512
482
<div class="variablelist"><table border="0">
513
483
<col align="left" valign="top">
514
484
<tbody><tr>
515
 
<td>
516
 
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
 
485
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
517
486
<td> an escaped URI
518
487
</td>
519
488
</tr></tbody>
520
489
</table></div>
521
 
<p>Since  GIMP 2.2
 
490
<p class="since">Since  GIMP 2.2
522
491
</p>
523
492
</div>
524
493
</div>