diff options
Diffstat (limited to '')
| -rw-r--r-- | devel-docs/libgimpwidgets/html/libgimpwidgets-GimpPropWidgets.html | 1988 |
1 files changed, 1988 insertions, 0 deletions
diff --git a/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpPropWidgets.html b/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpPropWidgets.html new file mode 100644 index 0000000..024498d --- /dev/null +++ b/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpPropWidgets.html @@ -0,0 +1,1988 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GimpPropWidgets: 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-GimpEnumWidgets.html" title="GimpEnumWidgets"> +<link rel="next" href="libgimpwidgets-GimpWidgets.html" title="GimpWidgets"> +<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="#libgimpwidgets-GimpPropWidgets.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-GimpEnumWidgets.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimpwidgets-GimpWidgets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimpwidgets-GimpPropWidgets"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimpwidgets-GimpPropWidgets.top_of_page"></a>GimpPropWidgets</span></h2> +<p>GimpPropWidgets — Editable views on <span class="type">GObject</span> properties.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpPropWidgets.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">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-boolean-combo-box-new" title="gimp_prop_boolean_combo_box_new ()">gimp_prop_boolean_combo_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-boolean-radio-frame-new" title="gimp_prop_boolean_radio_frame_new ()">gimp_prop_boolean_radio_frame_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-check-button-new" title="gimp_prop_check_button_new ()">gimp_prop_check_button_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-color-area-new" title="gimp_prop_color_area_new ()">gimp_prop_color_area_new</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="libgimpwidgets-GimpPropWidgets.html#gimp-prop-coordinates-connect" title="gimp_prop_coordinates_connect ()">gimp_prop_coordinates_connect</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-coordinates-new" title="gimp_prop_coordinates_new ()">gimp_prop_coordinates_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-entry-new" title="gimp_prop_entry_new ()">gimp_prop_entry_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-pointer-combo-box-new" title="gimp_prop_pointer_combo_box_new ()">gimp_prop_pointer_combo_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-enum-check-button-new" title="gimp_prop_enum_check_button_new ()">gimp_prop_enum_check_button_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-enum-combo-box-new" title="gimp_prop_enum_combo_box_new ()">gimp_prop_enum_combo_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-enum-label-new" title="gimp_prop_enum_label_new ()">gimp_prop_enum_label_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-enum-radio-box-new" title="gimp_prop_enum_radio_box_new ()">gimp_prop_enum_radio_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-enum-radio-frame-new" title="gimp_prop_enum_radio_frame_new ()">gimp_prop_enum_radio_frame_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-enum-stock-box-new" title="gimp_prop_enum_stock_box_new ()">gimp_prop_enum_stock_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-enum-icon-box-new" title="gimp_prop_enum_icon_box_new ()">gimp_prop_enum_icon_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-expander-new" title="gimp_prop_expander_new ()">gimp_prop_expander_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-file-chooser-button-new" title="gimp_prop_file_chooser_button_new ()">gimp_prop_file_chooser_button_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-file-chooser-button-new-with-dialog" title="gimp_prop_file_chooser_button_new_with_dialog ()">gimp_prop_file_chooser_button_new_with_dialog</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-hscale-new" title="gimp_prop_hscale_new ()">gimp_prop_hscale_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-icon-image-new" title="gimp_prop_icon_image_new ()">gimp_prop_icon_image_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-int-combo-box-new" title="gimp_prop_int_combo_box_new ()">gimp_prop_int_combo_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-label-new" title="gimp_prop_label_new ()">gimp_prop_label_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-memsize-entry-new" title="gimp_prop_memsize_entry_new ()">gimp_prop_memsize_entry_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkObject</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-opacity-entry-new" title="gimp_prop_opacity_entry_new ()">gimp_prop_opacity_entry_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-path-editor-new" title="gimp_prop_path_editor_new ()">gimp_prop_path_editor_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkObject</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-scale-entry-new" title="gimp_prop_scale_entry_new ()">gimp_prop_scale_entry_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-size-entry-new" title="gimp_prop_size_entry_new ()">gimp_prop_size_entry_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-spin-button-new" title="gimp_prop_spin_button_new ()">gimp_prop_spin_button_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-stock-image-new" title="gimp_prop_stock_image_new ()">gimp_prop_stock_image_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-string-combo-box-new" title="gimp_prop_string_combo_box_new ()">gimp_prop_string_combo_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkTextBuffer</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-text-buffer-new" title="gimp_prop_text_buffer_new ()">gimp_prop_text_buffer_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-unit-combo-box-new" title="gimp_prop_unit_combo_box_new ()">gimp_prop_unit_combo_box_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkWidget</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-unit-menu-new" title="gimp_prop_unit_menu_new ()">gimp_prop_unit_menu_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpPropWidgets.description"></a><h2>Description</h2> +<p>Editable views on <span class="type">GObject</span> properties.</p> +</div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpPropWidgets.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-prop-boolean-combo-box-new"></a><h3>gimp_prop_boolean_combo_box_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_boolean_combo_box_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *true_text</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *false_text</code></em>);</pre> +<p>Creates a <span class="type">GtkComboBox</span> widget to display and set the specified +boolean property. The combo box will have two entries, one +displaying the <em class="parameter"><code>true_text</code></em> + label, the other displaying the +<em class="parameter"><code>false_text</code></em> + label.</p> +<div class="refsect3"> +<a name="gimp-prop-boolean-combo-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of boolean property controlled by combo box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>true_text</p></td> +<td class="parameter_description"><p>Label used for entry corresponding to <code class="literal">TRUE</code> value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>false_text</p></td> +<td class="parameter_description"><p>Label used for entry corresponding to <code class="literal">FALSE</code> value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-boolean-combo-box-new.returns"></a><h4>Returns</h4> +<p> The newly created <span class="type">GtkComboBox</span> widget.</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-prop-boolean-radio-frame-new"></a><h3>gimp_prop_boolean_radio_frame_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_boolean_radio_frame_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *true_text</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *false_text</code></em>);</pre> +<p>Creates a pair of radio buttons which function to set and display +the specified boolean property. +If <em class="parameter"><code>title</code></em> + is <span class="type">NULL</span>, the <em class="parameter"><code>property_name</code></em> +'s nick will be used as label +of the returned frame.</p> +<div class="refsect3"> +<a name="gimp-prop-boolean-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of boolean property controlled by the radio buttons.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>title</p></td> +<td class="parameter_description"><p>Label for the frame.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>true_text</p></td> +<td class="parameter_description"><p>Label for the button corresponding to <code class="literal">TRUE</code>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>false_text</p></td> +<td class="parameter_description"><p>Label for the button corresponding to <code class="literal">FALSE</code>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-boolean-radio-frame-new.returns"></a><h4>Returns</h4> +<p> A <a class="link" href="GimpFrame.html" title="GimpFrame"><span class="type">GimpFrame</span></a> containing the radio buttons.</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-prop-check-button-new"></a><h3>gimp_prop_check_button_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_check_button_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);</pre> +<p>Creates a <span class="type">GtkCheckButton</span> that displays and sets the specified +boolean property. +If <em class="parameter"><code>label</code></em> + is <span class="type">NULL</span>, the <em class="parameter"><code>property_name</code></em> +'s nick will be used as label +of the returned button.</p> +<div class="refsect3"> +<a name="gimp-prop-check-button-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of boolean property controlled by checkbutton.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>label</p></td> +<td class="parameter_description"><p>Label to give checkbutton (including mnemonic).</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-check-button-new.returns"></a><h4>Returns</h4> +<p> The newly created <span class="type">GtkCheckButton</span> widget.</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-prop-color-area-new"></a><h3>gimp_prop_color_area_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_color_area_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">gint</span> width</code></em>, + <em class="parameter"><code><span class="type">gint</span> height</code></em>, + <em class="parameter"><code><a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType"><span class="type">GimpColorAreaType</span></a> type</code></em>);</pre> +<p>Creates a <a class="link" href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a> to set and display the value of an RGB +property.</p> +<div class="refsect3"> +<a name="gimp-prop-color-area-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of RGB property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>Width of color area.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>Height of color area.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>How transparency is represented.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-color-area-new.returns"></a><h4>Returns</h4> +<p> A new <a class="link" href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a> widget.</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-prop-coordinates-connect"></a><h3>gimp_prop_coordinates_connect ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_prop_coordinates_connect (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *x_property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *y_property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *unit_property_name</code></em>, + <em class="parameter"><code><span class="type">GtkWidget</span> *sizeentry</code></em>, + <em class="parameter"><code><span class="type">GtkWidget</span> *chainbutton</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> xresolution</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> yresolution</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-prop-coordinates-new"></a><h3>gimp_prop_coordinates_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_coordinates_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *x_property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *y_property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *unit_property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *unit_format</code></em>, + <em class="parameter"><code><a class="link" href="GimpSizeEntry.html#GimpSizeEntryUpdatePolicy" title="enum GimpSizeEntryUpdatePolicy"><span class="type">GimpSizeEntryUpdatePolicy</span></a> update_policy</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> xresolution</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> yresolution</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> has_chainbutton</code></em>);</pre> +<p>Creates a <a class="link" href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a> to set and display two double or int +properties, which will usually represent X and Y coordinates, and +their associated unit property.</p> +<div class="refsect3"> +<a name="gimp-prop-coordinates-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x_property_name</p></td> +<td class="parameter_description"><p>Name of int or double property for X coordinate.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y_property_name</p></td> +<td class="parameter_description"><p>Name of int or double property for Y coordinate.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>unit_property_name</p></td> +<td class="parameter_description"><p>Name of unit property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>unit_format</p></td> +<td class="parameter_description"><p>A printf-like unit-format string as is used with +<a class="link" href="GimpUnitMenu.html#gimp-unit-menu-new" title="gimp_unit_menu_new ()"><code class="function">gimp_unit_menu_new()</code></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>update_policy</p></td> +<td class="parameter_description"><p>How the automatic pixel <-> real-world-unit +calculations should be done.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>xresolution</p></td> +<td class="parameter_description"><p>The resolution (in dpi) for the X coordinate.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>yresolution</p></td> +<td class="parameter_description"><p>The resolution (in dpi) for the Y coordinate.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>has_chainbutton</p></td> +<td class="parameter_description"><p>Whether to add a chainbutton to the size entry.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-coordinates-new.returns"></a><h4>Returns</h4> +<p> A new <a class="link" href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a> widget.</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-prop-entry-new"></a><h3>gimp_prop_entry_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_entry_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">gint</span> max_len</code></em>);</pre> +<p>Creates a <span class="type">GtkEntry</span> to set and display the value of the specified +string property.</p> +<div class="refsect3"> +<a name="gimp-prop-entry-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of string property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>max_len</p></td> +<td class="parameter_description"><p>Maximum allowed length of string.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-entry-new.returns"></a><h4>Returns</h4> +<p> A new <span class="type">GtkEntry</span> widget.</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-prop-pointer-combo-box-new"></a><h3>gimp_prop_pointer_combo_box_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_pointer_combo_box_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a> *store</code></em>);</pre> +<p>Creates a <a class="link" href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a> widget to display and set the specified +property. The contents of the widget are determined by <em class="parameter"><code>store</code></em> +, +which should be created using <a class="link" href="GimpIntStore.html#gimp-int-store-new" title="gimp_int_store_new ()"><code class="function">gimp_int_store_new()</code></a>. +Values are GType/gpointer data, and therefore must be stored in the +"user-data" column, instead of the usual "value" column.</p> +<div class="refsect3"> +<a name="gimp-prop-pointer-combo-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of GType/gpointer property controlled by combo box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>store</p></td> +<td class="parameter_description"><p><a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a> holding list of labels, values, etc.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-pointer-combo-box-new.returns"></a><h4>Returns</h4> +<p> The newly created <a class="link" href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a> widget.</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-prop-enum-check-button-new"></a><h3>gimp_prop_enum_check_button_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_enum_check_button_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>, + <em class="parameter"><code><span class="type">gint</span> false_value</code></em>, + <em class="parameter"><code><span class="type">gint</span> true_value</code></em>);</pre> +<p>Creates a <span class="type">GtkCheckButton</span> that displays and sets the specified +property of type Enum. Note that this widget only allows two values +for the enum, one corresponding to the "checked" state and the +other to the "unchecked" state. +If <em class="parameter"><code>label</code></em> + is <span class="type">NULL</span>, the <em class="parameter"><code>property_name</code></em> +'s nick will be used as label +of the returned button.</p> +<div class="refsect3"> +<a name="gimp-prop-enum-check-button-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of enum property controlled by checkbutton.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>label</p></td> +<td class="parameter_description"><p>Label to give checkbutton (including mnemonic).</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>false_value</p></td> +<td class="parameter_description"><p>Enum value corresponding to unchecked state.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>true_value</p></td> +<td class="parameter_description"><p>Enum value corresponding to checked state.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-enum-check-button-new.returns"></a><h4>Returns</h4> +<p> The newly created <span class="type">GtkCheckButton</span> widget.</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-prop-enum-combo-box-new"></a><h3>gimp_prop_enum_combo_box_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_enum_combo_box_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</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>);</pre> +<p>Creates a <a class="link" href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a> widget to display and set the specified +enum property. The <em class="parameter"><code>mimimum_value</code></em> + and <em class="parameter"><code>maximum_value</code></em> + give the +possibility of restricting the allowed range to a subset of the +enum. If the two values are equal (e.g., 0, 0), then the full +range of the Enum is used.</p> +<div class="refsect3"> +<a name="gimp-prop-enum-combo-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of enum property controlled by combo box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>minimum</p></td> +<td class="parameter_description"><p>Smallest allowed value of enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>Largest allowed value of enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-enum-combo-box-new.returns"></a><h4>Returns</h4> +<p> The newly created <a class="link" href="GimpEnumComboBox.html" title="GimpEnumComboBox"><span class="type">GimpEnumComboBox</span></a> widget.</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-prop-enum-label-new"></a><h3>gimp_prop_enum_label_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_enum_label_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre> +<div class="refsect3"> +<a name="gimp-prop-enum-label-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of enum property to be displayed.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-enum-label-new.returns"></a><h4>Returns</h4> +<p> The newly created <a class="link" href="GimpEnumLabel.html" title="GimpEnumLabel"><span class="type">GimpEnumLabel</span></a> widget.</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-prop-enum-radio-box-new"></a><h3>gimp_prop_enum_radio_box_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_enum_radio_box_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</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>);</pre> +<p>Creates a group of radio buttons which function to set and display +the specified enum property. The <em class="parameter"><code>minimum</code></em> + and <em class="parameter"><code>maximum</code></em> + arguments +allow only a subset of the enum to be used. If the two arguments +are equal (e.g., 0, 0), then the full range of the enum will be used. +If you want to assign a label to the group of radio buttons, use +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-enum-radio-frame-new" title="gimp_prop_enum_radio_frame_new ()"><code class="function">gimp_prop_enum_radio_frame_new()</code></a> instead of this function.</p> +<div class="refsect3"> +<a name="gimp-prop-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of enum property controlled by the radio buttons.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>minimum</p></td> +<td class="parameter_description"><p>Smallest value of enum to be included.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>Largest value of enum to be included.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-enum-radio-box-new.returns"></a><h4>Returns</h4> +<p> A <span class="type">GtkVBox</span> containing the radio buttons.</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-prop-enum-radio-frame-new"></a><h3>gimp_prop_enum_radio_frame_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_enum_radio_frame_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *title</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>);</pre> +<p>Creates a group of radio buttons which function to set and display +the specified enum property. The <em class="parameter"><code>minimum</code></em> + and <em class="parameter"><code>maximum</code></em> + arguments +allow only a subset of the enum to be used. If the two arguments +are equal (e.g., 0, 0), then the full range of the enum will be used. +If <em class="parameter"><code>title</code></em> + is <span class="type">NULL</span>, the <em class="parameter"><code>property_name</code></em> +'s nick will be used as label +of the returned frame.</p> +<div class="refsect3"> +<a name="gimp-prop-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of enum property controlled by the radio buttons.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>title</p></td> +<td class="parameter_description"><p>Label for the frame holding the buttons</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>minimum</p></td> +<td class="parameter_description"><p>Smallest value of enum to be included.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>Largest value of enum to be included.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-enum-radio-frame-new.returns"></a><h4>Returns</h4> +<p> A <a class="link" href="GimpFrame.html" title="GimpFrame"><span class="type">GimpFrame</span></a> containing the radio buttons.</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-prop-enum-stock-box-new"></a><h3>gimp_prop_enum_stock_box_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_enum_stock_box_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *stock_prefix</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>);</pre> +<div class="warning"><p><code class="literal">gimp_prop_enum_stock_box_new</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p></div> +<p>Creates a horizontal box of radio buttons with stock icons, which +function to set and display the value of the specified Enum +property. 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> +. See +<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> for more information.</p> +<div class="refsect3"> +<a name="gimp-prop-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of enum property controlled by the radio buttons.</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>minimum</p></td> +<td class="parameter_description"><p>Smallest value of enum to be included.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>Largest value of enum to be included.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-enum-stock-box-new.returns"></a><h4>Returns</h4> +<p> A <span class="type">libgimpwidgets-gimpenumstockbox</span> containing the radio buttons.</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-prop-enum-icon-box-new"></a><h3>gimp_prop_enum_icon_box_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_enum_icon_box_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *icon_prefix</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>);</pre> +<p>Creates a horizontal box of radio buttons with named icons, which +function to set and display the value of the specified Enum +property. 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> +. See +<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> for more information.</p> +<div class="refsect3"> +<a name="gimp-prop-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of enum property controlled by the radio buttons.</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>minimum</p></td> +<td class="parameter_description"><p>Smallest value of enum to be included.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>Largest value of enum to be included.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-enum-icon-box-new.returns"></a><h4>Returns</h4> +<p> A <span class="type">libgimpwidgets-gimpenumiconbox</span> containing the radio buttons.</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-prop-expander-new"></a><h3>gimp_prop_expander_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_expander_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);</pre> +<p>Creates a <span class="type">GtkExpander</span> controlled by the specified boolean property. +A value of <code class="literal">TRUE</code> for the property corresponds to the expanded state +for the widget. +If <em class="parameter"><code>label</code></em> + is <span class="type">NULL</span>, the <em class="parameter"><code>property_name</code></em> +'s nick will be used as label +of the returned widget.</p> +<div class="refsect3"> +<a name="gimp-prop-expander-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of boolean property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>label</p></td> +<td class="parameter_description"><p>Label for expander.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-expander-new.returns"></a><h4>Returns</h4> +<p> A new <span class="type">GtkExpander</span> widget.</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-prop-file-chooser-button-new"></a><h3>gimp_prop_file_chooser_button_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_file_chooser_button_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>, + <em class="parameter"><code><span class="type">GtkFileChooserAction</span> action</code></em>);</pre> +<p>Creates a <span class="type">GtkFileChooserButton</span> to edit the specified path property.</p> +<p>Note that <span class="type">GtkFileChooserButton</span> implements the <span class="type">GtkFileChooser</span> +interface; you can use the <span class="type">GtkFileChooser</span> API with it.</p> +<div class="refsect3"> +<a name="gimp-prop-file-chooser-button-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>config</p></td> +<td class="parameter_description"><p>object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>name of path property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>title</p></td> +<td class="parameter_description"><p>the title of the browse dialog.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>action</p></td> +<td class="parameter_description"><p>the open mode for the widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-file-chooser-button-new.returns"></a><h4>Returns</h4> +<p> A new <span class="type">GtkFileChooserButton</span>.</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-prop-file-chooser-button-new-with-dialog"></a><h3>gimp_prop_file_chooser_button_new_with_dialog ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_file_chooser_button_new_with_dialog + (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">GtkWidget</span> *dialog</code></em>);</pre> +<p>Creates a <span class="type">GtkFileChooserButton</span> to edit the specified path property.</p> +<p>The button uses <em class="parameter"><code>dialog</code></em> + as it's file-picking window. Note that <em class="parameter"><code>dialog</code></em> + +must be a <span class="type">GtkFileChooserDialog</span> (or subclass) and must not have +<code class="literal">GTK_DIALOG_DESTROY_WITH_PARENT</code> set.</p> +<p>Note that <span class="type">GtkFileChooserButton</span> implements the <span class="type">GtkFileChooser</span> +interface; you can use the <span class="type">GtkFileChooser</span> API with it.</p> +<div class="refsect3"> +<a name="gimp-prop-file-chooser-button-new-with-dialog.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>config</p></td> +<td class="parameter_description"><p>object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>name of path property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>dialog</p></td> +<td class="parameter_description"><p>the <span class="type">GtkFileChooserDialog</span> widget to use.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-file-chooser-button-new-with-dialog.returns"></a><h4>Returns</h4> +<p> A new <span class="type">GtkFileChooserButton</span>.</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-prop-hscale-new"></a><h3>gimp_prop_hscale_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_hscale_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> step_increment</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> page_increment</code></em>, + <em class="parameter"><code><span class="type">gint</span> digits</code></em>);</pre> +<p>Creates a horizontal scale to control the value of the specified +integer or double property.</p> +<div class="refsect3"> +<a name="gimp-prop-hscale-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of integer or double property controlled by the scale.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>step_increment</p></td> +<td class="parameter_description"><p>Step size.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>page_increment</p></td> +<td class="parameter_description"><p>Page size.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>digits</p></td> +<td class="parameter_description"><p>Number of digits after decimal point to display.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-hscale-new.returns"></a><h4>Returns</h4> +<p> A new <span class="type">GtkScale</span>.</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-prop-icon-image-new"></a><h3>gimp_prop_icon_image_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_icon_image_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">GtkIconSize</span> icon_size</code></em>);</pre> +<p>Creates a widget to display a icon image representing the value of the +specified string property, which should encode an icon name. +See <code class="function">gtk_image_new_from_icon_name()</code> for more information.</p> +<div class="refsect3"> +<a name="gimp-prop-icon-image-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of string property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_size</p></td> +<td class="parameter_description"><p>Size of desired icon image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-icon-image-new.returns"></a><h4>Returns</h4> +<p> A new <span class="type">GtkImage</span> widget.</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-prop-int-combo-box-new"></a><h3>gimp_prop_int_combo_box_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_int_combo_box_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a> *store</code></em>);</pre> +<p>Creates a <a class="link" href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a> widget to display and set the specified +property. The contents of the widget are determined by <em class="parameter"><code>store</code></em> +, +which should be created using <a class="link" href="GimpIntStore.html#gimp-int-store-new" title="gimp_int_store_new ()"><code class="function">gimp_int_store_new()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-prop-int-combo-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of int property controlled by combo box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>store</p></td> +<td class="parameter_description"><p><a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a> holding list of labels, values, etc.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-int-combo-box-new.returns"></a><h4>Returns</h4> +<p> The newly created <a class="link" href="GimpIntComboBox.html" title="GimpIntComboBox"><span class="type">GimpIntComboBox</span></a> widget.</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-prop-label-new"></a><h3>gimp_prop_label_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_label_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre> +<p>Creates a <span class="type">GtkLabel</span> to display the value of the specified property. +The property should be a string property or at least transformable +to a string. If the user should be able to edit the string, use +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-entry-new" title="gimp_prop_entry_new ()"><code class="function">gimp_prop_entry_new()</code></a> instead.</p> +<div class="refsect3"> +<a name="gimp-prop-label-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of string property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-label-new.returns"></a><h4>Returns</h4> +<p> A new <span class="type">GtkLabel</span> widget.</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-prop-memsize-entry-new"></a><h3>gimp_prop_memsize_entry_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_memsize_entry_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre> +<p>Creates a <a class="link" href="GimpMemsizeEntry.html" title="GimpMemSizeEntry"><span class="type">GimpMemsizeEntry</span></a> (spin button and option menu) to set +and display the value of the specified memsize property. See +<a class="link" href="GimpMemsizeEntry.html#gimp-memsize-entry-new" title="gimp_memsize_entry_new ()"><code class="function">gimp_memsize_entry_new()</code></a> for more information.</p> +<div class="refsect3"> +<a name="gimp-prop-memsize-entry-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of memsize property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-memsize-entry-new.returns"></a><h4>Returns</h4> +<p> A new <a class="link" href="GimpMemsizeEntry.html" title="GimpMemSizeEntry"><span class="type">GimpMemsizeEntry</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-prop-opacity-entry-new"></a><h3>gimp_prop_opacity_entry_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkObject</span> * +gimp_prop_opacity_entry_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">GtkTable</span> *table</code></em>, + <em class="parameter"><code><span class="type">gint</span> column</code></em>, + <em class="parameter"><code><span class="type">gint</span> row</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);</pre> +<p>Creates a <span class="type">libgimpwidgets-gimpscaleentry</span> (slider and spin button) +to set and display the value of the specified double property, +which should represent an "opacity" variable with range 0 to 100. +See <a class="link" href="libgimpwidgets-GimpWidgets.html#gimp-scale-entry-new" title="gimp_scale_entry_new ()"><code class="function">gimp_scale_entry_new()</code></a> for more information.</p> +<div class="refsect3"> +<a name="gimp-prop-opacity-entry-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of double property controlled by the spin button.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>table</p></td> +<td class="parameter_description"><p>The <span class="type">GtkTable</span> the widgets will be attached to.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>column</p></td> +<td class="parameter_description"><p>The column to start with.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>row</p></td> +<td class="parameter_description"><p>The row to attach the widgets.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>label</p></td> +<td class="parameter_description"><p>The text for the <span class="type">GtkLabel</span> which will appear left of the +<span class="type">GtkHScale</span>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-opacity-entry-new.returns"></a><h4>Returns</h4> +<p> The <span class="type">GtkSpinButton</span>'s <span class="type">GtkAdjustment</span>.</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-prop-path-editor-new"></a><h3>gimp_prop_path_editor_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_path_editor_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *path_property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *writable_property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *filesel_title</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-prop-scale-entry-new"></a><h3>gimp_prop_scale_entry_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkObject</span> * +gimp_prop_scale_entry_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">GtkTable</span> *table</code></em>, + <em class="parameter"><code><span class="type">gint</span> column</code></em>, + <em class="parameter"><code><span class="type">gint</span> row</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> step_increment</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> page_increment</code></em>, + <em class="parameter"><code><span class="type">gint</span> digits</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> limit_scale</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> lower_limit</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> upper_limit</code></em>);</pre> +<p>Creates a <span class="type">libgimpwidgets-gimpscaleentry</span> (slider and spin button) +to set and display the value of the specified double property. See +<a class="link" href="libgimpwidgets-GimpWidgets.html#gimp-scale-entry-new" title="gimp_scale_entry_new ()"><code class="function">gimp_scale_entry_new()</code></a> for more information. +If <em class="parameter"><code>label</code></em> + is <span class="type">NULL</span>, the <em class="parameter"><code>property_name</code></em> +'s nick will be used as label +of the returned object.</p> +<p>Note that the <em class="parameter"><code>scale_limits</code></em> + boolean is the inverse of +<a class="link" href="libgimpwidgets-GimpWidgets.html#gimp-scale-entry-new" title="gimp_scale_entry_new ()"><code class="function">gimp_scale_entry_new()</code></a>'s "constrain" parameter.</p> +<div class="refsect3"> +<a name="gimp-prop-scale-entry-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of double property controlled by the spin button.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>table</p></td> +<td class="parameter_description"><p>The <span class="type">GtkTable</span> the widgets will be attached to.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>column</p></td> +<td class="parameter_description"><p>The column to start with.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>row</p></td> +<td class="parameter_description"><p>The row to attach the widgets.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>label</p></td> +<td class="parameter_description"><p>The text for the <span class="type">GtkLabel</span> which will appear left of +the <span class="type">GtkHScale</span>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>step_increment</p></td> +<td class="parameter_description"><p>Step size.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>page_increment</p></td> +<td class="parameter_description"><p>Page size.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>digits</p></td> +<td class="parameter_description"><p>Number of digits after decimal point to display.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>limit_scale</p></td> +<td class="parameter_description"><p><code class="literal">FALSE</code> if the range of possible values of the +GtkHScale should be the same as of the GtkSpinButton.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>lower_limit</p></td> +<td class="parameter_description"><p>The scale's lower boundary if <em class="parameter"><code>scale_limits</code></em> +is <code class="literal">TRUE</code>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>upper_limit</p></td> +<td class="parameter_description"><p>The scale's upper boundary if <em class="parameter"><code>scale_limits</code></em> +is <code class="literal">TRUE</code>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-scale-entry-new.returns"></a><h4>Returns</h4> +<p> The <span class="type">GtkSpinButton</span>'s <span class="type">GtkAdjustment</span>.</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-prop-size-entry-new"></a><h3>gimp_prop_size_entry_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_size_entry_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> property_is_pixel</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *unit_property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *unit_format</code></em>, + <em class="parameter"><code><a class="link" href="GimpSizeEntry.html#GimpSizeEntryUpdatePolicy" title="enum GimpSizeEntryUpdatePolicy"><span class="type">GimpSizeEntryUpdatePolicy</span></a> update_policy</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> resolution</code></em>);</pre> +<p>Creates a <a class="link" href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a> to set and display the specified double or +int property, and its associated unit property. Note that this +function is only suitable for creating a size entry holding a +single value. Use <a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-coordinates-new" title="gimp_prop_coordinates_new ()"><code class="function">gimp_prop_coordinates_new()</code></a> to create a size +entry holding two values.</p> +<div class="refsect3"> +<a name="gimp-prop-size-entry-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of int or double property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_is_pixel</p></td> +<td class="parameter_description"><p>When <code class="literal">TRUE</code>, the property value is in pixels, +and in the selected unit otherwise.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>unit_property_name</p></td> +<td class="parameter_description"><p>Name of unit property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>unit_format</p></td> +<td class="parameter_description"><p>A printf-like unit-format string as is used with +<a class="link" href="GimpUnitMenu.html#gimp-unit-menu-new" title="gimp_unit_menu_new ()"><code class="function">gimp_unit_menu_new()</code></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>update_policy</p></td> +<td class="parameter_description"><p>How the automatic pixel <-> real-world-unit +calculations should be done.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>resolution</p></td> +<td class="parameter_description"><p>The resolution (in dpi) for the field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-size-entry-new.returns"></a><h4>Returns</h4> +<p> A new <a class="link" href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a> widget.</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-prop-spin-button-new"></a><h3>gimp_prop_spin_button_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_spin_button_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> step_increment</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> page_increment</code></em>, + <em class="parameter"><code><span class="type">gint</span> digits</code></em>);</pre> +<p>Creates a spin button to set and display the value of the +specified double property.</p> +<div class="refsect3"> +<a name="gimp-prop-spin-button-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of double property controlled by the spin button.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>step_increment</p></td> +<td class="parameter_description"><p>Step size.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>page_increment</p></td> +<td class="parameter_description"><p>Page size.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>digits</p></td> +<td class="parameter_description"><p>Number of digits after decimal point to display.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-spin-button-new.returns"></a><h4>Returns</h4> +<p> A new <span class="type">libgimpwidgets-gimpspinbutton</span>.</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-prop-stock-image-new"></a><h3>gimp_prop_stock_image_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_stock_image_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">GtkIconSize</span> icon_size</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_prop_stock_image_new</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p></div> +<p>Creates a widget to display a stock image representing the value of the +specified string property, which should encode a Stock ID. +See <code class="function">gtk_image_new_from_stock()</code> for more information.</p> +<div class="refsect3"> +<a name="gimp-prop-stock-image-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of string property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_size</p></td> +<td class="parameter_description"><p>Size of desired stock image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-stock-image-new.returns"></a><h4>Returns</h4> +<p> A new <span class="type">GtkImage</span> widget.</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-prop-string-combo-box-new"></a><h3>gimp_prop_string_combo_box_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_string_combo_box_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">GtkTreeModel</span> *model</code></em>, + <em class="parameter"><code><span class="type">gint</span> id_column</code></em>, + <em class="parameter"><code><span class="type">gint</span> label_column</code></em>);</pre> +<p>Creates a <a class="link" href="GimpStringComboBox.html" title="GimpStringComboBox"><span class="type">GimpStringComboBox</span></a> widget to display and set the +specified property. The contents of the widget are determined by +<em class="parameter"><code>store</code></em> +.</p> +<div class="refsect3"> +<a name="gimp-prop-string-combo-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of int property controlled by combo box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>model</p></td> +<td class="parameter_description"><p><span class="type">GtkTreeStore</span> holding list of values</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>id_column</p></td> +<td class="parameter_description"><p>column in <em class="parameter"><code>store</code></em> +that holds string IDs</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>label_column</p></td> +<td class="parameter_description"><p>column in <em class="parameter"><code>store</code></em> +that holds labels to use in the combo-box</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-string-combo-box-new.returns"></a><h4>Returns</h4> +<p> The newly created <a class="link" href="GimpStringComboBox.html" title="GimpStringComboBox"><span class="type">GimpStringComboBox</span></a> widget.</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-prop-text-buffer-new"></a><h3>gimp_prop_text_buffer_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkTextBuffer</span> * +gimp_prop_text_buffer_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code><span class="type">gint</span> max_len</code></em>);</pre> +<p>Creates a <span class="type">GtkTextBuffer</span> to set and display the value of the +specified string property. Unless the string is expected to +contain multiple lines or a large amount of text, use +<a class="link" href="libgimpwidgets-GimpPropWidgets.html#gimp-prop-entry-new" title="gimp_prop_entry_new ()"><code class="function">gimp_prop_entry_new()</code></a> instead. See <span class="type">GtkTextView</span> for information on +how to insert a text buffer into a visible widget.</p> +<p>If <em class="parameter"><code>max_len</code></em> + is 0 or negative, the text buffer allows an unlimited +number of characters to be entered.</p> +<div class="refsect3"> +<a name="gimp-prop-text-buffer-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of string property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>max_len</p></td> +<td class="parameter_description"><p>Maximum allowed length of text (in characters).</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-text-buffer-new.returns"></a><h4>Returns</h4> +<p> A new <span class="type">GtkTextBuffer</span>.</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-prop-unit-combo-box-new"></a><h3>gimp_prop_unit_combo_box_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_unit_combo_box_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre> +<p>Creates a <a class="link" href="GimpUnitComboBox.html" title="GimpUnitComboBox"><span class="type">GimpUnitComboBox</span></a> to set and display the value of a Unit +property. See <a class="link" href="GimpUnitComboBox.html#gimp-unit-combo-box-new" title="gimp_unit_combo_box_new ()"><code class="function">gimp_unit_combo_box_new()</code></a> for more information.</p> +<div class="refsect3"> +<a name="gimp-prop-unit-combo-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of Unit property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-unit-combo-box-new.returns"></a><h4>Returns</h4> +<p> A new <a class="link" href="GimpUnitComboBox.html" title="GimpUnitComboBox"><span class="type">GimpUnitComboBox</span></a> widget.</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-prop-unit-menu-new"></a><h3>gimp_prop_unit_menu_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * +gimp_prop_unit_menu_new (<em class="parameter"><code><span class="type">GObject</span> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *unit_format</code></em>);</pre> +<div class="warning"><p><code class="literal">gimp_prop_unit_menu_new</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p></div> +<p>Creates a <a class="link" href="GimpUnitMenu.html" title="GimpUnitMenu"><span class="type">GimpUnitMenu</span></a> to set and display the value of a Unit +property. See <a class="link" href="GimpUnitMenu.html#gimp-unit-menu-new" title="gimp_unit_menu_new ()"><code class="function">gimp_unit_menu_new()</code></a> for more information.</p> +<div class="refsect3"> +<a name="gimp-prop-unit-menu-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>config</p></td> +<td class="parameter_description"><p>Object to which property is attached.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>property_name</p></td> +<td class="parameter_description"><p>Name of Unit property.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>unit_format</p></td> +<td class="parameter_description"><p>A printf-like format string which is used to create +the unit strings.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-prop-unit-menu-new.returns"></a><h4>Returns</h4> +<p> A new <a class="link" href="GimpUnitMenu.html" title="GimpUnitMenu"><span class="type">GimpUnitMenu</span></a> widget.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</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 |