← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

« back to all changes in this revision

Viewing changes to devel-docs/libgimpbase/html/libgimpbase-gimpbasetypes.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-12-09 19:44:52 UTC
  • Revision ID: james.westby@ubuntu.com-20051209194452-yggpemjlofpjqyf4
Tags: upstream-2.2.9
Import upstream version 2.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpbase/html/libgimpbase-gimpbasetypes.html
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>gimpbasetypes</title>
 
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
 
7
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
 
8
<link rel="prev" href="libgimpbase-gimpbaseenums.html" title="gimpbaseenums">
 
9
<link rel="next" href="libgimpbase-gimpversion.html" title="gimpversion">
 
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
 
11
<link rel="stylesheet" href="style.css" type="text/css">
 
12
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
 
16
<td><a accesskey="p" href="libgimpbase-gimpbaseenums.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
17
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
18
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
19
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
 
20
<td><a accesskey="n" href="libgimpbase-gimpversion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
21
</tr></table>
 
22
<div class="refentry" lang="en">
 
23
<a name="libgimpbase-gimpbasetypes"></a><div class="titlepage"></div>
 
24
<div class="refnamediv"><table width="100%"><tr>
 
25
<td valign="top">
 
26
<h2><span class="refentrytitle">gimpbasetypes</span></h2>
 
27
<p>gimpbasetypes &#8212; Translation between gettext translation domain identifier and GType.</p>
 
28
</td>
 
29
<td valign="top" align="right"></td>
 
30
</tr></table></div>
 
31
<div class="refsynopsisdiv">
 
32
<h2>Synopsis</h2>
 
33
<pre class="synopsis">
 
34
 
 
35
 
 
36
 
 
37
            <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>;
 
38
            <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>;
 
39
void        <a href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain">gimp_type_set_translation_domain</a>
 
40
                                            (GType type,
 
41
                                             const gchar *domain);
 
42
const gchar* <a href="libgimpbase-gimpbasetypes.html#gimp-type-get-translation-domain">gimp_type_get_translation_domain</a>
 
43
                                            (GType type);
 
44
void        <a href="libgimpbase-gimpbasetypes.html#gimp-enum-set-value-descriptions">gimp_enum_set_value_descriptions</a>
 
45
                                            (GType enum_type,
 
46
                                             const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a> *descriptions);
 
47
const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a href="libgimpbase-gimpbasetypes.html#gimp-enum-get-value-descriptions">gimp_enum_get_value_descriptions</a>
 
48
                                            (GType enum_type);
 
49
const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a href="libgimpbase-gimpbasetypes.html#gimp-flags-get-value-descriptions">gimp_flags_get_value_descriptions</a>
 
50
                                            (GType flags_type);
 
51
void        <a href="libgimpbase-gimpbasetypes.html#gimp-flags-set-value-descriptions">gimp_flags_set_value_descriptions</a>
 
52
                                            (GType flags_type,
 
53
                                             const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a> *descriptions);
 
54
</pre>
 
55
</div>
 
56
<div class="refsect1" lang="en">
 
57
<a name="id2530363"></a><h2>Description</h2>
 
58
<p>
 
59
Translation between gettext translation domain identifier and GType.
 
60
</p>
 
61
</div>
 
62
<div class="refsect1" lang="en">
 
63
<a name="id2530376"></a><h2>Details</h2>
 
64
<div class="refsect2" lang="en">
 
65
<a name="id2530382"></a><h3>
 
66
<a name="GimpEnumDesc"></a>GimpEnumDesc</h3>
 
67
<a class="indexterm" name="id2530392"></a><pre class="programlisting">typedef struct {
 
68
  gint   value;
 
69
  gchar *value_desc;
 
70
  gchar *value_help;
 
71
} GimpEnumDesc;
 
72
</pre>
 
73
<p>
 
74
 
 
75
</p>
 
76
</div>
 
77
<hr>
 
78
<div class="refsect2" lang="en">
 
79
<a name="id2540535"></a><h3>
 
80
<a name="GimpFlagsDesc"></a>GimpFlagsDesc</h3>
 
81
<a class="indexterm" name="id2540545"></a><pre class="programlisting">typedef struct {
 
82
  guint  value;
 
83
  gchar *value_desc;
 
84
  gchar *value_help;
 
85
} GimpFlagsDesc;
 
