← Back to branch summary

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

« back to all changes in this revision

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

  • 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/xml/gimpthumb-utils.xml
22
22
 
23
23
 
24
24
 
25
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-thumb-init">gimp_thumb_init</link>                 (const <link linkend="gchar">gchar</link> *creator,
26
 
                                             const <link linkend="gchar">gchar</link> *thumb_basedir);
27
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-thumb-find-thumb">gimp_thumb_find_thumb</link>           (const <link linkend="gchar">gchar</link> *uri,
28
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> *size);
29
 
<link linkend="GimpThumbFileType">GimpThumbFileType</link> <link linkend="gimp-thumb-file-test">gimp_thumb_file_test</link>      (const <link linkend="gchar">gchar</link> *filename,
30
 
                                             <link linkend="gint64">gint64</link> *mtime,
31
 
                                             <link linkend="gint64">gint64</link> *size,
32
 
                                             <link linkend="gint">gint</link> *err_no);
33
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-thumb-name-from-uri">gimp_thumb_name_from_uri</link>        (const <link linkend="gchar">gchar</link> *uri,
34
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> size);
35
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-thumb-ensure-thumb-dir">gimp_thumb_ensure_thumb_dir</link>     (<link linkend="GimpThumbSize">GimpThumbSize</link> size,
36
 
                                             <link linkend="GError">GError</link> **error);
37
 
const <link linkend="gchar">gchar</link>* <link linkend="gimp-thumb-get-thumb-dir">gimp_thumb_get_thumb_dir</link>       (<link linkend="GimpThumbSize">GimpThumbSize</link> size);
38
 
<link linkend="void">void</link>        <link linkend="gimp-thumbs-delete-for-uri">gimp_thumbs_delete_for_uri</link>      (const <link linkend="gchar">gchar</link> *uri);
39
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-thumb-name-from-uri-local">gimp_thumb_name_from_uri_local</link>  (const <link linkend="gchar">gchar</link> *uri,
40
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> size);
41
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-thumb-ensure-thumb-dir-local">gimp_thumb_ensure_thumb_dir_local</link>
42
 
                                            (const <link linkend="gchar">gchar</link> *dirname,
43
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> size,
44
 
                                             <link linkend="GError">GError</link> **error);
45
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-thumb-get-thumb-dir-local">gimp_thumb_get_thumb_dir_local</link>  (const <link linkend="gchar">gchar</link> *dirname,
46
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> size);
47
 
<link linkend="void">void</link>        <link linkend="gimp-thumbs-delete-for-uri-local">gimp_thumbs_delete_for_uri_local</link>
48
 
                                            (const <link linkend="gchar">gchar</link> *uri);
 
25
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-thumb-init">gimp_thumb_init</link>                     (const <link linkend="gchar">gchar</link> *creator,
 
26
                                                         const <link linkend="gchar">gchar</link> *thumb_basedir);
 
27
<link linkend="gchar">gchar</link>*              <link linkend="gimp-thumb-find-thumb">gimp_thumb_find_thumb</link>               (const <link linkend="gchar">gchar</link> *uri,
 
28
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> *size);
 
29
<link linkend="GimpThumbFileType">GimpThumbFileType</link>   <link linkend="gimp-thumb-file-test">gimp_thumb_file_test</link>                (const <link linkend="gchar">gchar</link> *filename,
 
30
                                                         <link linkend="gint64">gint64</link> *mtime,
 
31
                                                         <link linkend="gint64">gint64</link> *size,
 
32
                                                         <link linkend="gint">gint</link> *err_no);
 
33
<link linkend="gchar">gchar</link>*              <link linkend="gimp-thumb-name-from-uri">gimp_thumb_name_from_uri</link>            (const <link linkend="gchar">gchar</link> *uri,
 
34
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> size);
 
35
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-thumb-ensure-thumb-dir">gimp_thumb_ensure_thumb_dir</link>         (<link linkend="GimpThumbSize">GimpThumbSize</link> size,
 
36
                                                         <link linkend="GError">GError</link> **error);
 
37
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-thumb-get-thumb-dir">gimp_thumb_get_thumb_dir</link>            (<link linkend="GimpThumbSize">GimpThumbSize</link> size);
 
