1
<?xml version="1.0" encoding="UTF-8" ?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5
<refentry id="libgimpwidgets-GimpPropWidgets">
7
<refentrytitle role="top_of_page">GimpPropWidgets</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
13
<refname>GimpPropWidgets</refname>
14
<refpurpose></refpurpose>
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
18
<refsynopsisdiv role="synopsis">
19
<title role="synopsis.title">Synopsis</title>
25
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-boolean-combo-box-new">gimp_prop_boolean_combo_box_new</link> (<link linkend="GObject">GObject</link> *config,
26
const <link linkend="gchar">gchar</link> *property_name,
27
const <link linkend="gchar">gchar</link> *true_text,
28
const <link linkend="gchar">gchar</link> *false_text);
29
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-boolean-radio-frame-new">gimp_prop_boolean_radio_frame_new</link> (<link linkend="GObject">GObject</link> *config,
30
const <link linkend="gchar">gchar</link> *property_name,
31
const <link linkend="gchar">gchar</link> *title,
32
const <link linkend="gchar">gchar</link> *true_text,
33
const <link linkend="gchar">gchar</link> *false_text);
34
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-check-button-new">gimp_prop_check_button_new</link> (<link linkend="GObject">GObject</link> *config,
35
const <link linkend="gchar">gchar</link> *property_name,
36
const <link linkend="gchar">gchar</link> *label);
37
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-color-area-new">gimp_prop_color_area_new</link> (<link linkend="GObject">GObject</link> *config,
38
const <link linkend="gchar">gchar</link> *property_name,
39
<link linkend="gint">gint</link> width,
40
<link linkend="gint">gint</link> height,
41
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
42
<link linkend="gboolean">gboolean</link> <link linkend="gimp-prop-coordinates-connect">gimp_prop_coordinates_connect</link> (<link linkend="GObject">GObject</link> *config,
43
const <link linkend="gchar">gchar</link> *x_property_name,
44
const <link linkend="gchar">gchar</link> *y_property_name,
45
const <link linkend="gchar">gchar</link> *unit_property_name,
46
<link linkend="GtkWidget">GtkWidget</link> *sizeentry,
47
<link linkend="GtkWidget">GtkWidget</link> *chainbutton,
48
<link linkend="gdouble">gdouble</link> xresolution,
49
<link linkend="gdouble">gdouble</link> yresolution);
50
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-coordinates-new">gimp_prop_coordinates_new</link> (<link linkend="GObject">GObject</link> *config,
51
const <link linkend="gchar">gchar</link> *x_property_name,
52
const <link linkend="gchar">gchar</link> *y_property_name,
53
const <link linkend="gchar">gchar</link> *unit_property_name,
54
const <link linkend="gchar">gchar</link> *unit_format,
55
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy,
56
<link linkend="gdouble">gdouble</link> xresolution,
57
<link linkend="gdouble">gdouble</link> yresolution,
58
<link linkend="gboolean">gboolean</link> has_chainbutton);
59
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-entry-new">gimp_prop_entry_new</link> (<link linkend="GObject">GObject</link> *config,
60
const <link linkend="gchar">gchar</link> *property_name,
61
<link linkend="gint">gint</link> max_len);
62
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-enum-check-button-new">gimp_prop_enum_check_button_new</link> (<link linkend="GObject">GObject</link> *config,
63
const <link linkend="gchar">gchar</link> *property_name,
64
const <link linkend="gchar">gchar</link> *label,
65
<link linkend="gint">gint</link> false_value,
66
<link linkend="gint">gint</link> true_value);
67
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-enum-combo-box-new">gimp_prop_enum_combo_box_new</link> (<link linkend="GObject">GObject</link> *config,
68
const <link linkend="gchar">gchar</link> *property_name,
69
<link linkend="gint">gint</link> minimum,
70
<link linkend="gint">gint</link> maximum);
71
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-enum-label-new">gimp_prop_enum_label_new</link> (<link linkend="GObject">GObject</link> *config,
72
const <link linkend="gchar">gchar</link> *property_name);
73
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-enum-radio-box-new">gimp_prop_enum_radio_box_new</link> (<link linkend="GObject">GObject</link> *config,
74
const <link linkend="gchar">gchar</link> *property_name,
75
<link linkend="gint">gint</link> minimum,
76
<link linkend="gint">gint</link> maximum);
77
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-enum-radio-frame-new">gimp_prop_enum_radio_frame_new</link> (<link linkend="GObject">GObject</link> *config,
78
const <link linkend="gchar">gchar</link> *property_name,
79
const <link linkend="gchar">gchar</link> *title,
80
<link linkend="gint">gint</link> minimum,
81
<link linkend="gint">gint</link> maximum);
82
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-enum-stock-box-new">gimp_prop_enum_stock_box_new</link> (<link linkend="GObject">GObject</link> *config,
83
const <link linkend="gchar">gchar</link> *property_name,
84
const <link linkend="gchar">gchar</link> *stock_prefix,
85
<link linkend="gint">gint</link> minimum,
86
<link linkend="gint">gint</link> maximum);
87
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-expander-new">gimp_prop_expander_new</link> (<link linkend="GObject">GObject</link> *config,
88
const <link linkend="gchar">gchar</link> *property_name,
89
const <link linkend="gchar">gchar</link> *label);
90
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-file-chooser-button-new">gimp_prop_file_chooser_button_new</link> (<link linkend="GObject">GObject</link> *config,
91
const <link linkend="gchar">gchar</link> *property_name,
92
const <link linkend="gchar">gchar</link> *title,
93
<link linkend="GtkFileChooserAction">GtkFileChooserAction</link> action);
94
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-file-chooser-button-new-with-dialog">gimp_prop_file_chooser_button_new_with_dialog</link>
95
(<link linkend="GObject">GObject</link> *config,
96
const <link linkend="gchar">gchar</link> *property_name,
97
<link linkend="GtkWidget">GtkWidget</link> *dialog);
98
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-hscale-new">gimp_prop_hscale_new</link> (<link linkend="GObject">GObject</link> *config,
99
const <link linkend="gchar">gchar</link> *property_name,
100
<link linkend="gdouble">gdouble</link> step_increment,
101
<link linkend="gdouble">gdouble</link> page_increment,
102
<link linkend="gint">gint</link> digits);
103
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-int-combo-box-new">gimp_prop_int_combo_box_new</link> (<link linkend="GObject">GObject</link> *config,
104
const <link linkend="gchar">gchar</link> *property_name,
105
<link linkend="GimpIntStore">GimpIntStore</link> *store);
106
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-label-new">gimp_prop_label_new</link> (<link linkend="GObject">GObject</link> *config,
107
const <link linkend="gchar">gchar</link> *property_name);
108
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-memsize-entry-new">gimp_prop_memsize_entry_new</link> (<link linkend="GObject">GObject</link> *config,
109
const <link linkend="gchar">gchar</link> *property_name);
110
<link linkend="GtkObject">GtkObject</link>* <link linkend="gimp-prop-opacity-entry-new">gimp_prop_opacity_entry_new</link> (<link linkend="GObject">GObject</link> *config,
111
const <link linkend="gchar">gchar</link> *property_name,
112
<link linkend="GtkTable">GtkTable</link> *table,
113
<link linkend="gint">gint</link> column,
114
<link linkend="gint">gint</link> row,
115
const <link linkend="gchar">gchar</link> *label);
116
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-path-editor-new">gimp_prop_path_editor_new</link> (<link linkend="GObject">GObject</link> *config,
117
const <link linkend="gchar">gchar</link> *path_property_name,
118
const <link linkend="gchar">gchar</link> *writable_property_name,
119
const <link linkend="gchar">gchar</link> *filesel_title);
120
<link linkend="GtkObject">GtkObject</link>* <link linkend="gimp-prop-scale-entry-new">gimp_prop_scale_entry_new</link> (<link linkend="GObject">GObject</link> *config,
121
const <link linkend="gchar">gchar</link> *property_name,
122
<link linkend="GtkTable">GtkTable</link> *table,
123
<link linkend="gint">gint</link> column,
124
<link linkend="gint">gint</link> row,
125
const <link linkend="gchar">gchar</link> *label,
126
<link linkend="gdouble">gdouble</link> step_increment,
127
<link linkend="gdouble">gdouble</link> page_increment,
128
<link linkend="gint">gint</link> digits,
129
<link linkend="gboolean">gboolean</link> limit_scale,
130
<link linkend="gdouble">gdouble</link> lower_limit,
131
<link linkend="gdouble">gdouble</link> upper_limit);
132
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-size-entry-new">gimp_prop_size_entry_new</link> (<link linkend="GObject">GObject</link> *config,
133
const <link linkend="gchar">gchar</link> *property_name,
134
const <link linkend="gchar">gchar</link> *unit_property_name,
135
const <link linkend="gchar">gchar</link> *unit_format,
136
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy,
137
<link linkend="gdouble">gdouble</link> resolution);
138
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-spin-button-new">gimp_prop_spin_button_new</link> (<link linkend="GObject">GObject</link> *config,
139
const <link linkend="gchar">gchar</link> *property_name,
140
<link linkend="gdouble">gdouble</link> step_increment,
141
<link linkend="gdouble">gdouble</link> page_increment,
142
<link linkend="gint">gint</link> digits);
143
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-stock-image-new">gimp_prop_stock_image_new</link> (<link linkend="GObject">GObject</link> *config,
144
const <link linkend="gchar">gchar</link> *property_name,
145
<link linkend="GtkIconSize">GtkIconSize</link> icon_size);
146
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-string-combo-box-new">gimp_prop_string_combo_box_new</link> (<link linkend="GObject">GObject</link> *config,
147
const <link linkend="gchar">gchar</link> *property_name,
148
<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
149
<link linkend="gint">gint</link> id_column,
150
<link linkend="gint">gint</link> label_column);
151
<link linkend="GtkTextBuffer">GtkTextBuffer</link>* <link linkend="gimp-prop-text-buffer-new">gimp_prop_text_buffer_new</link> (<link linkend="GObject">GObject</link> *config,
152
const <link linkend="gchar">gchar</link> *property_name,
153
<link linkend="gint">gint</link> max_len);
154
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-prop-unit-menu-new">gimp_prop_unit_menu_new</link> (<link linkend="GObject">GObject</link> *config,
155
const <link linkend="gchar">gchar</link> *property_name,
156
const <link linkend="gchar">gchar</link> *unit_format);
168
<refsect1 role="desc">
169
<title role="desc.title">Description</title>
175
<refsect1 role="details">
176
<title role="details.title">Details</title>
178
<title><anchor id="gimp-prop-boolean-combo-box-new" role="function"/>gimp_prop_boolean_combo_box_new ()</title>
179
<indexterm><primary>gimp_prop_boolean_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_boolean_combo_box_new (<link linkend="GObject">GObject</link> *config,
180
const <link linkend="gchar">gchar</link> *property_name,
181
const <link linkend="gchar">gchar</link> *true_text,
182
const <link linkend="gchar">gchar</link> *false_text);</programlisting>
184
Creates a <link linkend="GtkComboBox"><type>GtkComboBox</type></link> widget to display and set the specified
185
boolean property. The combo box will have two entries, one
186
displaying the <parameter>true_text</parameter> label, the other displaying the
187
<parameter>false_text</parameter> label.</para>
190
</para><variablelist role="params">
191
<varlistentry><term><parameter>config</parameter> :</term>
192
<listitem><simpara> Object to which property is attached.
193
</simpara></listitem></varlistentry>
194
<varlistentry><term><parameter>property_name</parameter> :</term>
195
<listitem><simpara> Name of boolean property controlled by combo box.
196
</simpara></listitem></varlistentry>
197
<varlistentry><term><parameter>true_text</parameter> :</term>
198
<listitem><simpara> Label used for entry corresponding to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> value.
199
</simpara></listitem></varlistentry>
200
<varlistentry><term><parameter>false_text</parameter> :</term>
201
<listitem><simpara> Label used for entry corresponding to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> value.
202
</simpara></listitem></varlistentry>
203
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GtkComboBox"><type>GtkComboBox</type></link> widget, optionally
204
wrapped into a <link linkend="GtkEventBox"><type>GtkEventBox</type></link>..
207
</simpara></listitem></varlistentry>
208
</variablelist></refsect2>
210
<title><anchor id="gimp-prop-boolean-radio-frame-new" role="function"/>gimp_prop_boolean_radio_frame_new ()</title>
211
<indexterm><primary>gimp_prop_boolean_radio_frame_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_boolean_radio_frame_new (<link linkend="GObject">GObject</link> *config,
212
const <link linkend="gchar">gchar</link> *property_name,
213
const <link linkend="gchar">gchar</link> *title,
214
const <link linkend="gchar">gchar</link> *true_text,
215
const <link linkend="gchar">gchar</link> *false_text);</programlisting>
217
Creates a pair of radio buttons which function to set and display
218
the specified boolean property.</para>
221
</para><variablelist role="params">
222
<varlistentry><term><parameter>config</parameter> :</term>
223
<listitem><simpara> Object to which property is attached.
224
</simpara></listitem></varlistentry>
225
<varlistentry><term><parameter>property_name</parameter> :</term>
226
<listitem><simpara> Name of boolean property controlled by the radio buttons.
227
</simpara></listitem></varlistentry>
228
<varlistentry><term><parameter>title</parameter> :</term>
229
<listitem><simpara> Label for the frame.
230
</simpara></listitem></varlistentry>
231
<varlistentry><term><parameter>true_text</parameter> :</term>
232
<listitem><simpara> Label for the button corresponding to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.
233
</simpara></listitem></varlistentry>
234
<varlistentry><term><parameter>false_text</parameter> :</term>
235
<listitem><simpara> Label for the button corresponding to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
236
</simpara></listitem></varlistentry>
237
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpFrame"><type>GimpFrame</type></link> containing the radio buttons.
240
</simpara></listitem></varlistentry>
241
</variablelist></refsect2>
243
<title><anchor id="gimp-prop-check-button-new" role="function"/>gimp_prop_check_button_new ()</title>
244
<indexterm><primary>gimp_prop_check_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_check_button_new (<link linkend="GObject">GObject</link> *config,
245
const <link linkend="gchar">gchar</link> *property_name,
246
const <link linkend="gchar">gchar</link> *label);</programlisting>
248
Creates a <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> that displays and sets the specified
249
boolean property.</para>
252
</para><variablelist role="params">
253
<varlistentry><term><parameter>config</parameter> :</term>
254
<listitem><simpara> Object to which property is attached.
255
</simpara></listitem></varlistentry>
256
<varlistentry><term><parameter>property_name</parameter> :</term>
257
<listitem><simpara> Name of boolean property controlled by checkbutton.
258
</simpara></listitem></varlistentry>
259
<varlistentry><term><parameter>label</parameter> :</term>
260
<listitem><simpara> Label to give checkbutton (including mnemonic).
261
</simpara></listitem></varlistentry>
262
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> widget.
265
</simpara></listitem></varlistentry>
266
</variablelist></refsect2>
268
<title><anchor id="gimp-prop-color-area-new" role="function"/>gimp_prop_color_area_new ()</title>
269
<indexterm><primary>gimp_prop_color_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_color_area_new (<link linkend="GObject">GObject</link> *config,
270
const <link linkend="gchar">gchar</link> *property_name,
271
<link linkend="gint">gint</link> width,
272
<link linkend="gint">gint</link> height,
273
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
275
Creates a <link linkend="GimpColorArea"><type>GimpColorArea</type></link> to set and display the value of an RGB
279
</para><variablelist role="params">
280
<varlistentry><term><parameter>config</parameter> :</term>
281
<listitem><simpara> Object to which property is attached.
282
</simpara></listitem></varlistentry>
283
<varlistentry><term><parameter>property_name</parameter> :</term>
284
<listitem><simpara> Name of RGB property.
285
</simpara></listitem></varlistentry>
286
<varlistentry><term><parameter>width</parameter> :</term>
287
<listitem><simpara> Width of color area.
288
</simpara></listitem></varlistentry>
289
<varlistentry><term><parameter>height</parameter> :</term>
290
<listitem><simpara> Height of color area.
291
</simpara></listitem></varlistentry>
292
<varlistentry><term><parameter>type</parameter> :</term>
293
<listitem><simpara> How transparency is represented.
294
</simpara></listitem></varlistentry>
295
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpColorArea"><type>GimpColorArea</type></link> widget.
298
</simpara></listitem></varlistentry>
299
</variablelist></refsect2>
301
<title><anchor id="gimp-prop-coordinates-connect" role="function"/>gimp_prop_coordinates_connect ()</title>
302
<indexterm><primary>gimp_prop_coordinates_connect</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_prop_coordinates_connect (<link linkend="GObject">GObject</link> *config,
303
const <link linkend="gchar">gchar</link> *x_property_name,
304
const <link linkend="gchar">gchar</link> *y_property_name,
305
const <link linkend="gchar">gchar</link> *unit_property_name,
306
<link linkend="GtkWidget">GtkWidget</link> *sizeentry,
307
<link linkend="GtkWidget">GtkWidget</link> *chainbutton,
308
<link linkend="gdouble">gdouble</link> xresolution,
309
<link linkend="gdouble">gdouble</link> yresolution);</programlisting>
312
</para><variablelist role="params">
313
<varlistentry><term><parameter>config</parameter> :</term>
315
</simpara></listitem></varlistentry>
316
<varlistentry><term><parameter>x_property_name</parameter> :</term>
318
</simpara></listitem></varlistentry>
319
<varlistentry><term><parameter>y_property_name</parameter> :</term>
321
</simpara></listitem></varlistentry>
322
<varlistentry><term><parameter>unit_property_name</parameter> :</term>
324
</simpara></listitem></varlistentry>
325
<varlistentry><term><parameter>sizeentry</parameter> :</term>
327
</simpara></listitem></varlistentry>
328
<varlistentry><term><parameter>chainbutton</parameter> :</term>
330
</simpara></listitem></varlistentry>
331
<varlistentry><term><parameter>xresolution</parameter> :</term>
333
</simpara></listitem></varlistentry>
334
<varlistentry><term><parameter>yresolution</parameter> :</term>
336
</simpara></listitem></varlistentry>
337
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
340
</simpara></listitem></varlistentry>
341
</variablelist></refsect2>
343
<title><anchor id="gimp-prop-coordinates-new" role="function"/>gimp_prop_coordinates_new ()</title>
344
<indexterm><primary>gimp_prop_coordinates_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_coordinates_new (<link linkend="GObject">GObject</link> *config,
345
const <link linkend="gchar">gchar</link> *x_property_name,
346
const <link linkend="gchar">gchar</link> *y_property_name,
347
const <link linkend="gchar">gchar</link> *unit_property_name,
348
const <link linkend="gchar">gchar</link> *unit_format,
349
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy,
350
<link linkend="gdouble">gdouble</link> xresolution,
351
<link linkend="gdouble">gdouble</link> yresolution,
352
<link linkend="gboolean">gboolean</link> has_chainbutton);</programlisting>
354
Creates a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> to set and display two double or int
355
properties, which will usually represent X and Y coordinates, and
356
their associated unit property.</para>
359
</para><variablelist role="params">
360
<varlistentry><term><parameter>config</parameter> :</term>
361
<listitem><simpara> Object to which property is attached.
362
</simpara></listitem></varlistentry>
363
<varlistentry><term><parameter>x_property_name</parameter> :</term>
364
<listitem><simpara> Name of int or double property for X coordinate.
365
</simpara></listitem></varlistentry>
366
<varlistentry><term><parameter>y_property_name</parameter> :</term>
367
<listitem><simpara> Name of int or double property for Y coordinate.
368
</simpara></listitem></varlistentry>
369
<varlistentry><term><parameter>unit_property_name</parameter> :</term>
370
<listitem><simpara> Name of unit property.
371
</simpara></listitem></varlistentry>
372
<varlistentry><term><parameter>unit_format</parameter> :</term>
373
<listitem><simpara> A printf-like unit-format string as is used with
374
<link linkend="gimp-unit-menu-new"><function>gimp_unit_menu_new()</function></link>.
375
</simpara></listitem></varlistentry>
376
<varlistentry><term><parameter>update_policy</parameter> :</term>
377
<listitem><simpara> How the automatic pixel <-> real-world-unit
378
calculations should be done.
379
</simpara></listitem></varlistentry>
380
<varlistentry><term><parameter>xresolution</parameter> :</term>
381
<listitem><simpara> The resolution (in dpi) for the X coordinate.
382
</simpara></listitem></varlistentry>
383
<varlistentry><term><parameter>yresolution</parameter> :</term>
384
<listitem><simpara> The resolution (in dpi) for the Y coordinate.
385
</simpara></listitem></varlistentry>
386
<varlistentry><term><parameter>has_chainbutton</parameter> :</term>
387
<listitem><simpara> Whether to add a chainbutton to the size entry.
388
</simpara></listitem></varlistentry>
389
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> widget.
392
</simpara></listitem></varlistentry>
393
</variablelist></refsect2>
395
<title><anchor id="gimp-prop-entry-new" role="function"/>gimp_prop_entry_new ()</title>
396
<indexterm><primary>gimp_prop_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_entry_new (<link linkend="GObject">GObject</link> *config,
397
const <link linkend="gchar">gchar</link> *property_name,
398
<link linkend="gint">gint</link> max_len);</programlisting>
400
Creates a <link linkend="GtkEntry"><type>GtkEntry</type></link> to set and display the value of the specified
401
string property.</para>
404
</para><variablelist role="params">
405
<varlistentry><term><parameter>config</parameter> :</term>
406
<listitem><simpara> Object to which property is attached.
407
</simpara></listitem></varlistentry>
408
<varlistentry><term><parameter>property_name</parameter> :</term>
409
<listitem><simpara> Name of string property.
410
</simpara></listitem></varlistentry>
411
<varlistentry><term><parameter>max_len</parameter> :</term>
412
<listitem><simpara> Maximum allowed length of string.
413
</simpara></listitem></varlistentry>
414
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkEntry"><type>GtkEntry</type></link> widget.
417
</simpara></listitem></varlistentry>
418
</variablelist></refsect2>
420
<title><anchor id="gimp-prop-enum-check-button-new" role="function"/>gimp_prop_enum_check_button_new ()</title>
421
<indexterm><primary>gimp_prop_enum_check_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_enum_check_button_new (<link linkend="GObject">GObject</link> *config,
422
const <link linkend="gchar">gchar</link> *property_name,
423
const <link linkend="gchar">gchar</link> *label,
424
<link linkend="gint">gint</link> false_value,
425
<link linkend="gint">gint</link> true_value);</programlisting>
427
Creates a <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> that displays and sets the specified
428
property of type Enum. Note that this widget only allows two values
429
for the enum, one corresponding to the "checked" state and the
430
other to the "unchecked" state.</para>
433
</para><variablelist role="params">
434
<varlistentry><term><parameter>config</parameter> :</term>
435
<listitem><simpara> Object to which property is attached.
436
</simpara></listitem></varlistentry>
437
<varlistentry><term><parameter>property_name</parameter> :</term>
438
<listitem><simpara> Name of enum property controlled by checkbutton.
439
</simpara></listitem></varlistentry>
440
<varlistentry><term><parameter>label</parameter> :</term>
441
<listitem><simpara> Label to give checkbutton (including mnemonic).
442
</simpara></listitem></varlistentry>
443
<varlistentry><term><parameter>false_value</parameter> :</term>
444
<listitem><simpara> Enum value corresponding to unchecked state.
445
</simpara></listitem></varlistentry>
446
<varlistentry><term><parameter>true_value</parameter> :</term>
447
<listitem><simpara> Enum value corresonding to checked state.
448
</simpara></listitem></varlistentry>
449
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> widget.
452
</simpara></listitem></varlistentry>
453
</variablelist></refsect2>
455
<title><anchor id="gimp-prop-enum-combo-box-new" role="function"/>gimp_prop_enum_combo_box_new ()</title>
456
<indexterm><primary>gimp_prop_enum_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_enum_combo_box_new (<link linkend="GObject">GObject</link> *config,
457
const <link linkend="gchar">gchar</link> *property_name,
458
<link linkend="gint">gint</link> minimum,
459
<link linkend="gint">gint</link> maximum);</programlisting>
461
Creates a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> widget to display and set the specified
462
enum property. The <parameter>mimimum_value</parameter> and <parameter>maximum_value</parameter> give the
463
possibility of restricting the allowed range to a subset of the
464
enum. If the two values are equal (e.g., 0, 0), then the full
465
range of the Enum is used.</para>
468
</para><variablelist role="params">
469
<varlistentry><term><parameter>config</parameter> :</term>
470
<listitem><simpara> Object to which property is attached.
471
</simpara></listitem></varlistentry>
472
<varlistentry><term><parameter>property_name</parameter> :</term>
473
<listitem><simpara> Name of enum property controlled by combo box.
474
</simpara></listitem></varlistentry>
475
<varlistentry><term><parameter>minimum</parameter> :</term>
476
<listitem><simpara> Smallest allowed value of enum.
477
</simpara></listitem></varlistentry>
478
<varlistentry><term><parameter>maximum</parameter> :</term>
479
<listitem><simpara> Largest allowed value of enum.
480
</simpara></listitem></varlistentry>
481
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link> widget, optionally
482
wrapped into a <link linkend="GtkEventBox"><type>GtkEventBox</type></link>.
485
</simpara></listitem></varlistentry>
486
</variablelist></refsect2>
488
<title><anchor id="gimp-prop-enum-label-new" role="function"/>gimp_prop_enum_label_new ()</title>
489
<indexterm><primary>gimp_prop_enum_label_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_enum_label_new (<link linkend="GObject">GObject</link> *config,
490
const <link linkend="gchar">gchar</link> *property_name);</programlisting>
495
</para><variablelist role="params">
496
<varlistentry><term><parameter>config</parameter> :</term>
497
<listitem><simpara> Object to which property is attached.
498
</simpara></listitem></varlistentry>
499
<varlistentry><term><parameter>property_name</parameter> :</term>
500
<listitem><simpara> Name of enum property to be displayed.
501
</simpara></listitem></varlistentry>
502
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GimpEnumLabel"><type>GimpEnumLabel</type></link> widget.
505
</simpara></listitem></varlistentry>
506
</variablelist></refsect2>
508
<title><anchor id="gimp-prop-enum-radio-box-new" role="function"/>gimp_prop_enum_radio_box_new ()</title>
509
<indexterm><primary>gimp_prop_enum_radio_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_enum_radio_box_new (<link linkend="GObject">GObject</link> *config,
510
const <link linkend="gchar">gchar</link> *property_name,
511
<link linkend="gint">gint</link> minimum,
512
<link linkend="gint">gint</link> maximum);</programlisting>
514
Creates a group of radio buttons which function to set and display
515
the specified enum property. The <parameter>minimum</parameter> and <parameter>maximum</parameter> arguments
516
allow only a subset of the enum to be used. If the two arguments
517
are equal (e.g., 0, 0), then the full range of the enum will be used.
518
If you want to assign a label to the group of radio buttons, use
519
<link linkend="gimp-prop-enum-radio-frame-new"><function>gimp_prop_enum_radio_frame_new()</function></link> instead of this function.</para>
522
</para><variablelist role="params">
523
<varlistentry><term><parameter>config</parameter> :</term>
524
<listitem><simpara> Object to which property is attached.
525
</simpara></listitem></varlistentry>
526
<varlistentry><term><parameter>property_name</parameter> :</term>
527
<listitem><simpara> Name of enum property controlled by the radio buttons.
528
</simpara></listitem></varlistentry>
529
<varlistentry><term><parameter>minimum</parameter> :</term>
530
<listitem><simpara> Smallest value of enum to be included.
531
</simpara></listitem></varlistentry>
532
<varlistentry><term><parameter>maximum</parameter> :</term>
533
<listitem><simpara> Largest value of enum to be included.
534
</simpara></listitem></varlistentry>
535
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkVBox"><type>GtkVBox</type></link> containing the radio buttons.
538
</simpara></listitem></varlistentry>
539
</variablelist></refsect2>
541
<title><anchor id="gimp-prop-enum-radio-frame-new" role="function"/>gimp_prop_enum_radio_frame_new ()</title>
542
<indexterm><primary>gimp_prop_enum_radio_frame_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_enum_radio_frame_new (<link linkend="GObject">GObject</link> *config,
543
const <link linkend="gchar">gchar</link> *property_name,
544
const <link linkend="gchar">gchar</link> *title,
545
<link linkend="gint">gint</link> minimum,
546
<link linkend="gint">gint</link> maximum);</programlisting>
548
Creates a group of radio buttons which function to set and display
549
the specified enum property. The <parameter>minimum</parameter> and <parameter>maximum</parameter> arguments
550
allow only a subset of the enum to be used. If the two arguments
551
are equal (e.g., 0, 0), then the full range of the enum will be used.</para>
554
</para><variablelist role="params">
555
<varlistentry><term><parameter>config</parameter> :</term>
556
<listitem><simpara> Object to which property is attached.
557
</simpara></listitem></varlistentry>
558
<varlistentry><term><parameter>property_name</parameter> :</term>
559
<listitem><simpara> Name of enum property controlled by the radio buttons.
560
</simpara></listitem></varlistentry>
561
<varlistentry><term><parameter>title</parameter> :</term>
562
<listitem><simpara> Label for the frame holding the buttons
563
</simpara></listitem></varlistentry>
564
<varlistentry><term><parameter>minimum</parameter> :</term>
565
<listitem><simpara> Smallest value of enum to be included.
566
</simpara></listitem></varlistentry>
567
<varlistentry><term><parameter>maximum</parameter> :</term>
568
<listitem><simpara> Largest value of enum to be included.
569
</simpara></listitem></varlistentry>
570
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpFrame"><type>GimpFrame</type></link> containing the radio buttons.
573
</simpara></listitem></varlistentry>
574
</variablelist></refsect2>
576
<title><anchor id="gimp-prop-enum-stock-box-new" role="function"/>gimp_prop_enum_stock_box_new ()</title>
577
<indexterm><primary>gimp_prop_enum_stock_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_enum_stock_box_new (<link linkend="GObject">GObject</link> *config,
578
const <link linkend="gchar">gchar</link> *property_name,
579
const <link linkend="gchar">gchar</link> *stock_prefix,
580
<link linkend="gint">gint</link> minimum,
581
<link linkend="gint">gint</link> maximum);</programlisting>
583
Creates a horizontal box of radio buttons with stock icons, which
584
function to set and display the value of the specified Enum
585
property. The stock_id for each icon is created by appending the
586
enum_value's nick to the given <parameter>stock_prefix</parameter>. See
587
<link linkend="gimp-enum-stock-box-new"><function>gimp_enum_stock_box_new()</function></link> for more information.</para>
590
</para><variablelist role="params">
591
<varlistentry><term><parameter>config</parameter> :</term>
592
<listitem><simpara> Object to which property is attached.
593
</simpara></listitem></varlistentry>
594
<varlistentry><term><parameter>property_name</parameter> :</term>
595
<listitem><simpara> Name of enum property controlled by the radio buttons.
596
</simpara></listitem></varlistentry>
597
<varlistentry><term><parameter>stock_prefix</parameter> :</term>
598
<listitem><simpara> The prefix of the group of stock ids to use.
599
</simpara></listitem></varlistentry>
600
<varlistentry><term><parameter>minimum</parameter> :</term>
601
<listitem><simpara> Smallest value of enum to be included.
602
</simpara></listitem></varlistentry>
603
<varlistentry><term><parameter>maximum</parameter> :</term>
604
<listitem><simpara> Largest value of enum to be included.
605
</simpara></listitem></varlistentry>
606
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpEnumStockBox"><type>GimpEnumStockBox</type></link> containing the radio buttons.
609
</simpara></listitem></varlistentry>
610
</variablelist></refsect2>
612
<title><anchor id="gimp-prop-expander-new" role="function"/>gimp_prop_expander_new ()</title>
613
<indexterm><primary>gimp_prop_expander_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_expander_new (<link linkend="GObject">GObject</link> *config,
614
const <link linkend="gchar">gchar</link> *property_name,
615
const <link linkend="gchar">gchar</link> *label);</programlisting>
617
Creates a <link linkend="GtkExpander"><type>GtkExpander</type></link> controlled by the specified boolean property.
618
A value of <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> for the property corresponds to the expanded state
619
for the widget.</para>
622
</para><variablelist role="params">
623
<varlistentry><term><parameter>config</parameter> :</term>
624
<listitem><simpara> Object to which property is attached.
625
</simpara></listitem></varlistentry>
626
<varlistentry><term><parameter>property_name</parameter> :</term>
627
<listitem><simpara> Name of boolean property.
628
</simpara></listitem></varlistentry>
629
<varlistentry><term><parameter>label</parameter> :</term>
630
<listitem><simpara> Label for expander.
631
</simpara></listitem></varlistentry>
632
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkExpander"><type>GtkExpander</type></link> widget.
635
</simpara></listitem></varlistentry>
636
</variablelist></refsect2>
638
<title><anchor id="gimp-prop-file-chooser-button-new" role="function"/>gimp_prop_file_chooser_button_new ()</title>
639
<indexterm><primary>gimp_prop_file_chooser_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_file_chooser_button_new (<link linkend="GObject">GObject</link> *config,
640
const <link linkend="gchar">gchar</link> *property_name,
641
const <link linkend="gchar">gchar</link> *title,
642
<link linkend="GtkFileChooserAction">GtkFileChooserAction</link> action);</programlisting>
644
Creates a <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link> to edit the specified path property.
647
Note that <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link> implements the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link>
648
interface; you can use the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link> API with it.</para>
651
</para><variablelist role="params">
652
<varlistentry><term><parameter>config</parameter> :</term>
653
<listitem><simpara> object to which property is attached.
654
</simpara></listitem></varlistentry>
655
<varlistentry><term><parameter>property_name</parameter> :</term>
656
<listitem><simpara> name of path property.
657
</simpara></listitem></varlistentry>
658
<varlistentry><term><parameter>title</parameter> :</term>
659
<listitem><simpara> the title of the browse dialog.
660
</simpara></listitem></varlistentry>
661
<varlistentry><term><parameter>action</parameter> :</term>
662
<listitem><simpara> the open mode for the widget.
663
</simpara></listitem></varlistentry>
664
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link>.
667
</simpara></listitem></varlistentry>
668
</variablelist></refsect2>
670
<title><anchor id="gimp-prop-file-chooser-button-new-with-dialog" role="function"/>gimp_prop_file_chooser_button_new_with_dialog ()</title>
671
<indexterm><primary>gimp_prop_file_chooser_button_new_with_dialog</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_file_chooser_button_new_with_dialog
672
(<link linkend="GObject">GObject</link> *config,
673
const <link linkend="gchar">gchar</link> *property_name,
674
<link linkend="GtkWidget">GtkWidget</link> *dialog);</programlisting>
676
Creates a <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link> to edit the specified path property.
679
The button uses <parameter>dialog</parameter> as it's file-picking window. Note that <parameter>dialog</parameter>
680
must be a <link linkend="GtkFileChooserDialog"><type>GtkFileChooserDialog</type></link> (or subclass) and must not have
681
<link linkend="GTK-DIALOG-DESTROY-WITH-PARENT:CAPS"><literal>GTK_DIALOG_DESTROY_WITH_PARENT</literal></link> set.
684
Note that <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link> implements the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link>
685
interface; you can use the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link> API with it.</para>
688
</para><variablelist role="params">
689
<varlistentry><term><parameter>config</parameter> :</term>
690
<listitem><simpara> object to which property is attached.
691
</simpara></listitem></varlistentry>
692
<varlistentry><term><parameter>property_name</parameter> :</term>
693
<listitem><simpara> name of path property.
694
</simpara></listitem></varlistentry>
695
<varlistentry><term><parameter>dialog</parameter> :</term>
696
<listitem><simpara> the <link linkend="GtkFileChooserDialog"><type>GtkFileChooserDialog</type></link> widget to use.
697
</simpara></listitem></varlistentry>
698
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link>.
701
</simpara></listitem></varlistentry>
702
</variablelist></refsect2>
704
<title><anchor id="gimp-prop-hscale-new" role="function"/>gimp_prop_hscale_new ()</title>
705
<indexterm><primary>gimp_prop_hscale_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_hscale_new (<link linkend="GObject">GObject</link> *config,
706
const <link linkend="gchar">gchar</link> *property_name,
707
<link linkend="gdouble">gdouble</link> step_increment,
708
<link linkend="gdouble">gdouble</link> page_increment,
709
<link linkend="gint">gint</link> digits);</programlisting>
711
Creates a horizontal scale to control the value of the specified
712
integer or double property.</para>
715
</para><variablelist role="params">
716
<varlistentry><term><parameter>config</parameter> :</term>
717
<listitem><simpara> Object to which property is attached.
718
</simpara></listitem></varlistentry>
719
<varlistentry><term><parameter>property_name</parameter> :</term>
720
<listitem><simpara> Name of integer or double property controlled by the scale.
721
</simpara></listitem></varlistentry>
722
<varlistentry><term><parameter>step_increment</parameter> :</term>
723
<listitem><simpara> Step size.
724
</simpara></listitem></varlistentry>
725
<varlistentry><term><parameter>page_increment</parameter> :</term>
726
<listitem><simpara> Page size.
727
</simpara></listitem></varlistentry>
728
<varlistentry><term><parameter>digits</parameter> :</term>
729
<listitem><simpara> Number of digits after decimal point to display.
730
</simpara></listitem></varlistentry>
731
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkScale"><type>GtkScale</type></link>.
734
</simpara></listitem></varlistentry>
735
</variablelist></refsect2>
737
<title><anchor id="gimp-prop-int-combo-box-new" role="function"/>gimp_prop_int_combo_box_new ()</title>
738
<indexterm><primary>gimp_prop_int_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_int_combo_box_new (<link linkend="GObject">GObject</link> *config,
739
const <link linkend="gchar">gchar</link> *property_name,
740
<link linkend="GimpIntStore">GimpIntStore</link> *store);</programlisting>
742
Creates a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> widget to display and set the specified
743
property. The contents of the widget are determined by <parameter>store</parameter>,
744
which should be created using <link linkend="gimp-int-store-new"><function>gimp_int_store_new()</function></link>.</para>
747
</para><variablelist role="params">
748
<varlistentry><term><parameter>config</parameter> :</term>
749
<listitem><simpara> Object to which property is attached.
750
</simpara></listitem></varlistentry>
751
<varlistentry><term><parameter>property_name</parameter> :</term>
752
<listitem><simpara> Name of int property controlled by combo box.
753
</simpara></listitem></varlistentry>
754
<varlistentry><term><parameter>store</parameter> :</term>
755
<listitem><simpara> <link linkend="GimpIntStore"><type>GimpIntStore</type></link> holding list of labels, values, etc.
756
</simpara></listitem></varlistentry>
757
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> widget, optionally
758
wrapped into a <link linkend="GtkEventBox"><type>GtkEventBox</type></link>.
761
</simpara></listitem></varlistentry>
762
</variablelist></refsect2>
764
<title><anchor id="gimp-prop-label-new" role="function"/>gimp_prop_label_new ()</title>
765
<indexterm><primary>gimp_prop_label_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_label_new (<link linkend="GObject">GObject</link> *config,
766
const <link linkend="gchar">gchar</link> *property_name);</programlisting>
768
Creates a <link linkend="GtkLabel"><type>GtkLabel</type></link> to display the value of the specified property.
769
The property should be a string property or at least transformable
770
to a string. If the user should be able to edit the string, use
771
<link linkend="gimp-prop-entry-new"><function>gimp_prop_entry_new()</function></link> instead.</para>
774
</para><variablelist role="params">
775
<varlistentry><term><parameter>config</parameter> :</term>
776
<listitem><simpara> Object to which property is attached.
777
</simpara></listitem></varlistentry>
778
<varlistentry><term><parameter>property_name</parameter> :</term>
779
<listitem><simpara> Name of string property.
780
</simpara></listitem></varlistentry>
781
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkLabel"><type>GtkLabel</type></link> widget.
784
</simpara></listitem></varlistentry>
785
</variablelist></refsect2>
787
<title><anchor id="gimp-prop-memsize-entry-new" role="function"/>gimp_prop_memsize_entry_new ()</title>
788
<indexterm><primary>gimp_prop_memsize_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_memsize_entry_new (<link linkend="GObject">GObject</link> *config,
789
const <link linkend="gchar">gchar</link> *property_name);</programlisting>
791
Creates a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link> (spin button and option menu) to set
792
and display the value of the specified memsize property. See
793
<link linkend="gimp-memsize-entry-new"><function>gimp_memsize_entry_new()</function></link> for more information.</para>
796
</para><variablelist role="params">
797
<varlistentry><term><parameter>config</parameter> :</term>
798
<listitem><simpara> Object to which property is attached.
799
</simpara></listitem></varlistentry>
800
<varlistentry><term><parameter>property_name</parameter> :</term>
801
<listitem><simpara> Name of memsize property.
802
</simpara></listitem></varlistentry>
803
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>.
806
</simpara></listitem></varlistentry>
807
</variablelist></refsect2>
809
<title><anchor id="gimp-prop-opacity-entry-new" role="function"/>gimp_prop_opacity_entry_new ()</title>
810
<indexterm><primary>gimp_prop_opacity_entry_new</primary></indexterm><programlisting><link linkend="GtkObject">GtkObject</link>* gimp_prop_opacity_entry_new (<link linkend="GObject">GObject</link> *config,
811
const <link linkend="gchar">gchar</link> *property_name,
812
<link linkend="GtkTable">GtkTable</link> *table,
813
<link linkend="gint">gint</link> column,
814
<link linkend="gint">gint</link> row,
815
const <link linkend="gchar">gchar</link> *label);</programlisting>
817
Creates a <link linkend="GimpScaleEntry"><type>GimpScaleEntry</type></link> (slider and spin button) to set and
818
display the value of the specified double property, which should
819
represent an "opacity" variable with range 0 to 100. See
820
<link linkend="gimp-scale-entry-new"><function>gimp_scale_entry_new()</function></link> for more information.</para>
823
</para><variablelist role="params">
824
<varlistentry><term><parameter>config</parameter> :</term>
825
<listitem><simpara> Object to which property is attached.
826
</simpara></listitem></varlistentry>
827
<varlistentry><term><parameter>property_name</parameter> :</term>
828
<listitem><simpara> Name of double property controlled by the spin button.
829
</simpara></listitem></varlistentry>
830
<varlistentry><term><parameter>table</parameter> :</term>
831
<listitem><simpara> The <link linkend="GtkTable"><type>GtkTable</type></link> the widgets will be attached to.
832
</simpara></listitem></varlistentry>
833
<varlistentry><term><parameter>column</parameter> :</term>
834
<listitem><simpara> The column to start with.
835
</simpara></listitem></varlistentry>
836
<varlistentry><term><parameter>row</parameter> :</term>
837
<listitem><simpara> The row to attach the widgets.
838
</simpara></listitem></varlistentry>
839
<varlistentry><term><parameter>label</parameter> :</term>
840
<listitem><simpara> The text for the <link linkend="GtkLabel"><type>GtkLabel</type></link> which will appear left of the
841
<link linkend="GtkHScale"><type>GtkHScale</type></link>.
842
</simpara></listitem></varlistentry>
843
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>'s <link linkend="GtkAdjustment"><type>GtkAdjustment</type></link>.
846
</simpara></listitem></varlistentry>
847
</variablelist></refsect2>
849
<title><anchor id="gimp-prop-path-editor-new" role="function"/>gimp_prop_path_editor_new ()</title>
850
<indexterm><primary>gimp_prop_path_editor_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_path_editor_new (<link linkend="GObject">GObject</link> *config,
851
const <link linkend="gchar">gchar</link> *path_property_name,
852
const <link linkend="gchar">gchar</link> *writable_property_name,
853
const <link linkend="gchar">gchar</link> *filesel_title);</programlisting>
856
</para><variablelist role="params">
857
<varlistentry><term><parameter>config</parameter> :</term>
859
</simpara></listitem></varlistentry>
860
<varlistentry><term><parameter>path_property_name</parameter> :</term>
862
</simpara></listitem></varlistentry>
863
<varlistentry><term><parameter>writable_property_name</parameter> :</term>
865
</simpara></listitem></varlistentry>
866
<varlistentry><term><parameter>filesel_title</parameter> :</term>
868
</simpara></listitem></varlistentry>
869
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
872
</simpara></listitem></varlistentry>
873
</variablelist></refsect2>
875
<title><anchor id="gimp-prop-scale-entry-new" role="function"/>gimp_prop_scale_entry_new ()</title>
876
<indexterm><primary>gimp_prop_scale_entry_new</primary></indexterm><programlisting><link linkend="GtkObject">GtkObject</link>* gimp_prop_scale_entry_new (<link linkend="GObject">GObject</link> *config,
877
const <link linkend="gchar">gchar</link> *property_name,
878
<link linkend="GtkTable">GtkTable</link> *table,
879
<link linkend="gint">gint</link> column,
880
<link linkend="gint">gint</link> row,
881
const <link linkend="gchar">gchar</link> *label,
882
<link linkend="gdouble">gdouble</link> step_increment,
883
<link linkend="gdouble">gdouble</link> page_increment,
884
<link linkend="gint">gint</link> digits,
885
<link linkend="gboolean">gboolean</link> limit_scale,
886
<link linkend="gdouble">gdouble</link> lower_limit,
887
<link linkend="gdouble">gdouble</link> upper_limit);</programlisting>
889
Creates a <link linkend="GimpScaleEntry"><type>GimpScaleEntry</type></link> (slider and spin button) to set and
890
display the value of the specified double property. See
891
<link linkend="gimp-scale-entry-new"><function>gimp_scale_entry_new()</function></link> for more information.</para>
894
</para><variablelist role="params">
895
<varlistentry><term><parameter>config</parameter> :</term>
896
<listitem><simpara> Object to which property is attached.
897
</simpara></listitem></varlistentry>
898
<varlistentry><term><parameter>property_name</parameter> :</term>
899
<listitem><simpara> Name of double property controlled by the spin button.
900
</simpara></listitem></varlistentry>
901
<varlistentry><term><parameter>table</parameter> :</term>
902
<listitem><simpara> The <link linkend="GtkTable"><type>GtkTable</type></link> the widgets will be attached to.
903
</simpara></listitem></varlistentry>
904
<varlistentry><term><parameter>column</parameter> :</term>
905
<listitem><simpara> The column to start with.
906
</simpara></listitem></varlistentry>
907
<varlistentry><term><parameter>row</parameter> :</term>
908
<listitem><simpara> The row to attach the widgets.
909
</simpara></listitem></varlistentry>
910
<varlistentry><term><parameter>label</parameter> :</term>
911
<listitem><simpara> The text for the <link linkend="GtkLabel"><type>GtkLabel</type></link> which will appear left of
912
the <link linkend="GtkHScale"><type>GtkHScale</type></link>.
913
</simpara></listitem></varlistentry>
914
<varlistentry><term><parameter>step_increment</parameter> :</term>
915
<listitem><simpara> Step size.
916
</simpara></listitem></varlistentry>
917
<varlistentry><term><parameter>page_increment</parameter> :</term>
918
<listitem><simpara> Page size.
919
</simpara></listitem></varlistentry>
920
<varlistentry><term><parameter>digits</parameter> :</term>
921
<listitem><simpara> Number of digits after decimal point to display.
922
</simpara></listitem></varlistentry>
923
<varlistentry><term><parameter>limit_scale</parameter> :</term>
924
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the range of possible values of the
925
GtkSpinButton should be the same as of the GtkHScale.
926
</simpara></listitem></varlistentry>
927
<varlistentry><term><parameter>lower_limit</parameter> :</term>
928
<listitem><simpara> The spinbutton's lower boundary if <parameter>limit_scale</parameter> is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
929
</simpara></listitem></varlistentry>
930
<varlistentry><term><parameter>upper_limit</parameter> :</term>
931
<listitem><simpara> The spinbutton's upper boundary if <parameter>limit_scale</parameter> is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
932
</simpara></listitem></varlistentry>
933
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>'s <link linkend="GtkAdjustment"><type>GtkAdjustment</type></link>.
936
</simpara></listitem></varlistentry>
937
</variablelist></refsect2>
939
<title><anchor id="gimp-prop-size-entry-new" role="function"/>gimp_prop_size_entry_new ()</title>
940
<indexterm><primary>gimp_prop_size_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_size_entry_new (<link linkend="GObject">GObject</link> *config,
941
const <link linkend="gchar">gchar</link> *property_name,
942
const <link linkend="gchar">gchar</link> *unit_property_name,
943
const <link linkend="gchar">gchar</link> *unit_format,
944
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy,
945
<link linkend="gdouble">gdouble</link> resolution);</programlisting>
947
Creates a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> to set and display the specified double or
948
int property, and its associated unit property. Note that this
949
function is only suitable for creating a size entry holding a
950
single value. Use <link linkend="gimp-prop-coordinates-new"><function>gimp_prop_coordinates_new()</function></link> to create a size
951
entry holding two values.</para>
954
</para><variablelist role="params">
955
<varlistentry><term><parameter>config</parameter> :</term>
956
<listitem><simpara> Object to which property is attached.
957
</simpara></listitem></varlistentry>
958
<varlistentry><term><parameter>property_name</parameter> :</term>
959
<listitem><simpara> Name of int or double property.
960
</simpara></listitem></varlistentry>
961
<varlistentry><term><parameter>unit_property_name</parameter> :</term>
962
<listitem><simpara> Name of unit property.
963
</simpara></listitem></varlistentry>
964
<varlistentry><term><parameter>unit_format</parameter> :</term>
965
<listitem><simpara> A printf-like unit-format string as is used with
966
<link linkend="gimp-unit-menu-new"><function>gimp_unit_menu_new()</function></link>.
967
</simpara></listitem></varlistentry>
968
<varlistentry><term><parameter>update_policy</parameter> :</term>
969
<listitem><simpara> How the automatic pixel <-> real-world-unit
970
calculations should be done.
971
</simpara></listitem></varlistentry>
972
<varlistentry><term><parameter>resolution</parameter> :</term>
973
<listitem><simpara> The resolution (in dpi) for the field.
974
</simpara></listitem></varlistentry>
975
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> widget.
978
</simpara></listitem></varlistentry>
979
</variablelist></refsect2>
981
<title><anchor id="gimp-prop-spin-button-new" role="function"/>gimp_prop_spin_button_new ()</title>
982
<indexterm><primary>gimp_prop_spin_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_spin_button_new (<link linkend="GObject">GObject</link> *config,
983
const <link linkend="gchar">gchar</link> *property_name,
984
<link linkend="gdouble">gdouble</link> step_increment,
985
<link linkend="gdouble">gdouble</link> page_increment,
986
<link linkend="gint">gint</link> digits);</programlisting>
988
Creates a spin button to set and display the value of the
989
specified double property.</para>
992
</para><variablelist role="params">
993
<varlistentry><term><parameter>config</parameter> :</term>
994
<listitem><simpara> Object to which property is attached.
995
</simpara></listitem></varlistentry>
996
<varlistentry><term><parameter>property_name</parameter> :</term>
997
<listitem><simpara> Name of double property controlled by the spin button.
998
</simpara></listitem></varlistentry>
999
<varlistentry><term><parameter>step_increment</parameter> :</term>
1000
<listitem><simpara> Step size.
1001
</simpara></listitem></varlistentry>
1002
<varlistentry><term><parameter>page_increment</parameter> :</term>
1003
<listitem><simpara> Page size.
1004
</simpara></listitem></varlistentry>
1005
<varlistentry><term><parameter>digits</parameter> :</term>
1006
<listitem><simpara> Number of digits after decimal point to display.
1007
</simpara></listitem></varlistentry>
1008
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpSpinButton"><type>GimpSpinButton</type></link>.
1011
</simpara></listitem></varlistentry>
1012
</variablelist></refsect2>
1014
<title><anchor id="gimp-prop-stock-image-new" role="function"/>gimp_prop_stock_image_new ()</title>
1015
<indexterm><primary>gimp_prop_stock_image_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_stock_image_new (<link linkend="GObject">GObject</link> *config,
1016
const <link linkend="gchar">gchar</link> *property_name,
1017
<link linkend="GtkIconSize">GtkIconSize</link> icon_size);</programlisting>
1019
Creates a widget to display a stock image representing the value of the
1020
specified string property, which should encode a Stock ID.
1021
See <link linkend="gtk-image-new-from-stock"><function>gtk_image_new_from_stock()</function></link> for more information.</para>
1024
</para><variablelist role="params">
1025
<varlistentry><term><parameter>config</parameter> :</term>
1026
<listitem><simpara> Object to which property is attached.
1027
</simpara></listitem></varlistentry>
1028
<varlistentry><term><parameter>property_name</parameter> :</term>
1029
<listitem><simpara> Name of string property.
1030
</simpara></listitem></varlistentry>
1031
<varlistentry><term><parameter>icon_size</parameter> :</term>
1032
<listitem><simpara> Size of desired stock image.
1033
</simpara></listitem></varlistentry>
1034
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkImage"><type>GtkImage</type></link> widget.
1037
</simpara></listitem></varlistentry>
1038
</variablelist></refsect2>
1040
<title><anchor id="gimp-prop-string-combo-box-new" role="function"/>gimp_prop_string_combo_box_new ()</title>
1041
<indexterm><primary>gimp_prop_string_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_string_combo_box_new (<link linkend="GObject">GObject</link> *config,
1042
const <link linkend="gchar">gchar</link> *property_name,
1043
<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
1044
<link linkend="gint">gint</link> id_column,
1045
<link linkend="gint">gint</link> label_column);</programlisting>
1047
Creates a <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link> widget to display and set the
1048
specified property. The contents of the widget are determined by
1049
<parameter>store</parameter>.</para>
1052
</para><variablelist role="params">
1053
<varlistentry><term><parameter>config</parameter> :</term>
1054
<listitem><simpara> Object to which property is attached.
1055
</simpara></listitem></varlistentry>
1056
<varlistentry><term><parameter>property_name</parameter> :</term>
1057
<listitem><simpara> Name of int property controlled by combo box.
1058
</simpara></listitem></varlistentry>
1059
<varlistentry><term><parameter>model</parameter> :</term>
1060
<listitem><simpara> <link linkend="GtkTreeStore"><type>GtkTreeStore</type></link> holding list of values
1061
</simpara></listitem></varlistentry>
1062
<varlistentry><term><parameter>id_column</parameter> :</term>
1063
<listitem><simpara> column in <parameter>store</parameter> that holds string IDs
1064
</simpara></listitem></varlistentry>
1065
<varlistentry><term><parameter>label_column</parameter> :</term>
1066
<listitem><simpara> column in <parameter>store</parameter> that holds labels to use in the combo-box
1067
</simpara></listitem></varlistentry>
1068
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link> widget, optionally
1069
wrapped into a <link linkend="GtkEventBox"><type>GtkEventBox</type></link>.
1072
</simpara></listitem></varlistentry>
1073
</variablelist></refsect2>
1075
<title><anchor id="gimp-prop-text-buffer-new" role="function"/>gimp_prop_text_buffer_new ()</title>
1076
<indexterm><primary>gimp_prop_text_buffer_new</primary></indexterm><programlisting><link linkend="GtkTextBuffer">GtkTextBuffer</link>* gimp_prop_text_buffer_new (<link linkend="GObject">GObject</link> *config,
1077
const <link linkend="gchar">gchar</link> *property_name,
1078
<link linkend="gint">gint</link> max_len);</programlisting>
1080
Creates a <link linkend="GtkTextBuffer"><type>GtkTextBuffer</type></link> to set and display the value of the
1081
specified string property. Unless the string is expected to
1082
contain multiple lines or a large amount of text, use
1083
<link linkend="gimp-prop-entry-new"><function>gimp_prop_entry_new()</function></link> instead. See <link linkend="GtkTextView"><type>GtkTextView</type></link> for information on
1084
how to insert a text buffer into a visible widget.
1087
If <parameter>max_len</parameter> is 0 or negative, the text buffer allows an unlimited
1088
number of characters to be entered.</para>
1091
</para><variablelist role="params">
1092
<varlistentry><term><parameter>config</parameter> :</term>
1093
<listitem><simpara> Object to which property is attached.
1094
</simpara></listitem></varlistentry>
1095
<varlistentry><term><parameter>property_name</parameter> :</term>
1096
<listitem><simpara> Name of string property.
1097
</simpara></listitem></varlistentry>
1098
<varlistentry><term><parameter>max_len</parameter> :</term>
1099
<listitem><simpara> Maximum allowed length of text (in characters).
1100
</simpara></listitem></varlistentry>
1101
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkTextBuffer"><type>GtkTextBuffer</type></link>.
1104
</simpara></listitem></varlistentry>
1105
</variablelist></refsect2>
1107
<title><anchor id="gimp-prop-unit-menu-new" role="function"/>gimp_prop_unit_menu_new ()</title>
1108
<indexterm><primary>gimp_prop_unit_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_prop_unit_menu_new (<link linkend="GObject">GObject</link> *config,
1109
const <link linkend="gchar">gchar</link> *property_name,
1110
const <link linkend="gchar">gchar</link> *unit_format);</programlisting>
1112
Creates a <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> to set and display the value of a Unit
1113
property. See <link linkend="gimp-unit-menu-new"><function>gimp_unit_menu_new()</function></link> for more information.</para>
1116
</para><variablelist role="params">
1117
<varlistentry><term><parameter>config</parameter> :</term>
1118
<listitem><simpara> Object to which property is attached.
1119
</simpara></listitem></varlistentry>
1120
<varlistentry><term><parameter>property_name</parameter> :</term>
1121
<listitem><simpara> Name of Unit property.
1122
</simpara></listitem></varlistentry>
1123
<varlistentry><term><parameter>unit_format</parameter> :</term>
1124
<listitem><simpara> A printf-like format string which is used to create
1126
</simpara></listitem></varlistentry>
1127
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> widget.
1130
</simpara></listitem></varlistentry>
1131
</variablelist></refsect2>
added
removed
devel-docs/libgimpwidgets/xml/gimppropwidgets.xml