86
</pre>
 
87
<p>
 
88
 
 
89
</p>
 
90
</div>
 
91
<hr>
 
92
<div class="refsect2" lang="en">
 
93
<a name="id2540562"></a><h3>
 
94
<a name="gimp-type-set-translation-domain"></a>gimp_type_set_translation_domain ()</h3>
 
95
<a class="indexterm" name="id2540573"></a><pre class="programlisting">void        gimp_type_set_translation_domain
 
96
                                            (GType type,
 
97
                                             const gchar *domain);</pre>
 
98
<p>
 
99
This function attaches a constant string as a gettext translation
 
100
domain identifier to a <span class="type">GType</span>. The only purpose of this function is
 
101
to use it when registering a <span class="type">GTypeEnum</span> with translatable value
 
102
names.</p>
 
103
<p>
 
104
 
 
105
</p>
 
106
<div class="variablelist"><table border="0">
 
107
<col align="left" valign="top">
 
108
<tbody>
 
109
<tr>
 
110
<td>
 
111
<span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
 
112
<td>   a <span class="type">GType</span>
 
113
</td>
 
114
</tr>
 
115
<tr>
 
116
<td>
 
117
<span class="term"><em class="parameter"><code>domain</code></em>&#160;:</span></td>
 
118
<td> a constant string that identifies a translation domain or <code class="literal">NULL</code>
 
119
</td>
 
120
</tr>
 
121
</tbody>
 
122
</table></div>
 
123
<p>Since  GIMP 2.2
 
124
</p>
 
125
</div>
 
126
<hr>
 
127
<div class="refsect2" lang="en">
 
128
<a name="id2552476"></a><h3>
 
129
<a name="gimp-type-get-translation-domain"></a>gimp_type_get_translation_domain ()</h3>
 
130
<a class="indexterm" name="id2552487"></a><pre class="programlisting">const gchar* gimp_type_get_translation_domain
 
131
                                            (GType type);</pre>
 
132
<p>
 
133
Retrieves the gettext translation domain identifier that has been
 
134
previously set using <a href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain"><code class="function">gimp_type_set_translation_domain()</code></a>. You should
 
135
not need to use this function directly, use <a href="libgimpbase-gimputils.html#gimp-enum-get-value"><code class="function">gimp_enum_get_value()</code></a>
 
136
or <code class="function">gimp_enum_value_get_name()</code> instead.</p>
 
137
<p>
 
138
 
 
139
</p>
 
140
<div class="variablelist"><table border="0">
 
141
<col align="left" valign="top">
 
142
<tbody>
 
143
<tr>
 
144
<td>
 
145
<span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
 
146
<td> a <span class="type">GType</span>
 
147
</td>
 
148
</tr>
 
149
<tr>
 
150
<td>
 
151
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
152
<td> the translation domain associated with <em class="parameter"><code>type</code></em>
 
153
              or <code class="literal">NULL</code> if no domain was set
 
154
 
 
155
</td>
 
156
</tr>
 
157
</tbody>
 
158
</table></div>
 
159
<p>Since  GIMP 2.2
 
160
</p>
 
161
</div>
 
162
<hr>
 
163
<div class="refsect2" lang="en">
 
164
<a name="id2552603"></a><h3>
 
165
<a name="gimp-enum-set-value-descriptions"></a>gimp_enum_set_value_descriptions ()</h3>
 
166
<a class="indexterm" name="id2552614"></a><pre class="programlisting">void        gimp_enum_set_value_descriptions
 
167
                                            (GType enum_type,
 
168
                                             const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a> *descriptions);</pre>
 
169
<p>
 
170
Sets the array of human readable and translatable descriptions
 
171
and help texts for enum values.</p>
 
172
<p>
 
173
 
 
174
</p>
 
175
<div class="variablelist"><table border="0">
 
176
<col align="left" valign="top">
 
177
<tbody>
 
178
<tr>
 
179
<td>
 
180
<span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
 
181
<td>    a <span class="type">GType</span>
 
182
</td>
 
183
</tr>
 
184
<tr>
 
185
<td>
 
186
<span class="term"><em class="parameter"><code>descriptions</code></em>&#160;:</span></td>
 
187
<td> a <code class="literal">NULL</code> terminated constant static array of <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
 
188
</td>
 
