File: libgimpbase-gimpparasite.html

package info (click to toggle)
gimp 2.2.6-1sarge4
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 97,088 kB
  • ctags: 43,756
  • sloc: ansic: 525,782; xml: 36,543; lisp: 9,851; sh: 9,007; makefile: 7,974; python: 2,622; perl: 2,589; yacc: 520; lex: 334
file content (160 lines) | stat: -rw-r--r-- 18,736 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<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="PartI.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="PartI.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 &#8212; 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="id2550211"></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="id2550222"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2550227"></a><h3><a name="GimpParasite"></a>GimpParasite</h3><a class="indexterm" name="id2467218"></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="id2467234"></a><h3><a name="gimp-parasite-new"></a>gimp_parasite_new ()</h3><a class="indexterm" name="id2467242"></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="id2467336"></a><h3><a name="gimp-parasite-free"></a>gimp_parasite_free ()</h3><a class="indexterm" name="id2467345"></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="id2467378"></a><h3><a name="gimp-parasite-copy"></a>gimp_parasite_copy ()</h3><a class="indexterm" name="id2467387"></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="id2467431"></a><h3><a name="gimp-parasite-compare"></a>gimp_parasite_compare ()</h3><a class="indexterm" name="id2467439"></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="id2576116"></a><h3><a name="gimp-parasite-is-type"></a>gimp_parasite_is_type ()</h3><a class="indexterm" name="id2576124"></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="id2576184"></a><h3><a name="gimp-parasite-is-persistent"></a>gimp_parasite_is_persistent ()</h3><a class="indexterm" name="id2576193"></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="id2576237"></a><h3><a name="gimp-parasite-is-undoable"></a>gimp_parasite_is_undoable ()</h3><a class="indexterm" name="id2576245"></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="id2576289"></a><h3><a name="gimp-parasite-has-flag"></a>gimp_parasite_has_flag ()</h3><a class="indexterm" name="id2576298"></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="id2576359"></a><h3><a name="gimp-parasite-flags"></a>gimp_parasite_flags ()</h3><a class="indexterm" name="id2584918"></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="id2584962"></a><h3><a name="gimp-parasite-name"></a>gimp_parasite_name ()</h3><a class="indexterm" name="id2584970"></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="id2585015"></a><h3><a name="gimp-parasite-data"></a>gimp_parasite_data ()</h3><a class="indexterm" name="id2585024"></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="id2585068"></a><h3><a name="gimp-parasite-data-size"></a>gimp_parasite_data_size ()</h3><a class="indexterm" name="id2585076"></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="id2585121"></a><h3><a name="GIMP-PARASITE-PERSISTENT:CAPS"></a>GIMP_PARASITE_PERSISTENT</h3><a class="indexterm" name="id2585129"></a><pre class="programlisting">#define GIMP_PARASITE_PERSISTENT 1
</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2585139"></a><h3><a name="GIMP-PARASITE-UNDOABLE:CAPS"></a>GIMP_PARASITE_UNDOABLE</h3><a class="indexterm" name="id2585147"></a><pre class="programlisting">#define GIMP_PARASITE_UNDOABLE   2
</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2585157"></a><h3><a name="GIMP-PARASITE-ATTACH-PARENT:CAPS"></a>GIMP_PARASITE_ATTACH_PARENT</h3><a class="indexterm" name="id2585168"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_PARENT     (0x80 &lt;&lt; 8)
</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2585178"></a><h3><a name="GIMP-PARASITE-PARENT-PERSISTENT:CAPS"></a>GIMP_PARASITE_PARENT_PERSISTENT</h3><a class="indexterm" name="id2585190"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT &lt;&lt; 8)
</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2585202"></a><h3><a name="GIMP-PARASITE-PARENT-UNDOABLE:CAPS"></a>GIMP_PARASITE_PARENT_UNDOABLE</h3><a class="indexterm" name="id2585213"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_UNDOABLE   (GIMP_PARASITE_UNDOABLE &lt;&lt; 8)
</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2585224"></a><h3><a name="GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS"></a>GIMP_PARASITE_ATTACH_GRANDPARENT</h3><a class="indexterm" name="id2585236"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_GRANDPARENT     (0x80 &lt;&lt; 16)
</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2585247"></a><h3><a name="GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS"></a>GIMP_PARASITE_GRANDPARENT_PERSISTENT</h3><a class="indexterm" name="id2576067"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT &lt;&lt; 16)
</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2466451"></a><h3><a name="GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS"></a>GIMP_PARASITE_GRANDPARENT_UNDOABLE</h3><a class="indexterm" name="id2582720"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_UNDOABLE   (GIMP_PARASITE_UNDOABLE &lt;&lt; 16)
</pre><p>

</p></div></div><div class="refsect1" lang="en"><a name="id2571379"></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>&lt;&lt;gimpmemsize</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpparasiteio.html"><b>gimpparasiteio&gt;&gt;</b></a></td></tr></table></body></html>