File: KLocalizedString.html

package info (click to toggle)
pykde4 4%3A4.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 30,864 kB
  • ctags: 18,431
  • sloc: python: 2,063; cpp: 327; makefile: 52; sh: 5
file content (772 lines) | stat: -rw-r--r-- 27,850 bytes parent folder | download | duplicates (2)
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">

<head>
  <title>KLocalizedString</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
  <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
  <div id="header_top">
    <div>
      <div>
        <img alt ="" src="../common/top-kde.jpg"/>
        KDE 4.9 PyKDE API Reference
      </div>
    </div>
  </div>
  <div id="header_bottom">
    <div id="location">
      <ul>
        <li>KDE's Python API</li>
      </ul>
    </div>

    <div id="menu">
      <ul>
        <li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
    </div>
  </div>
</div>

<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer">&nbsp;</div>

<h1>KLocalizedString Class Reference</h1>
<code>from PyKDE4.kdecore import *</code>
<p>



<h2>Detailed Description</h2>

<p>Class for producing and handling localized messages
</p>
<p>
KLocalizedString handles translation and specific needs of argument
substitution and formatting in localized message strings.
</p>
<p>
Topics:
- gen_usage
- spec_usage
- subs_notes
- other_ref
</p>
<p>
<b>General Usage </b>
</p>
<p>
This class should mostly not be used directly, but through wrapper i18n
calls which return QString, for localization of user visible messages in
applications.
</p>
<p>
For the most frequent message type, the one without any arguments, you would
use simply:
<pre class="fragment">
   QString msg = i18n("Just plain info");
</pre>
</p>
<p>
If there are arguments to be substitued into the message, you just add them
after the message string:
<pre class="fragment">
   QString msg = i18n("%1 has scored %2", playerName, score);
</pre>
There can be up to some final number of arguments added like this (i18n
is realized by overloaded templates). If you overrun this number, use
ki18n* series of calls (described below). You can use several types as
arguments, see subs methods.
</p>
<p>
Sometimes a short message can be ambiguous in English, then you would use
the context version, i18nc. There the first string is context, and the
second is the message which really gets displayed:
<pre class="fragment">
   QString msg = i18nc("Player name - score", "%1 - %2", playerName, score);
</pre>
</p>
<p>
While English diferentiates plural forms only between 1 and else, in other
languages it might not be that simple, or it might be simpler. To handle
this properly, use plural call, i18np:
<pre class="fragment">
   QString msg = i18np("One image in album %2", "%1 images in album %2",
                       numImages, albumName);
</pre>
Note that the plural form shall be decided by first integer-valued argument,
(numImages in the example above). In rare cases when there are two integer
arguments, you should take care to order them properly.
</p>
<p>
Finally, message might need both context and plural, which is provided by
i18ncp call:
<pre class="fragment">
   QString msg = i18ncp("Personal file", "One file", "%1 files", numFiles);
</pre>
</p>
<p>
Be carefull not to use literal string as first argument after message text
in basic i18n() call. In debug mode, it will even trigger the static assert,
giving error at compile time. This is in order to prevent misnamed calls:
it may happen that you add context or plural to previously basic message,
but forget to change the name of the call.
</p>
<p>
All message strings are expected to pass for well-formed XML, whether or
not the output device supports some form of markup.
Thus, predefined XML entities are always available: &amp;amp;lt;, &amp;amp;gt;,
&amp;amp;amp;, &amp;amp;apos;, and &amp;amp;quot;. E.g. if you need a non-tag
less-than sign, use &amp;amp;lt; entity instead.
The exception to the well-formed XML requirement is the ampersand (&amp;amp;),
which is used a lot for marking accelerators, so you should not write it
as &amp;amp;amp; (except in the very unlikely case when the construct with
the naked ampersand can be interpreted as an entity in itself).
</p>
<p>
<b>Specialized Usage </b>
</p>
<p>
There are some situations where i18n* calls are not sufficient or
convenient. For one, if you need to substitute many arguments. Or, if you
find that you need to defer the substitution. For this you can use the
ki18n call which returns a KLocalizedString, substitute arguments
using its subs methods, and finalize the translation by calling
its toString method. For example:
<pre class="fragment">
   KLocalizedString ks;
   case (reportSource) {
     SRC_ENG: ks = ki18n("Engineering reports: %1"); break;
     SRC_HEL: ks = ki18n("Helm reports: %1"); break;
     SRC_SON: ks = ki18n("Sonar reports: %1"); break;
     default: ks = ki18n("General report: %1");
   }
   QString msg = ks.subs(reportText).toString();
