callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.3.16

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:21:23 -04:00
parent d694295a3e
commit 2e1d89b96f
944 changed files with 103935 additions and 69090 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
devel-docs/libgimpthumb/html/libgimpthumb-gimpthumb-utils.html
View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpthumb-utils</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<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&#160;I.&#160;GIMP Thumbnail Library">
<link rel="prev" href="GimpThumbnail.html" title="GimpThumbnail">
<link rel="next" href="libgimpthumb-gimpthumb-enums.html" title="gimpthumb-enums">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpthumb.html" title="Part&#160;I.&#160;GIMP Thumbnail Library">
<link rel="index" href="libgimpthumb-index.html" title="Index">
@ -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="#id2575256" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2593898" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2562931" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2581316" 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="id2575256"></a><span class="refentrytitle">gimpthumb-utils</span>
<a name="id2593898"></a><span class="refentrytitle">gimpthumb-utils</span>
</h2>
<p>gimpthumb-utils &#8212; Utility functions provided and used by libgimpthumb</p>
</td>
@ -46,45 +46,43 @@
gboolean <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-init">gimp_thumb_init</a> (const gchar *creator,
const gchar *thumb_basedir);
gchar* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-find-thumb">gimp_thumb_find_thumb</a> (const gchar *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 gchar *filename,
gint64 *mtime,
gint64 *size,
gint *err_no);
gchar* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri">gimp_thumb_name_from_uri</a> (const gchar *uri,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
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,
GError **error);
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);
void <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri">gimp_thumbs_delete_for_uri</a> (const gchar *uri);
gchar* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri-local">gimp_thumb_name_from_uri_local</a> (const gchar *uri,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
gboolean <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-ensure-thumb-dir-local">gimp_thumb_ensure_thumb_dir_local</a>
(const gchar *dirname,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
GError **error);
gchar* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir-local">gimp_thumb_get_thumb_dir_local</a> (const gchar *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 gchar *uri);
gboolean <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-init">gimp_thumb_init</a> (const gchar *creator,
const gchar *thumb_basedir);
gchar* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-find-thumb">gimp_thumb_find_thumb</a> (const gchar *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 gchar *filename,
gint64 *mtime,
gint64 *size,
gint *err_no);
gchar* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri">gimp_thumb_name_from_uri</a> (const gchar *uri,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
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,
GError **error);
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);
void <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-uri">gimp_thumbs_delete_for_uri</a> (const gchar *uri);
gchar* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-name-from-uri-local">gimp_thumb_name_from_uri_local</a> (const gchar *uri,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);
gboolean <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-ensure-thumb-dir-local">gimp_thumb_ensure_thumb_dir_local</a> (const gchar *dirname,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
GError **error);
gchar* <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-get-thumb-dir-local">gimp_thumb_get_thumb_dir_local</a> (const gchar *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 gchar *uri);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2562931"></a><h2>Description</h2>
<a name="id2581316"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2562947"></a><h2>Details</h2>
<a name="id2581332"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2562957"></a><h3>
<a name="id2581342"></a><h3>
<a name="gimp-thumb-init"></a>gimp_thumb_init ()</h3>
<a class="indexterm" name="id2562970"></a><pre class="programlisting">gboolean gimp_thumb_init (const gchar *creator,
const gchar *thumb_basedir);</pre>
<a class="indexterm" name="id2581355"></a><pre class="programlisting">gboolean gimp_thumb_init (const gchar *creator,
const gchar *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
@ -130,10 +128,10 @@ directory here.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553855"></a><h3>
<a name="id2577360"></a><h3>
<a name="gimp-thumb-find-thumb"></a>gimp_thumb_find_thumb ()</h3>
<a class="indexterm" name="id2553866"></a><pre class="programlisting">gchar* gimp_thumb_find_thumb (const gchar *uri,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> *size);</pre>
<a class="indexterm" name="id2577371"></a><pre class="programlisting">gchar* gimp_thumb_find_thumb (const gchar *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
@ -176,12 +174,12 @@ pointer to by <em class="parameter"><code>size</code></em> and the file location
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2580302"></a><h3>
<a name="id2566923"></a><h3>
<a name="gimp-thumb-file-test"></a>gimp_thumb_file_test ()</h3>
<a class="indexterm" name="id2580313"></a><pre class="programlisting"><a 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="id2566934"></a><pre class="programlisting"><a href="libgimpthumb-gimpthumb-enums.html#GimpThumbFileType">GimpThumbFileType</a> gimp_thumb_file_test (const gchar *filename,
gint64 *mtime,
gint64 *size,
gint *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
@ -223,10 +221,10 @@ and file size in 64bit integer values.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2580462"></a><h3>
<a name="id2567082"></a><h3>
<a name="gimp-thumb-name-from-uri"></a>gimp_thumb_name_from_uri ()</h3>
<a class="indexterm" name="id2580473"></a><pre class="programlisting">gchar* gimp_thumb_name_from_uri (const gchar *uri,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
<a class="indexterm" name="id2567093"></a><pre class="programlisting">gchar* gimp_thumb_name_from_uri (const gchar *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>
@ -258,10 +256,10 @@ belongs to an image file located at the given <em class="parameter"><code>uri</c
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2557917"></a><h3>
<a name="id2561093"></a><h3>
<a name="gimp-thumb-ensure-thumb-dir"></a>gimp_thumb_ensure_thumb_dir ()</h3>
<a class="indexterm" name="id2557929"></a><pre class="programlisting">gboolean gimp_thumb_ensure_thumb_dir (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
GError **error);</pre>
<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,
GError **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
@ -298,9 +296,9 @@ do this for you.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558061"></a><h3>
<a name="id2561236"></a><h3>
<a name="gimp-thumb-get-thumb-dir"></a>gimp_thumb_get_thumb_dir ()</h3>
<a class="indexterm" name="id2558072"></a><pre class="programlisting">const gchar* gimp_thumb_get_thumb_dir (<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
<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>
<p>
Retrieve the name of the thumbnail folder for a specific size. The
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
@ -326,9 +324,9 @@ again. It must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593321"></a><h3>
<a name="id2561322"></a><h3>
<a name="gimp-thumbs-delete-for-uri"></a>gimp_thumbs_delete_for_uri ()</h3>
<a class="indexterm" name="id2593334"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri (const gchar *uri);</pre>
<a class="indexterm" name="id2561336"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri (const gchar *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>
@ -343,15 +341,15 @@ user's thumbnail repository.</p>
</td>
</tr></tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593389"></a><h3>
<a name="id2601719"></a><h3>
<a name="gimp-thumb-name-from-uri-local"></a>gimp_thumb_name_from_uri_local ()</h3>
<a class="indexterm" name="id2593404"></a><pre class="programlisting">gchar* gimp_thumb_name_from_uri_local (const gchar *uri,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
<a class="indexterm" name="id2601733"></a><pre class="programlisting">gchar* gimp_thumb_name_from_uri_local (const gchar *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
@ -382,17 +380,16 @@ thumbnails have been introduced with version 0.7 of the spec.</p>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593527"></a><h3>
<a name="id2601850"></a><h3>
<a name="gimp-thumb-ensure-thumb-dir-local"></a>gimp_thumb_ensure_thumb_dir_local ()</h3>
<a class="indexterm" name="id2593543"></a><pre class="programlisting">gboolean gimp_thumb_ensure_thumb_dir_local
(const gchar *dirname,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
GError **error);</pre>
<a class="indexterm" name="id2601866"></a><pre class="programlisting">gboolean gimp_thumb_ensure_thumb_dir_local (const gchar *dirname,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size,
GError **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
@ -431,15 +428,15 @@ You shouldn't have to call this function directly since
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593693"></a><h3>
<a name="id2602018"></a><h3>
<a name="gimp-thumb-get-thumb-dir-local"></a>gimp_thumb_get_thumb_dir_local ()</h3>
<a class="indexterm" name="id2593709"></a><pre class="programlisting">gchar* gimp_thumb_get_thumb_dir_local (const gchar *dirname,
<a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a> size);</pre>
<a class="indexterm" name="id2602034"></a><pre class="programlisting">gchar* gimp_thumb_get_thumb_dir_local (const gchar *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 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
@ -468,15 +465,14 @@ constant and should be free'd when it is not any longer needed.</p>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593808"></a><h3>
<a name="id2602136"></a><h3>
<a name="gimp-thumbs-delete-for-uri-local"></a>gimp_thumbs_delete_for_uri_local ()</h3>
<a class="indexterm" name="id2593823"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri_local
(const gchar *uri);</pre>
<a class="indexterm" name="id2602151"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri_local (const gchar *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>
@ -491,7 +487,7 @@ the local thumbnail repository.</p>
</td>
</tr></tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
</div>