1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
|
<!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="prev" href="GimpDialog.html" title="GimpDialog">
<link rel="next" href="GimpEnumComboBox.html" title="GimpEnumComboBox">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
<link rel="index" href="libgimpwidgets-index.html" title="Index">
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GimpDialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpwidgets-widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
<td><a accesskey="n" href="GimpEnumComboBox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpEnumStore.synopsis" class="shortcut">Top</a>
|
<a href="#GimpEnumStore.description" class="shortcut">Description</a>
|
<a href="#GimpEnumStore.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GimpEnumStore.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GimpEnumStore.properties" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<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</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GimpEnumStore.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GimpEnumStore.html#GimpEnumStore-struct" title="GimpEnumStore">GimpEnumStore</a>;
GtkListStore* <a class="link" href="GimpEnumStore.html#gimp-enum-store-new" title="gimp_enum_store_new ()">gimp_enum_store_new</a> (GType enum_type);
GtkListStore* <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> (GType enum_type,
gint minimum,
gint maximum);
GtkListStore* <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> (GType enum_type,
gint n_values,
...);
GtkListStore* <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>
(GType enum_type,
gint n_values,
va_list args);
void <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> (<a class="link" href="GimpEnumStore.html" title="GimpEnumStore">GimpEnumStore</a> *store,
const gchar *stock_prefix);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumStore.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GtkListStore
+----<a class="link" href="GimpIntStore.html" title="GimpIntStore">GimpIntStore</a>
+----GimpEnumStore
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumStore.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpEnumStore implements
GtkBuildable, GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest and GtkTreeSortable.</p>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumStore.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GimpEnumStore.html#GimpEnumStore--enum-type" title='The "enum-type" property'>enum-type</a>" GType* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumStore.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumStore.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GimpEnumStore-struct"></a><h3>GimpEnumStore</h3>
<pre class="programlisting">typedef struct _GimpEnumStore GimpEnumStore;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-enum-store-new"></a><h3>gimp_enum_store_new ()</h3>
<pre class="programlisting">GtkListStore* gimp_enum_store_new (GType enum_type);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-enum-store-new-with-range"></a><h3>gimp_enum_store_new_with_range ()</h3>
<pre class="programlisting">GtkListStore* gimp_enum_store_new_with_range (GType enum_type,
gint minimum,
gint maximum);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minimum</code></em> :</span></p></td>
<td> the minimum value to include
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>maximum</code></em> :</span></p></td>
<td> the maximum value to include
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-enum-store-new-with-values"></a><h3>gimp_enum_store_new_with_values ()</h3>
<pre class="programlisting">GtkListStore* gimp_enum_store_new_with_values (GType enum_type,
gint n_values,
...);</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 expliticely list the enum values that should be added to the
store.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_values</code></em> :</span></p></td>
<td> the number of enum values to include
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td> a list of enum values (exactly <em class="parameter"><code>n_values</code></em>)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-enum-store-new-with-values-valist"></a><h3>gimp_enum_store_new_with_values_valist ()</h3>
<pre class="programlisting">GtkListStore* gimp_enum_store_new_with_values_valist
(GType enum_type,
gint n_values,
va_list args);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
<td> the <span class="type">GType</span> of an enum.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_values</code></em> :</span></p></td>
<td> the number of enum values to include
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
<td> a va_list of enum values (exactly <em class="parameter"><code>n_values</code></em>)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-enum-store-set-stock-prefix"></a><h3>gimp_enum_store_set_stock_prefix ()</h3>
<pre class="programlisting">void gimp_enum_store_set_stock_prefix (<a class="link" href="GimpEnumStore.html" title="GimpEnumStore">GimpEnumStore</a> *store,
const gchar *stock_prefix);</pre>
<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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td> a <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stock_prefix</code></em> :</span></p></td>
<td> a prefix to create icon stock ID from enum values
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumStore.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="GimpEnumStore--enum-type"></a><h3>The <code class="literal">"enum-type"</code> property</h3>
<pre class="programlisting"> "enum-type" GType* : Read / Write / Construct Only</pre>
<p>
Sets the <span class="type">GType</span> of the enum to be used in the store.</p>
<p>
</p>
<p>Since GIMP 2.4
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|