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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpEnumStore">
<refmeta>
<refentrytitle role="top_of_page" id="GimpEnumStore.top_of_page">GimpEnumStore</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpEnumStore</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="GimpEnumStore.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpEnumStore-struct">GimpEnumStore</link>;
<link linkend="GtkListStore">GtkListStore</link> * <link linkend="gimp-enum-store-new">gimp_enum_store_new</link> (<link linkend="GType">GType</link> enum_type);
<link linkend="GtkListStore">GtkListStore</link> * <link linkend="gimp-enum-store-new-with-range">gimp_enum_store_new_with_range</link> (<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> minimum,
<link linkend="gint">gint</link> maximum);
<link linkend="GtkListStore">GtkListStore</link> * <link linkend="gimp-enum-store-new-with-values">gimp_enum_store_new_with_values</link> (<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> n_values,
...);
<link linkend="GtkListStore">GtkListStore</link> * <link linkend="gimp-enum-store-new-with-values-valist">gimp_enum_store_new_with_values_valist</link>
(<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> n_values,
<link linkend="va-list">va_list</link> args);
<link linkend="void">void</link> <link linkend="gimp-enum-store-set-stock-prefix">gimp_enum_store_set_stock_prefix</link> (<link linkend="GimpEnumStore">GimpEnumStore</link> *store,
const <link linkend="gchar">gchar</link> *stock_prefix);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GimpEnumStore.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GtkListStore">GtkListStore</link>
+----<link linkend="GimpIntStore">GimpIntStore</link>
+----GimpEnumStore
</synopsis>
</refsect1>
<refsect1 id="GimpEnumStore.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpEnumStore implements
<link linkend="GtkBuildable">GtkBuildable</link>, <link linkend="GtkTreeModel">GtkTreeModel</link>, <link linkend="GtkTreeDragSource">GtkTreeDragSource</link>, <link linkend="GtkTreeDragDest">GtkTreeDragDest</link> and <link linkend="GtkTreeSortable">GtkTreeSortable</link>.</para>
</refsect1>
<refsect1 id="GimpEnumStore.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GimpEnumStore--enum-type">enum-type</link>" <link linkend="GType">GType</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="GimpEnumStore.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="GimpEnumStore.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpEnumStore-struct" role="struct">
<title>GimpEnumStore</title>
<indexterm zone="GimpEnumStore-struct"><primary sortas="GimpEnumStore">GimpEnumStore</primary></indexterm><programlisting>typedef struct _GimpEnumStore GimpEnumStore;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-enum-store-new" role="function" condition="since:GIMP 2.4">
<title>gimp_enum_store_new ()</title>
<indexterm zone="gimp-enum-store-new" role="GIMP 2.4"><primary sortas="gimp_enum_store_new">gimp_enum_store_new</primary></indexterm><programlisting><link linkend="GtkListStore">GtkListStore</link> * gimp_enum_store_new (<link linkend="GType">GType</link> enum_type);</programlisting>
<para>
Creates a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>, derived from <link linkend="GtkListStore"><type>GtkListStore</type></link> and fills
it with enum values. The enum needs to be registered to the type
system and should have translatable value names.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>enum_type</parameter> :</term>
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
<refsect2 id="gimp-enum-store-new-with-range" role="function" condition="since:GIMP 2.4">
<title>gimp_enum_store_new_with_range ()</title>
<indexterm zone="gimp-enum-store-new-with-range" role="GIMP 2.4"><primary sortas="gimp_enum_store_new_with_range">gimp_enum_store_new_with_range</primary></indexterm><programlisting><link linkend="GtkListStore">GtkListStore</link> * gimp_enum_store_new_with_range (<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> minimum,
<link linkend="gint">gint</link> maximum);</programlisting>
<para>
Creates a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link> like <link linkend="gimp-enum-store-new"><function>gimp_enum_store_new()</function></link> but allows
to limit the enum values to a certain range. Values smaller than
<parameter>minimum</parameter> or larger than <parameter>maximum</parameter> are not added to the store.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>enum_type</parameter> :</term>
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minimum</parameter> :</term>
<listitem><simpara> the minimum value to include
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>maximum</parameter> :</term>
<listitem><simpara> the maximum value to include
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
<refsect2 id="gimp-enum-store-new-with-values" role="function" condition="since:GIMP 2.4">
<title>gimp_enum_store_new_with_values ()</title>
<indexterm zone="gimp-enum-store-new-with-values" role="GIMP 2.4"><primary sortas="gimp_enum_store_new_with_values">gimp_enum_store_new_with_values</primary></indexterm><programlisting><link linkend="GtkListStore">GtkListStore</link> * gimp_enum_store_new_with_values (<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> n_values,
...);</programlisting>
<para>
Creates a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link> like <link linkend="gimp-enum-store-new"><function>gimp_enum_store_new()</function></link> but allows
to expliticely list the enum values that should be added to the
store.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>enum_type</parameter> :</term>
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_values</parameter> :</term>
<listitem><simpara> the number of enum values to include
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> a list of enum values (exactly <parameter>n_values</parameter>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
<refsect2 id="gimp-enum-store-new-with-values-valist" role="function" condition="since:GIMP 2.4">
<title>gimp_enum_store_new_with_values_valist ()</title>
<indexterm zone="gimp-enum-store-new-with-values-valist" role="GIMP 2.4"><primary sortas="gimp_enum_store_new_with_values_valist">gimp_enum_store_new_with_values_valist</primary></indexterm><programlisting><link linkend="GtkListStore">GtkListStore</link> * gimp_enum_store_new_with_values_valist
(<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> n_values,
<link linkend="va-list">va_list</link> args);</programlisting>
<para>
See <link linkend="gimp-enum-store-new-with-values"><function>gimp_enum_store_new_with_values()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>enum_type</parameter> :</term>
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_values</parameter> :</term>
<listitem><simpara> the number of enum values to include
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>args</parameter> :</term>
<listitem><simpara> a va_list of enum values (exactly <parameter>n_values</parameter>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
<refsect2 id="gimp-enum-store-set-stock-prefix" role="function" condition="since:GIMP 2.4">
<title>gimp_enum_store_set_stock_prefix ()</title>
<indexterm zone="gimp-enum-store-set-stock-prefix" role="GIMP 2.4"><primary sortas="gimp_enum_store_set_stock_prefix">gimp_enum_store_set_stock_prefix</primary></indexterm><programlisting><link linkend="void">void</link> gimp_enum_store_set_stock_prefix (<link linkend="GimpEnumStore">GimpEnumStore</link> *store,
const <link linkend="gchar">gchar</link> *stock_prefix);</programlisting>
<para>
Creates a stock ID for each enum value in the <parameter>store</parameter> by appending
the value's nick to the given <parameter>stock_prefix</parameter>, separated by a hyphen.
</para>
<para>
See also: <link linkend="gimp-enum-combo-box-set-stock-prefix"><function>gimp_enum_combo_box_set_stock_prefix()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>store</parameter> :</term>
<listitem><simpara> a <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stock_prefix</parameter> :</term>
<listitem><simpara> a prefix to create icon stock ID from enum values
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
</refsect1>
<refsect1 id="GimpEnumStore.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GimpEnumStore--enum-type" role="property"><title>The <literal>"enum-type"</literal> property</title>
<indexterm zone="GimpEnumStore--enum-type" role="GIMP 2.4"><primary sortas="GimpEnumStore:enum-type">GimpEnumStore:enum-type</primary></indexterm><programlisting> "enum-type" <link linkend="GType">GType</link>* : Read / Write / Construct Only</programlisting>
<para>
Sets the <link linkend="GType"><type>GType</type></link> of the enum to be used in the store.</para>
<para>
</para><para>Since GIMP 2.4</para>
</refsect2>
</refsect1>
</refentry>
|