</pre>
</p>
<p>
Another case is when you want extra formatting of arguments, like field
width or number of decimals. subs methods can take these formatting
parameters. In particular, you should never use some custom way to
format arguments, as subs methods will also properly localize them:
<pre class="fragment">
   QString s = i18n("Rounds: %1", myNumberFormat(n, 8)); // bad, number not localized
   QString s = ki18n("Rounds: %1").subs(n, 8).toString(); // good, number localized
</pre>
</p>
<p>
There are also context, plural and context-plural variants:
<pre class="fragment">
   QString s = ki18nc("No function", "None").toString();
   QString s = ki18np("File found", "%1 files found").subs(n).toString();
   QString s = ki18ncp("Personal file", "One file", "%1 files").subs(n).toString();
</pre>
</p>
<p>
If you need translation using locale (ie. KLocale object) other than the
default, you can use overloaded toString method which takes pointer to a
locale:
<pre class="fragment">
   KLocale *myLocale;
   ...
   QString msg = ki18n("Welcome").toString(myLocale);
</pre>
</p>
<p>
Normally all loaded catalogs are searched for translation,
and the first found translation is returned.
Sometimes this may lead to clashes, especially when dealing with
specialized collection catalogs (country names, language names, etc.)
in which messages are not equipped with contexts.
In such situations, toString method can take the name of
the specific catalog in which to look for translation:
<pre class="fragment">
   QString trName = ki18n("Georgia").toString("countries");
</pre>
</p>
<p>
Translators have a capability to script translations at runtime, which is
for the most part transparent to the programmer. However, sometimes the
programmer may help by providing some dynamic context to the message,
using the inContext method of KLocalizedString. Unlike the ordinary
context, this one changes at runtime; translators have the means to fetch
it and use it to script the translation properly. An example:
<pre class="fragment">
   KLocalizedString ks = ki18nc("%1 is user name; may have "
                                "dynamic context gender=[male,female]",
                                "%1 went offline");
   if (knownUsers.contains(user) &amp;&amp; !knownUsers[user].gender.isEmpty()) {
     ks = ks.inContext("gender", knownUsers[user].gender);
   }
   QString msg = ks.subs(user).toString();
</pre>
Several dynamic contexts, with different keys, can be added like this.
</p>
<p>
<b>Placeholder Substitution </b>
</p>
<p>
Hopefully, for the most part placeholders are being substituted the way
you would intuitively expect them to be. Nevertheless:
</p>
<p>
<li> Placeholders are substituted in one pass, so no need to worry about </li>
argument itself containing a placeholder.
</p>
<p>
<li> All same-numbered placeholders are substituted with same argument. </li>
</p>
<p>
<li> Placeholders directly index arguments: they should be numbered from 1 </li>
upwards, without gaps in the sequence so that each argument is indexed.
Otherwise you will get error marks in messages at runtime (when compiled
in debug mode), and any invalid placeholder will be left unsubstituted.
The exception is plural-deciding argument in plural call, where it is
allowed to drop its placeholder in either singular or plural form.
</p>
<p>
<li> If none of the arguments supplied to a plural call is integer-valued, </li>
you will get an error mark in message at runtime (in debug mode).
</p>
<p>
<li> Plain number arguments will be normally formatted as if they denote </li>
amounts, according to language rules (thousands separation, etc.)
But sometimes a number is a numerical identifier (e.g. port number),
and to be treated as such, wrap the placeholder with the numid tag:
<pre class="fragment">
       QString msg = i18n("Using port &lt;numid&gt;%1&lt;/numid&gt;", port);
