diff options
Diffstat (limited to 'devel-docs/libgimpwidgets/html/libgimpwidgets-GimpEnumWidgets.html')
| -rw-r--r-- | devel-docs/libgimpwidgets/html/libgimpwidgets-GimpEnumWidgets.html | 742 |
1 files changed, 742 insertions, 0 deletions
diff --git a/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpEnumWidgets.html b/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpEnumWidgets.html new file mode 100644 index 0000000..c672ec0 --- /dev/null +++ b/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpEnumWidgets.html @@ -0,0 +1,742 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GimpEnumWidgets: GIMP Widgets Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual"> +<link rel="up" href="libgimpwidgets-utils.html" title="Part VI. GIMP Widgets Utilities"> +<link rel="prev" href="libgimpwidgets-GimpIcons.html" title="GimpIcons"> +<link rel="next" href="libgimpwidgets-GimpPropWidgets.html" title="GimpPropWidgets"> +<meta name="generator" content="GTK-Doc V1.32 (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="#libgimpwidgets-GimpEnumWidgets.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="libgimpwidgets-utils.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimpwidgets-GimpIcons.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimpwidgets-GimpPropWidgets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimpwidgets-GimpEnumWidgets"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimpwidgets-GimpEnumWidgets.top_of_page"></a>GimpEnumWidgets</span></h2> +<p>GimpEnumWidgets — A set of utility functions to create widgets +based on enums.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpEnumWidgets.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"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new" title="gimp_enum_radio_box_new ()">gimp_enum_radio_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new-with-range" title="gimp_enum_radio_box_new_with_range ()">gimp_enum_radio_box_new_with_range</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-frame-new" title="gimp_enum_radio_frame_new ()">gimp_enum_radio_frame_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-frame-new-with-range" title="gimp_enum_radio_frame_new_with_range ()">gimp_enum_radio_frame_new_with_range</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-new" title="gimp_enum_stock_box_new ()">gimp_enum_stock_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-new-with-range" title="gimp_enum_stock_box_new_with_range ()">gimp_enum_stock_box_new_with_range</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-set-child-padding" title="gimp_enum_stock_box_set_child_padding ()">gimp_enum_stock_box_set_child_padding</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-icon-box-new" title="gimp_enum_icon_box_new ()">gimp_enum_icon_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-icon-box-new-with-range" title="gimp_enum_icon_box_new_with_range ()">gimp_enum_icon_box_new_with_range</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-icon-box-set-child-padding" title="gimp_enum_icon_box_set_child_padding ()">gimp_enum_icon_box_set_child_padding</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpEnumWidgets.description"></a><h2>Description</h2> +<p>A set of utility functions to create widgets based on enums.</p> +</div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpEnumWidgets.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-enum-radio-box-new"></a><h3>gimp_enum_radio_box_new ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_enum_radio_box_new (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> callback_data</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> **first_button</code></em>);</pre> +<p>Creates a new group of <a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButtons</span></a> 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 class="link" href="GimpEnumComboBox.html" title="GimpEnumComboBox"><span class="type">GimpEnumComboBox</span></a> instead.</p> +<div class="refsect3"> +<a name="gimp-enum-radio-box-new.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>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a callback to connect to the "toggled" signal of each +<a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> that is created.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback_data</p></td> +<td class="parameter_description"><p>data to pass to the <em class="parameter"><code>callback</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_button</p></td> +<td class="parameter_description"><p>returns the first button in the created group.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-radio-box-new.returns"></a><h4>Returns</h4> +<p> a new <a href="https://developer.gnome.org/gtk3/GtkVBox.html#GtkVBox-struct"><span class="type">GtkVBox</span></a> holding a group of <a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButtons</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-radio-box-new-with-range"></a><h3>gimp_enum_radio_box_new_with_range ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_enum_radio_box_new_with_range (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code><span class="type">gint</span> minimum</code></em>, + <em class="parameter"><code><span class="type">gint</span> maximum</code></em>, + <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> callback_data</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> **first_button</code></em>);</pre> +<p>Just like <a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new" title="gimp_enum_radio_box_new ()"><code class="function">gimp_enum_radio_box_new()</code></a>, this function creates a group +of radio buttons, but additionally it supports limiting the range +of available enum values.</p> +<div class="refsect3"> +<a name="gimp-enum-radio-box-new-with-range.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>minimum</p></td> +<td class="parameter_description"><p>the minimum enum value</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>the maximum enum value</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a callback to connect to the "toggled" signal of each +<a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> that is created.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback_data</p></td> +<td class="parameter_description"><p>data to pass to the <em class="parameter"><code>callback</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_button</p></td> +<td class="parameter_description"><p>returns the first button in the created group.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-radio-box-new-with-range.returns"></a><h4>Returns</h4> +<p> a new <a href="https://developer.gnome.org/gtk3/GtkVBox.html#GtkVBox-struct"><span class="type">GtkVBox</span></a> holding a group of <a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButtons</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-radio-frame-new"></a><h3>gimp_enum_radio_frame_new ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_enum_radio_frame_new (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *label_widget</code></em>, + <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> callback_data</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> **first_button</code></em>);</pre> +<p>Calls <a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new" title="gimp_enum_radio_box_new ()"><code class="function">gimp_enum_radio_box_new()</code></a> and puts the resulting vbox into a +<a href="https://developer.gnome.org/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a>.</p> +<div class="refsect3"> +<a name="gimp-enum-radio-frame-new.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>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>label_widget</p></td> +<td class="parameter_description"><p>a widget to use as label for the frame that will +hold the radio box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a callback to connect to the "toggled" signal of each +<a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> that is created.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback_data</p></td> +<td class="parameter_description"><p>data to pass to the <em class="parameter"><code>callback</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_button</p></td> +<td class="parameter_description"><p>returns the first button in the created group.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-radio-frame-new.returns"></a><h4>Returns</h4> +<p> a new <a href="https://developer.gnome.org/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a> holding a group of <a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButtons</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-radio-frame-new-with-range"></a><h3>gimp_enum_radio_frame_new_with_range ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_enum_radio_frame_new_with_range (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code><span class="type">gint</span> minimum</code></em>, + <em class="parameter"><code><span class="type">gint</span> maximum</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *label_widget</code></em>, + <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> callback_data</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> **first_button</code></em>);</pre> +<p>Calls <a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-radio-box-new-with-range" title="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 <a href="https://developer.gnome.org/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a>.</p> +<div class="refsect3"> +<a name="gimp-enum-radio-frame-new-with-range.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>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>minimum</p></td> +<td class="parameter_description"><p>the minimum enum value</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>the maximum enum value</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>label_widget</p></td> +<td class="parameter_description"><p>a widget to put into the frame that will hold the radio box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a callback to connect to the "toggled" signal of each +<a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> that is created.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback_data</p></td> +<td class="parameter_description"><p>data to pass to the <em class="parameter"><code>callback</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_button</p></td> +<td class="parameter_description"><p>returns the first button in the created group.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-radio-frame-new-with-range.returns"></a><h4>Returns</h4> +<p> a new <a href="https://developer.gnome.org/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a> holding a group of <a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButtons</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-stock-box-new"></a><h3>gimp_enum_stock_box_new ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_enum_stock_box_new (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *stock_prefix</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/gtk3-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a> icon_size</code></em>, + <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> callback_data</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> **first_button</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_enum_stock_box_new</code> is deprecated and should not be used in newly-written code.</p> +<p>GIMP 2.10</p> +</div> +<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> +<div class="refsect3"> +<a name="gimp-enum-stock-box-new.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>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>stock_prefix</p></td> +<td class="parameter_description"><p>the prefix of the group of stock ids to use.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_size</p></td> +<td class="parameter_description"><p>the icon size for the stock icons</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a callback to connect to the "toggled" signal of each +<a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> that is created.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback_data</p></td> +<td class="parameter_description"><p>data to pass to the <em class="parameter"><code>callback</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_button</p></td> +<td class="parameter_description"><p>returns the first button in the created group.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-stock-box-new.returns"></a><h4>Returns</h4> +<p> a new <a href="https://developer.gnome.org/gtk3/GtkHBox.html#GtkHBox-struct"><span class="type">GtkHBox</span></a> holding a group of <a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButtons</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-stock-box-new-with-range"></a><h3>gimp_enum_stock_box_new_with_range ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_enum_stock_box_new_with_range (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code><span class="type">gint</span> minimum</code></em>, + <em class="parameter"><code><span class="type">gint</span> maximum</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *stock_prefix</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/gtk3-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a> icon_size</code></em>, + <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> callback_data</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> **first_button</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_enum_stock_box_new_with_range</code> is deprecated and should not be used in newly-written code.</p> +<p>GIMP 2.10</p> +</div> +<p>Just like <a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-new" title="gimp_enum_stock_box_new ()"><code class="function">gimp_enum_stock_box_new()</code></a>, this function creates a group +of radio buttons, but additionally it supports limiting the range +of available enum values.</p> +<div class="refsect3"> +<a name="gimp-enum-stock-box-new-with-range.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>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>minimum</p></td> +<td class="parameter_description"><p>the minumim enum value</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>the maximum enum value</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>stock_prefix</p></td> +<td class="parameter_description"><p>the prefix of the group of stock ids to use.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_size</p></td> +<td class="parameter_description"><p>the icon size for the stock icons</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a callback to connect to the "toggled" signal of each +<a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> that is created.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback_data</p></td> +<td class="parameter_description"><p>data to pass to the <em class="parameter"><code>callback</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_button</p></td> +<td class="parameter_description"><p>returns the first button in the created group.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-stock-box-new-with-range.returns"></a><h4>Returns</h4> +<p> a new <a href="https://developer.gnome.org/gtk3/GtkHBox.html#GtkHBox-struct"><span class="type">GtkHBox</span></a> holding a group of <a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButtons</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-stock-box-set-child-padding"></a><h3>gimp_enum_stock_box_set_child_padding ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_enum_stock_box_set_child_padding (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *stock_box</code></em>, + <em class="parameter"><code><span class="type">gint</span> xpad</code></em>, + <em class="parameter"><code><span class="type">gint</span> ypad</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_enum_stock_box_set_child_padding</code> is deprecated and should not be used in newly-written code.</p> +<p>GIMP 2.10</p> +</div> +<p>Sets the padding of all buttons in a box created by +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-stock-box-new" title="gimp_enum_stock_box_new ()"><code class="function">gimp_enum_stock_box_new()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-enum-stock-box-set-child-padding.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>stock_box</p></td> +<td class="parameter_description"><p>a stock box widget</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>xpad</p></td> +<td class="parameter_description"><p>horizontal padding</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ypad</p></td> +<td class="parameter_description"><p>vertical padding</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-icon-box-new"></a><h3>gimp_enum_icon_box_new ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_enum_icon_box_new (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *icon_prefix</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/gtk3-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a> icon_size</code></em>, + <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> callback_data</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> **first_button</code></em>);</pre> +<p>Creates a horizontal box of radio buttons with named icons. The +icon name for each icon is created by appending the enum_value's +nick to the given <em class="parameter"><code>icon_prefix</code></em> +.</p> +<div class="refsect3"> +<a name="gimp-enum-icon-box-new.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>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_prefix</p></td> +<td class="parameter_description"><p>the prefix of the group of icon names to use.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_size</p></td> +<td class="parameter_description"><p>the icon size for the icons</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a callback to connect to the "toggled" signal of each +<a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> that is created.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback_data</p></td> +<td class="parameter_description"><p>data to pass to the <em class="parameter"><code>callback</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_button</p></td> +<td class="parameter_description"><p>returns the first button in the created group.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-icon-box-new.returns"></a><h4>Returns</h4> +<p> a new <a href="https://developer.gnome.org/gtk3/GtkHBox.html#GtkHBox-struct"><span class="type">GtkHBox</span></a> holding a group of <a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButtons</span></a>.</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-enum-icon-box-new-with-range"></a><h3>gimp_enum_icon_box_new_with_range ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_enum_icon_box_new_with_range (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code><span class="type">gint</span> minimum</code></em>, + <em class="parameter"><code><span class="type">gint</span> maximum</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *icon_prefix</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/gtk3-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a> icon_size</code></em>, + <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> callback_data</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> **first_button</code></em>);</pre> +<p>Just like <a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-icon-box-new" title="gimp_enum_icon_box_new ()"><code class="function">gimp_enum_icon_box_new()</code></a>, this function creates a group +of radio buttons, but additionally it supports limiting the range +of available enum values.</p> +<div class="refsect3"> +<a name="gimp-enum-icon-box-new-with-range.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>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>minimum</p></td> +<td class="parameter_description"><p>the minumim enum value</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>the maximum enum value</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_prefix</p></td> +<td class="parameter_description"><p>the prefix of the group of icon names to use.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_size</p></td> +<td class="parameter_description"><p>the icon size for the icons</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>a callback to connect to the "toggled" signal of each +<a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> that is created.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback_data</p></td> +<td class="parameter_description"><p>data to pass to the <em class="parameter"><code>callback</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_button</p></td> +<td class="parameter_description"><p>returns the first button in the created group.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-icon-box-new-with-range.returns"></a><h4>Returns</h4> +<p> a new <a href="https://developer.gnome.org/gtk3/GtkHBox.html#GtkHBox-struct"><span class="type">GtkHBox</span></a> holding a group of <a href="https://developer.gnome.org/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButtons</span></a>.</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-enum-icon-box-set-child-padding"></a><h3>gimp_enum_icon_box_set_child_padding ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_enum_icon_box_set_child_padding (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *icon_box</code></em>, + <em class="parameter"><code><span class="type">gint</span> xpad</code></em>, + <em class="parameter"><code><span class="type">gint</span> ypad</code></em>);</pre> +<p>Sets the padding of all buttons in a box created by +<a class="link" href="libgimpwidgets-GimpEnumWidgets.html#gimp-enum-icon-box-new" title="gimp_enum_icon_box_new ()"><code class="function">gimp_enum_icon_box_new()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-enum-icon-box-set-child-padding.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>icon_box</p></td> +<td class="parameter_description"><p>an icon box widget</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>xpad</p></td> +<td class="parameter_description"><p>horizontal padding</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ypad</p></td> +<td class="parameter_description"><p>vertical padding</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file |