← Back to branch summary

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

« back to all changes in this revision

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

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpsizeentry.xml
12
12
<refnamediv>
13
13
<refname>GimpSizeEntry</refname>
14
14
<refpurpose>Widget for entering pixel values and resolutions.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpSizeEntry.synopsis" role="synopsis">
22
21
                    <link linkend="GimpSizeEntry-struct">GimpSizeEntry</link>;
23
22
                    <link linkend="GimpSizeEntryField">GimpSizeEntryField</link>;
24
23
enum                <link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link>;
25
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-size-entry-new">gimp_size_entry_new</link>                 (<link linkend="gint">gint</link> number_of_fields,
 
24
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-size-entry-new">gimp_size_entry_new</link>                 (<link linkend="gint">gint</link> number_of_fields,
26
25
                                                         <link linkend="GimpUnit">GimpUnit</link> unit,
27
26
                                                         const <link linkend="gchar">gchar</link> *unit_format,
28
27
                                                         <link linkend="gboolean">gboolean</link> menu_show_pixels,
33
32
<link linkend="void">void</link>                <link linkend="gimp-size-entry-add-field">gimp_size_entry_add_field</link>           (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
34
33
                                                         <link linkend="GtkSpinButton">GtkSpinButton</link> *value_spinbutton,
35
34
                                                         <link linkend="GtkSpinButton">GtkSpinButton</link> *refval_spinbutton);
36
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-size-entry-attach-label">gimp_size_entry_attach_label</link>        (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
35
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-size-entry-attach-label">gimp_size_entry_attach_label</link>        (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
37
36
                                                         const <link linkend="gchar">gchar</link> *text,
38
37
                                                         <link linkend="gint">gint</link> row,
39
38
                                                         <link linkend="gint">gint</link> column,
80
79
<link linkend="void">void</link>                <link linkend="gimp-size-entry-set-activates-default">gimp_size_entry_set_activates_default</link>
81
80
                                                        (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
82
81
                                                         <link linkend="gboolean">gboolean</link> setting);
83
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-size-entry-get-help-widget">gimp_size_entry_get_help_widget</link>     (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
82
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-size-entry-get-help-widget">gimp_size_entry_get_help_widget</link>     (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
84
83
                                                         <link linkend="gint">gint</link> field);
85
84
</synopsis>
86
85
</refsynopsisdiv>
96
95
                           +----<link linkend="GtkTable">GtkTable</link>
97
96
                                 +----GimpSizeEntry
98
97
</synopsis>
99
 
 
100
98
</refsect1>
101
99
 
102
100
 
105
103
<title role="impl_interfaces.title">Implemented Interfaces</title>
106
104
<para>
107
105
GimpSizeEntry implements
108
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
109
 
 
 
106
 <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
110
107
</refsect1>
111
108
 
112
109
 
137
134
</para>
138
135
<para>
139
136
For each field, there can be one or two <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>'s to enter
140
 
"value" and "reference value". If you specify <parameter>show_refval</parameter> as <link linkend="FALSE:CAPS"><type>FALSE</type></link>
 
137
"value" and "reference value". If you specify <parameter>show_refval</parameter> as <link linkend="FALSE--CAPS"><type>FALSE</type></link>
141
138
in <link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> there will be only one <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> and the
142
139
<link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> will contain an item for selecting GIMP_UNIT_PIXEL.
143
140
</para>
154
151
<title role="details.title">Details</title>
155
152
<refsect2 id="GimpSizeEntry-struct" role="struct">
156
153
<title>GimpSizeEntry</title>
157
 
<indexterm zone="GimpSizeEntry-struct"><primary>GimpSizeEntry</primary></indexterm><programlisting>typedef struct _GimpSizeEntry GimpSizeEntry;</programlisting>
 
154
<indexterm zone="GimpSizeEntry-struct"><primary sortas="GimpSizeEntry">GimpSizeEntry</primary></indexterm><programlisting>typedef struct _GimpSizeEntry GimpSizeEntry;</programlisting>
158
155
<para>
159
 
 
160
156
</para></refsect2>
161
157
<refsect2 id="GimpSizeEntryField" role="struct">
162
158
<title>GimpSizeEntryField</title>
163
 
<indexterm zone="GimpSizeEntryField"><primary>GimpSizeEntryField</primary></indexterm><programlisting>typedef struct _GimpSizeEntryField GimpSizeEntryField;</programlisting>
 
159
<indexterm zone="GimpSizeEntryField"><primary sortas="GimpSizeEntryField">GimpSizeEntryField</primary></indexterm><programlisting>typedef struct _GimpSizeEntryField GimpSizeEntryField;</programlisting>
164
160
<para>
165
 
 
166
161
</para></refsect2>
167
162
<refsect2 id="GimpSizeEntryUpdatePolicy" role="enum">
168
163
<title>enum GimpSizeEntryUpdatePolicy</title>
169
 
<indexterm zone="GimpSizeEntryUpdatePolicy"><primary>GimpSizeEntryUpdatePolicy</primary></indexterm><programlisting>typedef enum
 
164
<indexterm zone="GimpSizeEntryUpdatePolicy"><primary sortas="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</primary></indexterm><programlisting>typedef enum
170
165
{
171
166
  GIMP_SIZE_ENTRY_UPDATE_NONE       = 0,
172
167
  GIMP_SIZE_ENTRY_UPDATE_SIZE       = 1,
174
169
} GimpSizeEntryUpdatePolicy;
175
170
</programlisting>
176
171
<para>
177
 
 
178
172
</para></refsect2>
179
173
<refsect2 id="gimp-size-entry-new" role="function">
180
174
<title>gimp_size_entry_new ()</title>
181
 
