1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpbasetypes</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part I. GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpbaseenums.html" title="gimpbaseenums">
<link rel="next" href="libgimpbase-gimpversion.html" title="gimpversion">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpbaseenums.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpversion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimpbase-gimpbasetypes.synopsis" class="shortcut">Top</a>
|
<a href="#libgimpbase-gimpbasetypes.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="gimpbasetypes">
<a name="libgimpbase-gimpbasetypes"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimpbase-gimpbasetypes.top_of_page"></a>gimpbasetypes</span></h2>
<p>gimpbasetypes — Translation between gettext translation domain identifier and GType.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libgimpbase-gimpbasetypes.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc">GimpEnumDesc</a>;
<a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc">GimpFlagsDesc</a>;
<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="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);
<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="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enum_type</code></em>,
<em class="parameter"><code>const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> *descriptions</code></em>);
const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="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="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enum_type</code></em>);
const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="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="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> flags_type</code></em>);
<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="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> flags_type</code></em>,
<em class="parameter"><code>const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> *descriptions</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libgimpbase-gimpbasetypes.description"></a><h2>Description</h2>
<p>
Translation between gettext translation domain identifier and GType.
</p>
</div>
<div class="refsect1" title="Details">
<a name="libgimpbase-gimpbasetypes.details"></a><h2>Details</h2>
<div class="refsect2" title="GimpEnumDesc">
<a name="GimpEnumDesc"></a><h3>GimpEnumDesc</h3>
<pre class="programlisting">typedef struct {
gint value;
const gchar *value_desc;
const gchar *value_help;
} GimpEnumDesc;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="GimpFlagsDesc">
<a name="GimpFlagsDesc"></a><h3>GimpFlagsDesc</h3>
<pre class="programlisting">typedef struct {
guint value;
const gchar *value_desc;
const gchar *value_help;
} GimpFlagsDesc;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="gimp_type_set_translation_domain ()">
<a name="gimp-type-set-translation-domain"></a><h3>gimp_type_set_translation_domain ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_type_set_translation_domain (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain</code></em>);</pre>
<p>
This function attaches a constant string as a gettext translation
domain identifier to a <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a>. The only purpose of this function is
to use it when registering a <span class="type">GTypeEnum</span> with translatable value
names.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>domain</code></em> :</span></p></td>
<td>a constant string that identifies a translation domain or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2" title="gimp_type_get_translation_domain ()">
<a name="gimp-type-get-translation-domain"></a><h3>gimp_type_get_translation_domain ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gimp_type_get_translation_domain (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre>
<p>
Retrieves the gettext translation domain identifier that has been
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
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>
or <code class="function">gimp_enum_value_get_name()</code> instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the translation domain associated with <em class="parameter"><code>type</code></em>
or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no domain was set
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2" title="gimp_enum_set_value_descriptions ()">
<a name="gimp-enum-set-value-descriptions"></a><h3>gimp_enum_set_value_descriptions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_enum_set_value_descriptions (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enum_type</code></em>,
<em class="parameter"><code>const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> *descriptions</code></em>);</pre>
<p>
Sets the array of human readable and translatable descriptions
and help texts for enum values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>descriptions</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated constant static array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2" title="gimp_enum_get_value_descriptions ()">
<a name="gimp-enum-get-value-descriptions"></a><h3>gimp_enum_get_value_descriptions ()</h3>
<pre class="programlisting">const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc"><span class="returnvalue">GimpEnumDesc</span></a> * gimp_enum_get_value_descriptions (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> enum_type</code></em>);</pre>
<p>
Retreives the array of human readable and translatable descriptions
and help texts for enum values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated constant array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2" title="gimp_flags_get_value_descriptions ()">
<a name="gimp-flags-get-value-descriptions"></a><h3>gimp_flags_get_value_descriptions ()</h3>
<pre class="programlisting">const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc"><span class="returnvalue">GimpFlagsDesc</span></a> * gimp_flags_get_value_descriptions (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> flags_type</code></em>);</pre>
<p>
Retreives the array of human readable and translatable descriptions
and help texts for flags values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_type</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated constant array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2" title="gimp_flags_set_value_descriptions ()">
<a name="gimp-flags-set-value-descriptions"></a><h3>gimp_flags_set_value_descriptions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_flags_set_value_descriptions (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> flags_type</code></em>,
<em class="parameter"><code>const <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> *descriptions</code></em>);</pre>
<p>
Sets the array of human readable and translatable descriptions
and help texts for flags values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags_type</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>descriptions</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated constant static array of <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
</body>
</html>
|
