← Back to branch summary

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

« 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: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

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