<indexterm zone="gimp-size-entry-new"><primary>gimp_size_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_size_entry_new                 (<link linkend="gint">gint</link> number_of_fields,
 
175
<indexterm zone="gimp-size-entry-new"><primary sortas="gimp_size_entry_new">gimp_size_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_size_entry_new                 (<link linkend="gint">gint</link> number_of_fields,
182
176
                                                         <link linkend="GimpUnit">GimpUnit</link> unit,
183
177
                                                         const <link linkend="gchar">gchar</link> *unit_format,
184
178
                                                         <link linkend="gboolean">gboolean</link> menu_show_pixels,
224
218
of the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> to allow the caller to add labels or a
225
219
<link linkend="GimpChainButton"><type>GimpChainButton</type></link>.</para>
226
220
<para>
227
 
 
228
221
</para><variablelist role="params">
229
 
<varlistentry><term><parameter>number_of_fields</parameter>&nbsp;:</term>
 
222
<varlistentry><term><parameter>number_of_fields</parameter>&#160;:</term>
230
223
<listitem><simpara>  The number of input fields.
231
224
</simpara></listitem></varlistentry>
232
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
225
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
233
226
<listitem><simpara>              The initial unit.
234
227
</simpara></listitem></varlistentry>
235
 
<varlistentry><term><parameter>unit_format</parameter>&nbsp;:</term>
 
228
<varlistentry><term><parameter>unit_format</parameter>&#160;:</term>
236
229
<listitem><simpara>       A printf-like unit-format string as is used with
237
230
                    <link linkend="gimp-unit-menu-new"><function>gimp_unit_menu_new()</function></link>.
238
231
</simpara></listitem></varlistentry>
239
 
<varlistentry><term><parameter>menu_show_pixels</parameter>&nbsp;:</term>
240
 
<listitem><simpara>  <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the unit menu shold contain an item for
 
232
<varlistentry><term><parameter>menu_show_pixels</parameter>&#160;:</term>
 
233
<listitem><simpara>  <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the unit menu shold contain an item for
241
234
                    GIMP_UNIT_PIXEL (ignored if the <parameter>update_policy</parameter> is not
242
235
                    GIMP_SIZE_ENTRY_UPDATE_NONE).
243
236
</simpara></listitem></varlistentry>
244
 
<varlistentry><term><parameter>menu_show_percent</parameter>&nbsp;:</term>
245
 
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the unit menu shold contain an item for
 
237
<varlistentry><term><parameter>menu_show_percent</parameter>&#160;:</term>
 
238
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the unit menu shold contain an item for
246
239
                    GIMP_UNIT_PERCENT.
247
240
</simpara></listitem></varlistentry>
248
 
<varlistentry><term><parameter>show_refval</parameter>&nbsp;:</term>
249
 
<listitem><simpara>       <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if you want an extra "reference value"
 
241
<varlistentry><term><parameter>show_refval</parameter>&#160;:</term>
 
242
<listitem><simpara>       <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if you want an extra "reference value"
250
243
                    spinbutton per input field.
251
244
</simpara></listitem></varlistentry>
252
 
<varlistentry><term><parameter>spinbutton_width</parameter>&nbsp;:</term>
 
245
<varlistentry><term><parameter>spinbutton_width</parameter>&#160;:</term>
253
246
<listitem><simpara>  The minimal horizontal size of the <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>'s.
254
247
</simpara></listitem></varlistentry>
255
 
<varlistentry><term><parameter>update_policy</parameter>&nbsp;:</term>
 
248
<varlistentry><term><parameter>update_policy</parameter>&#160;:</term>
256
249
<listitem><simpara>     How the automatic pixel &lt;-> real-world-unit
257
250
                    calculations should be done.
258
251
</simpara></listitem></varlistentry>
259
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A Pointer to the new <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> widget.
 
252
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A Pointer to the new <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> widget.
260
253
</simpara></listitem></varlistentry>
261
254
</variablelist></refsect2>
262
255
<refsect2 id="gimp-size-entry-add-field" role="function">
263
256
<title>gimp_size_entry_add_field ()</title>
264
 
<indexterm zone="gimp-size-entry-add-field"><primary>gimp_size_entry_add_field</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_add_field           (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
257
<indexterm zone="gimp-size-entry-add-field"><primary sortas="gimp_size_entry_add_field">gimp_size_entry_add_field</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_add_field           (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
265
258
                                                         <link linkend="GtkSpinButton">GtkSpinButton</link> *value_spinbutton,
266
259
                                                         <link linkend="GtkSpinButton">GtkSpinButton</link> *refval_spinbutton);</programlisting>
267
260
<para>
269
262
</para>
270
263
<para>
271
264
The new input field will have the index 0. If you specified <parameter>show_refval</parameter>
272
 
as <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> in <link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> you have to pass an additional
273
 
<link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> to hold the reference value. If <parameter>show_refval</parameter> was <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>,
 
265
as <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> in <link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> you have to pass an additional
 
266
<link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> to hold the reference value. If <parameter>show_refval</parameter> was <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>,
274
267
<parameter>refval_spinbutton</parameter> will be ignored.</para>
275
268
<para>
276
 
 
277
269
</para><variablelist role="params">
278
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
270
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
279
271
<listitem><simpara>               The sizeentry you want to add a field to.
280
272
</simpara></listitem></varlistentry>
281
 
<varlistentry><term><parameter>value_spinbutton</parameter>&nbsp;:</term>
 
273
<varlistentry><term><parameter>value_spinbutton</parameter>&#160;:</term>
282
274
<listitem><simpara>  The spinbutton to display the field's value.
283
275
</simpara></listitem></varlistentry>
284
 
<varlistentry><term><parameter>refval_spinbutton</parameter>&nbsp;:</term>
 
276
<varlistentry><term><parameter>refval_spinbutton</parameter>&#160;:</term>
285
277
<listitem><simpara> The spinbutton to display the field's reference value.
286
278
</simpara></listitem></varlistentry>
287
279
</variablelist></refsect2>
288
280
<refsect2 id="gimp-size-entry-attach-label" role="function">
289
281
<title>gimp_size_entry_attach_label ()</title>
290
 
<indexterm zone="gimp-size-entry-attach-label"><primary>gimp_size_entry_attach_label</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_size_entry_attach_label        (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
282
<indexterm zone="gimp-size-entry-attach-label"><primary sortas="gimp_size_entry_attach_label">gimp_size_entry_attach_label</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_size_entry_attach_label        (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
291
283
                                                         const <link linkend="gchar">gchar</link> *text,
292
284
                                                         <link linkend="gint">gint</link> row,
293
285
                                                         <link linkend="gint">gint</link> column,
295
287
<para>
296
288
Attaches a <link linkend="GtkLabel"><type>GtkLabel</type></link> to the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> (which is a <link linkend="GtkTable"><type>GtkTable</type></link>).</para>
297
289
<para>
298
 
 
299
290
</para><variablelist role="params">
300
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
291
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
301
292
<listitem><simpara>       The sizeentry you want to add a label to.
302
293
</simpara></listitem></varlistentry>
303
 
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
 
294
<varlistentry><term><parameter>text</parameter>&#160;:</term>
304
295
<listitem><simpara>      The text of the label.
305
296
</simpara></listitem></varlistentry>
306
 
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
 
297
<varlistentry><term><parameter>row</parameter>&#160;:</term>
307
298
<listitem><simpara>       The row where the label will be attached.
308
299
</simpara></listitem></varlistentry>
309
 
<varlistentry><term><parameter>column</parameter>&nbsp;:</term>
 
300
<varlistentry><term><parameter>column</parameter>&#160;:</term>
310
301
<listitem><simpara>    The column where the label will be attached.
311
302
</simpara></listitem></varlistentry>
312
 
<varlistentry><term><parameter>alignment</parameter>&nbsp;:</term>
 
303
<varlistentry><term><parameter>alignment</parameter>&#160;:</term>
313
304
<listitem><simpara> The horizontal alignment of the label.
314
305
</simpara></listitem></varlistentry>
315
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GtkLabel"><type>GtkLabel</type></link> widget.
 
306
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GtkLabel"><type>GtkLabel</type></link> widget.
316
307
</simpara></listitem></varlistentry>
317
308
</variablelist></refsect2>
318
309
<refsect2 id="gimp-size-entry-set-resolution" role="function">
319
310
<title>gimp_size_entry_set_resolution ()</title>
320
 
<indexterm zone="gimp-size-entry-set-resolution"><primary>gimp_size_entry_set_resolution</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_resolution      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
311
<indexterm zone="gimp-size-entry-set-resolution"><primary sortas="gimp_size_entry_set_resolution">gimp_size_entry_set_resolution</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_resolution      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
321
312
                                                         <link linkend="gint">gint</link> field,
322
313
                                                         <link linkend="gdouble">gdouble</link> resolution,
323
314
                                                         <link linkend="gboolean">gboolean</link> keep_size);</programlisting>
326
317
</para>
327
318
<para>
328
319
The <parameter>resolution</parameter> passed will be clamped to fit in
329
 
[<link linkend="GIMP-MIN-RESOLUTION:CAPS"><type>GIMP_MIN_RESOLUTION</type></link>..<link linkend="GIMP-MAX-RESOLUTION:CAPS"><type>GIMP_MAX_RESOLUTION</type></link>].
 
320
[<link linkend="GIMP-MIN-RESOLUTION--CAPS"><type>GIMP_MIN_RESOLUTION</type></link>..<link linkend="GIMP-MAX-RESOLUTION--CAPS"><type>GIMP_MAX_RESOLUTION</type></link>].
330
321
</para>
331
322
<para>
332
323
This function does nothing if the <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> specified in
333
 
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> doesn't equal to <link linkend="GIMP-SIZE-ENTRY-UPDATE-SIZE:CAPS"><type>GIMP_SIZE_ENTRY_UPDATE_SIZE</type></link>.</para>
 
324
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> doesn't equal to <link linkend="GIMP-SIZE-ENTRY-UPDATE-SIZE--CAPS"><type>GIMP_SIZE_ENTRY_UPDATE_SIZE</type></link>.</para>
334
325
<para>
335
 
 
336
326
</para><variablelist role="params">
337
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
327
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
338
328
<listitem><simpara>        The sizeentry you want to set a resolution for.
339
329
</simpara></listitem></varlistentry>
340
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
330
<varlistentry><term><parameter>field</parameter>&#160;:</term>
341
331
<listitem><simpara>      The index of the field you want to set the resolution for.
342
332
</simpara></listitem></varlistentry>
343
 
<varlistentry><term><parameter>resolution</parameter>&nbsp;:</term>
 
333
<varlistentry><term><parameter>resolution</parameter>&#160;:</term>
344
334
<listitem><simpara> The new resolution (in dpi) for the chosen <parameter>field</parameter>.
345
335
</simpara></listitem></varlistentry>
346
 
<varlistentry><term><parameter>keep_size</parameter>&nbsp;:</term>
347
 
<listitem><simpara>  <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the <parameter>field</parameter>'s size in pixels should stay the same.
348
 
             <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if the <parameter>field</parameter>'s size in units should stay the same.
 
336
<varlistentry><term><parameter>keep_size</parameter>&#160;:</term>
 
337
<listitem><simpara>  <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the <parameter>field</parameter>'s size in pixels should stay the same.
 
338
             <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if the <parameter>field</parameter>'s size in units should stay the same.
349
339
</simpara></listitem></varlistentry>
350
340
</variablelist></refsect2>
351
341
<refsect2 id="gimp-size-entry-set-size" role="function">
352
342
<title>gimp_size_entry_set_size ()</title>
353
 
<indexterm zone="gimp-size-entry-set-size"><primary>gimp_size_entry_set_size</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_size            (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
343
<indexterm zone="gimp-size-entry-set-size"><primary sortas="gimp_size_entry_set_size">gimp_size_entry_set_size</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_size            (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
354
344
                                                         <link linkend="gint">gint</link> field,
355
345
                                                         <link linkend="gdouble">gdouble</link> lower,
356
346
                                                         <link linkend="gdouble">gdouble</link> upper);</programlisting>
359
349
which will be treated as 0% and 100%.
360
350
</para>
361
351
<para>
362
 
These values will be used if you specified <parameter>menu_show_percent</parameter> as <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>
 
352
These values will be used if you specified <parameter>menu_show_percent</parameter> as <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>
363
353
in <link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> and the user has selected GIMP_UNIT_PERCENT in
364
354
the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
365
355
</para>
367
357
This function does nothing if the <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> specified in
368
358
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> doesn't equal to GIMP_SIZE_ENTRY_UPDATE_SIZE.</para>
369
359
<para>
370
 
 
371
360
</para><variablelist role="params">
372
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
361
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
373
362
<listitem><simpara>   The sizeentry you want to set a size for.
374
363
</simpara></listitem></varlistentry>
375
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
364
<varlistentry><term><parameter>field</parameter>&#160;:</term>
376
365
<listitem><simpara> The index of the field you want to set the size for.
377
366
</simpara></listitem></varlistentry>
378
 
<varlistentry><term><parameter>lower</parameter>&nbsp;:</term>
 
367
<varlistentry><term><parameter>lower</parameter>&#160;:</term>
379
368
<listitem><simpara> The reference value which will be treated as 0%.
380
369
</simpara></listitem></varlistentry>
381
 
<varlistentry><term><parameter>upper</parameter>&nbsp;:</term>
 
370
<varlistentry><term><parameter>upper</parameter>&#160;:</term>
382
371
<listitem><simpara> The reference value which will be treated as 100%.
383
372
</simpara></listitem></varlistentry>
384
373
</variablelist></refsect2>
385
374
<refsect2 id="gimp-size-entry-set-value-boundaries" role="function">
386
375
<title>gimp_size_entry_set_value_boundaries ()</title>
387
 
<indexterm zone="gimp-size-entry-set-value-boundaries"><primary>gimp_size_entry_set_value_boundaries</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_value_boundaries
 
376
<indexterm zone="gimp-size-entry-set-value-boundaries"><primary sortas="gimp_size_entry_set_value_boundaries">gimp_size_entry_set_value_boundaries</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_value_boundaries
388
377
                                                        (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
389
378
                                                         <link linkend="gint">gint</link> field,
390
379
                                                         <link linkend="gdouble">gdouble</link> lower,
404
393
      Whatever you do, don't mix these calls. A size entry should either
405
394
      be clamped by the value or the reference value.</para>
406
395
<para>
407
 
 
408
396
</para><variablelist role="params">
409
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
397
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
410
398
<listitem><simpara>   The sizeentry you want to set value boundaries for.
411
399
</simpara></listitem></varlistentry>
412
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
400
<varlistentry><term><parameter>field</parameter>&#160;:</term>
413
401
<listitem><simpara> The index of the field you want to set value boundaries for.
414
402
</simpara></listitem></varlistentry>
415
 
<varlistentry><term><parameter>lower</parameter>&nbsp;:</term>
 
403
<varlistentry><term><parameter>lower</parameter>&#160;:</term>
416
404
<listitem><simpara> The new lower boundary of the value of the chosen <parameter>field</parameter>.
417
405
</simpara></listitem></varlistentry>
418
 
<varlistentry><term><parameter>upper</parameter>&nbsp;:</term>
 
406
<varlistentry><term><parameter>upper</parameter>&#160;:</term>
419
407
<listitem><simpara> The new upper boundary of the value of the chosen <parameter>field</parameter>.
420
408
</simpara></listitem></varlistentry>
421
409
</variablelist></refsect2>
422
410
<refsect2 id="gimp-size-entry-get-value" role="function">
423
411
<title>gimp_size_entry_get_value ()</title>
424
 
<indexterm zone="gimp-size-entry-get-value"><primary>gimp_size_entry_get_value</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_size_entry_get_value           (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
412
<indexterm zone="gimp-size-entry-get-value"><primary sortas="gimp_size_entry_get_value">gimp_size_entry_get_value</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_size_entry_get_value           (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
425
413
                                                         <link linkend="gint">gint</link> field);</programlisting>
426
414
<para>
427
415
Returns the value of field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
436
424
      <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s purpose is to shield the programmer from unit
437
425
      calculations. Use <link linkend="gimp-size-entry-get-refval"><function>gimp_size_entry_get_refval()</function></link> instead.</para>
438
426
<para>
439
 
 
440
427
</para><variablelist role="params">
441
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
428
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
442
429
<listitem><simpara>   The sizeentry you want to know a value of.
443
430
</simpara></listitem></varlistentry>
444
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
431
<varlistentry><term><parameter>field</parameter>&#160;:</term>
445
432
<listitem><simpara> The index of the field you want to know the value of.
446
433
</simpara></listitem></varlistentry>
447
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of the chosen <parameter>field</parameter>.
 
434
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The value of the chosen <parameter>field</parameter>.
448
435
</simpara></listitem></varlistentry>
449
436
</variablelist></refsect2>
450
437
<refsect2 id="gimp-size-entry-set-value" role="function">
451
438
<title>gimp_size_entry_set_value ()</title>
452
 
<indexterm zone="gimp-size-entry-set-value"><primary>gimp_size_entry_set_value</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_value           (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
439
<indexterm zone="gimp-size-entry-set-value"><primary sortas="gimp_size_entry_set_value">gimp_size_entry_set_value</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_value           (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
453
440
                                                         <link linkend="gint">gint</link> field,
454
441
                                                         <link linkend="gdouble">gdouble</link> value);</programlisting>
455
442
<para>
465
452
      <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s purpose is to shield the programmer from unit
466
453
      calculations. Use <link linkend="gimp-size-entry-set-refval"><function>gimp_size_entry_set_refval()</function></link> instead.</para>
467
454
<para>
468
 
 
469
455
</para><variablelist role="params">
470
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
456
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
471
457
<listitem><simpara>   The sizeentry you want to set a value for.
472
458
</simpara></listitem></varlistentry>
473
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
459
<varlistentry><term><parameter>field</parameter>&#160;:</term>
474
460
<listitem><simpara> The index of the field you want to set a value for.
475
461
</simpara></listitem></varlistentry>
476
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
462
<varlistentry><term><parameter>value</parameter>&#160;:</term>
477
463
<listitem><simpara> The new value for <parameter>field</parameter>.
478
464
</simpara></listitem></varlistentry>
479
465
</variablelist></refsect2>
480
466
<refsect2 id="gimp-size-entry-set-refval-boundaries" role="function">
481
467
<title>gimp_size_entry_set_refval_boundaries ()</title>
482
 
<indexterm zone="gimp-size-entry-set-refval-boundaries"><primary>gimp_size_entry_set_refval_boundaries</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_refval_boundaries
 
468
<indexterm zone="gimp-size-entry-set-refval-boundaries"><primary sortas="gimp_size_entry_set_refval_boundaries">gimp_size_entry_set_refval_boundaries</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_refval_boundaries
483
469
                                                        (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
484
470
                                                         <link linkend="gint">gint</link> field,
485
471
                                                         <link linkend="gdouble">gdouble</link> lower,
492
478
The current reference value of the <parameter>field</parameter> will be clamped to fit in the
493
479
<parameter>field</parameter>'s new boundaries.</para>
494
480
<para>
495
 
 
496
481
</para><variablelist role="params">
497
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
482
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
498
483
<listitem><simpara>   The sizeentry you want to set the reference value boundaries for.
499
484
</simpara></listitem></varlistentry>
500
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
485
<varlistentry><term><parameter>field</parameter>&#160;:</term>
501
486
<listitem><simpara> The index of the field you want to set the reference value
502
487
        boundaries for.
503
488
</simpara></listitem></varlistentry>
504
 
<varlistentry><term><parameter>lower</parameter>&nbsp;:</term>
 
489
<varlistentry><term><parameter>lower</parameter>&#160;:</term>
505
490
<listitem><simpara> The new lower boundary of the reference value of the chosen <parameter>field</parameter>.
506
491
</simpara></listitem></varlistentry>
507
 
<varlistentry><term><parameter>upper</parameter>&nbsp;:</term>
 
492
<varlistentry><term><parameter>upper</parameter>&#160;:</term>
508
493
<listitem><simpara> The new upper boundary of the reference value of the chosen <parameter>field</parameter>.
509
494
</simpara></listitem></varlistentry>
510
495
</variablelist></refsect2>
511
496
<refsect2 id="gimp-size-entry-set-refval-digits" role="function">
512
497
<title>gimp_size_entry_set_refval_digits ()</title>
513
 
<indexterm zone="gimp-size-entry-set-refval-digits"><primary>gimp_size_entry_set_refval_digits</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_refval_digits   (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
498
<indexterm zone="gimp-size-entry-set-refval-digits"><primary sortas="gimp_size_entry_set_refval_digits">gimp_size_entry_set_refval_digits</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_refval_digits   (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
514
499
                                                         <link linkend="gint">gint</link> field,
515
500
                                                         <link linkend="gint">gint</link> digits);</programlisting>
516
501
<para>
519
504
</para>
520
505
<para>
521
506
If you don't specify this value explicitly, the reference value's number
522
 
of digits will equal to 0 for <link linkend="GIMP-SIZE-ENTRY-UPDATE-SIZE:CAPS"><type>GIMP_SIZE_ENTRY_UPDATE_SIZE</type></link> and to 2 for
523
 
<link linkend="GIMP-SIZE-ENTRY-UPDATE-RESOLUTION:CAPS"><type>GIMP_SIZE_ENTRY_UPDATE_RESOLUTION</type></link>.</para>
 
507
of digits will equal to 0 for <link linkend="GIMP-SIZE-ENTRY-UPDATE-SIZE--CAPS"><type>GIMP_SIZE_ENTRY_UPDATE_SIZE</type></link> and to 2 for
 
508
<link linkend="GIMP-SIZE-ENTRY-UPDATE-RESOLUTION--CAPS"><type>GIMP_SIZE_ENTRY_UPDATE_RESOLUTION</type></link>.</para>
524
509
<para>
525
 
 
526
510
</para><variablelist role="params">
527
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
511
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
528
512
<listitem><simpara>    The sizeentry you want to set the reference value digits for.
529
513
</simpara></listitem></varlistentry>
530
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
514
<varlistentry><term><parameter>field</parameter>&#160;:</term>
531
515
<listitem><simpara>  The index of the field you want to set the reference value for.
532
516
</simpara></listitem></varlistentry>
533
 
<varlistentry><term><parameter>digits</parameter>&nbsp;:</term>
 
517
<varlistentry><term><parameter>digits</parameter>&#160;:</term>
534
518
<listitem><simpara> The new number of decimal digits for the <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> which
535
519
         displays <parameter>field</parameter>'s reference value.
536
520
</simpara></listitem></varlistentry>
537
521
</variablelist></refsect2>
538
522
<refsect2 id="gimp-size-entry-get-refval" role="function">
539
523
<title>gimp_size_entry_get_refval ()</title>
540
 
<indexterm zone="gimp-size-entry-get-refval"><primary>gimp_size_entry_get_refval</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_size_entry_get_refval          (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
524
<indexterm zone="gimp-size-entry-get-refval"><primary sortas="gimp_size_entry_get_refval">gimp_size_entry_get_refval</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_size_entry_get_refval          (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
541
525
                                                         <link linkend="gint">gint</link> field);</programlisting>
542
526
<para>
543
527
Returns the reference value for field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
547
531
in dpi, depending on which <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> you chose in
548
532
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link>.</para>
549
533
<para>
550
 
 
551
534
</para><variablelist role="params">
552
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
535
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
553
536
<listitem><simpara>   The sizeentry you want to know a reference value of.
554
537
</simpara></listitem></varlistentry>
555
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
538
<varlistentry><term><parameter>field</parameter>&#160;:</term>
556
539
<listitem><simpara> The index of the field you want to know the reference value of.
557
540
</simpara></listitem></varlistentry>
558
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The reference value of the chosen <parameter>field</parameter>.
 
541
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The reference value of the chosen <parameter>field</parameter>.
559
542
</simpara></listitem></varlistentry>
560
543
</variablelist></refsect2>
561
544
<refsect2 id="gimp-size-entry-set-refval" role="function">
562
545
<title>gimp_size_entry_set_refval ()</title>
563
 
<indexterm zone="gimp-size-entry-set-refval"><primary>gimp_size_entry_set_refval</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_refval          (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
546
<indexterm zone="gimp-size-entry-set-refval"><primary sortas="gimp_size_entry_set_refval">gimp_size_entry_set_refval</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_refval          (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
564
547
                                                         <link linkend="gint">gint</link> field,
565
548
                                                         <link linkend="gdouble">gdouble</link> refval);</programlisting>
566
549
<para>
571
554
depending on which <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> you chose in
572
555
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link>.</para>
573
556
<para>
574
 
 
575
557
</para><variablelist role="params">
576
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
558
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
577
559
<listitem><simpara>    The sizeentry you want to set a reference value for.
578
560
</simpara></listitem></varlistentry>
579
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
561
<varlistentry><term><parameter>field</parameter>&#160;:</term>
580
562
<listitem><simpara>  The index of the field you want to set the reference value for.
581
563
</simpara></listitem></varlistentry>
582
 
<varlistentry><term><parameter>refval</parameter>&nbsp;:</term>
 
564
<varlistentry><term><parameter>refval</parameter>&#160;:</term>
583
565
<listitem><simpara> The new reference value for <parameter>field</parameter>.
584
566
</simpara></listitem></varlistentry>
585
567
</variablelist></refsect2>
586
568
<refsect2 id="gimp-size-entry-get-unit" role="function">
587
569
<title>gimp_size_entry_get_unit ()</title>
588
 
<indexterm zone="gimp-size-entry-get-unit"><primary>gimp_size_entry_get_unit</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link>            gimp_size_entry_get_unit            (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse);</programlisting>
 
570
<indexterm zone="gimp-size-entry-get-unit"><primary sortas="gimp_size_entry_get_unit">gimp_size_entry_get_unit</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link>            gimp_size_entry_get_unit            (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse);</programlisting>
589
571
<para>
590
572
Returns the <link linkend="GimpUnit"><type>GimpUnit</type></link> the user has selected in the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s
591
573
<link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.</para>
592
574
<para>
593
 
 
594
575
</para><variablelist role="params">
595
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
576
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
596
577
<listitem><simpara> The sizeentry you want to know the unit of.
597
578
</simpara></listitem></varlistentry>
598
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The sizeentry's unit.
 
579
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The sizeentry's unit.
599
580
</simpara></listitem></varlistentry>
600
581
</variablelist></refsect2>
601
582
<refsect2 id="gimp-size-entry-set-unit" role="function">
602
583
<title>gimp_size_entry_set_unit ()</title>
603
 
<indexterm zone="gimp-size-entry-set-unit"><primary>gimp_size_entry_set_unit</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_unit            (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
584
<indexterm zone="gimp-size-entry-set-unit"><primary sortas="gimp_size_entry_set_unit">gimp_size_entry_set_unit</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_unit            (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
604
585
                                                         <link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
605
586
<para>
606
587
Sets the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s unit. The reference value for all fields will
608
589
according to which <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> you chose in
609
590
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link>.</para>
610
591
<para>
611
 
 
612
592
</para><variablelist role="params">
613
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
593
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
614
594
<listitem><simpara>  The sizeentry you want to change the unit for.
615
595
</simpara></listitem></varlistentry>
616
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
596
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
617
597
<listitem><simpara> The new unit.
618
598
</simpara></listitem></varlistentry>
619
599
</variablelist></refsect2>
620
600
<refsect2 id="gimp-size-entry-set-pixel-digits" role="function">
621
601
<title>gimp_size_entry_set_pixel_digits ()</title>
622
 
<indexterm zone="gimp-size-entry-set-pixel-digits"><primary>gimp_size_entry_set_pixel_digits</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_pixel_digits    (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
602
<indexterm zone="gimp-size-entry-set-pixel-digits"><primary sortas="gimp_size_entry_set_pixel_digits">gimp_size_entry_set_pixel_digits</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_pixel_digits    (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
623
603
                                                         <link linkend="gint">gint</link> digits);</programlisting>
624
604
<para>
625
605
Similar to <link linkend="gimp-unit-menu-set-pixel-digits"><function>gimp_unit_menu_set_pixel_digits()</function></link>, this function allows
626
606
you set up a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> so that sub-pixel sizes can be entered.</para>
627
607
<para>
628
 
 
629
608
</para><variablelist role="params">
630
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
609
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
631
610
<listitem><simpara> a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>
632
611
</simpara></listitem></varlistentry>
633
 
<varlistentry><term><parameter>digits</parameter>&nbsp;:</term>
 
612
<varlistentry><term><parameter>digits</parameter>&#160;:</term>
634
613
<listitem><simpara> the number of digits to display for a pixel size
635
614
</simpara></listitem></varlistentry>
636
615
</variablelist></refsect2>
637
616
<refsect2 id="gimp-size-entry-show-unit-menu" role="function" condition="since:GIMP 2.4">
638
617
<title>gimp_size_entry_show_unit_menu ()</title>
639
 
<indexterm zone="gimp-size-entry-show-unit-menu" role="GIMP 2.4"><primary>gimp_size_entry_show_unit_menu</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_show_unit_menu      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
618
<indexterm zone="gimp-size-entry-show-unit-menu" role="GIMP 2.4"><primary sortas="gimp_size_entry_show_unit_menu">gimp_size_entry_show_unit_menu</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_show_unit_menu      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
640
619
                                                         <link linkend="gboolean">gboolean</link> show);</programlisting>
641
620
<para>
642
621
Controls whether a unit menu is shown in the size entry.  If
643
 
<parameter>show</parameter> is <link linkend="TRUE:CAPS"><type>TRUE</type></link>, the menu is shown; otherwise it is hidden.</para>
 
622
<parameter>show</parameter> is <link linkend="TRUE--CAPS"><type>TRUE</type></link>, the menu is shown; otherwise it is hidden.</para>
644
623
<para>
645
 
 
646
624
</para><variablelist role="params">
647
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
625
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
648
626
<listitem><simpara> a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>
649
627
</simpara></listitem></varlistentry>
650
 
<varlistentry><term><parameter>show</parameter>&nbsp;:</term>
 
628
<varlistentry><term><parameter>show</parameter>&#160;:</term>
651
629
<listitem><simpara> Boolean
652
630
</simpara></listitem></varlistentry>
653
 
</variablelist><para role="since">Since  GIMP 2.4
654
 
</para></refsect2>
 
631
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
655
632
<refsect2 id="gimp-size-entry-grab-focus" role="function">
656
633
<title>gimp_size_entry_grab_focus ()</title>
657
 
<indexterm zone="gimp-size-entry-grab-focus"><primary>gimp_size_entry_grab_focus</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_grab_focus          (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse);</programlisting>
 
634
<indexterm zone="gimp-size-entry-grab-focus"><primary sortas="gimp_size_entry_grab_focus">gimp_size_entry_grab_focus</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_grab_focus          (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse);</programlisting>
658
635
<para>
659
636
This function is rather ugly and just a workaround for the fact that
660
637
it's impossible to implement <link linkend="gtk-widget-grab-focus"><function>gtk_widget_grab_focus()</function></link> for a <link linkend="GtkTable"><type>GtkTable</type></link>.</para>
661
638
<para>
662
 
 
663
639
</para><variablelist role="params">
664
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
640
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
665
641
<listitem><simpara> The sizeentry you want to grab the keyboard focus.
666
642
</simpara></listitem></varlistentry>
667
643
</variablelist></refsect2>
668
644
<refsect2 id="gimp-size-entry-set-activates-default" role="function" condition="since:GIMP 2.4">
669
645
<title>gimp_size_entry_set_activates_default ()</title>
670
 
<indexterm zone="gimp-size-entry-set-activates-default" role="GIMP 2.4"><primary>gimp_size_entry_set_activates_default</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_activates_default
 
646
<indexterm zone="gimp-size-entry-set-activates-default" role="GIMP 2.4"><primary sortas="gimp_size_entry_set_activates_default">gimp_size_entry_set_activates_default</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_size_entry_set_activates_default
671
647
                                                        (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
672
648
                                                         <link linkend="gboolean">gboolean</link> setting);</programlisting>
673
649
<para>
674
650
Iterates over all entries in the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> and calls
675
651
<link linkend="gtk-entry-set-activates-default"><function>gtk_entry_set_activates_default()</function></link> on them.</para>
676
652
<para>
677
 
 
678
653
</para><variablelist role="params">
679
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
654
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
680
655
<listitem><simpara> A <link linkend="GimpSizeEntr"><type>GimpSizeEntr</type></link>
681
656
</simpara></listitem></varlistentry>
682
 
<varlistentry><term><parameter>setting</parameter>&nbsp;:</term>
683
 
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to activate window's default widget on Enter keypress
 
657
<varlistentry><term><parameter>setting</parameter>&#160;:</term>
 
658
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to activate window's default widget on Enter keypress
684
659
</simpara></listitem></varlistentry>
685
 
</variablelist><para role="since">Since  GIMP 2.4
686
 
</para></refsect2>
 
660
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
687
661
<refsect2 id="gimp-size-entry-get-help-widget" role="function">
688
662
<title>gimp_size_entry_get_help_widget ()</title>
689
 
<indexterm zone="gimp-size-entry-get-help-widget"><primary>gimp_size_entry_get_help_widget</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_size_entry_get_help_widget     (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
 
663
<indexterm zone="gimp-size-entry-get-help-widget"><primary sortas="gimp_size_entry_get_help_widget">gimp_size_entry_get_help_widget</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_size_entry_get_help_widget     (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
690
664
                                                         <link linkend="gint">gint</link> field);</programlisting>
691
665
<para>
692
666
You shouldn't fiddle with the internals of a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> but
693
667
if you want to set tooltips using <link linkend="gimp-help-set-help-data"><function>gimp_help_set_help_data()</function></link> you
694
668
can use this function to get a pointer to the spinbuttons.</para>
695
669
<para>
696
 
 
697
670
</para><variablelist role="params">
698
 
<varlistentry><term><parameter>gse</parameter>&nbsp;:</term>
 
671
<varlistentry><term><parameter>gse</parameter>&#160;:</term>
699
672
<listitem><simpara> a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>
700
673
</simpara></listitem></varlistentry>
701
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
674
<varlistentry><term><parameter>field</parameter>&#160;:</term>
702
675
<listitem><simpara> the index of the widget you want to get a pointer to
703
676
</simpara></listitem></varlistentry>
704
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> pointer that you can attach a tooltip to.
 
677
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> pointer that you can attach a tooltip to.
705
678
</simpara></listitem></varlistentry>
706
679
</variablelist></refsect2>
707
680
 
709
682
 
710
683
<refsect1 id="GimpSizeEntry.signal-details" role="signals">
711
684
<title role="signals.title">Signal Details</title>
712
 
<refsect2 id="GimpSizeEntry-refval-changed"><title>The <literal>&quot;refval-changed&quot;</literal> signal</title>
713
 
<indexterm zone="GimpSizeEntry-refval-changed"><primary>GimpSizeEntry::refval-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
714
 
                                                        <link linkend="gpointer">gpointer</link>       user_data)          : Run First</programlisting>
715
 
<para>
716
 
 
717
 
</para><variablelist role="params">
718
 
<varlistentry><term><parameter>gimpsizeentry</parameter>&nbsp;:</term>
719
 
<listitem><simpara>the object which received the signal.
720
 
 
721
 
</simpara></listitem></varlistentry>
722
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
723
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
724
 
</variablelist></refsect2><refsect2 id="GimpSizeEntry-unit-changed"><title>The <literal>&quot;unit-changed&quot;</literal> signal</title>
725
 
<indexterm zone="GimpSizeEntry-unit-changed"><primary>GimpSizeEntry::unit-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
726
 
                                                        <link linkend="gpointer">gpointer</link>       user_data)          : Run First</programlisting>
727
 
<para>
728
 
 
729
 
</para><variablelist role="params">
730
 
<varlistentry><term><parameter>gimpsizeentry</parameter>&nbsp;:</term>
731
 
<listitem><simpara>the object which received the signal.
732
 
 
733
 
</simpara></listitem></varlistentry>
734
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
735
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
736
 
</variablelist></refsect2><refsect2 id="GimpSizeEntry-value-changed"><title>The <literal>&quot;value-changed&quot;</literal> signal</title>
737
 
<indexterm zone="GimpSizeEntry-value-changed"><primary>GimpSizeEntry::value-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
738
 
                                                        <link linkend="gpointer">gpointer</link>       user_data)          : Run First</programlisting>
739
 
<para>
740
 
 
741
 
</para><variablelist role="params">
742
 
<varlistentry><term><parameter>gimpsizeentry</parameter>&nbsp;:</term>
743
 
<listitem><simpara>the object which received the signal.
744
 
 
745
 
</simpara></listitem></varlistentry>
746
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
685
<refsect2 id="GimpSizeEntry-refval-changed" role="signal"><title>The <literal>&quot;refval-changed&quot;</literal> signal</title>
 
686
<indexterm zone="GimpSizeEntry-refval-changed"><primary sortas="GimpSizeEntry::refval-changed">GimpSizeEntry::refval-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
 
687
                                                        <link linkend="gpointer">gpointer</link>       user_data)          : Run First</programlisting>
 
688
<para>
 
689
</para><variablelist role="params">
 
690
<varlistentry><term><parameter>gimpsizeentry</parameter>&#160;:</term>
 
691
<listitem><simpara>the object which received the signal.
 
692
</simpara></listitem></varlistentry>
 
693
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
694
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
695
</variablelist></refsect2><refsect2 id="GimpSizeEntry-unit-changed" role="signal"><title>The <literal>&quot;unit-changed&quot;</literal> signal</title>
 
696
<indexterm zone="GimpSizeEntry-unit-changed"><primary sortas="GimpSizeEntry::unit-changed">GimpSizeEntry::unit-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
 
697
                                                        <link linkend="gpointer">gpointer</link>       user_data)          : Run First</programlisting>
 
698
<para>
 
699
</para><variablelist role="params">
 
700
<varlistentry><term><parameter>gimpsizeentry</parameter>&#160;:</term>
 
701
<listitem><simpara>the object which received the signal.
 
702
</simpara></listitem></varlistentry>
 
703
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
704
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
705
</variablelist></refsect2><refsect2 id="GimpSizeEntry-value-changed" role="signal"><title>The <literal>&quot;value-changed&quot;</literal> signal</title>
 
706
<indexterm zone="GimpSizeEntry-value-changed"><primary sortas="GimpSizeEntry::value-changed">GimpSizeEntry::value-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
 
707
                                                        <link linkend="gpointer">gpointer</link>       user_data)          : Run First</programlisting>
 
708
<para>
 
709
</para><variablelist role="params">
 
710
<varlistentry><term><parameter>gimpsizeentry</parameter>&#160;:</term>
 
711
<listitem><simpara>the object which received the signal.
 
712
</simpara></listitem></varlistentry>
 
713
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
747
714
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
748
715
</variablelist></refsect2>
749
716
</refsect1>