Files
gimp/devel-docs/libgimp/html/GimpDrawableComboBox.html
2010-08-11 01:19:49 -04:00

351 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpdrawablecombobox</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
<link rel="prev" href="GimpZoomPreview.html" title="GimpZoomPreview">
<link rel="next" href="GimpImageComboBox.html" title="gimpimagecombobox">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GimpZoomPreview.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpui.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 Library Reference Manual</th>
<td><a accesskey="n" href="GimpImageComboBox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" class="shortcut">Description</a>
&#160;|&#160;
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpDrawableComboBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>gimpdrawablecombobox</span></h2>
<p>gimpdrawablecombobox &#8212; A widget providing a popup menu of drawables.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<a name="GimpChannelComboBox"></a><a name="GimpLayerComboBox"></a><pre class="synopsis">
<a href="GimpDrawableComboBox.html#GimpDrawableComboBox-struct">GimpDrawableComboBox</a>;
gboolean (<a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc">*GimpDrawableConstraintFunc</a>) (gint32 image_id,
gint32 drawable_id,
gpointer data);
GtkWidget* <a href="GimpDrawableComboBox.html#gimp-drawable-combo-box-new">gimp_drawable_combo_box_new</a> (<a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</a> constraint,
gpointer data);
<a href="GimpDrawableComboBox.html#GimpChannelComboBox-struct">GimpChannelComboBox</a>;
GtkWidget* <a href="GimpDrawableComboBox.html#gimp-channel-combo-box-new">gimp_channel_combo_box_new</a> (<a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</a> constraint,
gpointer data);
<a href="GimpDrawableComboBox.html#GimpLayerComboBox-struct">GimpLayerComboBox</a>;
GtkWidget* <a href="GimpDrawableComboBox.html#gimp-layer-combo-box-new">gimp_layer_combo_box_new</a> (<a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</a> constraint,
gpointer data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="object_hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkComboBox
+----<a
href="../libgimpwidgets/GimpIntComboBox.html"
>GimpIntComboBox</a>
+----GimpDrawableComboBox
</pre>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkComboBox
+----<a
href="../libgimpwidgets/GimpIntComboBox.html"
>GimpIntComboBox</a>
+----GimpChannelComboBox
</pre>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkComboBox
+----<a
href="../libgimpwidgets/GimpIntComboBox.html"
>GimpIntComboBox</a>
+----GimpLayerComboBox
</pre>
</div>
<div class="refsect1" lang="en">
<a name="impl_interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpDrawableComboBox implements
AtkImplementorIface, GtkCellLayout and GtkCellEditable.</p>
<p>
GimpChannelComboBox implements
AtkImplementorIface, GtkCellLayout and GtkCellEditable.</p>
<p>
GimpLayerComboBox implements
AtkImplementorIface, GtkCellLayout and GtkCellEditable.</p>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
A widget providing a popup menu of drawables.
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2675182"></a><h3>
<a name="GimpDrawableComboBox-struct"></a>GimpDrawableComboBox</h3>
<a class="indexterm" name="id2675194"></a><pre class="programlisting">typedef struct _GimpDrawableComboBox GimpDrawableComboBox;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2675209"></a><h3>
<a name="GimpDrawableConstraintFunc"></a>GimpDrawableConstraintFunc ()</h3>
<a class="indexterm" name="id2675220"></a><pre class="programlisting">gboolean (*GimpDrawableConstraintFunc) (gint32 image_id,
gint32 drawable_id,
gpointer data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_id</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_id</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2675318"></a><h3>
<a name="gimp-drawable-combo-box-new"></a>gimp_drawable_combo_box_new ()</h3>
<a class="indexterm" name="id2675331"></a><pre class="programlisting">GtkWidget* gimp_drawable_combo_box_new (<a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</a> constraint,
gpointer data);</pre>
<p>
Creates a new <a
href="../libgimpwidgets/GimpIntComboBox.html"
><span class="type">GimpIntComboBox</span></a> filled with all currently opened
drawables. If a <em class="parameter"><code>constraint</code></em> function is specified, it is called for
each drawable and only if the function returns <code class="literal">TRUE</code>, the drawable
is added to the combobox.
</p>
<p>
You should use <a
href="../libgimpwidgets/GimpIntComboBox.html#gimp-int-combo-box-connect"
><code class="function">gimp_int_combo_box_connect()</code></a> to initialize and connect
the combo. Use <a
href="../libgimpwidgets/GimpIntComboBox.html#gimp-int-combo-box-set-active"
><code class="function">gimp_int_combo_box_set_active()</code></a> to get the active
drawable ID and <a
href="../libgimpwidgets/GimpIntComboBox.html#gimp-int-combo-box-get-active"
><code class="function">gimp_int_combo_box_get_active()</code></a> to retrieve the ID
of the selected drawable.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>constraint</code></em>&#160;:</span></td>
<td> a <a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc"><span class="type">GimpDrawableConstraintFunc</span></a> or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td> a pointer that is passed to <em class="parameter"><code>constraint</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <a
href="../libgimpwidgets/GimpIntComboBox.html"
><span class="type">GimpIntComboBox</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2671385"></a><h3>
<a name="GimpChannelComboBox-struct"></a>GimpChannelComboBox</h3>
<a class="indexterm" name="id2671396"></a><pre class="programlisting">typedef struct _GimpChannelComboBox GimpChannelComboBox;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2671412"></a><h3>
<a name="gimp-channel-combo-box-new"></a>gimp_channel_combo_box_new ()</h3>
<a class="indexterm" name="id2671425"></a><pre class="programlisting">GtkWidget* gimp_channel_combo_box_new (<a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</a> constraint,
gpointer data);</pre>
<p>
Creates a new <a
href="../libgimpwidgets/GimpIntComboBox.html"
><span class="type">GimpIntComboBox</span></a> filled with all currently opened
channels. See <code class="function">gimp_drawable_combo_box()</code> for more info.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>constraint</code></em>&#160;:</span></td>
<td> a <a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc"><span class="type">GimpDrawableConstraintFunc</span></a> or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td> a pointer that is passed to <em class="parameter"><code>constraint</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <a
href="../libgimpwidgets/GimpIntComboBox.html"
><span class="type">GimpIntComboBox</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2671552"></a><h3>
<a name="GimpLayerComboBox-struct"></a>GimpLayerComboBox</h3>
<a class="indexterm" name="id2671563"></a><pre class="programlisting">typedef struct _GimpLayerComboBox GimpLayerComboBox;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2678053"></a><h3>
<a name="gimp-layer-combo-box-new"></a>gimp_layer_combo_box_new ()</h3>
<a class="indexterm" name="id2678065"></a><pre class="programlisting">GtkWidget* gimp_layer_combo_box_new (<a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</a> constraint,
gpointer data);</pre>
<p>
Creates a new <a
href="../libgimpwidgets/GimpIntComboBox.html"
><span class="type">GimpIntComboBox</span></a> filled with all currently opened
layers. See <code class="function">gimp_drawable_combo_box()</code> for more info.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>constraint</code></em>&#160;:</span></td>
<td> a <a href="GimpDrawableComboBox.html#GimpDrawableConstraintFunc"><span class="type">GimpDrawableConstraintFunc</span></a> or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td> a pointer that is passed to <em class="parameter"><code>constraint</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <a
href="../libgimpwidgets/GimpIntComboBox.html"
><span class="type">GimpIntComboBox</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
</div>
</div>
</body>
</html>