← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gimp/utopic

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2013-08-29 12:48:19 UTC
  • mfrom: (1.1.29) (0.4.20 saucy-proposed)
  • Revision ID: package-import@ubuntu.com-20130829124819-r4mliaiddrgv5x4g
Tags: 2.8.6-1ubuntu1
https://launchpad.net/bugs/1207734
* Synchronize with Debian (LP: #1207734). Remaining changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + Update some strings for Ubuntu
  - debian/control:
    + Update description
  - debian/rules:
    + Set gettext domain and update translation templates

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpbase/html/libgimpbase-gimputils.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>gimputils</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GIMP Base Library Reference Manual">
8
8
<link rel="up" href="libgimpbase.html" title="Part I. GIMP Base Library">
9
9
<link rel="prev" href="libgimpbase-gimpunit.html" title="gimpunit">
103
103
with "(invalid UTF-8 string)" is returned. If not even the start
104
104
of <em class="parameter"><code>str</code></em> is valid UTF-8, only "(invalid UTF-8 string)" is returned.
105
105
</p>
106
 
<div class="variablelist"><table border="0">
 
106
<div class="variablelist"><table border="0" class="variablelist">
 
107
<colgroup>
107
108
<col align="left" valign="top">
 
109
<col>
 
110
</colgroup>
108
111
<tbody>
109
112
<tr>
110
113
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
147
150
a filename in the filesystem encoding to a function that expects an
148
151
UTF-8 encoded filename.
149
152
</p>
150
 
<div class="variablelist"><table border="0">
 
153
<div class="variablelist"><table border="0" class="variablelist">
 
154
<colgroup>
151
155
<col align="left" valign="top">
 
156
<col>
 
157
</colgroup>
152
158
<tbody>
153
159
<tr>
154
160
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
172
178
exceeds <em class="parameter"><code>max_chars</code></em> characters or on the first newline. The fact
173
179
that the string was trimmed is indicated by appending an ellipsis.
174
180
</p>
175
 
<div class="variablelist"><table border="0">
 
181
<div class="variablelist"><table border="0" class="variablelist">
 
182
<colgroup>
176
183
<col align="left" valign="top">
 
184
<col>
 
185
</colgroup>
177
186
<tbody>
178
187
<tr>
179
188
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
202
211
strings with underlines (like filenames) in a place that would convert
203
212
them to mnemonics.
204
213
</p>
205
 
<div class="variablelist"><table border="0">
 
214
<div class="variablelist"><table border="0" class="variablelist">
 
215
<colgroup>
206
216
<col align="left" valign="top">
 
217
<col>
 
218
</colgroup>
207
219
<tbody>
208
220
<tr>
209
221
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
233
245
this construct and removes the whole bracket construction to get
234
246
rid of the mnemonic (see bug 157561).
235
247
</p>
236
 
<div class="variablelist"><table border="0">
 
248
<div class="variablelist"><table border="0" class="variablelist">
 
249
<colgroup>
237
250
<col align="left" valign="top">
 
251
<col>
 
252
</colgroup>
238
253
<tbody>
239
254
<tr>
240
255
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
260
275
and parameter names. Every character of the input string that is
261
276
not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'.
262
277
</p>
263
 
<div class="variablelist"><table border="0">
 
278
<div class="variablelist"><table border="0" class="variablelist">
 
279
<colgroup>
264
280
<col align="left" valign="top">
 
281
<col>
 
282
</colgroup>
265
283
<tbody>
266
284
<tr>
267
285
<td><p><span class="term"><em class="parameter"><code>identifier</code></em> :</span></p></td>
285
303
<p>
286
304
Retrieves <a class="link" href="libgimpbase-gimpbasetypes.html#GimpEnumDesc" title="struct GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <code class="literal">NULL</code>.
287
305
</p>
288
 
<div class="variablelist"><table border="0">
 
306
<div class="variablelist"><table border="0" class="variablelist">
 
307
<colgroup>
289
308
<col align="left" valign="top">
 
309
<col>
 
310
</colgroup>
290
311
<tbody>
291
312
<tr>
292
313
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em> :</span></p></td>
321
342
description and help are returned (if <em class="parameter"><code>value_name</code></em>, <em class="parameter"><code>value_nick</code></em>,
322
343
<em class="parameter"><code>value_desc</code></em> and <em class="parameter"><code>value_help</code></em> are not <code class="literal">NULL</code>).
323
344
</p>
324
 
<div class="variablelist"><table border="0">
 
345
<div class="variablelist"><table border="0" class="variablelist">
 
346
<colgroup>
325
347
<col align="left" valign="top">
 
348
<col>
 
349
</colgroup>
326
350
<tbody>
327
351
<tr>
328
352
<td><p><span class="term"><em class="parameter"><code>enum_type</code></em> :</span></p></td>
366
390
<p>
367
391
Retrieves the translated description for a given <em class="parameter"><code>enum_value</code></em>.
368
392
</p>
369
 
<div class="variablelist"><table border="0">
 
393
<div class="variablelist"><table border="0" class="variablelist">
 
394
<colgroup>
370
395
<col align="left" valign="top">
 
396
<col>
 
397
</colgroup>
371
398
<tbody>
372
399
<tr>
373
400
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em> :</span></p></td>
395
422
<p>
396
423
Retrieves the translated help for a given <em class="parameter"><code>enum_value</code></em>.
397
424
</p>
398
 
<div class="variablelist"><table border="0">
 
425
<div class="variablelist"><table border="0" class="variablelist">
 
426
<colgroup>
399
427
<col align="left" valign="top">
 
428
<col>
 
429
</colgroup>
400
430
<tbody>
401
431
<tr>
402
432
<td><p><span class="term"><em class="parameter"><code>enum_class</code></em> :</span></p></td>
424
454
<p>
425
455
Retrieves the first <a class="link" href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc" title="struct GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <code class="literal">NULL</code>.
426
456
</p>
427
 
<div class="variablelist"><table border="0">
 
457
<div class="variablelist"><table border="0" class="variablelist">
 
458
<colgroup>
428
459
<col align="left" valign="top">
 
460
<col>
 
461
</colgroup>
429
462
<tbody>
430
463
<tr>
431
464
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em> :</span></p></td>
460
493
translated description and help are returned (if <em class="parameter"><code>value_name</code></em>,
461
494
<em class="parameter"><code>value_nick</code></em>, <em class="parameter"><code>value_desc</code></em> and <em class="parameter"><code>value_help</code></em> are not <code class="literal">NULL</code>).
462
495
</p>
463
 
<div class="variablelist"><table border="0">
 
496
<div class="variablelist"><table border="0" class="variablelist">
 
497
<colgroup>
464
498
<col align="left" valign="top">
 
499
<col>
 
500
</colgroup>
465
501
<tbody>
466
502
<tr>
467
503
<td><p><span class="term"><em class="parameter"><code>flags_type</code></em> :</span></p></td>
505
541
<p>
506
542
Retrieves the translated description for a given <em class="parameter"><code>flags_value</code></em>.
507
543
</p>
508
 
<div class="variablelist"><table border="0">
 
544
<div class="variablelist"><table border="0" class="variablelist">
 
545
<colgroup>
509
546
<col align="left" valign="top">
 
547
<col>
 
548
</colgroup>
510
549
<tbody>
511
550
<tr>
512
551
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em> :</span></p></td>
534
573
<p>
535
574
Retrieves the translated help for a given <em class="parameter"><code>flags_value</code></em>.
536
575
</p>
537
 
<div class="variablelist"><table border="0">
 
576
<div class="variablelist"><table border="0" class="variablelist">
 
577
<colgroup>
538
578
<col align="left" valign="top">
 
579
<col>
 
580
</colgroup>
539
581
<tbody>
540
582
<tr>
541
583
<td><p><span class="term"><em class="parameter"><code>flags_class</code></em> :</span></p></td>