161 lines
18 KiB
HTML
161 lines
18 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpparasite</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part I. GIMP Base Library"><link rel="prev" href="libgimpbase-gimpmemsize.html" title="gimpmemsize"><link rel="next" href="libgimpbase-gimpparasiteio.html" title="gimpparasiteio"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part I. GIMP Base Library"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimpbase-gimpmemsize.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimpbase.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 Base Library Reference Manual</th><td><a accesskey="n" href="libgimpbase-gimpparasiteio.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libgimpbase-gimpparasite"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimpparasite</span></h2><p>gimpparasite — Arbitrary pieces of data which can be attached to various GIMP objects.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||
|
||
|
||
|
||
<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>;
|
||
<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* <a href="libgimpbase-gimpparasite.html#gimp-parasite-new">gimp_parasite_new</a> (const gchar *name,
|
||
guint32 flags,
|
||
guint32 size,
|
||
gconstpointer data);
|
||
void <a href="libgimpbase-gimpparasite.html#gimp-parasite-free">gimp_parasite_free</a> (<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
|
||
<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* <a href="libgimpbase-gimpparasite.html#gimp-parasite-copy">gimp_parasite_copy</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
|
||
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-compare">gimp_parasite_compare</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *a,
|
||
const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *b);
|
||
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-is-type">gimp_parasite_is_type</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
|
||
const gchar *name);
|
||
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-is-persistent">gimp_parasite_is_persistent</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
|
||
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-is-undoable">gimp_parasite_is_undoable</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
|
||
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-has-flag">gimp_parasite_has_flag</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
|
||
gulong flag);
|
||
gulong <a href="libgimpbase-gimpparasite.html#gimp-parasite-flags">gimp_parasite_flags</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
|
||
const gchar* <a href="libgimpbase-gimpparasite.html#gimp-parasite-name">gimp_parasite_name</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
|
||
gconstpointer <a href="libgimpbase-gimpparasite.html#gimp-parasite-data">gimp_parasite_data</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
|
||
glong <a href="libgimpbase-gimpparasite.html#gimp-parasite-data-size">gimp_parasite_data_size</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
|
||
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-PERSISTENT:CAPS">GIMP_PARASITE_PERSISTENT</a>
|
||
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-UNDOABLE:CAPS">GIMP_PARASITE_UNDOABLE</a>
|
||
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-PARENT:CAPS">GIMP_PARASITE_ATTACH_PARENT</a>
|
||
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-PERSISTENT:CAPS">GIMP_PARASITE_PARENT_PERSISTENT</a>
|
||
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-UNDOABLE:CAPS">GIMP_PARASITE_PARENT_UNDOABLE</a>
|
||
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS">GIMP_PARASITE_ATTACH_GRANDPARENT</a>
|
||
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS">GIMP_PARASITE_GRANDPARENT_PERSISTENT</a>
|
||
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS">GIMP_PARASITE_GRANDPARENT_UNDOABLE</a>
|
||
</pre></div><div class="refsect1" lang="en"><a name="id2584433"></a><h2>Description</h2><p>
|
||
Arbitrary pieces of data which can be attached to various GIMP objects.
|
||
|
||
</p></div><div class="refsect1" lang="en"><a name="id2584444"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2584449"></a><h3><a name="GimpParasite"></a>GimpParasite</h3><a class="indexterm" name="id2569798"></a><pre class="programlisting">typedef struct {
|
||
gchar *name; /* The name of the parasite. USE A UNIQUE PREFIX! */
|
||
guint32 flags; /* save Parasite in XCF file, etc. */
|
||
guint32 size; /* amount of data */
|
||
gpointer data; /* a pointer to the data. plugin is *
|
||
* responsible for tracking byte order */
|
||
} GimpParasite;
|
||
</pre><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2569814"></a><h3><a name="gimp-parasite-new"></a>gimp_parasite_new ()</h3><a class="indexterm" name="id2569822"></a><pre class="programlisting"><a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* gimp_parasite_new (const gchar *name,
|
||
guint32 flags,
|
||
guint32 size,
|
||
gconstpointer data);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>flags</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569916"></a><h3><a name="gimp-parasite-free"></a>gimp_parasite_free ()</h3><a class="indexterm" name="id2569925"></a><pre class="programlisting">void gimp_parasite_free (<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569958"></a><h3><a name="gimp-parasite-copy"></a>gimp_parasite_copy ()</h3><a class="indexterm" name="id2569967"></a><pre class="programlisting"><a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* gimp_parasite_copy (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2570011"></a><h3><a name="gimp-parasite-compare"></a>gimp_parasite_compare ()</h3><a class="indexterm" name="id2570019"></a><pre class="programlisting">gboolean gimp_parasite_compare (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *a,
|
||
const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *b);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>a</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>b</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582891"></a><h3><a name="gimp-parasite-is-type"></a>gimp_parasite_is_type ()</h3><a class="indexterm" name="id2582899"></a><pre class="programlisting">gboolean gimp_parasite_is_type (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
|
||
const gchar *name);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582961"></a><h3><a name="gimp-parasite-is-persistent"></a>gimp_parasite_is_persistent ()</h3><a class="indexterm" name="id2582970"></a><pre class="programlisting">gboolean gimp_parasite_is_persistent (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583014"></a><h3><a name="gimp-parasite-is-undoable"></a>gimp_parasite_is_undoable ()</h3><a class="indexterm" name="id2583023"></a><pre class="programlisting">gboolean gimp_parasite_is_undoable (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583067"></a><h3><a name="gimp-parasite-has-flag"></a>gimp_parasite_has_flag ()</h3><a class="indexterm" name="id2583075"></a><pre class="programlisting">gboolean gimp_parasite_has_flag (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
|
||
gulong flag);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>flag</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586066"></a><h3><a name="gimp-parasite-flags"></a>gimp_parasite_flags ()</h3><a class="indexterm" name="id2586075"></a><pre class="programlisting">gulong gimp_parasite_flags (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586119"></a><h3><a name="gimp-parasite-name"></a>gimp_parasite_name ()</h3><a class="indexterm" name="id2586127"></a><pre class="programlisting">const gchar* gimp_parasite_name (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586172"></a><h3><a name="gimp-parasite-data"></a>gimp_parasite_data ()</h3><a class="indexterm" name="id2586181"></a><pre class="programlisting">gconstpointer gimp_parasite_data (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586225"></a><h3><a name="gimp-parasite-data-size"></a>gimp_parasite_data_size ()</h3><a class="indexterm" name="id2586233"></a><pre class="programlisting">glong gimp_parasite_data_size (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586278"></a><h3><a name="GIMP-PARASITE-PERSISTENT:CAPS"></a>GIMP_PARASITE_PERSISTENT</h3><a class="indexterm" name="id2586289"></a><pre class="programlisting">#define GIMP_PARASITE_PERSISTENT 1
|
||
</pre><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586298"></a><h3><a name="GIMP-PARASITE-UNDOABLE:CAPS"></a>GIMP_PARASITE_UNDOABLE</h3><a class="indexterm" name="id2586307"></a><pre class="programlisting">#define GIMP_PARASITE_UNDOABLE 2
|
||
</pre><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586317"></a><h3><a name="GIMP-PARASITE-ATTACH-PARENT:CAPS"></a>GIMP_PARASITE_ATTACH_PARENT</h3><a class="indexterm" name="id2586328"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_PARENT (0x80 << 8)
|
||
</pre><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586339"></a><h3><a name="GIMP-PARASITE-PARENT-PERSISTENT:CAPS"></a>GIMP_PARASITE_PARENT_PERSISTENT</h3><a class="indexterm" name="id2586350"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT << 8)
|
||
</pre><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586362"></a><h3><a name="GIMP-PARASITE-PARENT-UNDOABLE:CAPS"></a>GIMP_PARASITE_PARENT_UNDOABLE</h3><a class="indexterm" name="id2586373"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE << 8)
|
||
</pre><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586385"></a><h3><a name="GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS"></a>GIMP_PARASITE_ATTACH_GRANDPARENT</h3><a class="indexterm" name="id2586396"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_GRANDPARENT (0x80 << 16)
|
||
</pre><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586407"></a><h3><a name="GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS"></a>GIMP_PARASITE_GRANDPARENT_PERSISTENT</h3><a class="indexterm" name="id2586418"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT << 16)
|
||
</pre><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586430"></a><h3><a name="GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS"></a>GIMP_PARASITE_GRANDPARENT_UNDOABLE</h3><a class="indexterm" name="id2586442"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE << 16)
|
||
</pre><p>
|
||
|
||
</p></div></div><div class="refsect1" lang="en"><a name="id2586455"></a><h2>See Also</h2><p>
|
||
<a
|
||
href="../libgimp/libgimp-gimpimage.html#gimp-image-parasite-attach"
|
||
><tt class="function">gimp_image_parasite_attach()</tt></a>, <a
|
||
href="../libgimp/libgimp-gimpdrawable.html#gimp-drawable-parasite-attach"
|
||
><tt class="function">gimp_drawable_parasite_attach()</tt></a>,
|
||
<a
|
||
href="../libgimp/libgimp-gimp.html#gimp-parasite-attach"
|
||
><tt class="function">gimp_parasite_attach()</tt></a> and their related functions.
|
||
</p></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimpbase-gimpmemsize.html"><b><< gimpmemsize</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpparasiteio.html"><b>gimpparasiteio >></b></a></td></tr></table></body></html>
|