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" id="libgimpwidgets-GimpPropWidgets.top_of_page">GimpPropWidgets</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
13
<refname>GimpPropWidgets</refname>
14
<refpurpose></refpurpose>
17
<refsynopsisdiv id="libgimpwidgets-GimpPropWidgets.synopsis" role="synopsis">
18
<title role="synopsis.title">Synopsis</title>
21
<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,
22
const <link linkend="gchar">gchar</link> *property_name,
23
const <link linkend="gchar">gchar</link> *true_text,
24
const <link linkend="gchar">gchar</link> *false_text);
25
<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,
26
const <link linkend="gchar">gchar</link> *property_name,
27
const <link linkend="gchar">gchar</link> *title,
28
const <link linkend="gchar">gchar</link> *true_text,
29
const <link linkend="gchar">gchar</link> *false_text);
30
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-check-button-new">gimp_prop_check_button_new</link> (<link linkend="GObject">GObject</link> *config,
31
const <link linkend="gchar">gchar</link> *property_name,
32
const <link linkend="gchar">gchar</link> *label);
33
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-color-area-new">gimp_prop_color_area_new</link> (<link linkend="GObject">GObject</link> *config,
34
const <link linkend="gchar">gchar</link> *property_name,
35
<link linkend="gint">gint</link> width,
36
<link linkend="gint">gint</link> height,
37
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
38
<link linkend="gboolean">gboolean</link> <link linkend="gimp-prop-coordinates-connect">gimp_prop_coordinates_connect</link> (<link linkend="GObject">GObject</link> *config,
39
const <link linkend="gchar">gchar</link> *x_property_name,
40
const <link linkend="gchar">gchar</link> *y_property_name,
41
const <link linkend="gchar">gchar</link> *unit_property_name,
42
<link linkend="GtkWidget">GtkWidget</link> *sizeentry,
43
<link linkend="GtkWidget">GtkWidget</link> *chainbutton,
44
<link linkend="gdouble">gdouble</link> xresolution,
45
<link linkend="gdouble">gdouble</link> yresolution);
46
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-coordinates-new">gimp_prop_coordinates_new</link> (<link linkend="GObject">GObject</link> *config,
47
const <link linkend="gchar">gchar</link> *x_property_name,
48
const <link linkend="gchar">gchar</link> *y_property_name,
49
const <link linkend="gchar">gchar</link> *unit_property_name,
50
const <link linkend="gchar">gchar</link> *unit_format,
51
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy,
52
<link linkend="gdouble">gdouble</link> xresolution,
53
<link linkend="gdouble">gdouble</link> yresolution,
54
<link linkend="gboolean">gboolean</link> has_chainbutton);
55
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-entry-new">gimp_prop_entry_new</link> (<link linkend="GObject">GObject</link> *config,
56
const <link linkend="gchar">gchar</link> *property_name,
57
<link linkend="gint">gint</link> max_len);
58
<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,
59
const <link linkend="gchar">gchar</link> *property_name,
60
const <link linkend="gchar">gchar</link> *label,
61
<link linkend="gint">gint</link> false_value,
62
<link linkend="gint">gint</link> true_value);
63
<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,
64
const <link linkend="gchar">gchar</link> *property_name,
65
<link linkend="gint">gint</link> minimum,
66
<link linkend="gint">gint</link> maximum);
67
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-enum-label-new">gimp_prop_enum_label_new</link> (<link linkend="GObject">GObject</link> *config,
68
const <link linkend="gchar">gchar</link> *property_name);
69
<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,
70
const <link linkend="gchar">gchar</link> *property_name,
71
<link linkend="gint">gint</link> minimum,
72
<link linkend="gint">gint</link> maximum);
73
<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,
74
const <link linkend="gchar">gchar</link> *property_name,
75
const <link linkend="gchar">gchar</link> *title,
76
<link linkend="gint">gint</link> minimum,
77
<link linkend="gint">gint</link> maximum);
78
<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,
79
const <link linkend="gchar">gchar</link> *property_name,
80
const <link linkend="gchar">gchar</link> *stock_prefix,
81
<link linkend="gint">gint</link> minimum,
82
<link linkend="gint">gint</link> maximum);
83
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-expander-new">gimp_prop_expander_new</link> (<link linkend="GObject">GObject</link> *config,
84
const <link linkend="gchar">gchar</link> *property_name,
85
const <link linkend="gchar">gchar</link> *label);
86
<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,
87
const <link linkend="gchar">gchar</link> *property_name,
88
const <link linkend="gchar">gchar</link> *title,
89
<link linkend="GtkFileChooserAction">GtkFileChooserAction</link> action);
90
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-file-chooser-button-new-with-dialog">gimp_prop_file_chooser_button_new_with_dialog</link>
91
(<link linkend="GObject">GObject</link> *config,
92
const <link linkend="gchar">gchar</link> *property_name,
93
<link linkend="GtkWidget">GtkWidget</link> *dialog);
94
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-hscale-new">gimp_prop_hscale_new</link> (<link linkend="GObject">GObject</link> *config,
95
const <link linkend="gchar">gchar</link> *property_name,
96
<link linkend="gdouble">gdouble</link> step_increment,
97
<link linkend="gdouble">gdouble</link> page_increment,
98
<link linkend="gint">gint</link> digits);
99
<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,
100
const <link linkend="gchar">gchar</link> *property_name,
101
<link linkend="GimpIntStore">GimpIntStore</link> *store);
102
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-label-new">gimp_prop_label_new</link> (<link linkend="GObject">GObject</link> *config,
103
const <link linkend="gchar">gchar</link> *property_name);
104
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-memsize-entry-new">gimp_prop_memsize_entry_new</link> (<link linkend="GObject">GObject</link> *config,
105
const <link linkend="gchar">gchar</link> *property_name);
106
<link linkend="GtkObject">GtkObject</link> * <link linkend="gimp-prop-opacity-entry-new">gimp_prop_opacity_entry_new</link> (<link linkend="GObject">GObject</link> *config,
107
const <link linkend="gchar">gchar</link> *property_name,
108
<link linkend="GtkTable">GtkTable</link> *table,
109
<link linkend="gint">gint</link> column,
110
<link linkend="gint">gint</link> row,
111
const <link linkend="gchar">gchar</link> *label);
112
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-path-editor-new">gimp_prop_path_editor_new</link> (<link linkend="GObject">GObject</link> *config,
113
const <link linkend="gchar">gchar</link> *path_property_name,
114
const <link linkend="gchar">gchar</link> *writable_property_name,
115
const <link linkend="gchar">gchar</link> *filesel_title);
116
<link linkend="GtkObject">GtkObject</link> * <link linkend="gimp-prop-scale-entry-new">gimp_prop_scale_entry_new</link> (<link linkend="GObject">GObject</link> *config,
117
const <link linkend="gchar">gchar</link> *property_name,
118
<link linkend="GtkTable">GtkTable</link> *table,
119
<link linkend="gint">gint</link> column,
120
<link linkend="gint">gint</link> row,
121
const <link linkend="gchar">gchar</link> *label,
122
<link linkend="gdouble">gdouble</link> step_increment,
123
<link linkend="gdouble">gdouble</link> page_increment,
124
<link linkend="gint">gint</link> digits,
125
<link linkend="gboolean">gboolean</link> limit_scale,
126
<link linkend="gdouble">gdouble</link> lower_limit,
127
<link linkend="gdouble">gdouble</link> upper_limit);
128
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-size-entry-new">gimp_prop_size_entry_new</link> (<link linkend="GObject">GObject</link> *config,
129
const <link linkend="gchar">gchar</link> *property_name,
130
<link linkend="gboolean">gboolean</link> property_is_pixel,
131
const <link linkend="gchar">gchar</link> *unit_property_name,
132
const <link linkend="gchar">gchar</link> *unit_format,
133
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy,
134
<link linkend="gdouble">gdouble</link> resolution);
135
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-spin-button-new">gimp_prop_spin_button_new</link> (<link linkend="GObject">GObject</link> *config,
136
const <link linkend="gchar">gchar</link> *property_name,
137
<link linkend="gdouble">gdouble</link> step_increment,
138
<link linkend="gdouble">gdouble</link> page_increment,
139
<link linkend="gint">gint</link> digits);
140
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-stock-image-new">gimp_prop_stock_image_new</link> (<link linkend="GObject">GObject</link> *config,
141
const <link linkend="gchar">gchar</link> *property_name,
142
<link linkend="GtkIconSize">GtkIconSize</link> icon_size);
143
<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,
144
const <link linkend="gchar">gchar</link> *property_name,
145
<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
146
<link linkend="gint">gint</link> id_column,
147
<link linkend="gint">gint</link> label_column);
148
<link linkend="GtkTextBuffer">GtkTextBuffer</link> * <link linkend="gimp-prop-text-buffer-new">gimp_prop_text_buffer_new</link> (<link linkend="GObject">GObject</link> *config,
149
const <link linkend="gchar">gchar</link> *property_name,
150
<link linkend="gint">gint</link> max_len);
151
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-prop-unit-menu-new">gimp_prop_unit_menu_new</link> (<link linkend="GObject">GObject</link> *config,
152
const <link linkend="gchar">gchar</link> *property_name,
153
const <link linkend="gchar">gchar</link> *unit_format);
165
<refsect1 id="libgimpwidgets-GimpPropWidgets.description" role="desc">
166
<title role="desc.title">Description</title>
171
<refsect1 id="libgimpwidgets-GimpPropWidgets.details" role="details">
172
<title role="details.title">Details</title>
173
<refsect2 id="gimp-prop-boolean-combo-box-new" role="function">
174
<title>gimp_prop_boolean_combo_box_new ()</title>
175
<indexterm zone="gimp-prop-boolean-combo-box-new"><primary sortas="gimp_prop_boolean_combo_box_new">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,
176
const <link linkend="gchar">gchar</link> *property_name,
177
const <link linkend="gchar">gchar</link> *true_text,
178
const <link linkend="gchar">gchar</link> *false_text);</programlisting>
180
Creates a <link linkend="GtkComboBox"><type>GtkComboBox</type></link> widget to display and set the specified
181
boolean property. The combo box will have two entries, one
182
displaying the <parameter>true_text</parameter> label, the other displaying the
183
<parameter>false_text</parameter> label.</para>
185
</para><variablelist role="params">
186
<varlistentry><term><parameter>config</parameter> :</term>
187
<listitem><simpara> Object to which property is attached.
188
</simpara></listitem></varlistentry>
189
<varlistentry><term><parameter>property_name</parameter> :</term>
190
<listitem><simpara> Name of boolean property controlled by combo box.
191
</simpara></listitem></varlistentry>
192
<varlistentry><term><parameter>true_text</parameter> :</term>
193
<listitem><simpara> Label used for entry corresponding to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> value.
194
</simpara></listitem></varlistentry>
195
<varlistentry><term><parameter>false_text</parameter> :</term>
196
<listitem><simpara> Label used for entry corresponding to <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> value.
197
</simpara></listitem></varlistentry>
198
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GtkComboBox"><type>GtkComboBox</type></link> widget.
201
</simpara></listitem></varlistentry>
202
</variablelist></refsect2>
203
<refsect2 id="gimp-prop-boolean-radio-frame-new" role="function">
204
<title>gimp_prop_boolean_radio_frame_new ()</title>
205
<indexterm zone="gimp-prop-boolean-radio-frame-new"><primary sortas="gimp_prop_boolean_radio_frame_new">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,
206
const <link linkend="gchar">gchar</link> *property_name,
207
const <link linkend="gchar">gchar</link> *title,
208
const <link linkend="gchar">gchar</link> *true_text,
209
const <link linkend="gchar">gchar</link> *false_text);</programlisting>
211
Creates a pair of radio buttons which function to set and display
212
the specified boolean property.</para>
214
</para><variablelist role="params">
215
<varlistentry><term><parameter>config</parameter> :</term>
216
<listitem><simpara> Object to which property is attached.
217
</simpara></listitem></varlistentry>
218
<varlistentry><term><parameter>property_name</parameter> :</term>
219
<listitem><simpara> Name of boolean property controlled by the radio buttons.
220
</simpara></listitem></varlistentry>
221
<varlistentry><term><parameter>title</parameter> :</term>
222
<listitem><simpara> Label for the frame.
223
</simpara></listitem></varlistentry>
224
<varlistentry><term><parameter>true_text</parameter> :</term>
225
<listitem><simpara> Label for the button corresponding to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.
226
</simpara></listitem></varlistentry>
227
<varlistentry><term><parameter>false_text</parameter> :</term>
228
<listitem><simpara> Label for the button corresponding to <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>.
229
</simpara></listitem></varlistentry>
230
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpFrame"><type>GimpFrame</type></link> containing the radio buttons.
233
</simpara></listitem></varlistentry>
234
</variablelist></refsect2>
235
<refsect2 id="gimp-prop-check-button-new" role="function">
236
<title>gimp_prop_check_button_new ()</title>
237
<indexterm zone="gimp-prop-check-button-new"><primary sortas="gimp_prop_check_button_new">gimp_prop_check_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_check_button_new (<link linkend="GObject">GObject</link> *config,
238
const <link linkend="gchar">gchar</link> *property_name,
239
const <link linkend="gchar">gchar</link> *label);</programlisting>
241
Creates a <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> that displays and sets the specified
242
boolean property.</para>
244
</para><variablelist role="params">
245
<varlistentry><term><parameter>config</parameter> :</term>
246
<listitem><simpara> Object to which property is attached.
247
</simpara></listitem></varlistentry>
248
<varlistentry><term><parameter>property_name</parameter> :</term>
249
<listitem><simpara> Name of boolean property controlled by checkbutton.
250
</simpara></listitem></varlistentry>
251
<varlistentry><term><parameter>label</parameter> :</term>
252
<listitem><simpara> Label to give checkbutton (including mnemonic).
253
</simpara></listitem></varlistentry>
254
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> widget.
257
</simpara></listitem></varlistentry>
258
</variablelist></refsect2>
259
<refsect2 id="gimp-prop-color-area-new" role="function">
260
<title>gimp_prop_color_area_new ()</title>
261
<indexterm zone="gimp-prop-color-area-new"><primary sortas="gimp_prop_color_area_new">gimp_prop_color_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_color_area_new (<link linkend="GObject">GObject</link> *config,
262
const <link linkend="gchar">gchar</link> *property_name,
263
<link linkend="gint">gint</link> width,
264
<link linkend="gint">gint</link> height,
265
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
267
Creates a <link linkend="GimpColorArea"><type>GimpColorArea</type></link> to set and display the value of an RGB
270
</para><variablelist role="params">
271
<varlistentry><term><parameter>config</parameter> :</term>
272
<listitem><simpara> Object to which property is attached.
273
</simpara></listitem></varlistentry>
274
<varlistentry><term><parameter>property_name</parameter> :</term>
275
<listitem><simpara> Name of RGB property.
276
</simpara></listitem></varlistentry>
277
<varlistentry><term><parameter>width</parameter> :</term>
278
<listitem><simpara> Width of color area.
279
</simpara></listitem></varlistentry>
280
<varlistentry><term><parameter>height</parameter> :</term>
281
<listitem><simpara> Height of color area.
282
</simpara></listitem></varlistentry>
283
<varlistentry><term><parameter>type</parameter> :</term>
284
<listitem><simpara> How transparency is represented.
285
</simpara></listitem></varlistentry>
286
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpColorArea"><type>GimpColorArea</type></link> widget.
289
</simpara></listitem></varlistentry>
290
</variablelist></refsect2>
291
<refsect2 id="gimp-prop-coordinates-connect" role="function">
292
<title>gimp_prop_coordinates_connect ()</title>
293
<indexterm zone="gimp-prop-coordinates-connect"><primary sortas="gimp_prop_coordinates_connect">gimp_prop_coordinates_connect</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_prop_coordinates_connect (<link linkend="GObject">GObject</link> *config,
294
const <link linkend="gchar">gchar</link> *x_property_name,
295
const <link linkend="gchar">gchar</link> *y_property_name,
296
const <link linkend="gchar">gchar</link> *unit_property_name,
297
<link linkend="GtkWidget">GtkWidget</link> *sizeentry,
298
<link linkend="GtkWidget">GtkWidget</link> *chainbutton,
299
<link linkend="gdouble">gdouble</link> xresolution,
300
<link linkend="gdouble">gdouble</link> yresolution);</programlisting>
302
</para><variablelist role="params">
303
<varlistentry><term><parameter>config</parameter> :</term>
305
</simpara></listitem></varlistentry>
306
<varlistentry><term><parameter>x_property_name</parameter> :</term>
308
</simpara></listitem></varlistentry>
309
<varlistentry><term><parameter>y_property_name</parameter> :</term>
311
</simpara></listitem></varlistentry>
312
<varlistentry><term><parameter>unit_property_name</parameter> :</term>
314
</simpara></listitem></varlistentry>
315
<varlistentry><term><parameter>sizeentry</parameter> :</term>
317
</simpara></listitem></varlistentry>
318
<varlistentry><term><parameter>chainbutton</parameter> :</term>
320
</simpara></listitem></varlistentry>
321
<varlistentry><term><parameter>xresolution</parameter> :</term>
323
</simpara></listitem></varlistentry>
324
<varlistentry><term><parameter>yresolution</parameter> :</term>
326
</simpara></listitem></varlistentry>
327
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
328
</simpara></listitem></varlistentry>
329
</variablelist></refsect2>
330
<refsect2 id="gimp-prop-coordinates-new" role="function">
331
<title>gimp_prop_coordinates_new ()</title>
332
<indexterm zone="gimp-prop-coordinates-new"><primary sortas="gimp_prop_coordinates_new">gimp_prop_coordinates_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_coordinates_new (<link linkend="GObject">GObject</link> *config,
333
const <link linkend="gchar">gchar</link> *x_property_name,
334
const <link linkend="gchar">gchar</link> *y_property_name,
335
const <link linkend="gchar">gchar</link> *unit_property_name,
336
const <link linkend="gchar">gchar</link> *unit_format,
337
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy,
338
<link linkend="gdouble">gdouble</link> xresolution,
339
<link linkend="gdouble">gdouble</link> yresolution,
340
<link linkend="gboolean">gboolean</link> has_chainbutton);</programlisting>
342
Creates a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> to set and display two double or int
343
properties, which will usually represent X and Y coordinates, and
344
their associated unit property.</para>
346
</para><variablelist role="params">
347
<varlistentry><term><parameter>config</parameter> :</term>
348
<listitem><simpara> Object to which property is attached.
349
</simpara></listitem></varlistentry>
350
<varlistentry><term><parameter>x_property_name</parameter> :</term>
351
<listitem><simpara> Name of int or double property for X coordinate.
352
</simpara></listitem></varlistentry>
353
<varlistentry><term><parameter>y_property_name</parameter> :</term>
354
<listitem><simpara> Name of int or double property for Y coordinate.
355
</simpara></listitem></varlistentry>
356
<varlistentry><term><parameter>unit_property_name</parameter> :</term>
357
<listitem><simpara> Name of unit property.
358
</simpara></listitem></varlistentry>
359
<varlistentry><term><parameter>unit_format</parameter> :</term>
360
<listitem><simpara> A printf-like unit-format string as is used with
361
<link linkend="gimp-unit-menu-new"><function>gimp_unit_menu_new()</function></link>.
362
</simpara></listitem></varlistentry>
363
<varlistentry><term><parameter>update_policy</parameter> :</term>
364
<listitem><simpara> How the automatic pixel <-> real-world-unit
365
calculations should be done.
366
</simpara></listitem></varlistentry>
367
<varlistentry><term><parameter>xresolution</parameter> :</term>
368
<listitem><simpara> The resolution (in dpi) for the X coordinate.
369
</simpara></listitem></varlistentry>
370
<varlistentry><term><parameter>yresolution</parameter> :</term>
371
<listitem><simpara> The resolution (in dpi) for the Y coordinate.
372
</simpara></listitem></varlistentry>
373
<varlistentry><term><parameter>has_chainbutton</parameter> :</term>
374
<listitem><simpara> Whether to add a chainbutton to the size entry.
375
</simpara></listitem></varlistentry>
376
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> widget.
379
</simpara></listitem></varlistentry>
380
</variablelist></refsect2>
381
<refsect2 id="gimp-prop-entry-new" role="function">
382
<title>gimp_prop_entry_new ()</title>
383
<indexterm zone="gimp-prop-entry-new"><primary sortas="gimp_prop_entry_new">gimp_prop_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_entry_new (<link linkend="GObject">GObject</link> *config,
384
const <link linkend="gchar">gchar</link> *property_name,
385
<link linkend="gint">gint</link> max_len);</programlisting>
387
Creates a <link linkend="GtkEntry"><type>GtkEntry</type></link> to set and display the value of the specified
388
string property.</para>
390
</para><variablelist role="params">
391
<varlistentry><term><parameter>config</parameter> :</term>
392
<listitem><simpara> Object to which property is attached.
393
</simpara></listitem></varlistentry>
394
<varlistentry><term><parameter>property_name</parameter> :</term>
395
<listitem><simpara> Name of string property.
396
</simpara></listitem></varlistentry>
397
<varlistentry><term><parameter>max_len</parameter> :</term>
398
<listitem><simpara> Maximum allowed length of string.
399
</simpara></listitem></varlistentry>
400
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkEntry"><type>GtkEntry</type></link> widget.
403
</simpara></listitem></varlistentry>
404
</variablelist></refsect2>
405
<refsect2 id="gimp-prop-enum-check-button-new" role="function">
406
<title>gimp_prop_enum_check_button_new ()</title>
407
<indexterm zone="gimp-prop-enum-check-button-new"><primary sortas="gimp_prop_enum_check_button_new">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,
408
const <link linkend="gchar">gchar</link> *property_name,
409
const <link linkend="gchar">gchar</link> *label,
410
<link linkend="gint">gint</link> false_value,
411
<link linkend="gint">gint</link> true_value);</programlisting>
413
Creates a <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> that displays and sets the specified
414
property of type Enum. Note that this widget only allows two values
415
for the enum, one corresponding to the "checked" state and the
416
other to the "unchecked" state.</para>
418
</para><variablelist role="params">
419
<varlistentry><term><parameter>config</parameter> :</term>
420
<listitem><simpara> Object to which property is attached.
421
</simpara></listitem></varlistentry>
422
<varlistentry><term><parameter>property_name</parameter> :</term>
423
<listitem><simpara> Name of enum property controlled by checkbutton.
424
</simpara></listitem></varlistentry>
425
<varlistentry><term><parameter>label</parameter> :</term>
426
<listitem><simpara> Label to give checkbutton (including mnemonic).
427
</simpara></listitem></varlistentry>
428
<varlistentry><term><parameter>false_value</parameter> :</term>
429
<listitem><simpara> Enum value corresponding to unchecked state.
430
</simpara></listitem></varlistentry>
431
<varlistentry><term><parameter>true_value</parameter> :</term>
432
<listitem><simpara> Enum value corresonding to checked state.
433
</simpara></listitem></varlistentry>
434
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GtkCheckButton"><type>GtkCheckButton</type></link> widget.
437
</simpara></listitem></varlistentry>
438
</variablelist></refsect2>
439
<refsect2 id="gimp-prop-enum-combo-box-new" role="function">
440
<title>gimp_prop_enum_combo_box_new ()</title>
441
<indexterm zone="gimp-prop-enum-combo-box-new"><primary sortas="gimp_prop_enum_combo_box_new">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,
442
const <link linkend="gchar">gchar</link> *property_name,
443
<link linkend="gint">gint</link> minimum,
444
<link linkend="gint">gint</link> maximum);</programlisting>
446
Creates a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> widget to display and set the specified
447
enum property. The <parameter>mimimum_value</parameter> and <parameter>maximum_value</parameter> give the
448
possibility of restricting the allowed range to a subset of the
449
enum. If the two values are equal (e.g., 0, 0), then the full
450
range of the Enum is used.</para>
452
</para><variablelist role="params">
453
<varlistentry><term><parameter>config</parameter> :</term>
454
<listitem><simpara> Object to which property is attached.
455
</simpara></listitem></varlistentry>
456
<varlistentry><term><parameter>property_name</parameter> :</term>
457
<listitem><simpara> Name of enum property controlled by combo box.
458
</simpara></listitem></varlistentry>
459
<varlistentry><term><parameter>minimum</parameter> :</term>
460
<listitem><simpara> Smallest allowed value of enum.
461
</simpara></listitem></varlistentry>
462
<varlistentry><term><parameter>maximum</parameter> :</term>
463
<listitem><simpara> Largest allowed value of enum.
464
</simpara></listitem></varlistentry>
465
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link> widget.
468
</simpara></listitem></varlistentry>
469
</variablelist></refsect2>
470
<refsect2 id="gimp-prop-enum-label-new" role="function">
471
<title>gimp_prop_enum_label_new ()</title>
472
<indexterm zone="gimp-prop-enum-label-new"><primary sortas="gimp_prop_enum_label_new">gimp_prop_enum_label_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_enum_label_new (<link linkend="GObject">GObject</link> *config,
473
const <link linkend="gchar">gchar</link> *property_name);</programlisting>
477
</para><variablelist role="params">
478
<varlistentry><term><parameter>config</parameter> :</term>
479
<listitem><simpara> Object to which property is attached.
480
</simpara></listitem></varlistentry>
481
<varlistentry><term><parameter>property_name</parameter> :</term>
482
<listitem><simpara> Name of enum property to be displayed.
483
</simpara></listitem></varlistentry>
484
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GimpEnumLabel"><type>GimpEnumLabel</type></link> widget.
487
</simpara></listitem></varlistentry>
488
</variablelist></refsect2>
489
<refsect2 id="gimp-prop-enum-radio-box-new" role="function">
490
<title>gimp_prop_enum_radio_box_new ()</title>
491
<indexterm zone="gimp-prop-enum-radio-box-new"><primary sortas="gimp_prop_enum_radio_box_new">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,
492
const <link linkend="gchar">gchar</link> *property_name,
493
<link linkend="gint">gint</link> minimum,
494
<link linkend="gint">gint</link> maximum);</programlisting>
496
Creates a group of radio buttons which function to set and display
497
the specified enum property. The <parameter>minimum</parameter> and <parameter>maximum</parameter> arguments
498
allow only a subset of the enum to be used. If the two arguments
499
are equal (e.g., 0, 0), then the full range of the enum will be used.
500
If you want to assign a label to the group of radio buttons, use
501
<link linkend="gimp-prop-enum-radio-frame-new"><function>gimp_prop_enum_radio_frame_new()</function></link> instead of this function.</para>
503
</para><variablelist role="params">
504
<varlistentry><term><parameter>config</parameter> :</term>
505
<listitem><simpara> Object to which property is attached.
506
</simpara></listitem></varlistentry>
507
<varlistentry><term><parameter>property_name</parameter> :</term>
508
<listitem><simpara> Name of enum property controlled by the radio buttons.
509
</simpara></listitem></varlistentry>
510
<varlistentry><term><parameter>minimum</parameter> :</term>
511
<listitem><simpara> Smallest value of enum to be included.
512
</simpara></listitem></varlistentry>
513
<varlistentry><term><parameter>maximum</parameter> :</term>
514
<listitem><simpara> Largest value of enum to be included.
515
</simpara></listitem></varlistentry>
516
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkVBox"><type>GtkVBox</type></link> containing the radio buttons.
519
</simpara></listitem></varlistentry>
520
</variablelist></refsect2>
521
<refsect2 id="gimp-prop-enum-radio-frame-new" role="function">
522
<title>gimp_prop_enum_radio_frame_new ()</title>
523
<indexterm zone="gimp-prop-enum-radio-frame-new"><primary sortas="gimp_prop_enum_radio_frame_new">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,
524
const <link linkend="gchar">gchar</link> *property_name,
525
const <link linkend="gchar">gchar</link> *title,
526
<link linkend="gint">gint</link> minimum,
527
<link linkend="gint">gint</link> maximum);</programlisting>
529
Creates a group of radio buttons which function to set and display
530
the specified enum property. The <parameter>minimum</parameter> and <parameter>maximum</parameter> arguments
531
allow only a subset of the enum to be used. If the two arguments
532
are equal (e.g., 0, 0), then the full range of the enum will be used.</para>
534
</para><variablelist role="params">
535
<varlistentry><term><parameter>config</parameter> :</term>
536
<listitem><simpara> Object to which property is attached.
537
</simpara></listitem></varlistentry>
538
<varlistentry><term><parameter>property_name</parameter> :</term>
539
<listitem><simpara> Name of enum property controlled by the radio buttons.
540
</simpara></listitem></varlistentry>
541
<varlistentry><term><parameter>title</parameter> :</term>
542
<listitem><simpara> Label for the frame holding the buttons
543
</simpara></listitem></varlistentry>
544
<varlistentry><term><parameter>minimum</parameter> :</term>
545
<listitem><simpara> Smallest value of enum to be included.
546
</simpara></listitem></varlistentry>
547
<varlistentry><term><parameter>maximum</parameter> :</term>
548
<listitem><simpara> Largest value of enum to be included.
549
</simpara></listitem></varlistentry>
550
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpFrame"><type>GimpFrame</type></link> containing the radio buttons.
553
</simpara></listitem></varlistentry>
554
</variablelist></refsect2>
555
<refsect2 id="gimp-prop-enum-stock-box-new" role="function">
556
<title>gimp_prop_enum_stock_box_new ()</title>
557
<indexterm zone="gimp-prop-enum-stock-box-new"><primary sortas="gimp_prop_enum_stock_box_new">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,
558
const <link linkend="gchar">gchar</link> *property_name,
559
const <link linkend="gchar">gchar</link> *stock_prefix,
560
<link linkend="gint">gint</link> minimum,
561
<link linkend="gint">gint</link> maximum);</programlisting>
563
Creates a horizontal box of radio buttons with stock icons, which
564
function to set and display the value of the specified Enum
565
property. The stock_id for each icon is created by appending the
566
enum_value's nick to the given <parameter>stock_prefix</parameter>. See
567
<link linkend="gimp-enum-stock-box-new"><function>gimp_enum_stock_box_new()</function></link> for more information.</para>
569
</para><variablelist role="params">
570
<varlistentry><term><parameter>config</parameter> :</term>
571
<listitem><simpara> Object to which property is attached.
572
</simpara></listitem></varlistentry>
573
<varlistentry><term><parameter>property_name</parameter> :</term>
574
<listitem><simpara> Name of enum property controlled by the radio buttons.
575
</simpara></listitem></varlistentry>
576
<varlistentry><term><parameter>stock_prefix</parameter> :</term>
577
<listitem><simpara> The prefix of the group of stock ids to use.
578
</simpara></listitem></varlistentry>
579
<varlistentry><term><parameter>minimum</parameter> :</term>
580
<listitem><simpara> Smallest value of enum to be included.
581
</simpara></listitem></varlistentry>
582
<varlistentry><term><parameter>maximum</parameter> :</term>
583
<listitem><simpara> Largest value of enum to be included.
584
</simpara></listitem></varlistentry>
585
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpEnumStockBox"><type>GimpEnumStockBox</type></link> containing the radio buttons.
588
</simpara></listitem></varlistentry>
589
</variablelist></refsect2>
590
<refsect2 id="gimp-prop-expander-new" role="function">
591
<title>gimp_prop_expander_new ()</title>
592
<indexterm zone="gimp-prop-expander-new"><primary sortas="gimp_prop_expander_new">gimp_prop_expander_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_expander_new (<link linkend="GObject">GObject</link> *config,
593
const <link linkend="gchar">gchar</link> *property_name,
594
const <link linkend="gchar">gchar</link> *label);</programlisting>
596
Creates a <link linkend="GtkExpander"><type>GtkExpander</type></link> controlled by the specified boolean property.
597
A value of <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> for the property corresponds to the expanded state
598
for the widget.</para>
600
</para><variablelist role="params">
601
<varlistentry><term><parameter>config</parameter> :</term>
602
<listitem><simpara> Object to which property is attached.
603
</simpara></listitem></varlistentry>
604
<varlistentry><term><parameter>property_name</parameter> :</term>
605
<listitem><simpara> Name of boolean property.
606
</simpara></listitem></varlistentry>
607
<varlistentry><term><parameter>label</parameter> :</term>
608
<listitem><simpara> Label for expander.
609
</simpara></listitem></varlistentry>
610
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkExpander"><type>GtkExpander</type></link> widget.
613
</simpara></listitem></varlistentry>
614
</variablelist></refsect2>
615
<refsect2 id="gimp-prop-file-chooser-button-new" role="function">
616
<title>gimp_prop_file_chooser_button_new ()</title>
617
<indexterm zone="gimp-prop-file-chooser-button-new"><primary sortas="gimp_prop_file_chooser_button_new">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,
618
const <link linkend="gchar">gchar</link> *property_name,
619
const <link linkend="gchar">gchar</link> *title,
620
<link linkend="GtkFileChooserAction">GtkFileChooserAction</link> action);</programlisting>
622
Creates a <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link> to edit the specified path property.
625
Note that <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link> implements the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link>
626
interface; you can use the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link> API with it.</para>
628
</para><variablelist role="params">
629
<varlistentry><term><parameter>config</parameter> :</term>
630
<listitem><simpara> object to which property is attached.
631
</simpara></listitem></varlistentry>
632
<varlistentry><term><parameter>property_name</parameter> :</term>
633
<listitem><simpara> name of path property.
634
</simpara></listitem></varlistentry>
635
<varlistentry><term><parameter>title</parameter> :</term>
636
<listitem><simpara> the title of the browse dialog.
637
</simpara></listitem></varlistentry>
638
<varlistentry><term><parameter>action</parameter> :</term>
639
<listitem><simpara> the open mode for the widget.
640
</simpara></listitem></varlistentry>
641
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link>.
644
</simpara></listitem></varlistentry>
645
</variablelist></refsect2>
646
<refsect2 id="gimp-prop-file-chooser-button-new-with-dialog" role="function">
647
<title>gimp_prop_file_chooser_button_new_with_dialog ()</title>
648
<indexterm zone="gimp-prop-file-chooser-button-new-with-dialog"><primary sortas="gimp_prop_file_chooser_button_new_with_dialog">gimp_prop_file_chooser_button_new_with_dialog</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_file_chooser_button_new_with_dialog
649
(<link linkend="GObject">GObject</link> *config,
650
const <link linkend="gchar">gchar</link> *property_name,
651
<link linkend="GtkWidget">GtkWidget</link> *dialog);</programlisting>
653
Creates a <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link> to edit the specified path property.
656
The button uses <parameter>dialog</parameter> as it's file-picking window. Note that <parameter>dialog</parameter>
657
must be a <link linkend="GtkFileChooserDialog"><type>GtkFileChooserDialog</type></link> (or subclass) and must not have
658
<link linkend="GTK-DIALOG-DESTROY-WITH-PARENT--CAPS"><literal>GTK_DIALOG_DESTROY_WITH_PARENT</literal></link> set.
661
Note that <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link> implements the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link>
662
interface; you can use the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link> API with it.</para>
664
</para><variablelist role="params">
665
<varlistentry><term><parameter>config</parameter> :</term>
666
<listitem><simpara> object to which property is attached.
667
</simpara></listitem></varlistentry>
668
<varlistentry><term><parameter>property_name</parameter> :</term>
669
<listitem><simpara> name of path property.
670
</simpara></listitem></varlistentry>
671
<varlistentry><term><parameter>dialog</parameter> :</term>
672
<listitem><simpara> the <link linkend="GtkFileChooserDialog"><type>GtkFileChooserDialog</type></link> widget to use.
673
</simpara></listitem></varlistentry>
674
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link>.
677
</simpara></listitem></varlistentry>
678
</variablelist></refsect2>
679
<refsect2 id="gimp-prop-hscale-new" role="function">
680
<title>gimp_prop_hscale_new ()</title>
681
<indexterm zone="gimp-prop-hscale-new"><primary sortas="gimp_prop_hscale_new">gimp_prop_hscale_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_hscale_new (<link linkend="GObject">GObject</link> *config,
682
const <link linkend="gchar">gchar</link> *property_name,
683
<link linkend="gdouble">gdouble</link> step_increment,
684
<link linkend="gdouble">gdouble</link> page_increment,
685
<link linkend="gint">gint</link> digits);</programlisting>
687
Creates a horizontal scale to control the value of the specified
688
integer or double property.</para>
690
</para><variablelist role="params">
691
<varlistentry><term><parameter>config</parameter> :</term>
692
<listitem><simpara> Object to which property is attached.
693
</simpara></listitem></varlistentry>
694
<varlistentry><term><parameter>property_name</parameter> :</term>
695
<listitem><simpara> Name of integer or double property controlled by the scale.
696
</simpara></listitem></varlistentry>
697
<varlistentry><term><parameter>step_increment</parameter> :</term>
698
<listitem><simpara> Step size.
699
</simpara></listitem></varlistentry>
700
<varlistentry><term><parameter>page_increment</parameter> :</term>
701
<listitem><simpara> Page size.
702
</simpara></listitem></varlistentry>
703
<varlistentry><term><parameter>digits</parameter> :</term>
704
<listitem><simpara> Number of digits after decimal point to display.
705
</simpara></listitem></varlistentry>
706
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkScale"><type>GtkScale</type></link>.
709
</simpara></listitem></varlistentry>
710
</variablelist></refsect2>
711
<refsect2 id="gimp-prop-int-combo-box-new" role="function">
712
<title>gimp_prop_int_combo_box_new ()</title>
713
<indexterm zone="gimp-prop-int-combo-box-new"><primary sortas="gimp_prop_int_combo_box_new">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,
714
const <link linkend="gchar">gchar</link> *property_name,
715
<link linkend="GimpIntStore">GimpIntStore</link> *store);</programlisting>
717
Creates a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> widget to display and set the specified
718
property. The contents of the widget are determined by <parameter>store</parameter>,
719
which should be created using <link linkend="gimp-int-store-new"><function>gimp_int_store_new()</function></link>.</para>
721
</para><variablelist role="params">
722
<varlistentry><term><parameter>config</parameter> :</term>
723
<listitem><simpara> Object to which property is attached.
724
</simpara></listitem></varlistentry>
725
<varlistentry><term><parameter>property_name</parameter> :</term>
726
<listitem><simpara> Name of int property controlled by combo box.
727
</simpara></listitem></varlistentry>
728
<varlistentry><term><parameter>store</parameter> :</term>
729
<listitem><simpara> <link linkend="GimpIntStore"><type>GimpIntStore</type></link> holding list of labels, values, etc.
730
</simpara></listitem></varlistentry>
731
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> widget.
734
</simpara></listitem></varlistentry>
735
</variablelist></refsect2>
736
<refsect2 id="gimp-prop-label-new" role="function">
737
<title>gimp_prop_label_new ()</title>
738
<indexterm zone="gimp-prop-label-new"><primary sortas="gimp_prop_label_new">gimp_prop_label_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_label_new (<link linkend="GObject">GObject</link> *config,
739
const <link linkend="gchar">gchar</link> *property_name);</programlisting>
741
Creates a <link linkend="GtkLabel"><type>GtkLabel</type></link> to display the value of the specified property.
742
The property should be a string property or at least transformable
743
to a string. If the user should be able to edit the string, use
744
<link linkend="gimp-prop-entry-new"><function>gimp_prop_entry_new()</function></link> instead.</para>
746
</para><variablelist role="params">
747
<varlistentry><term><parameter>config</parameter> :</term>
748
<listitem><simpara> Object to which property is attached.
749
</simpara></listitem></varlistentry>
750
<varlistentry><term><parameter>property_name</parameter> :</term>
751
<listitem><simpara> Name of string property.
752
</simpara></listitem></varlistentry>
753
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkLabel"><type>GtkLabel</type></link> widget.
756
</simpara></listitem></varlistentry>
757
</variablelist></refsect2>
758
<refsect2 id="gimp-prop-memsize-entry-new" role="function">
759
<title>gimp_prop_memsize_entry_new ()</title>
760
<indexterm zone="gimp-prop-memsize-entry-new"><primary sortas="gimp_prop_memsize_entry_new">gimp_prop_memsize_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_memsize_entry_new (<link linkend="GObject">GObject</link> *config,
761
const <link linkend="gchar">gchar</link> *property_name);</programlisting>
763
Creates a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link> (spin button and option menu) to set
764
and display the value of the specified memsize property. See
765
<link linkend="gimp-memsize-entry-new"><function>gimp_memsize_entry_new()</function></link> for more information.</para>
767
</para><variablelist role="params">
768
<varlistentry><term><parameter>config</parameter> :</term>
769
<listitem><simpara> Object to which property is attached.
770
</simpara></listitem></varlistentry>
771
<varlistentry><term><parameter>property_name</parameter> :</term>
772
<listitem><simpara> Name of memsize property.
773
</simpara></listitem></varlistentry>
774
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>.
777
</simpara></listitem></varlistentry>
778
</variablelist></refsect2>
779
<refsect2 id="gimp-prop-opacity-entry-new" role="function">
780
<title>gimp_prop_opacity_entry_new ()</title>
781
<indexterm zone="gimp-prop-opacity-entry-new"><primary sortas="gimp_prop_opacity_entry_new">gimp_prop_opacity_entry_new</primary></indexterm><programlisting><link linkend="GtkObject">GtkObject</link> * gimp_prop_opacity_entry_new (<link linkend="GObject">GObject</link> *config,
782
const <link linkend="gchar">gchar</link> *property_name,
783
<link linkend="GtkTable">GtkTable</link> *table,
784
<link linkend="gint">gint</link> column,
785
<link linkend="gint">gint</link> row,
786
const <link linkend="gchar">gchar</link> *label);</programlisting>
788
Creates a <link linkend="GimpScaleEntry"><type>GimpScaleEntry</type></link> (slider and spin button) to set and
789
display the value of the specified double property, which should
790
represent an "opacity" variable with range 0 to 100. See
791
<link linkend="gimp-scale-entry-new"><function>gimp_scale_entry_new()</function></link> for more information.</para>
793
</para><variablelist role="params">
794
<varlistentry><term><parameter>config</parameter> :</term>
795
<listitem><simpara> Object to which property is attached.
796
</simpara></listitem></varlistentry>
797
<varlistentry><term><parameter>property_name</parameter> :</term>
798
<listitem><simpara> Name of double property controlled by the spin button.
799
</simpara></listitem></varlistentry>
800
<varlistentry><term><parameter>table</parameter> :</term>
801
<listitem><simpara> The <link linkend="GtkTable"><type>GtkTable</type></link> the widgets will be attached to.
802
</simpara></listitem></varlistentry>
803
<varlistentry><term><parameter>column</parameter> :</term>
804
<listitem><simpara> The column to start with.
805
</simpara></listitem></varlistentry>
806
<varlistentry><term><parameter>row</parameter> :</term>
807
<listitem><simpara> The row to attach the widgets.
808
</simpara></listitem></varlistentry>
809
<varlistentry><term><parameter>label</parameter> :</term>
810
<listitem><simpara> The text for the <link linkend="GtkLabel"><type>GtkLabel</type></link> which will appear left of the
811
<link linkend="GtkHScale"><type>GtkHScale</type></link>.
812
</simpara></listitem></varlistentry>
813
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>'s <link linkend="GtkAdjustment"><type>GtkAdjustment</type></link>.
816
</simpara></listitem></varlistentry>
817
</variablelist></refsect2>
818
<refsect2 id="gimp-prop-path-editor-new" role="function">
819
<title>gimp_prop_path_editor_new ()</title>
820
<indexterm zone="gimp-prop-path-editor-new"><primary sortas="gimp_prop_path_editor_new">gimp_prop_path_editor_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_path_editor_new (<link linkend="GObject">GObject</link> *config,
821
const <link linkend="gchar">gchar</link> *path_property_name,
822
const <link linkend="gchar">gchar</link> *writable_property_name,
823
const <link linkend="gchar">gchar</link> *filesel_title);</programlisting>
825
</para><variablelist role="params">
826
<varlistentry><term><parameter>config</parameter> :</term>
828
</simpara></listitem></varlistentry>
829
<varlistentry><term><parameter>path_property_name</parameter> :</term>
831
</simpara></listitem></varlistentry>
832
<varlistentry><term><parameter>writable_property_name</parameter> :</term>
834
</simpara></listitem></varlistentry>
835
<varlistentry><term><parameter>filesel_title</parameter> :</term>
837
</simpara></listitem></varlistentry>
838
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
839
</simpara></listitem></varlistentry>
840
</variablelist></refsect2>
841
<refsect2 id="gimp-prop-scale-entry-new" role="function">
842
<title>gimp_prop_scale_entry_new ()</title>
843
<indexterm zone="gimp-prop-scale-entry-new"><primary sortas="gimp_prop_scale_entry_new">gimp_prop_scale_entry_new</primary></indexterm><programlisting><link linkend="GtkObject">GtkObject</link> * gimp_prop_scale_entry_new (<link linkend="GObject">GObject</link> *config,
844
const <link linkend="gchar">gchar</link> *property_name,
845
<link linkend="GtkTable">GtkTable</link> *table,
846
<link linkend="gint">gint</link> column,
847
<link linkend="gint">gint</link> row,
848
const <link linkend="gchar">gchar</link> *label,
849
<link linkend="gdouble">gdouble</link> step_increment,
850
<link linkend="gdouble">gdouble</link> page_increment,
851
<link linkend="gint">gint</link> digits,
852
<link linkend="gboolean">gboolean</link> limit_scale,
853
<link linkend="gdouble">gdouble</link> lower_limit,
854
<link linkend="gdouble">gdouble</link> upper_limit);</programlisting>
856
Creates a <link linkend="GimpScaleEntry"><type>GimpScaleEntry</type></link> (slider and spin button) to set and
857
display the value of the specified double property. See
858
<link linkend="gimp-scale-entry-new"><function>gimp_scale_entry_new()</function></link> for more information.</para>
860
</para><variablelist role="params">
861
<varlistentry><term><parameter>config</parameter> :</term>
862
<listitem><simpara> Object to which property is attached.
863
</simpara></listitem></varlistentry>
864
<varlistentry><term><parameter>property_name</parameter> :</term>
865
<listitem><simpara> Name of double property controlled by the spin button.
866
</simpara></listitem></varlistentry>
867
<varlistentry><term><parameter>table</parameter> :</term>
868
<listitem><simpara> The <link linkend="GtkTable"><type>GtkTable</type></link> the widgets will be attached to.
869
</simpara></listitem></varlistentry>
870
<varlistentry><term><parameter>column</parameter> :</term>
871
<listitem><simpara> The column to start with.
872
</simpara></listitem></varlistentry>
873
<varlistentry><term><parameter>row</parameter> :</term>
874
<listitem><simpara> The row to attach the widgets.
875
</simpara></listitem></varlistentry>
876
<varlistentry><term><parameter>label</parameter> :</term>
877
<listitem><simpara> The text for the <link linkend="GtkLabel"><type>GtkLabel</type></link> which will appear left of
878
the <link linkend="GtkHScale"><type>GtkHScale</type></link>.
879
</simpara></listitem></varlistentry>
880
<varlistentry><term><parameter>step_increment</parameter> :</term>
881
<listitem><simpara> Step size.
882
</simpara></listitem></varlistentry>
883
<varlistentry><term><parameter>page_increment</parameter> :</term>
884
<listitem><simpara> Page size.
885
</simpara></listitem></varlistentry>
886
<varlistentry><term><parameter>digits</parameter> :</term>
887
<listitem><simpara> Number of digits after decimal point to display.
888
</simpara></listitem></varlistentry>
889
<varlistentry><term><parameter>limit_scale</parameter> :</term>
890
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the range of possible values of the
891
GtkSpinButton should be the same as of the GtkHScale.
892
</simpara></listitem></varlistentry>
893
<varlistentry><term><parameter>lower_limit</parameter> :</term>
894
<listitem><simpara> The spinbutton's lower boundary if <parameter>limit_scale</parameter> is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>.
895
</simpara></listitem></varlistentry>
896
<varlistentry><term><parameter>upper_limit</parameter> :</term>
897
<listitem><simpara> The spinbutton's upper boundary if <parameter>limit_scale</parameter> is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>.
898
</simpara></listitem></varlistentry>
899
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>'s <link linkend="GtkAdjustment"><type>GtkAdjustment</type></link>.
902
</simpara></listitem></varlistentry>
903
</variablelist></refsect2>
904
<refsect2 id="gimp-prop-size-entry-new" role="function">
905
<title>gimp_prop_size_entry_new ()</title>
906
<indexterm zone="gimp-prop-size-entry-new"><primary sortas="gimp_prop_size_entry_new">gimp_prop_size_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_size_entry_new (<link linkend="GObject">GObject</link> *config,
907
const <link linkend="gchar">gchar</link> *property_name,
908
<link linkend="gboolean">gboolean</link> property_is_pixel,
909
const <link linkend="gchar">gchar</link> *unit_property_name,
910
const <link linkend="gchar">gchar</link> *unit_format,
911
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy,
912
<link linkend="gdouble">gdouble</link> resolution);</programlisting>
914
Creates a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> to set and display the specified double or
915
int property, and its associated unit property. Note that this
916
function is only suitable for creating a size entry holding a
917
single value. Use <link linkend="gimp-prop-coordinates-new"><function>gimp_prop_coordinates_new()</function></link> to create a size
918
entry holding two values.</para>
920
</para><variablelist role="params">
921
<varlistentry><term><parameter>config</parameter> :</term>
922
<listitem><simpara> Object to which property is attached.
923
</simpara></listitem></varlistentry>
924
<varlistentry><term><parameter>property_name</parameter> :</term>
925
<listitem><simpara> Name of int or double property.
926
</simpara></listitem></varlistentry>
927
<varlistentry><term><parameter>property_is_pixel</parameter> :</term>
928
<listitem><simpara> When <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, the property value is in pixels,
929
and in the selected unit otherwise.
930
</simpara></listitem></varlistentry>
931
<varlistentry><term><parameter>unit_property_name</parameter> :</term>
932
<listitem><simpara> Name of unit property.
933
</simpara></listitem></varlistentry>
934
<varlistentry><term><parameter>unit_format</parameter> :</term>
935
<listitem><simpara> A printf-like unit-format string as is used with
936
<link linkend="gimp-unit-menu-new"><function>gimp_unit_menu_new()</function></link>.
937
</simpara></listitem></varlistentry>
938
<varlistentry><term><parameter>update_policy</parameter> :</term>
939
<listitem><simpara> How the automatic pixel <-> real-world-unit
940
calculations should be done.
941
</simpara></listitem></varlistentry>
942
<varlistentry><term><parameter>resolution</parameter> :</term>
943
<listitem><simpara> The resolution (in dpi) for the field.
944
</simpara></listitem></varlistentry>
945
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> widget.
948
</simpara></listitem></varlistentry>
949
</variablelist></refsect2>
950
<refsect2 id="gimp-prop-spin-button-new" role="function">
951
<title>gimp_prop_spin_button_new ()</title>
952
<indexterm zone="gimp-prop-spin-button-new"><primary sortas="gimp_prop_spin_button_new">gimp_prop_spin_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_spin_button_new (<link linkend="GObject">GObject</link> *config,
953
const <link linkend="gchar">gchar</link> *property_name,
954
<link linkend="gdouble">gdouble</link> step_increment,
955
<link linkend="gdouble">gdouble</link> page_increment,
956
<link linkend="gint">gint</link> digits);</programlisting>
958
Creates a spin button to set and display the value of the
959
specified double property.</para>
961
</para><variablelist role="params">
962
<varlistentry><term><parameter>config</parameter> :</term>
963
<listitem><simpara> Object to which property is attached.
964
</simpara></listitem></varlistentry>
965
<varlistentry><term><parameter>property_name</parameter> :</term>
966
<listitem><simpara> Name of double property controlled by the spin button.
967
</simpara></listitem></varlistentry>
968
<varlistentry><term><parameter>step_increment</parameter> :</term>
969
<listitem><simpara> Step size.
970
</simpara></listitem></varlistentry>
971
<varlistentry><term><parameter>page_increment</parameter> :</term>
972
<listitem><simpara> Page size.
973
</simpara></listitem></varlistentry>
974
<varlistentry><term><parameter>digits</parameter> :</term>
975
<listitem><simpara> Number of digits after decimal point to display.
976
</simpara></listitem></varlistentry>
977
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpSpinButton"><type>GimpSpinButton</type></link>.
980
</simpara></listitem></varlistentry>
981
</variablelist></refsect2>
982
<refsect2 id="gimp-prop-stock-image-new" role="function">
983
<title>gimp_prop_stock_image_new ()</title>
984
<indexterm zone="gimp-prop-stock-image-new"><primary sortas="gimp_prop_stock_image_new">gimp_prop_stock_image_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_stock_image_new (<link linkend="GObject">GObject</link> *config,
985
const <link linkend="gchar">gchar</link> *property_name,
986
<link linkend="GtkIconSize">GtkIconSize</link> icon_size);</programlisting>
988
Creates a widget to display a stock image representing the value of the
989
specified string property, which should encode a Stock ID.
990
See <link linkend="gtk-image-new-from-stock"><function>gtk_image_new_from_stock()</function></link> for more information.</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 string property.
998
</simpara></listitem></varlistentry>
999
<varlistentry><term><parameter>icon_size</parameter> :</term>
1000
<listitem><simpara> Size of desired stock image.
1001
</simpara></listitem></varlistentry>
1002
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkImage"><type>GtkImage</type></link> widget.
1005
</simpara></listitem></varlistentry>
1006
</variablelist></refsect2>
1007
<refsect2 id="gimp-prop-string-combo-box-new" role="function">
1008
<title>gimp_prop_string_combo_box_new ()</title>
1009
<indexterm zone="gimp-prop-string-combo-box-new"><primary sortas="gimp_prop_string_combo_box_new">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,
1010
const <link linkend="gchar">gchar</link> *property_name,
1011
<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
1012
<link linkend="gint">gint</link> id_column,
1013
<link linkend="gint">gint</link> label_column);</programlisting>
1015
Creates a <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link> widget to display and set the
1016
specified property. The contents of the widget are determined by
1017
<parameter>store</parameter>.</para>
1019
</para><variablelist role="params">
1020
<varlistentry><term><parameter>config</parameter> :</term>
1021
<listitem><simpara> Object to which property is attached.
1022
</simpara></listitem></varlistentry>
1023
<varlistentry><term><parameter>property_name</parameter> :</term>
1024
<listitem><simpara> Name of int property controlled by combo box.
1025
</simpara></listitem></varlistentry>
1026
<varlistentry><term><parameter>model</parameter> :</term>
1027
<listitem><simpara> <link linkend="GtkTreeStore"><type>GtkTreeStore</type></link> holding list of values
1028
</simpara></listitem></varlistentry>
1029
<varlistentry><term><parameter>id_column</parameter> :</term>
1030
<listitem><simpara> column in <parameter>store</parameter> that holds string IDs
1031
</simpara></listitem></varlistentry>
1032
<varlistentry><term><parameter>label_column</parameter> :</term>
1033
<listitem><simpara> column in <parameter>store</parameter> that holds labels to use in the combo-box
1034
</simpara></listitem></varlistentry>
1035
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link> widget.
1038
</simpara></listitem></varlistentry>
1039
</variablelist></refsect2>
1040
<refsect2 id="gimp-prop-text-buffer-new" role="function">
1041
<title>gimp_prop_text_buffer_new ()</title>
1042
<indexterm zone="gimp-prop-text-buffer-new"><primary sortas="gimp_prop_text_buffer_new">gimp_prop_text_buffer_new</primary></indexterm><programlisting><link linkend="GtkTextBuffer">GtkTextBuffer</link> * gimp_prop_text_buffer_new (<link linkend="GObject">GObject</link> *config,
1043
const <link linkend="gchar">gchar</link> *property_name,
1044
<link linkend="gint">gint</link> max_len);</programlisting>
1046
Creates a <link linkend="GtkTextBuffer"><type>GtkTextBuffer</type></link> to set and display the value of the
1047
specified string property. Unless the string is expected to
1048
contain multiple lines or a large amount of text, use
1049
<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
1050
how to insert a text buffer into a visible widget.
1053
If <parameter>max_len</parameter> is 0 or negative, the text buffer allows an unlimited
1054
number of characters to be entered.</para>
1056
</para><variablelist role="params">
1057
<varlistentry><term><parameter>config</parameter> :</term>
1058
<listitem><simpara> Object to which property is attached.
1059
</simpara></listitem></varlistentry>
1060
<varlistentry><term><parameter>property_name</parameter> :</term>
1061
<listitem><simpara> Name of string property.
1062
</simpara></listitem></varlistentry>
1063
<varlistentry><term><parameter>max_len</parameter> :</term>
1064
<listitem><simpara> Maximum allowed length of text (in characters).
1065
</simpara></listitem></varlistentry>
1066
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GtkTextBuffer"><type>GtkTextBuffer</type></link>.
1069
</simpara></listitem></varlistentry>
1070
</variablelist></refsect2>
1071
<refsect2 id="gimp-prop-unit-menu-new" role="function">
1072
<title>gimp_prop_unit_menu_new ()</title>
1073
<indexterm zone="gimp-prop-unit-menu-new"><primary sortas="gimp_prop_unit_menu_new">gimp_prop_unit_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_prop_unit_menu_new (<link linkend="GObject">GObject</link> *config,
1074
const <link linkend="gchar">gchar</link> *property_name,
1075
const <link linkend="gchar">gchar</link> *unit_format);</programlisting>
1077
Creates a <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> to set and display the value of a Unit
1078
property. See <link linkend="gimp-unit-menu-new"><function>gimp_unit_menu_new()</function></link> for more information.</para>
1080
</para><variablelist role="params">
1081
<varlistentry><term><parameter>config</parameter> :</term>
1082
<listitem><simpara> Object to which property is attached.
1083
</simpara></listitem></varlistentry>
1084
<varlistentry><term><parameter>property_name</parameter> :</term>
1085
<listitem><simpara> Name of Unit property.
1086
</simpara></listitem></varlistentry>
1087
<varlistentry><term><parameter>unit_format</parameter> :</term>
1088
<listitem><simpara> A printf-like format string which is used to create
1090
</simpara></listitem></varlistentry>
1091
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> widget.
1094
</simpara></listitem></varlistentry>
1095
</variablelist></refsect2>
added
removed
devel-docs/libgimpwidgets/xml/gimppropwidgets.xml