38
<link linkend="void">void</link>                <link linkend="gimp-thumbs-delete-for-uri">gimp_thumbs_delete_for_uri</link>          (const <link linkend="gchar">gchar</link> *uri);
 
39
<link linkend="gchar">gchar</link>*              <link linkend="gimp-thumb-name-from-uri-local">gimp_thumb_name_from_uri_local</link>      (const <link linkend="gchar">gchar</link> *uri,
 
40
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> size);
 
41
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-thumb-ensure-thumb-dir-local">gimp_thumb_ensure_thumb_dir_local</link>   (const <link linkend="gchar">gchar</link> *dirname,
 
42
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> size,
 
43
                                                         <link linkend="GError">GError</link> **error);
 
44
<link linkend="gchar">gchar</link>*              <link linkend="gimp-thumb-get-thumb-dir-local">gimp_thumb_get_thumb_dir_local</link>      (const <link linkend="gchar">gchar</link> *dirname,
 
45
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> size);
 
46
<link linkend="void">void</link>                <link linkend="gimp-thumbs-delete-for-uri-local">gimp_thumbs_delete_for_uri_local</link>    (const <link linkend="gchar">gchar</link> *uri);
49
47
</synopsis>
50
48
</refsynopsisdiv>
51
49
 
68
66
<title role="details.title">Details</title>
69
67
<refsect2>
70
68
<title><anchor id="gimp-thumb-init" role="function"/>gimp_thumb_init ()</title>
71
 
<indexterm><primary>gimp_thumb_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_thumb_init                 (const <link linkend="gchar">gchar</link> *creator,
72
 
                                             const <link linkend="gchar">gchar</link> *thumb_basedir);</programlisting>
 
69
<indexterm><primary>gimp_thumb_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_thumb_init                     (const <link linkend="gchar">gchar</link> *creator,
 
70
                                                         const <link linkend="gchar">gchar</link> *thumb_basedir);</programlisting>
73
71
<para>
74
72
This function initializes the thumbnail system. It must be called
75
73
before any other functions from libgimpthumb are used. You may call
103
101
</variablelist></refsect2>
104
102
<refsect2>
105
103
<title><anchor id="gimp-thumb-find-thumb" role="function"/>gimp_thumb_find_thumb ()</title>
106
 
<indexterm><primary>gimp_thumb_find_thumb</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_thumb_find_thumb           (const <link linkend="gchar">gchar</link> *uri,
107
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> *size);</programlisting>
 
104
<indexterm><primary>gimp_thumb_find_thumb</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_thumb_find_thumb               (const <link linkend="gchar">gchar</link> *uri,
 
105
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> *size);</programlisting>
108
106
<para>
109
107
This function attempts to locate a thumbnail for the given
110
108
<parameter>uri</parameter>. First it tries the size that is stored at <parameter>size</parameter>. If no
135
133
</variablelist></refsect2>
136
134
<refsect2>
137
135
<title><anchor id="gimp-thumb-file-test" role="function"/>gimp_thumb_file_test ()</title>
138
 
<indexterm><primary>gimp_thumb_file_test</primary></indexterm><programlisting><link linkend="GimpThumbFileType">GimpThumbFileType</link> gimp_thumb_file_test      (const <link linkend="gchar">gchar</link> *filename,
139
 
                                             <link linkend="gint64">gint64</link> *mtime,
140
 
                                             <link linkend="gint64">gint64</link> *size,
141
 
                                             <link linkend="gint">gint</link> *err_no);</programlisting>
 
136
<indexterm><primary>gimp_thumb_file_test</primary></indexterm><programlisting><link linkend="GimpThumbFileType">GimpThumbFileType</link>   gimp_thumb_file_test                (const <link linkend="gchar">gchar</link> *filename,
 
137
                                                         <link linkend="gint64">gint64</link> *mtime,
 
138
                                                         <link linkend="gint64">gint64</link> *size,
 
139
                                                         <link linkend="gint">gint</link> *err_no);</programlisting>
