← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpbase/xml/gimpunit.xml

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2009-03-17 03:00:24 UTC
  • mfrom: (1.1.20 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317030024-gnp1dhd0hnt80f4h
Tags: 2.6.6-0ubuntu1
https://launchpad.net/bugs/344052
* New upstream release (LP: #344052)
* debian/patches/04_from_bugzilla_572403.patch:
  - Dropped, the fix is in the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpbase/xml/gimpunit.xml
13
13
<refname>gimpunit</refname>
14
14
<refpurpose>Provides a collection of predefined units and functions for creating
15
15
user-defined units.</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
18
<refsynopsisdiv id="libgimpbase-gimpunit.synopsis" role="synopsis">
36
35
                                                         <link linkend="gboolean">gboolean</link> deletion_flag);
37
36
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-unit-get-factor">gimp_unit_get_factor</link>                (<link linkend="GimpUnit">GimpUnit</link> unit);
38
37
<link linkend="gint">gint</link>                <link linkend="gimp-unit-get-digits">gimp_unit_get_digits</link>                (<link linkend="GimpUnit">GimpUnit</link> unit);
39
 
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-unit-get-identifier">gimp_unit_get_identifier</link>            (<link linkend="GimpUnit">GimpUnit</link> unit);
40
 
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-unit-get-symbol">gimp_unit_get_symbol</link>                (<link linkend="GimpUnit">GimpUnit</link> unit);
41
 
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-unit-get-abbreviation">gimp_unit_get_abbreviation</link>          (<link linkend="GimpUnit">GimpUnit</link> unit);
42
 
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-unit-get-singular">gimp_unit_get_singular</link>              (<link linkend="GimpUnit">GimpUnit</link> unit);
43
 
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-unit-get-plural">gimp_unit_get_plural</link>                (<link linkend="GimpUnit">GimpUnit</link> unit);
44
 
#define             <link linkend="GIMP-TYPE-UNIT:CAPS">GIMP_TYPE_UNIT</link>
45
 
#define             <link linkend="GIMP-TYPE-PARAM-UNIT:CAPS">GIMP_TYPE_PARAM_UNIT</link>
46
 
#define             <link linkend="GIMP-IS-PARAM-SPEC-UNIT:CAPS">GIMP_IS_PARAM_SPEC_UNIT</link>             (pspec)
47
 
<link linkend="GParamSpec">GParamSpec</link>*         <link linkend="gimp-param-spec-unit">gimp_param_spec_unit</link>                (const <link linkend="gchar">gchar</link> *name,
 
38
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-unit-get-identifier">gimp_unit_get_identifier</link>            (<link linkend="GimpUnit">GimpUnit</link> unit);
 
39
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-unit-get-symbol">gimp_unit_get_symbol</link>                (<link linkend="GimpUnit">GimpUnit</link> unit);
 
40
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-unit-get-abbreviation">gimp_unit_get_abbreviation</link>          (<link linkend="GimpUnit">GimpUnit</link> unit);
 
41
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-unit-get-singular">gimp_unit_get_singular</link>              (<link linkend="GimpUnit">GimpUnit</link> unit);
 
42
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-unit-get-plural">gimp_unit_get_plural</link>                (<link linkend="GimpUnit">GimpUnit</link> unit);
 
43
#define             <link linkend="GIMP-TYPE-UNIT--CAPS">GIMP_TYPE_UNIT</link>
 
44
#define             <link linkend="GIMP-TYPE-PARAM-UNIT--CAPS">GIMP_TYPE_PARAM_UNIT</link>
 
45
#define             <link linkend="GIMP-IS-PARAM-SPEC-UNIT--CAPS">GIMP_IS_PARAM_SPEC_UNIT</link>             (pspec)
 
46
<link linkend="GParamSpec">GParamSpec</link> *        <link linkend="gimp-param-spec-unit">gimp_param_spec_unit</link>                (const <link linkend="gchar">gchar</link> *name,
48
47
                                                         const <link linkend="gchar">gchar</link> *nick,
49
48
                                                         const <link linkend="gchar">gchar</link> *blurb,
50
49
                                                         <link linkend="gboolean">gboolean</link> allow_pixels,
51
50
                                                         <link linkend="gboolean">gboolean</link> allow_percent,
52
51
                                                         <link linkend="GimpUnit">GimpUnit</link> default_value,
53
52
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);
54
 
#define             <link linkend="GIMP-VALUE-HOLDS-UNIT:CAPS">GIMP_VALUE_HOLDS_UNIT</link>               (value)
 
53
#define             <link linkend="GIMP-VALUE-HOLDS-UNIT--CAPS">GIMP_VALUE_HOLDS_UNIT</link>               (value)
55
54
</synopsis>
56
55
</refsynopsisdiv>
57
56
 
68
67
<para>
69
68
Provides a collection of predefined units and functions for creating
70
69
user-defined units.
71
 
 
72
70
</para>
73
71
</refsect1>
74
72
 
76
74
<title role="details.title">Details</title>
77
75
<refsect2 id="GimpUnit" role="enum">
78
76
<title>enum GimpUnit</title>
79
 
<indexterm zone="GimpUnit"><primary>GimpUnit</primary></indexterm><programlisting>typedef enum /*&lt; skip &gt;*/
 
77
<indexterm zone="GimpUnit"><primary sortas="GimpUnit">GimpUnit</primary></indexterm><programlisting>typedef enum /*&lt; skip &gt;*/
80
78
{
81
79
  GIMP_UNIT_PIXEL   = 0,
82
80
 
91
89
} GimpUnit;
92
90
</programlisting>
93
91
<para>
94
 
 
95
92
</para></refsect2>
96
93
<refsect2 id="gimp-unit-get-number-of-units" role="function">
97
94
<title>gimp_unit_get_number_of_units ()</title>
98
 
<indexterm zone="gimp-unit-get-number-of-units"><primary>gimp_unit_get_number_of_units</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_unit_get_number_of_units       (void);</programlisting>
 
95
<indexterm zone="gimp-unit-get-number-of-units"><primary sortas="gimp_unit_get_number_of_units">gimp_unit_get_number_of_units</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_unit_get_number_of_units       (void);</programlisting>
99
96
<para>
100
97
Returns the number of units which are known to the <link linkend="GimpUnit"><type>GimpUnit</type></link> system.</para>
101
98
<para>
102
 
 
103
99
</para><variablelist role="params">
104
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The number of defined units.
 
100
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The number of defined units.
105
101
</simpara></listitem></varlistentry>
106
102
</variablelist></refsect2>
107
103
<refsect2 id="gimp-unit-get-number-of-built-in-units" role="function">
108
104
<title>gimp_unit_get_number_of_built_in_units ()</title>
109
 
<indexterm zone="gimp-unit-get-number-of-built-in-units"><primary>gimp_unit_get_number_of_built_in_units</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_unit_get_number_of_built_in_units
 
105
<indexterm zone="gimp-unit-get-number-of-built-in-units"><primary sortas="gimp_unit_get_number_of_built_in_units">gimp_unit_get_number_of_built_in_units</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_unit_get_number_of_built_in_units
110
106
                                                        (void);</programlisting>
111
107
<para>
112
108
Returns the number of <link linkend="GimpUnit"><type>GimpUnit</type></link>'s which are hardcoded in the unit system
113
109
(UNIT_INCH, UNIT_MM, UNIT_POINT, UNIT_PICA and the two "pseudo unit"
114
110
 UNIT_PIXEL).</para>
115
111
<para>
116
 
 
117
112
</para><variablelist role="params">
118
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The number of built-in units.
 
113
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The number of built-in units.
119
114
</simpara></listitem></varlistentry>
120
115
</variablelist></refsect2>
121
116
<refsect2 id="gimp-unit-new" role="function">
122
117
<title>gimp_unit_new ()</title>
123
 
<indexterm zone="gimp-unit-new"><primary>gimp_unit_new</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link>            gimp_unit_new                       (<link linkend="gchar">gchar</link> *identifier,
 
118
<indexterm zone="gimp-unit-new"><primary sortas="gimp_unit_new">gimp_unit_new</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link>            gimp_unit_new                       (<link linkend="gchar">gchar</link> *identifier,
124
119
                                                         <link linkend="gdouble">gdouble</link> factor,
125
120
                                                         <link linkend="gint">gint</link> digits,
126
121
                                                         <link linkend="gchar">gchar</link> *symbol,
132
127
</para>
133
128
<para>
134
129
Note that a new unit is always created with it's deletion flag
135
 
set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. You will have to set it to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with
 
130
set to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>. You will have to set it to <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with
136
131
<link linkend="gimp-unit-set-deletion-flag"><function>gimp_unit_set_deletion_flag()</function></link> to make the unit definition persistent.</para>
137
132
<para>
138
 
 
139
133
</para><variablelist role="params">
140
 
<varlistentry><term><parameter>identifier</parameter>&nbsp;:</term>
 
134
<varlistentry><term><parameter>identifier</parameter>&#160;:</term>
141
135
<listitem><simpara> The unit's identifier string.
142
136
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><parameter>factor</parameter>&nbsp;:</term>
 
137
<varlistentry><term><parameter>factor</parameter>&#160;:</term>
144
138
<listitem><simpara> The unit's factor (how many units are in one inch).
145
139
</simpara></listitem></varlistentry>
146
 
<varlistentry><term><parameter>digits</parameter>&nbsp;:</term>
 
140
<varlistentry><term><parameter>digits</parameter>&#160;:</term>
147
141
<listitem><simpara> The unit's suggested number of digits (see <link linkend="gimp-unit-get-digits"><function>gimp_unit_get_digits()</function></link>).
148
142
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><parameter>symbol</parameter>&nbsp;:</term>
 
143
<varlistentry><term><parameter>symbol</parameter>&#160;:</term>
150
144
<listitem><simpara> The symbol of the unit (e.g. "''" for inch).
151
145
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><parameter>abbreviation</parameter>&nbsp;:</term>
 
146
<varlistentry><term><parameter>abbreviation</parameter>&#160;:</term>
153
147
<listitem><simpara> The abbreviation of the unit.
154
148
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><parameter>singular</parameter>&nbsp;:</term>
 
149
<varlistentry><term><parameter>singular</parameter>&#160;:</term>
156
150
<listitem><simpara> The singular form of the unit.
157
151
</simpara></listitem></varlistentry>
158
 
<varlistentry><term><parameter>plural</parameter>&nbsp;:</term>
 
152
<varlistentry><term><parameter>plural</parameter>&#160;:</term>
159
153
<listitem><simpara> The plural form of the unit.
160
154
</simpara></listitem></varlistentry>
161
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The ID of the new unit.
 
155
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The ID of the new unit.
162
156
</simpara></listitem></varlistentry>
163
157
</variablelist></refsect2>
164
158
<refsect2 id="gimp-unit-get-deletion-flag" role="function">
165
159
<title>gimp_unit_get_deletion_flag ()</title>
166
 
<indexterm zone="gimp-unit-get-deletion-flag"><primary>gimp_unit_get_deletion_flag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_unit_get_deletion_flag         (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
 
160
<indexterm zone="gimp-unit-get-deletion-flag"><primary sortas="gimp_unit_get_deletion_flag">gimp_unit_get_deletion_flag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_unit_get_deletion_flag         (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
167
161
<para>
168
162
</para>
169
163
<para>
170
 
 
171
164
</para><variablelist role="params">
172
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
165
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
173
166
<listitem><simpara> The unit you want to know the <parameter>deletion_flag</parameter> of.
174
167
</simpara></listitem></varlistentry>
175
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The unit's <parameter>deletion_flag</parameter>.
 
168
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The unit's <parameter>deletion_flag</parameter>.
176
169
</simpara></listitem></varlistentry>
177
170
</variablelist></refsect2>
178
171
<refsect2 id="gimp-unit-set-deletion-flag" role="function">
179
172
<title>gimp_unit_set_deletion_flag ()</title>
180
 
<indexterm zone="gimp-unit-set-deletion-flag"><primary>gimp_unit_set_deletion_flag</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_unit_set_deletion_flag         (<link linkend="GimpUnit">GimpUnit</link> unit,
 
173
<indexterm zone="gimp-unit-set-deletion-flag"><primary sortas="gimp_unit_set_deletion_flag">gimp_unit_set_deletion_flag</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_unit_set_deletion_flag         (<link linkend="GimpUnit">GimpUnit</link> unit,
181
174
                                                         <link linkend="gboolean">gboolean</link> deletion_flag);</programlisting>
182
175
<para>
183
176
Sets a <link linkend="GimpUnit"><type>GimpUnit</type></link>'s <parameter>deletion_flag</parameter>. If the <parameter>deletion_flag</parameter> of a unit is
184
 
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> when GIMP exits, this unit will not be saved in the users's
 
177
<link linkend="TRUE--CAPS"><literal>TRUE</literal></link> when GIMP exits, this unit will not be saved in the users's
185
178
"unitrc" file.
186
179
</para>
187
180
<para>
188
181
Trying to change the <parameter>deletion_flag</parameter> of a built-in unit will be silently
189
182
ignored.</para>
190
183
<para>
191
 
 
192
184
</para><variablelist role="params">
193
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
185
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
194
186
<listitem><simpara> The unit you want to set the <parameter>deletion_flag</parameter> for.
195
187
</simpara></listitem></varlistentry>
196
 
<varlistentry><term><parameter>deletion_flag</parameter>&nbsp;:</term>
 
188
<varlistentry><term><parameter>deletion_flag</parameter>&#160;:</term>
197
189
<listitem><simpara> The new deletion_flag.
198
190
</simpara></listitem></varlistentry>
199
191
</variablelist></refsect2>
200
192
<refsect2 id="gimp-unit-get-factor" role="function">
201
193
<title>gimp_unit_get_factor ()</title>
202
 
<indexterm zone="gimp-unit-get-factor"><primary>gimp_unit_get_factor</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_unit_get_factor                (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
 
194
<indexterm zone="gimp-unit-get-factor"><primary sortas="gimp_unit_get_factor">gimp_unit_get_factor</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_unit_get_factor                (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
203
195
<para>
204
196
A <link linkend="GimpUnit"><type>GimpUnit</type></link>'s <parameter>factor</parameter> is defined to be:
205
197
</para>
209
201
<para>
210
202
Returns 0 for <parameter>unit</parameter> == GIMP_UNIT_PIXEL.</para>
211
203
<para>
212
 
 
213
204
</para><variablelist role="params">
214
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
205
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
215
206
<listitem><simpara> The unit you want to know the factor of.
216
207
</simpara></listitem></varlistentry>
217
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The unit's factor.
 
208
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The unit's factor.
218
209
</simpara></listitem></varlistentry>
219
210
</variablelist></refsect2>
220
211
<refsect2 id="gimp-unit-get-digits" role="function">
221
212
<title>gimp_unit_get_digits ()</title>
222
 
<indexterm zone="gimp-unit-get-digits"><primary>gimp_unit_get_digits</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_unit_get_digits                (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
 
213
<indexterm zone="gimp-unit-get-digits"><primary sortas="gimp_unit_get_digits">gimp_unit_get_digits</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_unit_get_digits                (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
223
214
<para>
224
215
Returns the number of digits an entry field should provide to get
225
216
approximately the same accuracy as an inch input field with two digits.
227
218
<para>
228
219
Returns 0 for <parameter>unit</parameter> == GIMP_UNIT_PIXEL.</para>
229
220
<para>
230
 
 
231
221
</para><variablelist role="params">
232
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
222
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
233
223
<listitem><simpara> The unit you want to know the digits.
234
224
</simpara></listitem></varlistentry>
235
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The suggested number of digits.
 
225
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The suggested number of digits.
236
226
</simpara></listitem></varlistentry>
237
227
</variablelist></refsect2>
238
228
<refsect2 id="gimp-unit-get-identifier" role="function">
239
229
<title>gimp_unit_get_identifier ()</title>
240
 
<indexterm zone="gimp-unit-get-identifier"><primary>gimp_unit_get_identifier</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_unit_get_identifier            (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
 
230
<indexterm zone="gimp-unit-get-identifier"><primary sortas="gimp_unit_get_identifier">gimp_unit_get_identifier</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_unit_get_identifier            (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
241
231
<para>
242
232
This is an unstranslated string and must not be changed or freed.</para>
243
233
<para>
244
 
 
245
234
</para><variablelist role="params">
246
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
235
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
247
236
<listitem><simpara> The unit you want to know the identifier of.
248
237
</simpara></listitem></varlistentry>
249
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The unit's identifier.
 
238
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The unit's identifier.
250
239
</simpara></listitem></varlistentry>
251
240
</variablelist></refsect2>
252
241
<refsect2 id="gimp-unit-get-symbol" role="function">
253
242
<title>gimp_unit_get_symbol ()</title>
254
 
<indexterm zone="gimp-unit-get-symbol"><primary>gimp_unit_get_symbol</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_unit_get_symbol                (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
 
243
<indexterm zone="gimp-unit-get-symbol"><primary sortas="gimp_unit_get_symbol">gimp_unit_get_symbol</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_unit_get_symbol                (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
255
244
<para>
256
245
This is e.g. "''" for UNIT_INCH.
257
246
</para>
258
247
<para>
259
248
NOTE: This string must not be changed or freed.</para>
260
249
<para>
261
 
 
262
250
</para><variablelist role="params">
263
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
251
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
264
252
<listitem><simpara> The unit you want to know the symbol of.
265
253
</simpara></listitem></varlistentry>
266
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The unit's symbol.
 
254
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The unit's symbol.
267
255
</simpara></listitem></varlistentry>
268
256
</variablelist></refsect2>
269
257
<refsect2 id="gimp-unit-get-abbreviation" role="function">
270
258
<title>gimp_unit_get_abbreviation ()</title>
271
 
<indexterm zone="gimp-unit-get-abbreviation"><primary>gimp_unit_get_abbreviation</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_unit_get_abbreviation          (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
 
259
<indexterm zone="gimp-unit-get-abbreviation"><primary sortas="gimp_unit_get_abbreviation">gimp_unit_get_abbreviation</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_unit_get_abbreviation          (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
272
260
<para>
273
261
For built-in units, this function returns the translated abbreviation
274
262
of the unit.
276
264
<para>
277
265
NOTE: This string must not be changed or freed.</para>
278
266
<para>
279
 
 
280
267
</para><variablelist role="params">
281
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
268
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
282
269
<listitem><simpara> The unit you want to know the abbreviation of.
283
270
</simpara></listitem></varlistentry>
284
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The unit's abbreviation.
 
271
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The unit's abbreviation.
285
272
</simpara></listitem></varlistentry>
286
273
</variablelist></refsect2>
287
274
<refsect2 id="gimp-unit-get-singular" role="function">
288
275
<title>gimp_unit_get_singular ()</title>
289
 
<indexterm zone="gimp-unit-get-singular"><primary>gimp_unit_get_singular</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_unit_get_singular              (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
 
276
<indexterm zone="gimp-unit-get-singular"><primary sortas="gimp_unit_get_singular">gimp_unit_get_singular</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_unit_get_singular              (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
290
277
<para>
291
278
For built-in units, this function returns the translated singular form
292
279
of the unit's name.
294
281
<para>
295
282
NOTE: This string must not be changed or freed.</para>
296
283
<para>
297
 
 
298
284
</para><variablelist role="params">
299
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
285
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
300
286
<listitem><simpara> The unit you want to know the singular form of.
301
287
</simpara></listitem></varlistentry>
302
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The unit's singular form.
 
288
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The unit's singular form.
303
289
</simpara></listitem></varlistentry>
304
290
</variablelist></refsect2>
305
291
<refsect2 id="gimp-unit-get-plural" role="function">
306
292
<title>gimp_unit_get_plural ()</title>
307
 
<indexterm zone="gimp-unit-get-plural"><primary>gimp_unit_get_plural</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_unit_get_plural                (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
 
293
<indexterm zone="gimp-unit-get-plural"><primary sortas="gimp_unit_get_plural">gimp_unit_get_plural</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_unit_get_plural                (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
308
294
<para>
309
295
For built-in units, this function returns the translated plural form
310
296
of the unit's name.
312
298
<para>
313
299
NOTE: This string must not be changed or freed.</para>
314
300
<para>
315
 
 
316
301
</para><variablelist role="params">
317
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
302
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
318
303
<listitem><simpara> The unit you want to know the plural form of.
319
304
</simpara></listitem></varlistentry>
320
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The unit's plural form.
 
305
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The unit's plural form.
321
306
</simpara></listitem></varlistentry>
322
307
</variablelist></refsect2>
323
 
<refsect2 id="GIMP-TYPE-UNIT:CAPS" role="macro">
 
308
<refsect2 id="GIMP-TYPE-UNIT--CAPS" role="macro">
324
309
<title>GIMP_TYPE_UNIT</title>
325
 
<indexterm zone="GIMP-TYPE-UNIT:CAPS"><primary>GIMP_TYPE_UNIT</primary></indexterm><programlisting>#define GIMP_TYPE_UNIT               (gimp_unit_get_type ())
 
310
<indexterm zone="GIMP-TYPE-UNIT--CAPS"><primary sortas="GIMP_TYPE_UNIT">GIMP_TYPE_UNIT</primary></indexterm><programlisting>#define GIMP_TYPE_UNIT               (gimp_unit_get_type ())
326
311
</programlisting>
327
312
<para>
328
 
<link linkend="GIMP-TYPE-UNIT:CAPS"><type>GIMP_TYPE_UNIT</type></link> is a <link linkend="GType"><type>GType</type></link> derived from <link linkend="G-TYPE-INT:CAPS"><type>G_TYPE_INT</type></link>.
 
313
<link linkend="GIMP-TYPE-UNIT--CAPS"><type>GIMP_TYPE_UNIT</type></link> is a <link linkend="GType"><type>GType</type></link> derived from <link linkend="G-TYPE-INT--CAPS"><type>G_TYPE_INT</type></link>.
329
314
</para></refsect2>
330
 
<refsect2 id="GIMP-TYPE-PARAM-UNIT:CAPS" role="macro">
 
315
<refsect2 id="GIMP-TYPE-PARAM-UNIT--CAPS" role="macro">
331
316
<title>GIMP_TYPE_PARAM_UNIT</title>
332
 
<indexterm zone="GIMP-TYPE-PARAM-UNIT:CAPS"><primary>GIMP_TYPE_PARAM_UNIT</primary></indexterm><programlisting>#define GIMP_TYPE_PARAM_UNIT              (gimp_param_unit_get_type ())
 
317
<indexterm zone="GIMP-TYPE-PARAM-UNIT--CAPS"><primary sortas="GIMP_TYPE_PARAM_UNIT">GIMP_TYPE_PARAM_UNIT</primary></indexterm><programlisting>#define GIMP_TYPE_PARAM_UNIT              (gimp_param_unit_get_type ())
333
318
</programlisting>
334
319
<para>
335
 
 
336
320
</para></refsect2>
337
 
<refsect2 id="GIMP-IS-PARAM-SPEC-UNIT:CAPS" role="macro">
 
321
<refsect2 id="GIMP-IS-PARAM-SPEC-UNIT--CAPS" role="macro">
338
322
<title>GIMP_IS_PARAM_SPEC_UNIT()</title>
339
 
<indexterm zone="GIMP-IS-PARAM-SPEC-UNIT:CAPS"><primary>GIMP_IS_PARAM_SPEC_UNIT</primary></indexterm><programlisting>#define GIMP_IS_PARAM_SPEC_UNIT(pspec)    (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))
 
323
<indexterm zone="GIMP-IS-PARAM-SPEC-UNIT--CAPS"><primary sortas="GIMP_IS_PARAM_SPEC_UNIT">GIMP_IS_PARAM_SPEC_UNIT</primary></indexterm><programlisting>#define GIMP_IS_PARAM_SPEC_UNIT(pspec)    (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))
340
324
</programlisting>
341
325
<para>
342
 
 
343
326
</para><variablelist role="params">
344
 
<varlistentry><term><parameter>pspec</parameter>&nbsp;:</term>
 
327
<varlistentry><term><parameter>pspec</parameter>&#160;:</term>
345
328
<listitem><simpara>
346
 
 
347
 
 
348
329
</simpara></listitem></varlistentry>
349
330
</variablelist></refsect2>
350
331
<refsect2 id="gimp-param-spec-unit" role="function" condition="since:GIMP 2.4">
351
332
<title>gimp_param_spec_unit ()</title>
352
 
<indexterm zone="gimp-param-spec-unit" role="GIMP 2.4"><primary>gimp_param_spec_unit</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link>*         gimp_param_spec_unit                (const <link linkend="gchar">gchar</link> *name,
 
333
<indexterm zone="gimp-param-spec-unit" role="GIMP 2.4"><primary sortas="gimp_param_spec_unit">gimp_param_spec_unit</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link> *        gimp_param_spec_unit                (const <link linkend="gchar">gchar</link> *name,
353
334
                                                         const <link linkend="gchar">gchar</link> *nick,
354
335
                                                         const <link linkend="gchar">gchar</link> *blurb,
355
336
                                                         <link linkend="gboolean">gboolean</link> allow_pixels,
360
341
Creates a param spec to hold a units param.
361
342
See <link linkend="g-param-spec-internal"><function>g_param_spec_internal()</function></link> for more information.</para>
362
343
<para>
363
 
 
364
344
</para><variablelist role="params">
365
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
345
<varlistentry><term><parameter>name</parameter>&#160;:</term>
366
346
<listitem><simpara>          Canonical name of the param
367
347
</simpara></listitem></varlistentry>
368
 
<varlistentry><term><parameter>nick</parameter>&nbsp;:</term>
 
348
<varlistentry><term><parameter>nick</parameter>&#160;:</term>
369
349
<listitem><simpara>          Nickname of the param
370
350
</simpara></listitem></varlistentry>
371
 
<varlistentry><term><parameter>blurb</parameter>&nbsp;:</term>
 
351
<varlistentry><term><parameter>blurb</parameter>&#160;:</term>
372
352
<listitem><simpara>         Brief desciption of param.
373
353
</simpara></listitem></varlistentry>
374
 
<varlistentry><term><parameter>allow_pixels</parameter>&nbsp;:</term>
 
354
<varlistentry><term><parameter>allow_pixels</parameter>&#160;:</term>
375
355
<listitem><simpara>  Whether "pixels" is an allowed unit.
376
356
</simpara></listitem></varlistentry>
377
 
<varlistentry><term><parameter>allow_percent</parameter>&nbsp;:</term>
 
357
<varlistentry><term><parameter>allow_percent</parameter>&#160;:</term>
378
358
<listitem><simpara> Whether "perecent" is an allowed unit.
379
359
</simpara></listitem></varlistentry>
380
 
<varlistentry><term><parameter>default_value</parameter>&nbsp;:</term>
 
360
<varlistentry><term><parameter>default_value</parameter>&#160;:</term>
381
361
<listitem><simpara> Unit to use if none is assigned.
382
362
</simpara></listitem></varlistentry>
383
 
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
363
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
384
364
<listitem><simpara>         a combination of <link linkend="GParamFlags"><type>GParamFlags</type></link>
385
365
</simpara></listitem></varlistentry>
386
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
 
366
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
387
367
 
388
368
</simpara></listitem></varlistentry>
389
 
</variablelist><para role="since">Since  GIMP 2.4
390
 
</para></refsect2>
391
 
<refsect2 id="GIMP-VALUE-HOLDS-UNIT:CAPS" role="macro">
 
369
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
 
370
<refsect2 id="GIMP-VALUE-HOLDS-UNIT--CAPS" role="macro">
392
371
<title>GIMP_VALUE_HOLDS_UNIT()</title>
393
 
<indexterm zone="GIMP-VALUE-HOLDS-UNIT:CAPS"><primary>GIMP_VALUE_HOLDS_UNIT</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
 
372
<indexterm zone="GIMP-VALUE-HOLDS-UNIT--CAPS"><primary sortas="GIMP_VALUE_HOLDS_UNIT">GIMP_VALUE_HOLDS_UNIT</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
394
373
</programlisting>
395
374
<para>
396
 
 
397
375
</para><variablelist role="params">
398
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
376
<varlistentry><term><parameter>value</parameter>&#160;:</term>
399
377
<listitem><simpara>
400
 
 
401
 
 
402
378
</simpara></listitem></varlistentry>
403
379
</variablelist></refsect2>
404
380