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

Imported Upstream version 2.2.14

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:17:12 -04:00
parent 70ad8213cf
commit a2f097051e
490 changed files with 35329 additions and 58398 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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.68.1">
<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">
@ -21,16 +21,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="#id2560338" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2573489" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2538172" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2581257" 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="id2560338"></a><span class="refentrytitle">gimpthumb-utils</span>
<a name="id2573489"></a><span class="refentrytitle">gimpthumb-utils</span>
</h2>
<p>gimpthumb-utils &#8212; Utility functions provided and used by libgimpthumb</p>
</td>
@ -69,17 +69,17 @@ void <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumbs-delete-for-ur
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2538172"></a><h2>Description</h2>
<a name="id2581257"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2538188"></a><h2>Details</h2>
<a name="id2581273"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2538199"></a><h3>
<a name="id2581283"></a><h3>
<a name="gimp-thumb-init"></a>gimp_thumb_init ()</h3>
<a class="indexterm" name="id2538211"></a><pre class="programlisting">gboolean gimp_thumb_init (const gchar *creator,
<a class="indexterm" name="id2581296"></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
@ -107,20 +107,17 @@ directory here.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>creator</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>creator</code></em>&#160;:</span></td>
<td> an ASCII string that identifies the thumbnail creator
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>thumb_basedir</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>thumb_basedir</code></em>&#160;:</span></td>
<td> an absolute path or <code class="literal">NULL</code> to use the default
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the library was successfully initialized.
</td>
</tr>
@ -129,9 +126,9 @@ directory here.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2528242"></a><h3>
<a name="id2577300"></a><h3>
<a name="gimp-thumb-find-thumb"></a>gimp_thumb_find_thumb ()</h3>
<a class="indexterm" name="id2528253"></a><pre class="programlisting">gchar* gimp_thumb_find_thumb (const gchar *uri,
<a class="indexterm" name="id2577311"></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
@ -155,20 +152,17 @@ pointer to by <em class="parameter"><code>size</code></em> and the file location
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td> an escaped URI
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> pointer to a <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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
</td>
@ -178,9 +172,9 @@ pointer to by <em class="parameter"><code>size</code></em> and the file location
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554834"></a><h3>
<a name="id2566863"></a><h3>
<a name="gimp-thumb-file-test"></a>gimp_thumb_file_test ()</h3>
<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,
<a class="indexterm" name="id2566874"></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>
@ -195,32 +189,27 @@ and file size in 64bit integer values.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td> a filename in the encoding of the filesystem
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mtime</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>mtime</code></em>&#160;:</span></td>
<td> return location for modification time
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> return location for file size
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>err_no</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>err_no</code></em>&#160;:</span></td>
<td> return location for system "errno"
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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>
@ -230,9 +219,9 @@ and file size in 64bit integer values.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554992"></a><h3>
<a name="id2567020"></a><h3>
<a name="gimp-thumb-name-from-uri"></a>gimp_thumb_name_from_uri ()</h3>
<a class="indexterm" name="id2555004"></a><pre class="programlisting">gchar* gimp_thumb_name_from_uri (const gchar *uri,
<a class="indexterm" name="id2567031"></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
@ -244,20 +233,17 @@ belongs to an image file located at the given <em class="parameter"><code>uri</c
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td> an escaped URI
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> a <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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
thumbnail repository.
@ -268,9 +254,9 @@ belongs to an image file located at the given <em class="parameter"><code>uri</c
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2533146"></a><h3>
<a name="id2561045"></a><h3>
<a name="gimp-thumb-ensure-thumb-dir"></a>gimp_thumb_ensure_thumb_dir ()</h3>
<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,
<a class="indexterm" name="id2561057"></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
@ -288,20 +274,17 @@ do this for you.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> a GimpThumbSize
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td> return location for possible errors
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> is the directory exists, <code class="literal">FALSE</code> if it could not
be created
</td>
@ -311,9 +294,9 @@ do this for you.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2533287"></a><h3>
<a name="id2561188"></a><h3>
<a name="gimp-thumb-get-thumb-dir"></a>gimp_thumb_get_thumb_dir ()</h3>
<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>
<a class="indexterm" name="id2561199"></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
@ -325,14 +308,12 @@ again. It must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> a GimpThumbSize
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the thumbnail directory in the encoding of the filesystem
</td>
</tr>
@ -341,9 +322,9 @@ again. It must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568561"></a><h3>
<a name="id2561274"></a><h3>
<a name="gimp-thumbs-delete-for-uri"></a>gimp_thumbs_delete_for_uri ()</h3>
<a class="indexterm" name="id2568574"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri (const gchar *uri);</pre>
<a class="indexterm" name="id2561288"></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>
@ -353,8 +334,7 @@ user's thumbnail repository.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td> an escaped URI
</td>
</tr></tbody>
@ -364,9 +344,9 @@ user's thumbnail repository.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568629"></a><h3>
<a name="id2601613"></a><h3>
<a name="gimp-thumb-name-from-uri-local"></a>gimp_thumb_name_from_uri_local ()</h3>
<a class="indexterm" name="id2568643"></a><pre class="programlisting">gchar* gimp_thumb_name_from_uri_local (const gchar *uri,
<a class="indexterm" name="id2601627"></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>
@ -379,20 +359,17 @@ thumbnails have been introduced with version 0.7 of the spec.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td> an escaped URI
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> a <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize"><span class="type">GimpThumbSize</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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
points to the user's thumbnail repository.
@ -406,9 +383,9 @@ thumbnails have been introduced with version 0.7 of the spec.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568767"></a><h3>
<a name="id2601742"></a><h3>
<a name="gimp-thumb-ensure-thumb-dir-local"></a>gimp_thumb_ensure_thumb_dir_local ()</h3>
<a class="indexterm" name="id2568783"></a><pre class="programlisting">gboolean gimp_thumb_ensure_thumb_dir_local
<a class="indexterm" name="id2601759"></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>
@ -427,26 +404,22 @@ You shouldn't have to call this function directly since
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dirname</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>dirname</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> a GimpThumbSize
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td> return location for possible errors
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> is the directory exists, <code class="literal">FALSE</code> if it could not
be created
@ -459,9 +432,9 @@ You shouldn't have to call this function directly since
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568933"></a><h3>
<a name="id2601909"></a><h3>
<a name="gimp-thumb-get-thumb-dir-local"></a>gimp_thumb_get_thumb_dir_local ()</h3>
<a class="indexterm" name="id2568949"></a><pre class="programlisting">gchar* gimp_thumb_get_thumb_dir_local (const gchar *dirname,
<a class="indexterm" name="id2601924"></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
@ -474,20 +447,17 @@ constant and should be free'd when it is not any longer needed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dirname</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>dirname</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> a GimpThumbSize
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the thumbnail directory in the encoding of the filesystem
</td>
@ -499,9 +469,9 @@ constant and should be free'd when it is not any longer needed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2569048"></a><h3>
<a name="id2602023"></a><h3>
<a name="gimp-thumbs-delete-for-uri-local"></a>gimp_thumbs_delete_for_uri_local ()</h3>
<a class="indexterm" name="id2569063"></a><pre class="programlisting">void gimp_thumbs_delete_for_uri_local
<a class="indexterm" name="id2602039"></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
@ -512,8 +482,7 @@ the local thumbnail repository.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
<td> an escaped URI
</td>
</tr></tbody>