142
140
<para>
143
141
This is a convenience and portability wrapper around <link linkend="stat"><function>stat()</function></link>. It
144
142
checks if the given <parameter>filename</parameter> exists and returns modification time
164
162
</variablelist></refsect2>
165
163
<refsect2>
166
164
<title><anchor id="gimp-thumb-name-from-uri" role="function"/>gimp_thumb_name_from_uri ()</title>
167
 
<indexterm><primary>gimp_thumb_name_from_uri</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_thumb_name_from_uri        (const <link linkend="gchar">gchar</link> *uri,
168
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
 
165
<indexterm><primary>gimp_thumb_name_from_uri</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_thumb_name_from_uri            (const <link linkend="gchar">gchar</link> *uri,
 
166
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
169
167
<para>
170
168
Creates the name of the thumbnail file of the specified <parameter>size</parameter> that
171
169
belongs to an image file located at the given <parameter>uri</parameter>.</para>
185
183
</variablelist></refsect2>
186
184
<refsect2>
187
185
<title><anchor id="gimp-thumb-ensure-thumb-dir" role="function"/>gimp_thumb_ensure_thumb_dir ()</title>
188
 
<indexterm><primary>gimp_thumb_ensure_thumb_dir</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_thumb_ensure_thumb_dir     (<link linkend="GimpThumbSize">GimpThumbSize</link> size,
189
 
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
186
<indexterm><primary>gimp_thumb_ensure_thumb_dir</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_thumb_ensure_thumb_dir         (<link linkend="GimpThumbSize">GimpThumbSize</link> size,
 
187
                                                         <link linkend="GError">GError</link> **error);</programlisting>
190
188
<para>
191
189
This function checks if the directory that is required to store
192
190
thumbnails for a particular <parameter>size</parameter> exist and attempts to create it
211
209
</variablelist></refsect2>
212
210
<refsect2>
213
211
<title><anchor id="gimp-thumb-get-thumb-dir" role="function"/>gimp_thumb_get_thumb_dir ()</title>
214
 
<indexterm><primary>gimp_thumb_get_thumb_dir</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_thumb_get_thumb_dir       (<link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
 
212
<indexterm><primary>gimp_thumb_get_thumb_dir</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_thumb_get_thumb_dir            (<link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
215
213
<para>
216
214
Retrieve the name of the thumbnail folder for a specific size. The
217
215
returned pointer will become invalid if <link linkend="gimp-thumb-init"><function>gimp_thumb_init()</function></link> is used
227
225
</variablelist></refsect2>
228
226
<refsect2>
229
227
<title><anchor id="gimp-thumbs-delete-for-uri" role="function" condition="since:GIMP 2.2"/>gimp_thumbs_delete_for_uri ()</title>
230
 
<indexterm role="GIMP 2.2"><primary>gimp_thumbs_delete_for_uri</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_thumbs_delete_for_uri      (const <link linkend="gchar">gchar</link> *uri);</programlisting>
 
228
<indexterm role="GIMP 2.2"><primary>gimp_thumbs_delete_for_uri</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_thumbs_delete_for_uri          (const <link linkend="gchar">gchar</link> *uri);</programlisting>
231
229
<para>
232
230
Deletes all thumbnails for the image file specified by <parameter>uri</parameter> from the
233
231
user's thumbnail repository.</para>
237
235
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
238
236
<listitem><simpara> an escaped URI
239
237
</simpara></listitem></varlistentry>
240
 
</variablelist><para>Since  GIMP 2.2
 
238
</variablelist><para role="since">Since  GIMP 2.2
241
239
</para></refsect2>
242
240
<refsect2>
243
241
<title><anchor id="gimp-thumb-name-from-uri-local" role="function" condition="since:GIMP 2.2"/>gimp_thumb_name_from_uri_local ()</title>
244
 
<indexterm role="GIMP 2.2"><primary>gimp_thumb_name_from_uri_local</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_thumb_name_from_uri_local  (const <link linkend="gchar">gchar</link> *uri,
245
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
 
242
<indexterm role="GIMP 2.2"><primary>gimp_thumb_name_from_uri_local</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_thumb_name_from_uri_local      (const <link linkend="gchar">gchar</link> *uri,
 
243
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
246
244
<para>
247
245
Creates the name of a local thumbnail file of the specified <parameter>size</parameter>
248
246
that belongs to an image file located at the given <parameter>uri</parameter>. Local
261
259
              points to the user's thumbnail repository.
262
260
 
263
261
</simpara></listitem></varlistentry>
264
 
</variablelist><para>Since  GIMP 2.2
 
262
</variablelist><para role="since">Since  GIMP 2.2
265
263
</para></refsect2>
266
264
<refsect2>
267
265
<title><anchor id="gimp-thumb-ensure-thumb-dir-local" role="function" condition="since:GIMP 2.2"/>gimp_thumb_ensure_thumb_dir_local ()</title>
268
 
<indexterm role="GIMP 2.2"><primary>gimp_thumb_ensure_thumb_dir_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_thumb_ensure_thumb_dir_local
269
 
                                            (const <link linkend="gchar">gchar</link> *dirname,
270
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> size,
271
 
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
266
<indexterm role="GIMP 2.2"><primary>gimp_thumb_ensure_thumb_dir_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_thumb_ensure_thumb_dir_local   (const <link linkend="gchar">gchar</link> *dirname,
 
267
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> size,
 
268
                                                         <link linkend="GError">GError</link> **error);</programlisting>
272
269
<para>
273
270
This function checks if the directory that is required to store
274
271
local thumbnails for a particular <parameter>size</parameter> exist and attempts to
293
290
              be created
294
291
 
295
292
</simpara></listitem></varlistentry>
296
 
</variablelist><para>Since  GIMP 2.2
 
293
</variablelist><para role="since">Since  GIMP 2.2
297
294
</para></refsect2>
298
295
<refsect2>
299
296
<title><anchor id="gimp-thumb-get-thumb-dir-local" role="function" condition="since:GIMP 2.2"/>gimp_thumb_get_thumb_dir_local ()</title>
300
 
<indexterm role="GIMP 2.2"><primary>gimp_thumb_get_thumb_dir_local</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_thumb_get_thumb_dir_local  (const <link linkend="gchar">gchar</link> *dirname,
301
 
                                             <link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
 
297
<indexterm role="GIMP 2.2"><primary>gimp_thumb_get_thumb_dir_local</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_thumb_get_thumb_dir_local      (const <link linkend="gchar">gchar</link> *dirname,
 
298
                                                         <link linkend="GimpThumbSize">GimpThumbSize</link> size);</programlisting>
302
299
<para>
303
300
Retrieve the name of the local thumbnail folder for a specific
304
301
size.  Unlike <link linkend="gimp-thumb-get-thumb-dir"><function>gimp_thumb_get_thumb_dir()</function></link> the returned string is not
315
312
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the thumbnail directory in the encoding of the filesystem
316
313
 
317
314
</simpara></listitem></varlistentry>
318
 
</variablelist><para>Since  GIMP 2.2
 
315
</variablelist><para role="since">Since  GIMP 2.2
319
316
</para></refsect2>
320
317
<refsect2>
321
318
<title><anchor id="gimp-thumbs-delete-for-uri-local" role="function" condition="since:GIMP 2.2"/>gimp_thumbs_delete_for_uri_local ()</title>
322
 
<indexterm role="GIMP 2.2"><primary>gimp_thumbs_delete_for_uri_local</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_thumbs_delete_for_uri_local
323
 
                                            (const <link linkend="gchar">gchar</link> *uri);</programlisting>
 
319
<indexterm role="GIMP 2.2"><primary>gimp_thumbs_delete_for_uri_local</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_thumbs_delete_for_uri_local    (const <link linkend="gchar">gchar</link> *uri);</programlisting>
324
320
<para>
325
321
Deletes all thumbnails for the image file specified by <parameter>uri</parameter> from
326
322
the local thumbnail repository.</para>
330
326
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
331
327
<listitem><simpara> an escaped URI
332
328
</simpara></listitem></varlistentry>
333
 
</variablelist><para>Since  GIMP 2.2
 
329
</variablelist><para role="since">Since  GIMP 2.2
334
330
</para></refsect2>
335
331
 
336
332
</refsect1>