438 lines
18 KiB
HTML
438 lines
18 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>GimpIntComboBox</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
|
|
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
|
|
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
|
|
<link rel="prev" href="GimpFrame.html" title="GimpFrame">
|
|
<link rel="next" href="GimpIntStore.html" title="GimpIntStore">
|
|
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
|
|
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
|
|
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
|
|
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
|
|
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
|
|
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
|
|
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
|
|
</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="GimpFrame.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimpwidgets-widgets.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 Widgets Library Reference Manual</th>
|
|
<td><a accesskey="n" href="GimpIntStore.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="#id2588913" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2596791" class="shortcut">Description</a>
|
|
 | 
|
|
<a href="#id2596697" class="shortcut">Object Hierarchy</a>
|
|
 | 
|
|
<a href="#id2596757" class="shortcut">Implemented Interfaces</a></nobr></td></tr>
|
|
</table>
|
|
<div class="refentry" lang="en">
|
|
<a name="GimpIntComboBox"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2>
|
|
<a name="id2588913"></a><span class="refentrytitle">GimpIntComboBox</span>
|
|
</h2>
|
|
<p>GimpIntComboBox — A widget providing a popup menu of integer values (e.g. enums).</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
<a href="GimpIntComboBox.html#GimpIntComboBox-struct">GimpIntComboBox</a>;
|
|
GtkWidget* <a href="GimpIntComboBox.html#gimp-int-combo-box-new">gimp_int_combo_box_new</a> (const gchar *first_label,
|
|
gint first_value,
|
|
...);
|
|
GtkWidget* <a href="GimpIntComboBox.html#gimp-int-combo-box-new-valist">gimp_int_combo_box_new_valist</a> (const gchar *first_label,
|
|
gint first_value,
|
|
va_list values);
|
|
GtkWidget* <a href="GimpIntComboBox.html#gimp-int-combo-box-new-array">gimp_int_combo_box_new_array</a> (gint n_values,
|
|
const gchar *labels[]);
|
|
void <a href="GimpIntComboBox.html#gimp-int-combo-box-prepend">gimp_int_combo_box_prepend</a> (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
...);
|
|
void <a href="GimpIntComboBox.html#gimp-int-combo-box-append">gimp_int_combo_box_append</a> (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
...);
|
|
gboolean <a href="GimpIntComboBox.html#gimp-int-combo-box-set-active">gimp_int_combo_box_set_active</a> (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
gint value);
|
|
gboolean <a href="GimpIntComboBox.html#gimp-int-combo-box-get-active">gimp_int_combo_box_get_active</a> (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
gint *value);
|
|
gulong <a href="GimpIntComboBox.html#gimp-int-combo-box-connect">gimp_int_combo_box_connect</a> (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
gint value,
|
|
GCallback callback,
|
|
gpointer data);
|
|
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2596697"></a><h2>Object Hierarchy</h2>
|
|
<pre class="synopsis">
|
|
|
|
GObject
|
|
+----GInitiallyUnowned
|
|
+----GtkObject
|
|
+----GtkWidget
|
|
+----GtkContainer
|
|
+----GtkBin
|
|
+----GtkComboBox
|
|
+----GimpIntComboBox
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2596757"></a><h2>Implemented Interfaces</h2>
|
|
<p>
|
|
GimpIntComboBox implements
|
|
AtkImplementorIface, GtkCellEditable and GtkCellLayout.</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2596791"></a><h2>Description</h2>
|
|
<p>
|
|
A widget providing a popup menu of integer values (e.g. enums).
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2596808"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2603256"></a><h3>
|
|
<a name="GimpIntComboBox-struct"></a>GimpIntComboBox</h3>
|
|
<a class="indexterm" name="id2603268"></a><pre class="programlisting">typedef struct _GimpIntComboBox GimpIntComboBox;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2603284"></a><h3>
|
|
<a name="gimp-int-combo-box-new"></a>gimp_int_combo_box_new ()</h3>
|
|
<a class="indexterm" name="id2603298"></a><pre class="programlisting">GtkWidget* gimp_int_combo_box_new (const gchar *first_label,
|
|
gint first_value,
|
|
...);</pre>
|
|
<p>
|
|
Creates a GtkComboBox that has integer values associated with each
|
|
item. The items to fill the combo box with are specified as a <code class="literal">NULL</code>
|
|
terminated list of label/value pairs.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>first_label</code></em> :</span></td>
|
|
<td> the label of the first item
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>first_value</code></em> :</span></td>
|
|
<td> the value of the first item
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
|
|
<td> a <code class="literal">NULL</code> terminated list of more label, value pairs
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> a new <a href="GimpIntComboBox.html" title="GimpIntComboBox"><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="id2603426"></a><h3>
|
|
<a name="gimp-int-combo-box-new-valist"></a>gimp_int_combo_box_new_valist ()</h3>
|
|
<a class="indexterm" name="id2603440"></a><pre class="programlisting">GtkWidget* gimp_int_combo_box_new_valist (const gchar *first_label,
|
|
gint first_value,
|
|
va_list values);</pre>
|
|
<p>
|
|
A variant of <a href="GimpIntComboBox.html#gimp-int-combo-box-new"><code class="function">gimp_int_combo_box_new()</code></a> that takes a va_list of
|
|
label/value pairs. Probably only useful for language bindings.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>first_label</code></em> :</span></td>
|
|
<td> the label of the first item
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>first_value</code></em> :</span></td>
|
|
<td> the value of the first item
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>values</code></em> :</span></td>
|
|
<td> a va_list with more values
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> a new <a href="GimpIntComboBox.html" title="GimpIntComboBox"><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="id2603706"></a><h3>
|
|
<a name="gimp-int-combo-box-new-array"></a>gimp_int_combo_box_new_array ()</h3>
|
|
<a class="indexterm" name="id2603722"></a><pre class="programlisting">GtkWidget* gimp_int_combo_box_new_array (gint n_values,
|
|
const gchar *labels[]);</pre>
|
|
<p>
|
|
A variant of <a href="GimpIntComboBox.html#gimp-int-combo-box-new"><code class="function">gimp_int_combo_box_new()</code></a> that takes an array of labels.
|
|
The array indices are used as values.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>n_values</code></em> :</span></td>
|
|
<td> the number of values
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>labels</code></em> :</span></td>
|
|
<td> an array of labels (array length must be <em class="parameter"><code>n_values</code></em>)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> a new <a href="GimpIntComboBox.html" title="GimpIntComboBox"><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="id2603831"></a><h3>
|
|
<a name="gimp-int-combo-box-prepend"></a>gimp_int_combo_box_prepend ()</h3>
|
|
<a class="indexterm" name="id2603845"></a><pre class="programlisting">void gimp_int_combo_box_prepend (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
...);</pre>
|
|
<p>
|
|
This function provides a convenient way to prepend items to a
|
|
<a href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a>. It prepends a row to the <em class="parameter"><code>combo_box</code></em>'s list store
|
|
and calls <code class="function">gtk_list_store_set()</code> for you.
|
|
</p>
|
|
<p>
|
|
The column number must be taken from the enum <a href="GimpIntStore.html#GimpIntStoreColumns"><span class="type">GimpIntStoreColumns</span></a>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>combo_box</code></em> :</span></td>
|
|
<td> a <a href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
|
|
<td> pairs of column number and value, terminated with -1
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608483"></a><h3>
|
|
<a name="gimp-int-combo-box-append"></a>gimp_int_combo_box_append ()</h3>
|
|
<a class="indexterm" name="id2608496"></a><pre class="programlisting">void gimp_int_combo_box_append (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
...);</pre>
|
|
<p>
|
|
This function provides a convenient way to append items to a
|
|
<a href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a>. It appends a row to the <em class="parameter"><code>combo_box</code></em>'s list store
|
|
and calls <code class="function">gtk_list_store_set()</code> for you.
|
|
</p>
|
|
<p>
|
|
The column number must be taken from the enum <a href="GimpIntStore.html#GimpIntStoreColumns"><span class="type">GimpIntStoreColumns</span></a>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>combo_box</code></em> :</span></td>
|
|
<td> a <a href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
|
|
<td> pairs of column number and value, terminated with -1
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608602"></a><h3>
|
|
<a name="gimp-int-combo-box-set-active"></a>gimp_int_combo_box_set_active ()</h3>
|
|
<a class="indexterm" name="id2608617"></a><pre class="programlisting">gboolean gimp_int_combo_box_set_active (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
gint value);</pre>
|
|
<p>
|
|
Looks up the item that belongs to the given <em class="parameter"><code>value</code></em> and makes it the
|
|
selected item in the <em class="parameter"><code>combo_box</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>combo_box</code></em> :</span></td>
|
|
<td> a <a href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value</code></em> :</span></td>
|
|
<td> an integer value
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> if there was no item for
|
|
this value.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608744"></a><h3>
|
|
<a name="gimp-int-combo-box-get-active"></a>gimp_int_combo_box_get_active ()</h3>
|
|
<a class="indexterm" name="id2608759"></a><pre class="programlisting">gboolean gimp_int_combo_box_get_active (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
gint *value);</pre>
|
|
<p>
|
|
Retrieves the value of the selected (active) item in the <em class="parameter"><code>combo_box</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>combo_box</code></em> :</span></td>
|
|
<td> a <a href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value</code></em> :</span></td>
|
|
<td> return location for the integer value
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>value</code></em> has been set or <code class="literal">FALSE</code> if no item was
|
|
active.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608886"></a><h3>
|
|
<a name="gimp-int-combo-box-connect"></a>gimp_int_combo_box_connect ()</h3>
|
|
<a class="indexterm" name="id2608900"></a><pre class="programlisting">gulong gimp_int_combo_box_connect (<a href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a> *combo_box,
|
|
gint value,
|
|
GCallback callback,
|
|
gpointer data);</pre>
|
|
<p>
|
|
A convenience function that sets the inital <em class="parameter"><code>value</code></em> of a
|
|
<a href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a> and connects <em class="parameter"><code>callback</code></em> to the "changed"
|
|
signal.
|
|
</p>
|
|
<p>
|
|
This function also calls the <em class="parameter"><code>callback</code></em> once after setting the
|
|
initial <em class="parameter"><code>value</code></em>. This is often convenient when working with combo
|
|
boxes that select a default active item (like for example
|
|
gimp_drawable_combo_box_new). If you pass an invalid initial
|
|
<em class="parameter"><code>value</code></em>, the <em class="parameter"><code>callback</code></em> will be called with the default item active.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>combo_box</code></em> :</span></td>
|
|
<td> a <a href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>value</code></em> :</span></td>
|
|
<td> the value to set
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>callback</code></em> :</span></td>
|
|
<td> a callback to connect to the <em class="parameter"><code>combo_box</code></em>'s "changed" signal
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
|
|
<td> a pointer passed as data to <code class="function">g_signal_connect()</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> the signal handler ID as returned by <code class="function">g_signal_connect()</code>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|