diff options
Diffstat (limited to 'devel-docs/libgimp/html/libgimp-gimpitem.html')
| -rw-r--r-- | devel-docs/libgimp/html/libgimp-gimpitem.html | 1361 |
1 files changed, 1361 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpitem.html b/devel-docs/libgimp/html/libgimp-gimpitem.html new file mode 100644 index 0000000..0964c16 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpitem.html @@ -0,0 +1,1361 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gimpitem: GIMP Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Library Reference Manual"> +<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties"> +<link rel="prev" href="libgimp-gimpmetadata.html" title="gimpmetadata"> +<link rel="next" href="libgimp-gimpitemtransform.html" title="gimpitemtransform"> +<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#libgimp-gimpitem.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimp-gimpmetadata.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimp-gimpitemtransform.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimp-gimpitem"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimp-gimpitem.top_of_page"></a>gimpitem</span></h2> +<p>gimpitem — Functions to manipulate items.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimp-gimpitem.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-valid" title="gimp_item_is_valid ()">gimp_item_is_valid</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-image" title="gimp_item_get_image ()">gimp_item_get_image</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-delete" title="gimp_item_delete ()">gimp_item_delete</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-drawable" title="gimp_item_is_drawable ()">gimp_item_is_drawable</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-layer" title="gimp_item_is_layer ()">gimp_item_is_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-text-layer" title="gimp_item_is_text_layer ()">gimp_item_is_text_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-channel" title="gimp_item_is_channel ()">gimp_item_is_channel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-layer-mask" title="gimp_item_is_layer_mask ()">gimp_item_is_layer_mask</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-selection" title="gimp_item_is_selection ()">gimp_item_is_selection</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-vectors" title="gimp_item_is_vectors ()">gimp_item_is_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-group" title="gimp_item_is_group ()">gimp_item_is_group</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-parent" title="gimp_item_get_parent ()">gimp_item_get_parent</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-children" title="gimp_item_get_children ()">gimp_item_get_children</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-expanded" title="gimp_item_get_expanded ()">gimp_item_get_expanded</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-set-expanded" title="gimp_item_set_expanded ()">gimp_item_set_expanded</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-name" title="gimp_item_get_name ()">gimp_item_get_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-set-name" title="gimp_item_set_name ()">gimp_item_set_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-visible" title="gimp_item_get_visible ()">gimp_item_get_visible</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-set-visible" title="gimp_item_set_visible ()">gimp_item_set_visible</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-linked" title="gimp_item_get_linked ()">gimp_item_get_linked</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-set-linked" title="gimp_item_set_linked ()">gimp_item_set_linked</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-lock-content" title="gimp_item_get_lock_content ()">gimp_item_get_lock_content</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-set-lock-content" title="gimp_item_set_lock_content ()">gimp_item_set_lock_content</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-lock-position" title="gimp_item_get_lock_position ()">gimp_item_get_lock_position</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-set-lock-position" title="gimp_item_set_lock_position ()">gimp_item_set_lock_position</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../html/libgimpbase-gimpbaseenums.html#GimpColorTag"><span class="returnvalue">GimpColorTag</span></a> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-color-tag" title="gimp_item_get_color_tag ()">gimp_item_get_color_tag</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-set-color-tag" title="gimp_item_set_color_tag ()">gimp_item_set_color_tag</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-tattoo" title="gimp_item_get_tattoo ()">gimp_item_get_tattoo</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-set-tattoo" title="gimp_item_set_tattoo ()">gimp_item_set_tattoo</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-attach-parasite" title="gimp_item_attach_parasite ()">gimp_item_attach_parasite</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-detach-parasite" title="gimp_item_detach_parasite ()">gimp_item_detach_parasite</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-parasite" title="gimp_item_get_parasite ()">gimp_item_get_parasite</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> ** +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpitem.html#gimp-item-get-parasite-list" title="gimp_item_get_parasite_list ()">gimp_item_get_parasite_list</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpitem.description"></a><h2>Description</h2> +<p>Functions to manipulate items.</p> +</div> +<div class="refsect1"> +<a name="libgimp-gimpitem.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-item-is-valid"></a><h3>gimp_item_is_valid ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_is_valid (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns TRUE if the item is valid.</p> +<p>This procedure checks if the given item ID is valid and refers to an +existing item.</p> +<div class="refsect3"> +<a name="gimp-item-is-valid.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item to check.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-is-valid.returns"></a><h4>Returns</h4> +<p> Whether the item ID is valid.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-image"></a><h3>gimp_item_get_image ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_item_get_image (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns the item's image.</p> +<p>This procedure returns the item's image.</p> +<div class="refsect3"> +<a name="gimp-item-get-image.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-image.returns"></a><h4>Returns</h4> +<p> The item's image.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-delete"></a><h3>gimp_item_delete ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_delete (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Delete a item.</p> +<p>This procedure deletes the specified item. This must not be done if +the image containing this item was already deleted or if the item +was already removed from the image. The only case in which this +procedure is useful is if you want to get rid of a item which has +not yet been added to an image.</p> +<div class="refsect3"> +<a name="gimp-item-delete.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item to delete.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-delete.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-is-drawable"></a><h3>gimp_item_is_drawable ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_is_drawable (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns whether the item is a drawable.</p> +<p>This procedure returns TRUE if the specified item is a drawable.</p> +<div class="refsect3"> +<a name="gimp-item-is-drawable.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-is-drawable.returns"></a><h4>Returns</h4> +<p> TRUE if the item is a drawable, FALSE otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-is-layer"></a><h3>gimp_item_is_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_is_layer (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns whether the item is a layer.</p> +<p>This procedure returns TRUE if the specified item is a layer.</p> +<div class="refsect3"> +<a name="gimp-item-is-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-is-layer.returns"></a><h4>Returns</h4> +<p> TRUE if the item is a layer, FALSE otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-is-text-layer"></a><h3>gimp_item_is_text_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_is_text_layer (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns whether the item is a text layer.</p> +<p>This procedure returns TRUE if the specified item is a text layer.</p> +<div class="refsect3"> +<a name="gimp-item-is-text-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-is-text-layer.returns"></a><h4>Returns</h4> +<p> TRUE if the item is a text layer, FALSE otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-is-channel"></a><h3>gimp_item_is_channel ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_is_channel (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns whether the item is a channel.</p> +<p>This procedure returns TRUE if the specified item is a channel.</p> +<div class="refsect3"> +<a name="gimp-item-is-channel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-is-channel.returns"></a><h4>Returns</h4> +<p> TRUE if the item is a channel, FALSE otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-is-layer-mask"></a><h3>gimp_item_is_layer_mask ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_is_layer_mask (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns whether the item is a layer mask.</p> +<p>This procedure returns TRUE if the specified item is a layer mask.</p> +<div class="refsect3"> +<a name="gimp-item-is-layer-mask.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-is-layer-mask.returns"></a><h4>Returns</h4> +<p> TRUE if the item is a layer mask, FALSE otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-is-selection"></a><h3>gimp_item_is_selection ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_is_selection (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns whether the item is a selection.</p> +<p>This procedure returns TRUE if the specified item is a selection.</p> +<div class="refsect3"> +<a name="gimp-item-is-selection.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-is-selection.returns"></a><h4>Returns</h4> +<p> TRUE if the item is a selection, FALSE otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-is-vectors"></a><h3>gimp_item_is_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_is_vectors (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns whether the item is a vectors.</p> +<p>This procedure returns TRUE if the specified item is a vectors.</p> +<div class="refsect3"> +<a name="gimp-item-is-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-is-vectors.returns"></a><h4>Returns</h4> +<p> TRUE if the item is a vectors, FALSE otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-is-group"></a><h3>gimp_item_is_group ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_is_group (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns whether the item is a group item.</p> +<p>This procedure returns TRUE if the specified item is a group item +which can have children.</p> +<div class="refsect3"> +<a name="gimp-item-is-group.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-is-group.returns"></a><h4>Returns</h4> +<p> TRUE if the item is a group, FALSE otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-parent"></a><h3>gimp_item_get_parent ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_item_get_parent (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns the item's parent item.</p> +<p>This procedure returns the item's parent item, if any.</p> +<div class="refsect3"> +<a name="gimp-item-get-parent.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-parent.returns"></a><h4>Returns</h4> +<p> The item's parent item.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-children"></a><h3>gimp_item_get_children ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> * +gimp_item_get_children (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_children</code></em>);</pre> +<p>Returns the item's list of children.</p> +<p>This procedure returns the list of items which are children of the +specified item. The order is topmost to bottommost.</p> +<div class="refsect3"> +<a name="gimp-item-get-children.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_children</p></td> +<td class="parameter_description"><p>The item's number of children.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-children.returns"></a><h4>Returns</h4> +<p> The item's list of children.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-expanded"></a><h3>gimp_item_get_expanded ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_get_expanded (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns whether the item is expanded.</p> +<p>This procedure returns TRUE if the specified item is expanded.</p> +<div class="refsect3"> +<a name="gimp-item-get-expanded.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-expanded.returns"></a><h4>Returns</h4> +<p> TRUE if the item is expanded, FALSE otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-set-expanded"></a><h3>gimp_item_set_expanded ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_set_expanded (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> expanded</code></em>);</pre> +<p>Sets the expanded state of the item.</p> +<p>This procedure expands or collapses the item.</p> +<div class="refsect3"> +<a name="gimp-item-set-expanded.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>expanded</p></td> +<td class="parameter_description"><p>TRUE to expand the item, FALSE to collapse the item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-set-expanded.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-name"></a><h3>gimp_item_get_name ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_item_get_name (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Get the name of the specified item.</p> +<p>This procedure returns the specified item's name.</p> +<div class="refsect3"> +<a name="gimp-item-get-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-name.returns"></a><h4>Returns</h4> +<p> The item name.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-set-name"></a><h3>gimp_item_set_name ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_set_name (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Set the name of the specified item.</p> +<p>This procedure sets the specified item's name.</p> +<div class="refsect3"> +<a name="gimp-item-set-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The new item name.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-set-name.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-visible"></a><h3>gimp_item_get_visible ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_get_visible (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Get the visibility of the specified item.</p> +<p>This procedure returns the specified item's visibility.</p> +<div class="refsect3"> +<a name="gimp-item-get-visible.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-visible.returns"></a><h4>Returns</h4> +<p> The item visibility.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-set-visible"></a><h3>gimp_item_set_visible ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_set_visible (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> visible</code></em>);</pre> +<p>Set the visibility of the specified item.</p> +<p>This procedure sets the specified item's visibility.</p> +<div class="refsect3"> +<a name="gimp-item-set-visible.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>visible</p></td> +<td class="parameter_description"><p>The new item visibility.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-set-visible.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-linked"></a><h3>gimp_item_get_linked ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_get_linked (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Get the linked state of the specified item.</p> +<p>This procedure returns the specified item's linked state.</p> +<div class="refsect3"> +<a name="gimp-item-get-linked.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-linked.returns"></a><h4>Returns</h4> +<p> The item linked state (for moves).</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-set-linked"></a><h3>gimp_item_set_linked ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_set_linked (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> linked</code></em>);</pre> +<p>Set the linked state of the specified item.</p> +<p>This procedure sets the specified item's linked state.</p> +<div class="refsect3"> +<a name="gimp-item-set-linked.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>linked</p></td> +<td class="parameter_description"><p>The new item linked state.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-set-linked.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-lock-content"></a><h3>gimp_item_get_lock_content ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_get_lock_content (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Get the 'lock content' state of the specified item.</p> +<p>This procedure returns the specified item's lock content state.</p> +<div class="refsect3"> +<a name="gimp-item-get-lock-content.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-lock-content.returns"></a><h4>Returns</h4> +<p> Whether the item's contents are locked.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-set-lock-content"></a><h3>gimp_item_set_lock_content ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_set_lock_content (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> lock_content</code></em>);</pre> +<p>Set the 'lock content' state of the specified item.</p> +<p>This procedure sets the specified item's lock content state.</p> +<div class="refsect3"> +<a name="gimp-item-set-lock-content.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>lock_content</p></td> +<td class="parameter_description"><p>The new item 'lock content' state.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-set-lock-content.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-lock-position"></a><h3>gimp_item_get_lock_position ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_get_lock_position (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Get the 'lock position' state of the specified item.</p> +<p>This procedure returns the specified item's lock position state.</p> +<div class="refsect3"> +<a name="gimp-item-get-lock-position.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-lock-position.returns"></a><h4>Returns</h4> +<p> Whether the item's position is locked.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-set-lock-position"></a><h3>gimp_item_set_lock_position ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_set_lock_position (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> lock_position</code></em>);</pre> +<p>Set the 'lock position' state of the specified item.</p> +<p>This procedure sets the specified item's lock position state.</p> +<div class="refsect3"> +<a name="gimp-item-set-lock-position.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>lock_position</p></td> +<td class="parameter_description"><p>The new item 'lock position' state.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-set-lock-position.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-color-tag"></a><h3>gimp_item_get_color_tag ()</h3> +<pre class="programlisting"><a href="../html/libgimpbase-gimpbaseenums.html#GimpColorTag"><span class="returnvalue">GimpColorTag</span></a> +gimp_item_get_color_tag (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Get the color tag of the specified item.</p> +<p>This procedure returns the specified item's color tag.</p> +<div class="refsect3"> +<a name="gimp-item-get-color-tag.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-color-tag.returns"></a><h4>Returns</h4> +<p> The item's color tag.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-set-color-tag"></a><h3>gimp_item_set_color_tag ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_set_color_tag (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpColorTag"><span class="type">GimpColorTag</span></a> color_tag</code></em>);</pre> +<p>Set the color tag of the specified item.</p> +<p>This procedure sets the specified item's color tag.</p> +<div class="refsect3"> +<a name="gimp-item-set-color-tag.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>color_tag</p></td> +<td class="parameter_description"><p>The new item color tag.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-set-color-tag.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-tattoo"></a><h3>gimp_item_get_tattoo ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_item_get_tattoo (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Get the tattoo of the specified item.</p> +<p>This procedure returns the specified item's tattoo. A tattoo is a +unique and permanent identifier attached to a item that can be used +to uniquely identify a item within an image even between sessions.</p> +<div class="refsect3"> +<a name="gimp-item-get-tattoo.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-tattoo.returns"></a><h4>Returns</h4> +<p> The item tattoo.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-set-tattoo"></a><h3>gimp_item_set_tattoo ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_set_tattoo (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> tattoo</code></em>);</pre> +<p>Set the tattoo of the specified item.</p> +<p>This procedure sets the specified item's tattoo. A tattoo is a +unique and permanent identifier attached to a item that can be used +to uniquely identify a item within an image even between sessions.</p> +<div class="refsect3"> +<a name="gimp-item-set-tattoo.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>tattoo</p></td> +<td class="parameter_description"><p>The new item tattoo.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-set-tattoo.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-attach-parasite"></a><h3>gimp_item_attach_parasite ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_attach_parasite (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code>const <a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="type">GimpParasite</span></a> *parasite</code></em>);</pre> +<p>Add a parasite to an item.</p> +<p>This procedure attaches a parasite to an item. It has no return +values.</p> +<div class="refsect3"> +<a name="gimp-item-attach-parasite.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parasite</p></td> +<td class="parameter_description"><p>The parasite to attach to the item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-attach-parasite.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-detach-parasite"></a><h3>gimp_item_detach_parasite ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_item_detach_parasite (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Removes a parasite from an item.</p> +<p>This procedure detaches a parasite from an item. It has no return +values.</p> +<div class="refsect3"> +<a name="gimp-item-detach-parasite.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the parasite to detach from the item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-detach-parasite.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-parasite"></a><h3>gimp_item_get_parasite ()</h3> +<pre class="programlisting"><a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> * +gimp_item_get_parasite (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Look up a parasite in an item</p> +<p>Finds and returns the parasite that is attached to an item.</p> +<div class="refsect3"> +<a name="gimp-item-get-parasite.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the parasite to find.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-parasite.returns"></a><h4>Returns</h4> +<p> The found parasite.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-item-get-parasite-list"></a><h3>gimp_item_get_parasite_list ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> ** +gimp_item_get_parasite_list (<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_parasites</code></em>);</pre> +<p>List all parasites.</p> +<p>Returns a list of all parasites currently attached the an item.</p> +<div class="refsect3"> +<a name="gimp-item-get-parasite-list.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_parasites</p></td> +<td class="parameter_description"><p>The number of attached parasites.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-item-get-parasite-list.returns"></a><h4>Returns</h4> +<p> The names of currently attached parasites. The returned +value must be freed with <code class="function">g_strfreev()</code>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html>
\ No newline at end of file |