diff options
Diffstat (limited to 'devel-docs/libgimpwidgets/html/GimpEnumStore.html')
| -rw-r--r-- | devel-docs/libgimpwidgets/html/GimpEnumStore.html | 403 |
1 files changed, 403 insertions, 0 deletions
diff --git a/devel-docs/libgimpwidgets/html/GimpEnumStore.html b/devel-docs/libgimpwidgets/html/GimpEnumStore.html new file mode 100644 index 0000000..034ef31 --- /dev/null +++ b/devel-docs/libgimpwidgets/html/GimpEnumStore.html @@ -0,0 +1,403 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GimpEnumStore: 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-widgets.html" title="Part I. GIMP Widgets"> +<link rel="prev" href="GimpDialog.html" title="GimpDialog"> +<link rel="next" href="GimpEnumComboBox.html" title="GimpEnumComboBox"> +<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="#GimpEnumStore.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GimpEnumStore.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#GimpEnumStore.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#GimpEnumStore.properties" class="shortcut">Properties</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-widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GimpDialog.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GimpEnumComboBox.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GimpEnumStore"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GimpEnumStore.top_of_page"></a>GimpEnumStore</span></h2> +<p>GimpEnumStore — A <a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a> subclass that keeps enum values.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GimpEnumStore.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">GtkListStore</span> * +</td> +<td class="function_name"> +<a class="link" href="GimpEnumStore.html#gimp-enum-store-new" title="gimp_enum_store_new ()">gimp_enum_store_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkListStore</span> * +</td> +<td class="function_name"> +<a class="link" href="GimpEnumStore.html#gimp-enum-store-new-with-range" title="gimp_enum_store_new_with_range ()">gimp_enum_store_new_with_range</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkListStore</span> * +</td> +<td class="function_name"> +<a class="link" href="GimpEnumStore.html#gimp-enum-store-new-with-values" title="gimp_enum_store_new_with_values ()">gimp_enum_store_new_with_values</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GtkListStore</span> * +</td> +<td class="function_name"> +<a class="link" href="GimpEnumStore.html#gimp-enum-store-new-with-values-valist" title="gimp_enum_store_new_with_values_valist ()">gimp_enum_store_new_with_values_valist</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpEnumStore.html#gimp-enum-store-set-stock-prefix" title="gimp_enum_store_set_stock_prefix ()">gimp_enum_store_set_stock_prefix</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpEnumStore.html#gimp-enum-store-set-icon-prefix" title="gimp_enum_store_set_icon_prefix ()">gimp_enum_store_set_icon_prefix</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpEnumStore.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"> +<span class="type">GType</span> *</td> +<td class="property_name"><a class="link" href="GimpEnumStore.html#GimpEnumStore--enum-type" title="The “enum-type” property">enum-type</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpEnumStore.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="GimpEnumStore.html#GimpEnumStore-struct" title="GimpEnumStore">GimpEnumStore</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpEnumStore.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> GtkListStore + <span class="lineart">╰──</span> <a class="link" href="GimpIntStore.html" title="GimpIntStore">GimpIntStore</a> + <span class="lineart">╰──</span> GimpEnumStore +</pre> +</div> +<div class="refsect1"> +<a name="GimpEnumStore.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GimpEnumStore implements + GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest, GtkTreeSortable and GtkBuildable.</p> +</div> +<div class="refsect1"> +<a name="GimpEnumStore.description"></a><h2>Description</h2> +<p>A <a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a> subclass that keeps enum values.</p> +</div> +<div class="refsect1"> +<a name="GimpEnumStore.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-enum-store-new"></a><h3>gimp_enum_store_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkListStore</span> * +gimp_enum_store_new (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>);</pre> +<p>Creates a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>, derived from <span class="type">GtkListStore</span> and fills +it with enum values. The enum needs to be registered to the type +system and should have translatable value names.</p> +<div class="refsect3"> +<a name="gimp-enum-store-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-store-new.returns"></a><h4>Returns</h4> +<p> a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-store-new-with-range"></a><h3>gimp_enum_store_new_with_range ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkListStore</span> * +gimp_enum_store_new_with_range (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code><span class="type">gint</span> minimum</code></em>, + <em class="parameter"><code><span class="type">gint</span> maximum</code></em>);</pre> +<p>Creates a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a> like <a class="link" href="GimpEnumStore.html#gimp-enum-store-new" title="gimp_enum_store_new ()"><code class="function">gimp_enum_store_new()</code></a> but allows +to limit the enum values to a certain range. Values smaller than +<em class="parameter"><code>minimum</code></em> + or larger than <em class="parameter"><code>maximum</code></em> + are not added to the store.</p> +<div class="refsect3"> +<a name="gimp-enum-store-new-with-range.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>minimum</p></td> +<td class="parameter_description"><p>the minimum value to include</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>maximum</p></td> +<td class="parameter_description"><p>the maximum value to include</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-store-new-with-range.returns"></a><h4>Returns</h4> +<p> a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-store-new-with-values"></a><h3>gimp_enum_store_new_with_values ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkListStore</span> * +gimp_enum_store_new_with_values (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code><span class="type">gint</span> n_values</code></em>, + <em class="parameter"><code>...</code></em>);</pre> +<p>Creates a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a> like <a class="link" href="GimpEnumStore.html#gimp-enum-store-new" title="gimp_enum_store_new ()"><code class="function">gimp_enum_store_new()</code></a> but allows +to explicitly list the enum values that should be added to the +store.</p> +<div class="refsect3"> +<a name="gimp-enum-store-new-with-values.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_values</p></td> +<td class="parameter_description"><p>the number of enum values to include</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>...</p></td> +<td class="parameter_description"><p>a list of enum values (exactly <em class="parameter"><code>n_values</code></em> +)</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-store-new-with-values.returns"></a><h4>Returns</h4> +<p> a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-store-new-with-values-valist"></a><h3>gimp_enum_store_new_with_values_valist ()</h3> +<pre class="programlisting"><span class="returnvalue">GtkListStore</span> * +gimp_enum_store_new_with_values_valist + (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>, + <em class="parameter"><code><span class="type">gint</span> n_values</code></em>, + <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre> +<p>See <a class="link" href="GimpEnumStore.html#gimp-enum-store-new-with-values" title="gimp_enum_store_new_with_values ()"><code class="function">gimp_enum_store_new_with_values()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-enum-store-new-with-values-valist.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>enum_type</p></td> +<td class="parameter_description"><p>the <span class="type">GType</span> of an enum.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_values</p></td> +<td class="parameter_description"><p>the number of enum values to include</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>args</p></td> +<td class="parameter_description"><p>a va_list of enum values (exactly <em class="parameter"><code>n_values</code></em> +)</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-enum-store-new-with-values-valist.returns"></a><h4>Returns</h4> +<p> a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-store-set-stock-prefix"></a><h3>gimp_enum_store_set_stock_prefix ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_enum_store_set_stock_prefix (<em class="parameter"><code><a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a> *store</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *stock_prefix</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_enum_store_set_stock_prefix</code> is deprecated and should not be used in newly-written code.</p> +<p>GIMP 2.10</p> +</div> +<p>Creates a stock ID for each enum value in the <em class="parameter"><code>store</code></em> + by appending +the value's nick to the given <em class="parameter"><code>stock_prefix</code></em> +, separated by a hyphen.</p> +<p>See also: <a class="link" href="GimpEnumComboBox.html#gimp-enum-combo-box-set-stock-prefix" title="gimp_enum_combo_box_set_stock_prefix ()"><code class="function">gimp_enum_combo_box_set_stock_prefix()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-enum-store-set-stock-prefix.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>store</p></td> +<td class="parameter_description"><p>a <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>stock_prefix</p></td> +<td class="parameter_description"><p>a prefix to create icon stock ID from enum values</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-enum-store-set-icon-prefix"></a><h3>gimp_enum_store_set_icon_prefix ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_enum_store_set_icon_prefix (<em class="parameter"><code><a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a> *store</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *icon_prefix</code></em>);</pre> +<p>Creates an icon name for each enum value in the <em class="parameter"><code>store</code></em> + by appending +the value's nick to the given <em class="parameter"><code>icon_prefix</code></em> +, separated by a hyphen.</p> +<p>See also: <a class="link" href="GimpEnumComboBox.html#gimp-enum-combo-box-set-icon-prefix" title="gimp_enum_combo_box_set_icon_prefix ()"><code class="function">gimp_enum_combo_box_set_icon_prefix()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-enum-store-set-icon-prefix.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>store</p></td> +<td class="parameter_description"><p>a <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_prefix</p></td> +<td class="parameter_description"><p>a prefix to create icon names from enum values</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +</div> +<div class="refsect1"> +<a name="GimpEnumStore.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GimpEnumStore-struct"></a><h3>GimpEnumStore</h3> +<pre class="programlisting">typedef struct _GimpEnumStore GimpEnumStore;</pre> +</div> +</div> +<div class="refsect1"> +<a name="GimpEnumStore.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GimpEnumStore--enum-type"></a><h3>The <code class="literal">“enum-type”</code> property</h3> +<pre class="programlisting"> “enum-type” <span class="type">GType</span> *</pre> +<p>Sets the <span class="type">GType</span> of the enum to be used in the store.</p> +<p>Owner: GimpEnumStore</p> +<p>Flags: Read / Write / Construct Only</p> +<p>Allowed values: int</p> +<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 |