Files
gimp/devel-docs/libgimpthumb/html/libgimpthumb-gimpthumb-enums.html
2010-08-11 01:23:08 -04:00

217 lines
7.8 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpthumb-enums</title>
<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="libgimpthumb-gimpthumb-utils.html" title="gimpthumb-utils">
<link rel="next" href="libgimpthumb-gimpthumb-error.html" title="gimpthumb-error">
<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">
<link rel="index" href="libgimpthumb-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpthumb-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpthumb-index-deprecated.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimpthumb-gimpthumb-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpthumb.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Thumbnail Library Reference Manual</th>
<td><a accesskey="n" href="libgimpthumb-gimpthumb-error.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="#id2597910" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2572844" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpthumb-gimpthumb-enums"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2597910"></a><span class="refentrytitle">gimpthumb-enums</span>
</h2>
<p>gimpthumb-enums &#8212; Enumerations used by libgimpthumb</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
enum <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbFileType">GimpThumbFileType</a>;
enum <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbSize">GimpThumbSize</a>;
enum <a href="libgimpthumb-gimpthumb-enums.html#GimpThumbState">GimpThumbState</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2572844"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2563601"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2563612"></a><h3>
<a name="GimpThumbFileType"></a>enum GimpThumbFileType</h3>
<a class="indexterm" name="id2563624"></a><pre class="programlisting">typedef enum
{
GIMP_THUMB_FILE_TYPE_NONE,
GIMP_THUMB_FILE_TYPE_REGULAR,
GIMP_THUMB_FILE_TYPE_FOLDER,
GIMP_THUMB_FILE_TYPE_SPECIAL
} GimpThumbFileType;
</pre>
<p>
File types as returned by <a href="libgimpthumb-gimpthumb-utils.html#gimp-thumb-file-test"><code class="function">gimp_thumb_file_test()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="GIMP-THUMB-FILE-TYPE-NONE:CAPS"></a><code class="literal">GIMP_THUMB_FILE_TYPE_NONE</code></span></td>
<td> file does not exist
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-FILE-TYPE-REGULAR:CAPS"></a><code class="literal">GIMP_THUMB_FILE_TYPE_REGULAR</code></span></td>
<td> a regular file
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-FILE-TYPE-FOLDER:CAPS"></a><code class="literal">GIMP_THUMB_FILE_TYPE_FOLDER</code></span></td>
<td> a directory
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-FILE-TYPE-SPECIAL:CAPS"></a><code class="literal">GIMP_THUMB_FILE_TYPE_SPECIAL</code></span></td>
<td> a special file (device node, fifo, socket, ...)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573251"></a><h3>
<a name="GimpThumbSize"></a>enum GimpThumbSize</h3>
<a class="indexterm" name="id2573264"></a><pre class="programlisting">typedef enum
{
GIMP_THUMB_SIZE_FAIL = 0,
GIMP_THUMB_SIZE_NORMAL = 128,
GIMP_THUMB_SIZE_LARGE = 256
} GimpThumbSize;
</pre>
<p>
Possible thumbnail sizes as defined by the Thumbnail Managaging Standard
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="GIMP-THUMB-SIZE-FAIL:CAPS"></a><code class="literal">GIMP_THUMB_SIZE_FAIL</code></span></td>
<td> special size used to indicate a thumbnail
creation failure
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-SIZE-NORMAL:CAPS"></a><code class="literal">GIMP_THUMB_SIZE_NORMAL</code></span></td>
<td> normal thumbnail size (128 pixels)
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-SIZE-LARGE:CAPS"></a><code class="literal">GIMP_THUMB_SIZE_LARGE</code></span></td>
<td> large thumbnail size (256 pixels)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581414"></a><h3>
<a name="GimpThumbState"></a>enum GimpThumbState</h3>
<a class="indexterm" name="id2581426"></a><pre class="programlisting">typedef enum
{
GIMP_THUMB_STATE_UNKNOWN,
GIMP_THUMB_STATE_REMOTE,
GIMP_THUMB_STATE_FOLDER,
GIMP_THUMB_STATE_SPECIAL,
GIMP_THUMB_STATE_NOT_FOUND,
GIMP_THUMB_STATE_EXISTS,
GIMP_THUMB_STATE_OLD,
GIMP_THUMB_STATE_FAILED,
GIMP_THUMB_STATE_OK
} GimpThumbState;
</pre>
<p>
Possible image and thumbnail file states used by libgimpthumb.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="GIMP-THUMB-STATE-UNKNOWN:CAPS"></a><code class="literal">GIMP_THUMB_STATE_UNKNOWN</code></span></td>
<td> nothing is known about the file/thumbnail
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-STATE-REMOTE:CAPS"></a><code class="literal">GIMP_THUMB_STATE_REMOTE</code></span></td>
<td> the file is on a remote file system
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-STATE-FOLDER:CAPS"></a><code class="literal">GIMP_THUMB_STATE_FOLDER</code></span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-STATE-SPECIAL:CAPS"></a><code class="literal">GIMP_THUMB_STATE_SPECIAL</code></span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-STATE-NOT-FOUND:CAPS"></a><code class="literal">GIMP_THUMB_STATE_NOT_FOUND</code></span></td>
<td> the file/thumbnail doesn't exist
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-STATE-EXISTS:CAPS"></a><code class="literal">GIMP_THUMB_STATE_EXISTS</code></span></td>
<td> the file/thumbnail exists
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-STATE-OLD:CAPS"></a><code class="literal">GIMP_THUMB_STATE_OLD</code></span></td>
<td> the thumbnail may be outdated
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-STATE-FAILED:CAPS"></a><code class="literal">GIMP_THUMB_STATE_FAILED</code></span></td>
<td> the thumbnail couldn't be created
</td>
</tr>
<tr>
<td><span class="term"><a name="GIMP-THUMB-STATE-OK:CAPS"></a><code class="literal">GIMP_THUMB_STATE_OK</code></span></td>
<td> the thumbnail exists and matches the image
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>