189
</tr>
 
190
</tbody>
 
191
</table></div>
 
192
<p>Since  GIMP 2.2
 
193
</p>
 
194
</div>
 
195
<hr>
 
196
<div class="refsect2" lang="en">
 
197
<a name="id2552713"></a><h3>
 
198
<a name="gimp-enum-get-value-descriptions"></a>gimp_enum_get_value_descriptions ()</h3>
 
199
<a class="indexterm" name="id2552724"></a><pre class="programlisting">const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_value_descriptions
 
200
                                            (GType enum_type);</pre>
 
201
<p>
 
202
Retreives the array of human readable and translatable descriptions
 
203
and help texts for enum values.</p>
 
204
<p>
 
205
 
 
206
</p>
 
207
<div class="variablelist"><table border="0">
 
208
<col align="left" valign="top">
 
209
<tbody>
 
210
<tr>
 
211
<td>
 
212
<span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
 
213
<td> a <span class="type">GType</span>
 
214
</td>
 
215
</tr>
 
216
<tr>
 
217
<td>
 
218
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
219
<td> a <code class="literal">NULL</code> terminated constant array of <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
 
220
 
 
221
</td>
 
222
</tr>
 
223
</tbody>
 
224
</table></div>
 
225
<p>Since  GIMP 2.2
 
226
</p>
 
227
</div>
 
228
<hr>
 
229
<div class="refsect2" lang="en">
 
230
<a name="id2474187"></a><h3>
 
231
<a name="gimp-flags-get-value-descriptions"></a>gimp_flags_get_value_descriptions ()</h3>
 
232
<a class="indexterm" name="id2474198"></a><pre class="programlisting">const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_value_descriptions
 
233
                                            (GType flags_type);</pre>
 
234
<p>
 
235
Retreives the array of human readable and translatable descriptions
 
236
and help texts for flags values.</p>
 
237
<p>
 
238
 
 
239
</p>
 
240
<div class="variablelist"><table border="0">
 
241
<col align="left" valign="top">
 
242
<tbody>
 
243
<tr>
 
244
<td>
 
245
<span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></td>
 
246
<td> a <span class="type">GType</span>
 
247
</td>
 
248
</tr>
 
249
<tr>
 
250
<td>
 
251
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
252
<td> a <code class="literal">NULL</code> terminated constant array of <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
 
253
 
 
254
</td>
 
255
</tr>
 
256
</tbody>
 
257
</table></div>
 
258
<p>Since  GIMP 2.2
 
259
</p>
 
260
</div>
 
261
<hr>
 
262
<div class="refsect2" lang="en">
 
263
<a name="id2474287"></a><h3>
 
264
<a name="gimp-flags-set-value-descriptions"></a>gimp_flags_set_value_descriptions ()</h3>
 
265
<a class="indexterm" name="id2474298"></a><pre class="programlisting">void        gimp_flags_set_value_descriptions
 
266
                                            (GType flags_type,
 
267
                                             const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a> *descriptions);</pre>
 
268
<p>
 
269
Sets the array of human readable and translatable descriptions
 
270
and help texts for flags values.</p>
 
271
<p>
 
272
 
 
273
</p>
 
274
<div class="variablelist"><table border="0">
 
275
<col align="left" valign="top">
 
276
<tbody>
 
277
<tr>
 
278
<td>
 
279
<span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></td>
 
280
<td>   a <span class="type">GType</span>
 
281
</td>
 
282
</tr>
 
283
<tr>
 
284
<td>
 
285
<span class="term"><em class="parameter"><code>descriptions</code></em>&#160;:</span></td>
 
286
<td> a <code class="literal">NULL</code> terminated constant static array of <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
 
287
</td>
 
288
</tr>
 
289
</tbody>
 
290
</table></div>
 
291
<p>Since  GIMP 2.2
 
292
</p>
 
293
</div>
 
294
</div>
 
295
</div>
 
296
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
297
<td align="left"><a accesskey="p" href="libgimpbase-gimpbaseenums.html"><b>&lt;&lt;&#160;gimpbaseenums</b></a></td>
 
298
<td align="right"><a accesskey="n" href="libgimpbase-gimpversion.html"><b>gimpversion&#160;&gt;&gt;</b></a></td>
 
299
</tr></table>
 
300
</body>
 
301
</html>