</pre>
</p>
<p>
<b>Further References </b>
</p>
<p>
<a href="http://techbase.kde.org/">KDE Techbase</a> contains a
<a href="http://techbase.kde.org/Development/Tutorials/Localization">
series of tutorials</a> on preparing the code for localization (and on
internationalization process in general), where the intended patterns of
usage of i18n API are covered in great detail.
</p>
<p>
All i18n'd messages, whether sent to widgets expecting plain text or
allowing Qt rich text (HTML), support the new KDE semantic markup for
user interface text, KUIT in short. Semantic markup both increases the
consistency of visual presentation for the end user, and provides extra
information to translators, so that translations can be of higher quality.
KUIT is documented in an
<a href="http://techbase.kde.org/Development/Tutorials/Localization/i18n_Semantics">
Techbase article</a> as well.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KLocale
</dd></dl> 
<dl class="author" compact><dt><b>Author:</b></dt><dd> Chusslove Illich &lt;caslav.ilic@gmx.net&gt; </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KLocalizedString">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KLocalizedString">__init__</a> (self, <a href="../kdecore/KLocalizedString.html">KLocalizedString</a> rhs)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KLocalizedString">__init__</a> (self, QString ctxt, QString msg, QString plural)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KLocalizedString.html">KLocalizedString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#inContext">inContext</a> (self, QString key, QString text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#isEmpty">isEmpty</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KLocalizedString.html">KLocalizedString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#subs">subs</a> (self, long a, int fieldWidth=0, int base=10, QChar fillChar=QLatin1Char(' '))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KLocalizedString.html">KLocalizedString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#subs">subs</a> (self, QChar a, int fieldWidth=0, QChar fillChar=QLatin1Char(' '))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KLocalizedString.html">KLocalizedString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#subs">subs</a> (self, QString a, int fieldWidth=0, QChar fillChar=QLatin1Char(' '))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#toString">toString</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#toString">toString</a> (self, <a href="../kdecore/KLocale.html">KLocale</a> locale)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#toString">toString</a> (self, QString catalogName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#toString">toString</a> (self, <a href="../kdecore/KLocale.html">KLocale</a> locale, QString catalogName)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KLocalizedString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Constructs an empty message, which is not valid for finalization.
Useful when you later need to assign KLocalizedString obtained by one
of ki18n* calls.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> isEmpty()
</dd></dl>
</p></div></div><a class="anchor" name="KLocalizedString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KLocalizedString.html">KLocalizedString</a>&nbsp;</td>
<td class="paramname"><em>rhs</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Copy constructor.
</p></div></div><a class="anchor" name="KLocalizedString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>ctxt</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>plural</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="inContext"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KLocalizedString.html">KLocalizedString</a> inContext</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>text</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Adds dynamic context to the message.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em>&nbsp;</td><td> context key

<tr><td></td><td valign="top"><em>text</em>&nbsp;</td><td> context value
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> resultant KLocalizedString
</dd></dl>
</p></div></div><a class="anchor" name="isEmpty"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isEmpty</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Checks whether the message is empty. This will happen if you just
constructed the object via default constructor.
</p>
<p>
Empty messages are not valid for finalization; if you use toString() on
them, you will get error mark instead of empty QString (in debug mode).
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the message is empty, else false
</dd></dl>
</p></div></div><a class="anchor" name="subs"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KLocalizedString.html">KLocalizedString</a> subs</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long&nbsp;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>fieldWidth=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>base=10</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QChar&nbsp;</td>
<td class="paramname"><em>fillChar=QLatin1Char(' ')</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Substitutes a QString argument into the message.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>a</em>&nbsp;</td><td> the argument

