Imported Upstream version 2.4.0~rc3
This commit is contained in:
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
||||
<title>gimpthumb-utils</title>
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
|
||||
<link rel="start" href="index.html" title="GIMP Thumbnail Library Reference Manual">
|
||||
<link rel="up" href="libgimpthumb.html" title="Part I. GIMP Thumbnail Library">
|
||||
<link rel="prev" href="GimpThumbnail.html" title="GimpThumbnail">
|
||||
@ -25,16 +25,16 @@
|
||||
<th width="100%" align="center">GIMP Thumbnail Library Reference Manual</th>
|
||||
<td><a accesskey="n" href="libgimpthumb-gimpthumb-enums.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
||||
</tr>
|
||||
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2605821" class="shortcut">Top</a>
|
||||
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2568544" class="shortcut">Top</a>
|
||||
 | 
|
||||
<a href="#id2588537" class="shortcut">Description</a></nobr></td></tr>
|
||||
<a href="#id2569503" class="shortcut">Description</a></nobr></td></tr>
|
||||
</table>
|
||||
<div class="refentry" lang="en">
|
||||
<a name="libgimpthumb-gimpthumb-utils"></a><div class="titlepage"></div>
|
||||
<div class="refnamediv"><table width="100%"><tr>
|
||||
<td valign="top">
|
||||
<h2>
|
||||
<a name="id2605821"></a><span class="refentrytitle">gimpthumb-utils</span>
|
||||
<a name="id2568544"></a><span class="refentrytitle">gimpthumb-utils</span>
|
||||
</h2>
|
||||
<p>gimpthumb-utils — Utility functions provided and used by libgimpthumb</p>
|
||||
</td>
|
||||
@ -46,43 +46,95 @@
|
||||
|
||||
|
||||
|
||||
gboolean <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-init">gimp_thumb_init</a> (const gchar *creator,
|
||||
const gchar *thumb_basedir);
|
||||
gchar* <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-find-thumb">gimp_thumb_find_thumb</a> (const gchar *uri,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> *size);
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbFileType">GimpThumbFileType</a> <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-file-test">gimp_thumb_file_test</a> (const gchar *filename,
|
||||
gint64 *mtime,
|
||||
gint64 *size,
|
||||
gint *err_no);
|
||||
gchar* <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri">gimp_thumb_name_from_uri</a> (const gchar *uri,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
|
||||
gboolean <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-ensure-thumb-dir">gimp_thumb_ensure_thumb_dir</a> (<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
|
||||
GError **error);
|
||||
const gchar* <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir">gimp_thumb_get_thumb_dir</a> (<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
|
||||
void <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri">gimp_thumbs_delete_for_uri</a> (const gchar *uri);
|
||||
gchar* <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri-local">gimp_thumb_name_from_uri_local</a> (const gchar *uri,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
|
||||
gboolean <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-ensure-thumb-dir-local">gimp_thumb_ensure_thumb_dir_local</a> (const gchar *dirname,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
|
||||
GError **error);
|
||||
gchar* <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir-local">gimp_thumb_get_thumb_dir_local</a> (const gchar *dirname,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
|
||||
void <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri-local">gimp_thumbs_delete_for_uri_local</a> (const gchar *uri);
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gboolean"
|
||||
>gboolean</a> <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-init">gimp_thumb_init</a> (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *creator,
|
||||
const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *thumb_basedir);
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-find-thumb">gimp_thumb_find_thumb</a> (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> *size);
|
||||
<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 <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *filename,
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gint64"
|
||||
>gint64</a> *mtime,
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gint64"
|
||||
>gint64</a> *size,
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gint"
|
||||
>gint</a> *err_no);
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri">gimp_thumb_name_from_uri</a> (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gboolean"
|
||||
>gboolean</a> <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,
|
||||
<a
|
||||
href="../glib/glib-Error-Reporting.html#GError"
|
||||
>GError</a> **error);
|
||||
const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* <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);
|
||||
void <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri">gimp_thumbs_delete_for_uri</a> (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri);
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri-local">gimp_thumb_name_from_uri_local</a> (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gboolean"
|
||||
>gboolean</a> <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-ensure-thumb-dir-local">gimp_thumb_ensure_thumb_dir_local</a> (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *dirname,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
|
||||
<a
|
||||
href="../glib/glib-Error-Reporting.html#GError"
|
||||
>GError</a> **error);
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir-local">gimp_thumb_get_thumb_dir_local</a> (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *dirname,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
|
||||
void <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri-local">gimp_thumbs_delete_for_uri_local</a> (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri);
|
||||
</pre>
|
||||
</div>
|
||||
<div class="refsect1" lang="en">
|
||||
<a name="id2588537"></a><h2>Description</h2>
|
||||
<a name="id2569503"></a><h2>Description</h2>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="refsect1" lang="en">
|
||||
<a name="id2588552"></a><h2>Details</h2>
|
||||
<a name="id2569518"></a><h2>Details</h2>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2588563"></a><h3>
|
||||
<a name="id2569529"></a><h3>
|
||||
<a name="gimp-thumb-init"></a>gimp_thumb_init ()</h3>
|
||||
<a class="indexterm" name="id2588576"></a><pre class="programlisting">gboolean gimp_thumb_init (const gchar *creator,
|
||||
const gchar *thumb_basedir);</pre>
|
||||
<a class="indexterm" name="id2569542"></a><pre class="programlisting"><a
|
||||
href="../glib/glib-Basic-Types.html#gboolean"
|
||||
>gboolean</a> gimp_thumb_init (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *creator,
|
||||
const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *thumb_basedir);</pre>
|
||||
<p>
|
||||
This function initializes the thumbnail system. It must be called
|
||||
before any other functions from libgimpthumb are used. You may call
|
||||
@ -97,7 +149,9 @@ of the software that creates the thumbnails. It is used to handle
|
||||
thumbnail creation failures. See the spec for more details.
|
||||
</p>
|
||||
<p>
|
||||
Usually you will pass <code class="literal">NULL</code> for <em class="parameter"><code>thumb_basedir</code></em>. Thumbnails will
|
||||
Usually you will pass <a
|
||||
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
|
||||
><code class="literal">NULL</code></a> for <em class="parameter"><code>thumb_basedir</code></em>. Thumbnails will
|
||||
then be stored in the user's personal thumbnail directory as
|
||||
defined in the spec. If you wish to use libgimpthumb to store
|
||||
application-specific thumbnails, you can specify a different base
|
||||
@ -109,18 +163,22 @@ directory here.</p>
|
||||
<col align="left" valign="top">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>creator</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>creator</code></em> :</span></td>
|
||||
<td> an ASCII string that identifies the thumbnail creator
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>thumb_basedir</code></em> :</span></p></td>
|
||||
<td> an absolute path or <code class="literal">NULL</code> to use the default
|
||||
<td><span class="term"><em class="parameter"><code>thumb_basedir</code></em> :</span></td>
|
||||
<td> an absolute path or <a
|
||||
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
|
||||
><code class="literal">NULL</code></a> to use the default
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||||
<td> <code class="literal">TRUE</code> if the library was successfully initialized.
|
||||
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
||||
<td> <a
|
||||
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
|
||||
><code class="literal">TRUE</code></a> if the library was successfully initialized.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -128,10 +186,14 @@ directory here.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2579664"></a><h3>
|
||||
<a name="id2588130"></a><h3>
|
||||
<a name="gimp-thumb-find-thumb"></a>gimp_thumb_find_thumb ()</h3>
|
||||
<a class="indexterm" name="id2579675"></a><pre class="programlisting">gchar* gimp_thumb_find_thumb (const gchar *uri,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> *size);</pre>
|
||||
<a class="indexterm" name="id2588142"></a><pre class="programlisting"><a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* gimp_thumb_find_thumb (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> *size);</pre>
|
||||
<p>
|
||||
This function attempts to locate a thumbnail for the given
|
||||
<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
|
||||
@ -154,19 +216,21 @@ pointer to by <em class="parameter"><code>size</code></em> and the file location
|
||||
<col align="left" valign="top">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
|
||||
<td> an escaped URI
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||||
<td> pointer to a <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
|
||||
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
|
||||
<td> pointer to a <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||||
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
||||
<td> a newly allocated string in the encoding of the
|
||||
filesystem or <code class="literal">NULL</code> if no thumbnail for <em class="parameter"><code>uri</code></em> was found
|
||||
filesystem or <a
|
||||
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
|
||||
><code class="literal">NULL</code></a> if no thumbnail for <em class="parameter"><code>uri</code></em> was found
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -174,12 +238,20 @@ pointer to by <em class="parameter"><code>size</code></em> and the file location
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2573407"></a><h3>
|
||||
<a name="id2588291"></a><h3>
|
||||
<a name="gimp-thumb-file-test"></a>gimp_thumb_file_test ()</h3>
|
||||
<a class="indexterm" name="id2573418"></a><pre class="programlisting"><a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbFileType">GimpThumbFileType</a> gimp_thumb_file_test (const gchar *filename,
|
||||
gint64 *mtime,
|
||||
gint64 *size,
|
||||
gint *err_no);</pre>
|
||||
<a class="indexterm" name="id2588302"></a><pre class="programlisting"><a href="libgimpthumb-gimpthumb-enums.html#GimpThumbFileType">GimpThumbFileType</a> gimp_thumb_file_test (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *filename,
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gint64"
|
||||
>gint64</a> *mtime,
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gint64"
|
||||
>gint64</a> *size,
|
||||
<a
|
||||
href="../glib/glib-Basic-Types.html#gint"
|
||||
>gint</a> *err_no);</pre>
|
||||
<p>
|
||||
This is a convenience and portability wrapper around <code class="function">stat()</code>. It
|
||||
checks if the given <em class="parameter"><code>filename</code></em> exists and returns modification time
|
||||
@ -191,28 +263,28 @@ and file size in 64bit integer values.</p>
|
||||
<col align="left" valign="top">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>filename</code></em> :</span></td>
|
||||
<td> a filename in the encoding of the filesystem
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>mtime</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>mtime</code></em> :</span></td>
|
||||
<td> return location for modification time
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
|
||||
<td> return location for file size
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>err_no</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>err_no</code></em> :</span></td>
|
||||
<td> return location for system "errno"
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||||
<td> The type of the file, or <a class="link" href="libgimpthumb-gimpthumb-enums.html#GIMP-THUMB-FILE-TYPE-NONE:CAPS"><span class="type">GIMP_THUMB_FILE_TYPE_NONE</span></a> if
|
||||
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
||||
<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
|
||||
the file doesn't exist.
|
||||
</td>
|
||||
</tr>
|
||||
@ -221,10 +293,14 @@ and file size in 64bit integer values.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2573566"></a><h3>
|
||||
<a name="id2588450"></a><h3>
|
||||
<a name="gimp-thumb-name-from-uri"></a>gimp_thumb_name_from_uri ()</h3>
|
||||
<a class="indexterm" name="id2594589"></a><pre class="programlisting">gchar* gimp_thumb_name_from_uri (const gchar *uri,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
|
||||
<a class="indexterm" name="id2588461"></a><pre class="programlisting"><a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* gimp_thumb_name_from_uri (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
|
||||
<p>
|
||||
Creates the name of the thumbnail file of the specified <em class="parameter"><code>size</code></em> that
|
||||
belongs to an image file located at the given <em class="parameter"><code>uri</code></em>.</p>
|
||||
@ -235,19 +311,21 @@ belongs to an image file located at the given <em class="parameter"><code>uri</c
|
||||
<col align="left" valign="top">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
|
||||
<td> an escaped URI
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||||
<td> a <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
|
||||
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
|
||||
<td> a <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||||
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
||||
<td> a newly allocated filename in the encoding of the
|
||||
filesystem or <code class="literal">NULL</code> if <em class="parameter"><code>uri</code></em> points to the user's
|
||||
filesystem or <a
|
||||
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
|
||||
><code class="literal">NULL</code></a> if <em class="parameter"><code>uri</code></em> points to the user's
|
||||
thumbnail repository.
|
||||
</td>
|
||||
</tr>
|
||||
@ -256,10 +334,14 @@ belongs to an image file located at the given <em class="parameter"><code>uri</c
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2594709"></a><h3>
|
||||
<a name="id2562051"></a><h3>
|
||||
<a name="gimp-thumb-ensure-thumb-dir"></a>gimp_thumb_ensure_thumb_dir ()</h3>
|
||||
<a class="indexterm" name="id2594721"></a><pre class="programlisting">gboolean gimp_thumb_ensure_thumb_dir (<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
|
||||
GError **error);</pre>
|
||||
<a class="indexterm" name="id2562063"></a><pre class="programlisting"><a
|
||||
href="../glib/glib-Basic-Types.html#gboolean"
|
||||
>gboolean</a> gimp_thumb_ensure_thumb_dir (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
|
||||
<a
|
||||
href="../glib/glib-Error-Reporting.html#GError"
|
||||
>GError</a> **error);</pre>
|
||||
<p>
|
||||
This function checks if the directory that is required to store
|
||||
thumbnails for a particular <em class="parameter"><code>size</code></em> exist and attempts to create it
|
||||
@ -267,7 +349,7 @@ if necessary.
|
||||
</p>
|
||||
<p>
|
||||
You shouldn't have to call this function directly since
|
||||
<a class="link" href="GimpThumbnail.html#gimp-thumbnail-save-thumb"><code class="function">gimp_thumbnail_save_thumb()</code></a> and <a class="link" href="GimpThumbnail.html#gimp-thumbnail-save-failure"><code class="function">gimp_thumbnail_save_failure()</code></a> will
|
||||
<a href="GimpThumbnail.html#gimp-thumbnail-save-thumb"><code class="function">gimp_thumbnail_save_thumb()</code></a> and <a href="GimpThumbnail.html#gimp-thumbnail-save-failure"><code class="function">gimp_thumbnail_save_failure()</code></a> will
|
||||
do this for you.</p>
|
||||
<p>
|
||||
|
||||
@ -276,18 +358,22 @@ do this for you.</p>
|
||||
<col align="left" valign="top">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
|
||||
<td> a GimpThumbSize
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
|
||||
<td> return location for possible errors
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||||
<td> <code class="literal">TRUE</code> is the directory exists, <code class="literal">FALSE</code> if it could not
|
||||
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
||||
<td> <a
|
||||
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
|
||||
><code class="literal">TRUE</code></a> is the directory exists, <a
|
||||
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
|
||||
><code class="literal">FALSE</code></a> if it could not
|
||||
be created
|
||||
</td>
|
||||
</tr>
|
||||
@ -296,12 +382,14 @@ do this for you.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2594851"></a><h3>
|
||||
<a name="id2562193"></a><h3>
|
||||
<a name="gimp-thumb-get-thumb-dir"></a>gimp_thumb_get_thumb_dir ()</h3>
|
||||
<a class="indexterm" name="id2618915"></a><pre class="programlisting">const gchar* gimp_thumb_get_thumb_dir (<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
|
||||
<a class="indexterm" name="id2562204"></a><pre class="programlisting">const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* gimp_thumb_get_thumb_dir (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
|
||||
<p>
|
||||
Retrieve the name of the thumbnail folder for a specific size. The
|
||||
returned pointer will become invalid if <a class="link" href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-init"><code class="function">gimp_thumb_init()</code></a> is used
|
||||
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
|
||||
again. It must not be changed or freed.</p>
|
||||
<p>
|
||||
|
||||
@ -310,12 +398,12 @@ again. It must not be changed or freed.</p>
|
||||
<col align="left" valign="top">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
|
||||
<td> a GimpThumbSize
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||||
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
||||
<td> the thumbnail directory in the encoding of the filesystem
|
||||
</td>
|
||||
</tr>
|
||||
@ -324,9 +412,11 @@ again. It must not be changed or freed.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2618982"></a><h3>
|
||||
<a name="id2562278"></a><h3>
|
||||
<a name="gimp-thumbs-delete-for-uri"></a>gimp_thumbs_delete_for_uri ()</h3>
|
||||
<a class="indexterm" name="id2618995"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri (const gchar *uri);</pre>
|
||||
<a class="indexterm" name="id2562293"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri);</pre>
|
||||
<p>
|
||||
Deletes all thumbnails for the image file specified by <em class="parameter"><code>uri</code></em> from the
|
||||
user's thumbnail repository.</p>
|
||||
@ -336,7 +426,7 @@ user's thumbnail repository.</p>
|
||||
<div class="variablelist"><table border="0">
|
||||
<col align="left" valign="top">
|
||||
<tbody><tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
|
||||
<td> an escaped URI
|
||||
</td>
|
||||
</tr></tbody>
|
||||
@ -346,10 +436,14 @@ user's thumbnail repository.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2619054"></a><h3>
|
||||
<a name="id2601881"></a><h3>
|
||||
<a name="gimp-thumb-name-from-uri-local"></a>gimp_thumb_name_from_uri_local ()</h3>
|
||||
<a class="indexterm" name="id2619070"></a><pre class="programlisting">gchar* gimp_thumb_name_from_uri_local (const gchar *uri,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
|
||||
<a class="indexterm" name="id2601895"></a><pre class="programlisting"><a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* gimp_thumb_name_from_uri_local (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
|
||||
<p>
|
||||
Creates the name of a local thumbnail file of the specified <em class="parameter"><code>size</code></em>
|
||||
that belongs to an image file located at the given <em class="parameter"><code>uri</code></em>. Local
|
||||
@ -361,19 +455,21 @@ thumbnails have been introduced with version 0.7 of the spec.</p>
|
||||
<col align="left" valign="top">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
|
||||
<td> an escaped URI
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||||
<td> a <a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
|
||||
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
|
||||
<td> a <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||||
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
||||
<td> a newly allocated filename in the encoding of the
|
||||
filesystem or <code class="literal">NULL</code> if <em class="parameter"><code>uri</code></em> is a remote file or
|
||||
filesystem or <a
|
||||
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
|
||||
><code class="literal">NULL</code></a> if <em class="parameter"><code>uri</code></em> is a remote file or
|
||||
points to the user's thumbnail repository.
|
||||
|
||||
</td>
|
||||
@ -385,11 +481,17 @@ thumbnails have been introduced with version 0.7 of the spec.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2619199"></a><h3>
|
||||
<a name="id2602013"></a><h3>
|
||||
<a name="gimp-thumb-ensure-thumb-dir-local"></a>gimp_thumb_ensure_thumb_dir_local ()</h3>
|
||||
<a class="indexterm" name="id2619215"></a><pre class="programlisting">gboolean gimp_thumb_ensure_thumb_dir_local (const gchar *dirname,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
|
||||
GError **error);</pre>
|
||||
<a class="indexterm" name="id2602029"></a><pre class="programlisting"><a
|
||||
href="../glib/glib-Basic-Types.html#gboolean"
|
||||
>gboolean</a> gimp_thumb_ensure_thumb_dir_local (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *dirname,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
|
||||
<a
|
||||
href="../glib/glib-Error-Reporting.html#GError"
|
||||
>GError</a> **error);</pre>
|
||||
<p>
|
||||
This function checks if the directory that is required to store
|
||||
local thumbnails for a particular <em class="parameter"><code>size</code></em> exist and attempts to
|
||||
@ -397,7 +499,7 @@ create it if necessary.
|
||||
</p>
|
||||
<p>
|
||||
You shouldn't have to call this function directly since
|
||||
<a class="link" href="GimpThumbnail.html#gimp-thumbnail-save-thumb-local"><code class="function">gimp_thumbnail_save_thumb_local()</code></a> will do this for you.</p>
|
||||
<a href="GimpThumbnail.html#gimp-thumbnail-save-thumb-local"><code class="function">gimp_thumbnail_save_thumb_local()</code></a> will do this for you.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
@ -405,23 +507,27 @@ You shouldn't have to call this function directly since
|
||||
<col align="left" valign="top">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>dirname</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>dirname</code></em> :</span></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
|
||||
<td> a GimpThumbSize
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
|
||||
<td> return location for possible errors
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||||
<td> <code class="literal">TRUE</code> is the directory exists, <code class="literal">FALSE</code> if it could not
|
||||
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
||||
<td> <a
|
||||
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
|
||||
><code class="literal">TRUE</code></a> is the directory exists, <a
|
||||
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
|
||||
><code class="literal">FALSE</code></a> if it could not
|
||||
be created
|
||||
|
||||
</td>
|
||||
@ -433,13 +539,17 @@ You shouldn't have to call this function directly since
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2619368"></a><h3>
|
||||
<a name="id2602181"></a><h3>
|
||||
<a name="gimp-thumb-get-thumb-dir-local"></a>gimp_thumb_get_thumb_dir_local ()</h3>
|
||||
<a class="indexterm" name="id2619383"></a><pre class="programlisting">gchar* gimp_thumb_get_thumb_dir_local (const gchar *dirname,
|
||||
<a class="link" href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
|
||||
<a class="indexterm" name="id2602197"></a><pre class="programlisting"><a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a>* gimp_thumb_get_thumb_dir_local (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *dirname,
|
||||
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
|
||||
<p>
|
||||
Retrieve the name of the local thumbnail folder for a specific
|
||||
size. Unlike <a class="link" 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
|
||||
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
|
||||
constant and should be free'd when it is not any longer needed.</p>
|
||||
<p>
|
||||
|
||||
@ -448,17 +558,17 @@ constant and should be free'd when it is not any longer needed.</p>
|
||||
<col align="left" valign="top">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>dirname</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>dirname</code></em> :</span></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
|
||||
<td> a GimpThumbSize
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||||
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
||||
<td> the thumbnail directory in the encoding of the filesystem
|
||||
|
||||
</td>
|
||||
@ -470,9 +580,11 @@ constant and should be free'd when it is not any longer needed.</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2" lang="en">
|
||||
<a name="id2619464"></a><h3>
|
||||
<a name="id2602299"></a><h3>
|
||||
<a name="gimp-thumbs-delete-for-uri-local"></a>gimp_thumbs_delete_for_uri_local ()</h3>
|
||||
<a class="indexterm" name="id2619478"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri_local (const gchar *uri);</pre>
|
||||
<a class="indexterm" name="id2602314"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri_local (const <a
|
||||
href="../glib/glib-Basic-Types.html#gchar"
|
||||
>gchar</a> *uri);</pre>
|
||||
<p>
|
||||
Deletes all thumbnails for the image file specified by <em class="parameter"><code>uri</code></em> from
|
||||
the local thumbnail repository.</p>
|
||||
@ -482,7 +594,7 @@ the local thumbnail repository.</p>
|
||||
<div class="variablelist"><table border="0">
|
||||
<col align="left" valign="top">
|
||||
<tbody><tr>
|
||||
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
|
||||
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
|
||||
<td> an escaped URI
|
||||
</td>
|
||||
</tr></tbody>
|
||||
|
Reference in New Issue
Block a user