← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpenumstore.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpenumstore.xml
12
12
<refnamediv>
13
13
<refname>GimpEnumStore</refname>
14
14
<refpurpose></refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpEnumStore.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpEnumStore-struct">GimpEnumStore</link>;
23
 
<link linkend="GtkListStore">GtkListStore</link>*       <link linkend="gimp-enum-store-new">gimp_enum_store_new</link>                 (<link linkend="GType">GType</link> enum_type);
24
 
<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,
 
22
<link linkend="GtkListStore">GtkListStore</link> *      <link linkend="gimp-enum-store-new">gimp_enum_store_new</link>                 (<link linkend="GType">GType</link> enum_type);
 
23
<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,
25
24
                                                         <link linkend="gint">gint</link> minimum,
26
25
                                                         <link linkend="gint">gint</link> maximum);
27
 
<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,
 
26
<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,
28
27
                                                         <link linkend="gint">gint</link> n_values,
29
28
                                                         ...);
30
 
<link linkend="GtkListStore">GtkListStore</link>*       <link linkend="gimp-enum-store-new-with-values-valist">gimp_enum_store_new_with_values_valist</link>
 
29
<link linkend="GtkListStore">GtkListStore</link> *      <link linkend="gimp-enum-store-new-with-values-valist">gimp_enum_store_new_with_values_valist</link>
31
30
                                                        (<link linkend="GType">GType</link> enum_type,
32
31
                                                         <link linkend="gint">gint</link> n_values,
33
32
                                                         <link linkend="va-list">va_list</link> args);
44
43
         +----<link linkend="GimpIntStore">GimpIntStore</link>
45
44
               +----GimpEnumStore
46
45
</synopsis>
47
 
 
48
46
</refsect1>
49
47
 
50
48
 
54
52
<para>
55
53
GimpEnumStore implements
56
54
 <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>
57
 
 
58
55
</refsect1>
59
56
 
60
57
 
70
67
<refsect1 id="GimpEnumStore.description" role="desc">
71
68
<title role="desc.title">Description</title>
72
69
<para>
73
 
 
74
70
</para>
75
71
</refsect1>
76
72
 
78
74
<title role="details.title">Details</title>
79
75
<refsect2 id="GimpEnumStore-struct" role="struct">
80
76
<title>GimpEnumStore</title>
81
 
<indexterm zone="GimpEnumStore-struct"><primary>GimpEnumStore</primary></indexterm><programlisting>typedef struct _GimpEnumStore GimpEnumStore;</programlisting>
 
77
<indexterm zone="GimpEnumStore-struct"><primary sortas="GimpEnumStore">GimpEnumStore</primary></indexterm><programlisting>typedef struct _GimpEnumStore GimpEnumStore;</programlisting>
82
78
<para>
83
 
 
84
79
</para></refsect2>
85
80
<refsect2 id="gimp-enum-store-new" role="function" condition="since:GIMP 2.4">
86
81
<title>gimp_enum_store_new ()</title>
87
 
<indexterm zone="gimp-enum-store-new" role="GIMP 2.4"><primary>gimp_enum_store_new</primary></indexterm><programlisting><link linkend="GtkListStore">GtkListStore</link>*       gimp_enum_store_new                 (<link linkend="GType">GType</link> enum_type);</programlisting>
 
82
<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>
88
83
<para>
89
84
Creates a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>, derived from <link linkend="GtkListStore"><type>GtkListStore</type></link> and fills
90
85
it with enum values. The enum needs to be registered to the type
91
86
system and should have translatable value names.</para>
92
87
<para>
93
 
 
94
88
</para><variablelist role="params">
95
 
<varlistentry><term><parameter>enum_type</parameter>&nbsp;:</term>
 
89
<varlistentry><term><parameter>enum_type</parameter>&#160;:</term>
96
90
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
97
91
</simpara></listitem></varlistentry>
98
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
 
92
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
99
93
 
100
94
</simpara></listitem></varlistentry>
101
 
</variablelist><para role="since">Since  GIMP 2.4
102
 