<tr><td></td><td valign="top"><em>fieldWidth</em>&nbsp;</td><td> width of the formatted field, padded by spaces.
Positive value aligns right, negative aligns left

<tr><td></td><td valign="top"><em>fillChar</em>&nbsp;</td><td> the character used to fill up the empty places when
field width is greater than argument width
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> resultant KLocalizedString
</dd></dl>
</p></div></div><a class="anchor" name="subs"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KLocalizedString.html">KLocalizedString</a> subs</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QChar&nbsp;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>fieldWidth=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QChar&nbsp;</td>
<td class="paramname"><em>fillChar=QLatin1Char(' ')</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Substitutes a QString argument into the message.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>a</em>&nbsp;</td><td> the argument

<tr><td></td><td valign="top"><em>fieldWidth</em>&nbsp;</td><td> width of the formatted field, padded by spaces.
Positive value aligns right, negative aligns left

<tr><td></td><td valign="top"><em>fillChar</em>&nbsp;</td><td> the character used to fill up the empty places when
field width is greater than argument width
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> resultant KLocalizedString
</dd></dl>
</p></div></div><a class="anchor" name="subs"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KLocalizedString.html">KLocalizedString</a> subs</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>fieldWidth=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QChar&nbsp;</td>
<td class="paramname"><em>fillChar=QLatin1Char(' ')</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Substitutes a QString argument into the message.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>a</em>&nbsp;</td><td> the argument

<tr><td></td><td valign="top"><em>fieldWidth</em>&nbsp;</td><td> width of the formatted field, padded by spaces.
Positive value aligns right, negative aligns left

<tr><td></td><td valign="top"><em>fillChar</em>&nbsp;</td><td> the character used to fill up the empty places when
field width is greater than argument width
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> resultant KLocalizedString
</dd></dl>
</p></div></div><a class="anchor" name="toString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString toString</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl> </p>
<p>
Like toString, but looks for translation only in specific catalog.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>locale</em>&nbsp;</td><td> locale from which translations are to be taken

<tr><td></td><td valign="top"><em>catalogName</em>&nbsp;</td><td> the name of the catalog to check for translation
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> finalized translation
</dd></dl>
</p></div></div><a class="anchor" name="toString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString toString</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KLocale.html">KLocale</a>&nbsp;</td>
<td class="paramname"><em>locale</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl> </p>
<p>
Like toString, but looks for translation only in specific catalog.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>locale</em>&nbsp;</td><td> locale from which translations are to be taken

<tr><td></td><td valign="top"><em>catalogName</em>&nbsp;</td><td> the name of the catalog to check for translation
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> finalized translation
</dd></dl>
</p></div></div><a class="anchor" name="toString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString toString</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>catalogName</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl> </p>
<p>
Like toString, but looks for translation only in specific catalog.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>locale</em>&nbsp;</td><td> locale from which translations are to be taken

<tr><td></td><td valign="top"><em>catalogName</em>&nbsp;</td><td> the name of the catalog to check for translation
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> finalized translation
</dd></dl>
</p></div></div><a class="anchor" name="toString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString toString</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KLocale.html">KLocale</a>&nbsp;</td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>catalogName</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl> </p>
<p>
Like toString, but looks for translation only in specific catalog.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>locale</em>&nbsp;</td><td> locale from which translations are to be taken

<tr><td></td><td valign="top"><em>catalogName</em>&nbsp;</td><td> the name of the catalog to check for translation
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> finalized translation
</dd></dl>
</p></div></div>
</div>
</div>
</div>

<div id="left">

<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>

<a name="cp-menu" /><div class="menutitle"><div>
  <h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>

</div>

</div>
  <div class="clearer"/>
</div>

<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
        <a href="http://www.kde.org/contact/impressum.php">Legal</a>
    </div></div>
</body>
</html>