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