</para></refsect2>
 
95
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
103
96
<refsect2 id="gimp-enum-store-new-with-range" role="function" condition="since:GIMP 2.4">
104
97
<title>gimp_enum_store_new_with_range ()</title>
105
 
<indexterm zone="gimp-enum-store-new-with-range" role="GIMP 2.4"><primary>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,
 
98
<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,
106
99
                                                         <link linkend="gint">gint</link> minimum,
107
100
                                                         <link linkend="gint">gint</link> maximum);</programlisting>
108
101
<para>
110
103
to limit the enum values to a certain range. Values smaller than
111
104
<parameter>minimum</parameter> or larger than <parameter>maximum</parameter> are not added to the store.</para>
112
105
<para>
113
 
 
114
106
</para><variablelist role="params">
115
 
<varlistentry><term><parameter>enum_type</parameter>&nbsp;:</term>
 
107
<varlistentry><term><parameter>enum_type</parameter>&#160;:</term>
116
108
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
117
109
</simpara></listitem></varlistentry>
118
 
<varlistentry><term><parameter>minimum</parameter>&nbsp;:</term>
 
110
<varlistentry><term><parameter>minimum</parameter>&#160;:</term>
119
111
<listitem><simpara> the minimum value to include
120
112
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><parameter>maximum</parameter>&nbsp;:</term>
 
113
<varlistentry><term><parameter>maximum</parameter>&#160;:</term>
122
114
<listitem><simpara> the maximum value to include
123
115
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
 
116
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
125
117
 
126
118
</simpara></listitem></varlistentry>
127
 
</variablelist><para role="since">Since  GIMP 2.4
128
 
</para></refsect2>
 
119
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
129
120
<refsect2 id="gimp-enum-store-new-with-values" role="function" condition="since:GIMP 2.4">
130
121
<title>gimp_enum_store_new_with_values ()</title>
131
 
<indexterm zone="gimp-enum-store-new-with-values" role="GIMP 2.4"><primary>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,
 
122
<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,
132
123
                                                         <link linkend="gint">gint</link> n_values,
133
124
                                                         ...);</programlisting>
134
125
<para>
136
127
to expliticely list the enum values that should be added to the
137
128
store.</para>
138
129
<para>
139
 
 
140
130
</para><variablelist role="params">
141
 
<varlistentry><term><parameter>enum_type</parameter>&nbsp;:</term>
 
131
<varlistentry><term><parameter>enum_type</parameter>&#160;:</term>
142
132
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
143
133
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>n_values</parameter>&nbsp;:</term>
 
134
<varlistentry><term><parameter>n_values</parameter>&#160;:</term>
145
135
<listitem><simpara>  the number of enum values to include
146
136
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
137
<varlistentry><term><parameter>...</parameter>&#160;:</term>
148
138
<listitem><simpara>       a list of enum values (exactly <parameter>n_values</parameter>)
149
139
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
 
140
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
151
141
 
152
142
</simpara></listitem></varlistentry>
153
 
</variablelist><para role="since">Since  GIMP 2.4
154
 
</para></refsect2>
 
143
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
155
144
<refsect2 id="gimp-enum-store-new-with-values-valist" role="function" condition="since:GIMP 2.4">
156
145
<title>gimp_enum_store_new_with_values_valist ()</title>
157
 
<indexterm zone="gimp-enum-store-new-with-values-valist" role="GIMP 2.4"><primary>gimp_enum_store_new_with_values_valist</primary></indexterm><programlisting><link linkend="GtkListStore">GtkListStore</link>*       gimp_enum_store_new_with_values_valist
 
146
<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
158
147
                                                        (<link linkend="GType">GType</link> enum_type,
159
148
                                                         <link linkend="gint">gint</link> n_values,
160
149
                                                         <link linkend="va-list">va_list</link> args);</programlisting>
161
150
<para>
162
151
See <link linkend="gimp-enum-store-new-with-values"><function>gimp_enum_store_new_with_values()</function></link>.</para>
163
152
<para>
164
 
 
165
153
</para><variablelist role="params">
166
 
