Files
gimp/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpEnumWidgets.html
2010-08-11 01:21:39 -04:00

521 lines
22 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>GimpEnumWidgets</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-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="prev" href="libgimpwidgets-GimpStock.html" title="GimpStock">
<link rel="next" href="libgimpwidgets-GimpPropWidgets.html" title="GimpPropWidgets">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part&#160;II.&#160;GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part&#160;III.&#160;GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;Deprecated API">
<link rel="index" href="libgimpwidgets-index.html" title="Index">
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpwidgets-index-deprecated.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="libgimpwidgets-GimpStock.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpwidgets-utils.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="libgimpwidgets-GimpPropWidgets.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="#id2568629" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2659463" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpwidgets-GimpEnumWidgets"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2568629"></a><span class="refentrytitle">GimpEnumWidgets</span>
</h2>
<p>GimpEnumWidgets</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
GtkWidget* <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new">gimp_enum_radio_box_new</a> (GType enum_type,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);
GtkWidget* <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new-with-range">gimp_enum_radio_box_new_with_range</a> (GType enum_type,
gint minimum,
gint maximum,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);
GtkWidget* <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-frame-new">gimp_enum_radio_frame_new</a> (GType enum_type,
GtkWidget *label_widget,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);
GtkWidget* <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-frame-new-with-range">gimp_enum_radio_frame_new_with_range</a>
(GType enum_type,
gint minimum,
gint maximum,
GtkWidget *label_widget,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);
GtkWidget* <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-new">gimp_enum_stock_box_new</a> (GType enum_type,
const gchar *stock_prefix,
GtkIconSize icon_size,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);
GtkWidget* <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-new-with-range">gimp_enum_stock_box_new_with_range</a> (GType enum_type,
gint minimum,
gint maximum,
const gchar *stock_prefix,
GtkIconSize icon_size,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);
void <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-set-child-padding">gimp_enum_stock_box_set_child_padding</a>
(GtkWidget *stock_box,
gint xpad,
gint ypad);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2659463"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2659479"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2659490"></a><h3>
<a name="gimp-enum-radio-box-new"></a>gimp_enum_radio_box_new ()</h3>
<a class="indexterm" name="id2659504"></a><pre class="programlisting">GtkWidget* gimp_enum_radio_box_new (GType enum_type,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);</pre>
<p>
Creates a new group of <span class="type">GtkRadioButtons</span> representing the enum
values. A group of radiobuttons is a good way to represent enums
with up to three or four values. Often it is better to use a
<a href="GimpEnumComboBox.html" title="GimpEnumComboBox"><span class="type">GimpEnumComboBox</span></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td> a callback to connect to the "toggled" signal of each
<span class="type">GtkRadioButton</span> that is created.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td> data to pass to the <em class="parameter"><code>callback</code></em>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>first_button</code></em>&#160;:</span></td>
<td> returns the first button in the created group.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <span class="type">GtkVBox</span> holding a group of <span class="type">GtkRadioButtons</span>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2647167"></a><h3>
<a name="gimp-enum-radio-box-new-with-range"></a>gimp_enum_radio_box_new_with_range ()</h3>
<a class="indexterm" name="id2647180"></a><pre class="programlisting">GtkWidget* gimp_enum_radio_box_new_with_range (GType enum_type,
gint minimum,
gint maximum,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);</pre>
<p>
Just like <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new"><code class="function">gimp_enum_radio_box_new()</code></a>, this function creates a group
of radio buttons, but it allows to limit the range of available
enum 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>enum_type</code></em>&#160;:</span></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>minimum</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>maximum</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td> a callback to connect to the "toggled" signal of each
<span class="type">GtkRadioButton</span> that is created.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td> data to pass to the <em class="parameter"><code>callback</code></em>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>first_button</code></em>&#160;:</span></td>
<td> returns the first button in the created group.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <span class="type">GtkVBox</span> holding a group of <span class="type">GtkRadioButtons</span>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2647401"></a><h3>
<a name="gimp-enum-radio-frame-new"></a>gimp_enum_radio_frame_new ()</h3>
<a class="indexterm" name="id2647414"></a><pre class="programlisting">GtkWidget* gimp_enum_radio_frame_new (GType enum_type,
GtkWidget *label_widget,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);</pre>
<p>
Calls <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new"><code class="function">gimp_enum_radio_box_new()</code></a> and puts the resulting vbox into a
<span class="type">GtkFrame</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>label_widget</code></em>&#160;:</span></td>
<td> a widget to use as label for the frame that will
hold the radio box.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td> a callback to connect to the "toggled" signal of each
<span class="type">GtkRadioButton</span> that is created.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td> data to pass to the <em class="parameter"><code>callback</code></em>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>first_button</code></em>&#160;:</span></td>
<td> returns the first button in the created group.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <span class="type">GtkFrame</span> holding a group of <span class="type">GtkRadioButtons</span>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2648432"></a><h3>
<a name="gimp-enum-radio-frame-new-with-range"></a>gimp_enum_radio_frame_new_with_range ()</h3>
<a class="indexterm" name="id2648446"></a><pre class="programlisting">GtkWidget* gimp_enum_radio_frame_new_with_range
(GType enum_type,
gint minimum,
gint maximum,
GtkWidget *label_widget,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);</pre>
<p>
Calls <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new-with-range"><code class="function">gimp_enum_radio_box_new_with_range()</code></a> and puts the resulting
vbox into a <span class="type">GtkFrame</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>minimum</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>maximum</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>label_widget</code></em>&#160;:</span></td>
<td> a widget to put into the frame that will hold the radio box.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td> a callback to connect to the "toggled" signal of each
<span class="type">GtkRadioButton</span> that is created.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td> data to pass to the <em class="parameter"><code>callback</code></em>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>first_button</code></em>&#160;:</span></td>
<td> returns the first button in the created group.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <span class="type">GtkFrame</span> holding a group of <span class="type">GtkRadioButtons</span>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2648698"></a><h3>
<a name="gimp-enum-stock-box-new"></a>gimp_enum_stock_box_new ()</h3>
<a class="indexterm" name="id2648711"></a><pre class="programlisting">GtkWidget* gimp_enum_stock_box_new (GType enum_type,
const gchar *stock_prefix,
GtkIconSize icon_size,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);</pre>
<p>
Creates a horizontal box of radio buttons with stock icons. The
stock_id for each icon is created by appending the enum_value's
nick to the given <em class="parameter"><code>stock_prefix</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>enum_type</code></em>&#160;:</span></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>stock_prefix</code></em>&#160;:</span></td>
<td> the prefix of the group of stock ids to use.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>icon_size</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td> a callback to connect to the "toggled" signal of each
<span class="type">GtkRadioButton</span> that is created.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td> data to pass to the <em class="parameter"><code>callback</code></em>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>first_button</code></em>&#160;:</span></td>
<td> returns the first button in the created group.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <span class="type">GtkHbox</span> holding a group of <span class="type">GtkRadioButtons</span>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2648931"></a><h3>
<a name="gimp-enum-stock-box-new-with-range"></a>gimp_enum_stock_box_new_with_range ()</h3>
<a class="indexterm" name="id2648945"></a><pre class="programlisting">GtkWidget* gimp_enum_stock_box_new_with_range (GType enum_type,
gint minimum,
gint maximum,
const gchar *stock_prefix,
GtkIconSize icon_size,
GCallback callback,
gpointer callback_data,
GtkWidget **first_button);</pre>
<p>
Just like <a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-new"><code class="function">gimp_enum_stock_box_new()</code></a>, this function creates a group
of radio buttons, but it allows to limit the range of available
enum 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>enum_type</code></em>&#160;:</span></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>minimum</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>maximum</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>stock_prefix</code></em>&#160;:</span></td>
<td> the prefix of the group of stock ids to use.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>icon_size</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td> a callback to connect to the "toggled" signal of each
<span class="type">GtkRadioButton</span> that is created.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td> data to pass to the <em class="parameter"><code>callback</code></em>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>first_button</code></em>&#160;:</span></td>
<td> returns the first button in the created group.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <span class="type">GtkHbox</span> holding a group of <span class="type">GtkRadioButtons</span>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2653580"></a><h3>
<a name="gimp-enum-stock-box-set-child-padding"></a>gimp_enum_stock_box_set_child_padding ()</h3>
<a class="indexterm" name="id2653596"></a><pre class="programlisting">void gimp_enum_stock_box_set_child_padding
(GtkWidget *stock_box,
gint xpad,
gint ypad);</pre>
<p>
Sets the padding of all buttons in a box created by
<a href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-new"><code class="function">gimp_enum_stock_box_new()</code></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>stock_box</code></em>&#160;:</span></td>
<td> a stock box widget
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>xpad</code></em>&#160;:</span></td>
<td> horizontal padding
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>ypad</code></em>&#160;:</span></td>
<td> vertical padding
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>