31
31
<div class="refnamediv"><table width="100%"><tr>
33
33
<h2><span class="refentrytitle"><a name="libgimpbase-gimpbasetypes.top_of_page"></a>gimpbasetypes</span></h2>
34
<p>gimpbasetypes — Translation between gettext translation domain identifier and GType.</p>
34
<p>gimpbasetypes — Translation between gettext translation domain
35
identifier and GType.</p>
36
37
<td valign="top" align="right"></td>
37
38
</tr></table></div>
39
40
<a name="libgimpbase-gimpbasetypes.synopsis"></a><h2>Synopsis</h2>
40
41
<pre class="synopsis">struct <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc">GimpEnumDesc</a>;
41
42
struct <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc">GimpFlagsDesc</a>;
42
<span class="returnvalue">void</span> <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain" title="gimp_type_set_translation_domain ()">gimp_type_set_translation_domain</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>,
43
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain</code></em>);
44
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-type-get-translation-domain" title="gimp_type_get_translation_domain ()">gimp_type_get_translation_domain</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);
45
<span class="returnvalue">void</span> <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-enum-set-value-descriptions" title="gimp_enum_set_value_descriptions ()">gimp_enum_set_value_descriptions</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enum_type</code></em>,
43
<span class="returnvalue">void</span> <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain" title="gimp_type_set_translation_domain ()">gimp_type_set_translation_domain</a> (<em class="parameter"><code><span class="type">GType</span> type</code></em>,
44
<em class="parameter"><code>const <span class="type">gchar</span> *domain</code></em>);
45
const <span class="returnvalue">gchar</span> * <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-type-get-translation-domain" title="gimp_type_get_translation_domain ()">gimp_type_get_translation_domain</a> (<em class="parameter"><code><span class="type">GType</span> type</code></em>);
46
<span class="returnvalue">void</span> <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-context" title="gimp_type_set_translation_context ()">gimp_type_set_translation_context</a> (<em class="parameter"><code><span class="type">GType</span> type</code></em>,
47
<em class="parameter"><code>const <span class="type">gchar</span> *context</code></em>);
48
const <span class="returnvalue">gchar</span> * <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-type-get-translation-context" title="gimp_type_get_translation_context ()">gimp_type_get_translation_context</a> (<em class="parameter"><code><span class="type">GType</span> type</code></em>);
49
<span class="returnvalue">void</span> <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-enum-set-value-descriptions" title="gimp_enum_set_value_descriptions ()">gimp_enum_set_value_descriptions</a> (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>,
46
50
<em class="parameter"><code>const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> *descriptions</code></em>);
47
const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="returnvalue">GimpEnumDesc</span></a> * <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-enum-get-value-descriptions" title="gimp_enum_get_value_descriptions ()">gimp_enum_get_value_descriptions</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enum_type</code></em>);
48
const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="returnvalue">GimpFlagsDesc</span></a> * <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-flags-get-value-descriptions" title="gimp_flags_get_value_descriptions ()">gimp_flags_get_value_descriptions</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> flags_type</code></em>);
49
<span class="returnvalue">void</span> <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-flags-set-value-descriptions" title="gimp_flags_set_value_descriptions ()">gimp_flags_set_value_descriptions</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> flags_type</code></em>,
51
const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="returnvalue">GimpEnumDesc</span></a> * <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-enum-get-value-descriptions" title="gimp_enum_get_value_descriptions ()">gimp_enum_get_value_descriptions</a> (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>);
52
const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="returnvalue">GimpFlagsDesc</span></a> * <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-flags-get-value-descriptions" title="gimp_flags_get_value_descriptions ()">gimp_flags_get_value_descriptions</a> (<em class="parameter"><code><span class="type">GType</span> flags_type</code></em>);
53
<span class="returnvalue">void</span> <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-flags-set-value-descriptions" title="gimp_flags_set_value_descriptions ()">gimp_flags_set_value_descriptions</a> (<em class="parameter"><code><span class="type">GType</span> flags_type</code></em>,
50
54
<em class="parameter"><code>const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> *descriptions</code></em>);
53
57
<div class="refsect1">
54
58
<a name="libgimpbase-gimpbasetypes.description"></a><h2>Description</h2>
56
Translation between gettext translation domain identifier and GType.
60
Translation between gettext translation domain identifier and
59
64
<div class="refsect1">
75
This structure is used to register translatable descriptions and
76
help texts for enum values. See <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-enum-set-value-descriptions" title="gimp_enum_set_value_descriptions ()"><code class="function">gimp_enum_set_value_descriptions()</code></a>.
78
<div class="variablelist"><table border="0">
79
<col align="left" valign="top">
82
<td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="GimpEnumDesc.value"></a>value</code></em>;</span></p></td>
83
<td>An enum value.</td>
86
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="GimpEnumDesc.value-desc"></a>value_desc</code></em>;</span></p></td>
87
<td>The value's description.</td>
90
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="GimpEnumDesc.value-help"></a>value_help</code></em>;</span></p></td>
91
<td>The value's help text.</td>
73
97
<div class="refsect2">
106
This structure is used to register translatable descriptions and
107
help texts for flag values. See <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-flags-set-value-descriptions" title="gimp_flags_set_value_descriptions ()"><code class="function">gimp_flags_set_value_descriptions()</code></a>.
109
<div class="variablelist"><table border="0">
110
<col align="left" valign="top">
113
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="GimpFlagsDesc.value"></a>value</code></em>;</span></p></td>
114
<td>A flag value.</td>
117
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="GimpFlagsDesc.value-desc"></a>value_desc</code></em>;</span></p></td>
118
<td>The value's description.</td>
121
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="GimpFlagsDesc.value-help"></a>value_help</code></em>;</span></p></td>
122
<td>The value's help text.</td>
85
128
<div class="refsect2">
86
129
<a name="gimp-type-set-translation-domain"></a><h3>gimp_type_set_translation_domain ()</h3>
87
<pre class="programlisting"><span class="returnvalue">void</span> gimp_type_set_translation_domain (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>,
88
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain</code></em>);</pre>
130
<pre class="programlisting"><span class="returnvalue">void</span> gimp_type_set_translation_domain (<em class="parameter"><code><span class="type">GType</span> type</code></em>,
131
<em class="parameter"><code>const <span class="type">gchar</span> *domain</code></em>);</pre>
90
133
This function attaches a constant string as a gettext translation
91
domain identifier to a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>. The only purpose of this function is
92
to use it when registering a <span class="type">GTypeEnum</span> with translatable value
134
domain identifier to a <span class="type">GType</span>. The only purpose of this function is
135
to use it when registering a <span class="type">G_TYPE_ENUM</span> with translatable value
95
138
<div class="variablelist"><table border="0">
99
142
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
100
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
143
<td>a <span class="type">GType</span>
104
147
<td><p><span class="term"><em class="parameter"><code>domain</code></em> :</span></p></td>
105
<td>a constant string that identifies a translation domain or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
148
<td>a constant string that identifies a translation domain or <code class="literal">NULL</code>
113
156
<div class="refsect2">
114
157
<a name="gimp-type-get-translation-domain"></a><h3>gimp_type_get_translation_domain ()</h3>
115
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gimp_type_get_translation_domain (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre>
158
<pre class="programlisting">const <span class="returnvalue">gchar</span> * gimp_type_get_translation_domain (<em class="parameter"><code><span class="type">GType</span> type</code></em>);</pre>
117
160
Retrieves the gettext translation domain identifier that has been
118
161
previously set using <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain" title="gimp_type_set_translation_domain ()"><code class="function">gimp_type_set_translation_domain()</code></a>. You should
119
162
not need to use this function directly, use <a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-value" title="gimp_enum_get_value ()"><code class="function">gimp_enum_get_value()</code></a>
120
or <code class="function">gimp_enum_value_get_name()</code> instead.
163
or <a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-desc" title="gimp_enum_value_get_desc ()"><code class="function">gimp_enum_value_get_desc()</code></a> instead.
122
165
<div class="variablelist"><table border="0">
123
166
<col align="left" valign="top">
126
169
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
127
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
170
<td>a <span class="type">GType</span>
131
174
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
132
175
<td>the translation domain associated with <em class="parameter"><code>type</code></em>
133
or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if no domain was set</td>
176
or <code class="literal">NULL</code> if no domain was set</td>
140
183
<div class="refsect2">
184
<a name="gimp-type-set-translation-context"></a><h3>gimp_type_set_translation_context ()</h3>
185
<pre class="programlisting"><span class="returnvalue">void</span> gimp_type_set_translation_context (<em class="parameter"><code><span class="type">GType</span> type</code></em>,
186
<em class="parameter"><code>const <span class="type">gchar</span> *context</code></em>);</pre>
188
This function attaches a constant string as a translation context
189
to a <span class="type">GType</span>. The only purpose of this function is to use it when
190
registering a <span class="type">G_TYPE_ENUM</span> with translatable value names.
192
<div class="variablelist"><table border="0">
193
<col align="left" valign="top">
196
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
197
<td>a <span class="type">GType</span>
201
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
202
<td>a constant string that identifies a translation context or <code class="literal">NULL</code>
207
<p class="since">Since GIMP 2.8</p>
210
<div class="refsect2">
211
<a name="gimp-type-get-translation-context"></a><h3>gimp_type_get_translation_context ()</h3>
212
<pre class="programlisting">const <span class="returnvalue">gchar</span> * gimp_type_get_translation_context (<em class="parameter"><code><span class="type">GType</span> type</code></em>);</pre>
214
Retrieves the translation context that has been previously set
215
using <a class="link" href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-context" title="gimp_type_set_translation_context ()"><code class="function">gimp_type_set_translation_context()</code></a>. You should not need to
216
use this function directly, use <a class="link" href="libgimpbase-gimputils.html#gimp-enum-get-value" title="gimp_enum_get_value ()"><code class="function">gimp_enum_get_value()</code></a> or
217
<a class="link" href="libgimpbase-gimputils.html#gimp-enum-value-get-desc" title="gimp_enum_value_get_desc ()"><code class="function">gimp_enum_value_get_desc()</code></a> instead.
219
<div class="variablelist"><table border="0">
220
<col align="left" valign="top">
223
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
224
<td>a <span class="type">GType</span>
228
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
229
<td>the translation context associated with <em class="parameter"><code>type</code></em>
230
or <code class="literal">NULL</code> if no context was set</td>
234
<p class="since">Since GIMP 2.8</p>
237
<div class="refsect2">
141
238
<a name="gimp-enum-set-value-descriptions"></a><h3>gimp_enum_set_value_descriptions ()</h3>
142
<pre class="programlisting"><span class="returnvalue">void</span> gimp_enum_set_value_descriptions (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enum_type</code></em>,
239
<pre class="programlisting"><span class="returnvalue">void</span> gimp_enum_set_value_descriptions (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>,
143
240
<em class="parameter"><code>const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> *descriptions</code></em>);</pre>
145
242
Sets the array of human readable and translatable descriptions
152
249
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
153
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
250
<td>a <span class="type">GType</span>
157
254
<td><p><span class="term"><em class="parameter"><code>descriptions</code></em> :</span></p></td>
158
<td>a <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated constant static array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
255
<td>a <code class="literal">NULL</code> terminated constant static array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
166
263
<div class="refsect2">
167
264
<a name="gimp-enum-get-value-descriptions"></a><h3>gimp_enum_get_value_descriptions ()</h3>
168
<pre class="programlisting">const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="returnvalue">GimpEnumDesc</span></a> * gimp_enum_get_value_descriptions (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enum_type</code></em>);</pre>
265
<pre class="programlisting">const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="returnvalue">GimpEnumDesc</span></a> * gimp_enum_get_value_descriptions (<em class="parameter"><code><span class="type">GType</span> enum_type</code></em>);</pre>
170
267
Retreives the array of human readable and translatable descriptions
171
268
and help texts for enum values.
177
274
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
178
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
275
<td>a <span class="type">GType</span>
182
279
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
183
<td>a <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated constant array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
280
<td>a <code class="literal">NULL</code> terminated constant array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
191
288
<div class="refsect2">
192
289
<a name="gimp-flags-get-value-descriptions"></a><h3>gimp_flags_get_value_descriptions ()</h3>
193
<pre class="programlisting">const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="returnvalue">GimpFlagsDesc</span></a> * gimp_flags_get_value_descriptions (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> flags_type</code></em>);</pre>
290
<pre class="programlisting">const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="returnvalue">GimpFlagsDesc</span></a> * gimp_flags_get_value_descriptions (<em class="parameter"><code><span class="type">GType</span> flags_type</code></em>);</pre>
195
292
Retreives the array of human readable and translatable descriptions
196
293
and help texts for flags values.
202
299
<td><p><span class="term"><em class="parameter"><code>flags_type</code></em> :</span></p></td>
203
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
300
<td>a <span class="type">GType</span>
207
304
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
208
<td>a <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated constant array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
305
<td>a <code class="literal">NULL</code> terminated constant array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
216
313
<div class="refsect2">
217
314
<a name="gimp-flags-set-value-descriptions"></a><h3>gimp_flags_set_value_descriptions ()</h3>
218
<pre class="programlisting"><span class="returnvalue">void</span> gimp_flags_set_value_descriptions (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> flags_type</code></em>,
315
<pre class="programlisting"><span class="returnvalue">void</span> gimp_flags_set_value_descriptions (<em class="parameter"><code><span class="type">GType</span> flags_type</code></em>,
219
316
<em class="parameter"><code>const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> *descriptions</code></em>);</pre>
221
318
Sets the array of human readable and translatable descriptions
228
325
<td><p><span class="term"><em class="parameter"><code>flags_type</code></em> :</span></p></td>
229
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
326
<td>a <span class="type">GType</span>
233
330
<td><p><span class="term"><em class="parameter"><code>descriptions</code></em> :</span></p></td>
234
<td>a <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated constant static array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
331
<td>a <code class="literal">NULL</code> terminated constant static array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>