<varlistentry><term><parameter>enum_type</parameter>&nbsp;:</term>
 
154
<varlistentry><term><parameter>enum_type</parameter>&#160;:</term>
167
155
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
168
156
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>n_values</parameter>&nbsp;:</term>
 
157
<varlistentry><term><parameter>n_values</parameter>&#160;:</term>
170
158
<listitem><simpara>  the number of enum values to include
171
159
</simpara></listitem></varlistentry>
172
 
<varlistentry><term><parameter>args</parameter>&nbsp;:</term>
 
160
<varlistentry><term><parameter>args</parameter>&#160;:</term>
173
161
<listitem><simpara>      a va_list of enum values (exactly <parameter>n_values</parameter>)
174
162
</simpara></listitem></varlistentry>
175
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
 
163
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>.
176
164
 
177
165
</simpara></listitem></varlistentry>
178
 
</variablelist><para role="since">Since  GIMP 2.4
179
 
</para></refsect2>
 
166
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
180
167
<refsect2 id="gimp-enum-store-set-stock-prefix" role="function" condition="since:GIMP 2.4">
181
168
<title>gimp_enum_store_set_stock_prefix ()</title>
182
 
<indexterm zone="gimp-enum-store-set-stock-prefix" role="GIMP 2.4"><primary>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,
 
169
<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,
183
170
                                                         const <link linkend="gchar">gchar</link> *stock_prefix);</programlisting>
184
171
<para>
185
172
Creates a stock ID for each enum value in the <parameter>store</parameter> by appending
188
175
<para>
189
176
See also: <link linkend="gimp-enum-combo-box-set-stock-prefix"><function>gimp_enum_combo_box_set_stock_prefix()</function></link>.</para>
190
177
<para>
191
 
 
192
178
</para><variablelist role="params">
193
 
<varlistentry><term><parameter>store</parameter>&nbsp;:</term>
 
179
<varlistentry><term><parameter>store</parameter>&#160;:</term>
194
180
<listitem><simpara>        a <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link>
195
181
</simpara></listitem></varlistentry>
196
 
<varlistentry><term><parameter>stock_prefix</parameter>&nbsp;:</term>
 
182
<varlistentry><term><parameter>stock_prefix</parameter>&#160;:</term>
197
183
<listitem><simpara> a prefix to create icon stock ID from enum values
198
184
</simpara></listitem></varlistentry>
199
 
</variablelist><para role="since">Since  GIMP 2.4
200
 
</para></refsect2>
 
185
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
201
186
 
202
187
</refsect1>
203
188
<refsect1 id="GimpEnumStore.property-details" role="property_details">
204
189
<title role="property_details.title">Property Details</title>
205
 
<refsect2 id="GimpEnumStore--enum-type"><title>The <literal>&quot;enum-type&quot;</literal> property</title>
206
 
<indexterm zone="GimpEnumStore--enum-type" role="GIMP 2.4"><primary>GimpEnumStore:enum-type</primary></indexterm><programlisting>  &quot;enum-type&quot;                <link linkend="GType">GType</link>*                : Read / Write / Construct Only</programlisting>
 
190
<refsect2 id="GimpEnumStore--enum-type" role="property"><title>The <literal>&quot;enum-type&quot;</literal> property</title>
 
191
<indexterm zone="GimpEnumStore--enum-type" role="GIMP 2.4"><primary sortas="GimpEnumStore:enum-type">GimpEnumStore:enum-type</primary></indexterm><programlisting>  &quot;enum-type&quot;                <link linkend="GType">GType</link>*                : Read / Write / Construct Only</programlisting>
207
192
<para>
208
193
Sets the <link linkend="GType"><type>GType</type></link> of the enum to be used in the store.</para>
209
194
<para>
210
 
 
211
 
</para><para>Since  GIMP 2.4
212
 
</para>
 
195
</para><para>Since GIMP 2.4</para>
213
196
</refsect2>
214
 
 
215
197
</refsect1>
216
198
 
217
199