Subversion Repositories Scribus

Rev

Rev 18785 | Rev 19382 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
12456 jghali 1
<?xml version="1.0" encoding="utf-8"?>
14397 jghali 2
<!DOCTYPE TS>
3
<TS version="2.0" language="zh_TW">
9498 cbradney 4
<context>
12918 cbradney 5
    <name></name>
9498 cbradney 6
    <message>
12918 cbradney 7
        <source>getColorNames() -&gt; list
8
 
9
Returns a list containing the names of all defined colors in the document.
10
If no document is open, returns a list of the default document colors.
11
</source>
15354 cbradney 12
        <translation type="obsolete">
14474 cbradney 13
      getColorNames() -&gt; list
14
 
15
      傳回檔案中所有已定義顏色名稱的列表
16
 
17
      </translation>
12918 cbradney 18
    </message>
19
    <message>
20
        <source>getColor(&quot;name&quot;) -&gt; tuple
21
 
22
Returns a tuple (C, M, Y, K) containing the four color components of the
23
color &quot;name&quot; from the current document. If no document is open, returns
24
the value of the named color from the default document colors.
25
 
26
May raise NotFoundError if the named color wasn&apos;t found.
27
May raise ValueError if an invalid color name is specified.
28
</source>
15354 cbradney 29
        <translation type="obsolete">getColor(&quot;name&quot;) -&gt; tuple
12918 cbradney 30
 
31
Returns a tuple (C, M, Y, K) containing the four colour components of the
32
colour &quot;name&quot; from the current document. If no document is open, returns
33
the value of the named colour from the default document colours.
34
 
35
May raise NotFoundError if the named colour wasn&apos;t found.
36
May raise ValueError if an invalid colour name is specified.
37
</translation>
38
    </message>
39
    <message>
40
        <source>getColorAsRGB(&quot;name&quot;) -&gt; tuple
41
 
42
Returns a tuple (R,G,B) containing the three color components of the
43
color &quot;name&quot; from the current document, converted to the RGB color
44
space. If no document is open, returns the value of the named color
45
from the default document colors.
46
 
47
May raise NotFoundError if the named color wasn&apos;t found.
48
May raise ValueError if an invalid color name is specified.
49
</source>
15354 cbradney 50
        <translation type="obsolete">getColorAsRGB(&quot;name&quot;) -&gt; tuple
12918 cbradney 51
 
52
Returns a tuple (R,G,B) containing the three colour components of the
53
colour &quot;name&quot; from the current document, converted to the RGB colour
54
space. If no document is open, returns the value of the named colour
55
from the default document colours.
56
 
57
May raise NotFoundError if the named colour wasn&apos;t found.
58
May raise ValueError if an invalid colour name is specified.
59
</translation>
60
    </message>
61
    <message>
9498 cbradney 62
        <source>changeColor(&quot;name&quot;, c, m, y, k)
63
 
64
Changes the color &quot;name&quot; to the specified CMYK value. The color value is
65
defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black.
66
Color components should be in the range from 0 to 255.
67
 
68
May raise NotFoundError if the named color wasn&apos;t found.
69
May raise ValueError if an invalid color name is specified.
70
</source>
15099 cbradney 71
        <translation type="obsolete">changeColour(&quot;name&quot;, c, m, y, k)
9498 cbradney 72
 
73
Changes the colour &quot;name&quot; to the specified CMYK value. The colour value is
74
defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black.
75
Colour components should be in the range from 0 to 255.
76
 
77
May raise NotFoundError if the named colour wasn&apos;t found.
78
May raise ValueError if an invalid colour name is specified.
79
</translation>
80
    </message>
81
    <message>
12918 cbradney 82
        <source>deleteColor(&quot;name&quot;, &quot;replace&quot;)
83
 
84
Deletes the color &quot;name&quot;. Every occurence of that color is replaced by the
85
color &quot;replace&quot;. If not specified, &quot;replace&quot; defaults to the color
86
&quot;None&quot; - transparent.
87
 
88
deleteColor works on the default document colors if there is no document open.
89
In that case, &quot;replace&quot;, if specified, has no effect.
90
 
91
May raise NotFoundError if a named color wasn&apos;t found.
92
May raise ValueError if an invalid color name is specified.
93
</source>
15354 cbradney 94
        <translation type="obsolete">deleteColor(&quot;name&quot;, &quot;replace&quot;)
12918 cbradney 95
 
96
Deletes the colour &quot;name&quot;. Every occurence of that colour is replaced by the
97
colour &quot;replace&quot;. If not specified, &quot;replace&quot; defaults to the colour
98
&quot;None&quot; - transparent.
99
 
100
deleteColor works on the default document colours if there is no document open.
101
In that case, &quot;replace&quot;, if specified, has no effect.
102
 
103
May raise NotFoundError if a named colour wasn&apos;t found.
104
May raise ValueError if an invalid colour name is specified.
105
</translation>
106
    </message>
107
    <message>
108
        <source>replaceColor(&quot;name&quot;, &quot;replace&quot;)
109
 
110
Every occurence of the color &quot;name&quot; is replaced by the color &quot;replace&quot;.
111
 
112
May raise NotFoundError if a named color wasn&apos;t found.
113
May raise ValueError if an invalid color name is specified.
114
</source>
15354 cbradney 115
        <translation type="obsolete">replaceColor(&quot;name&quot;, &quot;replace&quot;)
12918 cbradney 116
 
117
Every occurence of the colour &quot;name&quot; is replaced by the colour &quot;replace&quot;.
118
 
119
May raise NotFoundError if a named colour wasn&apos;t found.
120
May raise ValueError if an invalid colour name is specified.
121
</translation>
122
    </message>
123
    <message>
124
        <source>newDocDialog() -&gt; bool
125
 
126
Displays the &quot;New Document&quot; dialog box. Creates a new document if the user
127
accepts the settings. Does not create a document if the user presses cancel.
128
Returns true if a new document was created.
129
</source>
15354 cbradney 130
        <translation type="obsolete">newDocDialog() -&gt; bool
12918 cbradney 131
 
132
顯示 &quot;新建檔案&quot; 對話視窗, 如果使用者接受設定值, 則開啟新的檔案. 如果使用者案取消鍵,
133
檔案將不會新建. 如果新檔案已經新增, 傳回 &quot;真&quot;.
134
      </translation>
135
    </message>
136
    <message>
137
        <source>messageBox(&quot;caption&quot;, &quot;message&quot;,
138
    icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT,
139
    button2=BUTTON_NONE, button3=BUTTON_NONE) -&gt; integer
140
 
141
Displays a message box with the title &quot;caption&quot;, the message &quot;message&quot;, and
142
an icon &quot;icon&quot; and up to 3 buttons. By default no icon is used and a single
143
button, OK, is displayed. Only the caption and message arguments are required,
144
though setting an icon and appropriate button(s) is strongly
145
recommended. The message text may contain simple HTML-like markup.
146
 
147
Returns the number of the button the user pressed. Button numbers start
148
at 1.
149
 
150
For the icon and the button parameters there are predefined constants available
151
with the same names as in the Qt Documentation. These are the BUTTON_* and
152
ICON_* constants defined in the module. There are also two extra constants that
153
can be binary-ORed with button constants:
154
    BUTTONOPT_DEFAULT   Pressing enter presses this button.
155
    BUTTONOPT_ESCAPE    Pressing escape presses this button.
156
 
157
Usage examples:
158
result = messageBox(&apos;Script failed&apos;,
159
                    &apos;This script only works when you have a text frame selected.&apos;,
160
                    ICON_ERROR)
161
result = messageBox(&apos;Monkeys!&apos;, &apos;Something went ook! &lt;i&gt;Was it a monkey?&lt;/i&gt;&apos;,
162
                    ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
163
                    BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)
164
 
165
Defined button and icon constants:
166
BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO,
167
BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL,
168
ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.
169
</source>
15354 cbradney 170
        <translation type="obsolete">messageBox(&quot;caption&quot;, &quot;message&quot;,
12918 cbradney 171
    icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT,
172
    button2=BUTTON_NONE, button3=BUTTON_NONE) -&gt; integer
173
 
174
Displays a message box with the title &quot;caption&quot;, the message &quot;message&quot;, and
175
an icon &quot;icon&quot; and up to 3 buttons. By default no icon is used and a single
176
button, OK, is displayed. Only the caption and message arguments are required,
177
though setting an icon and appropriate button(s) is strongly
178
recommended. The message text may contain simple HTML-like markup.
179
 
180
Returns the number of the button the user pressed. Button numbers start
181
at 1.
182
 
183
For the icon and the button parameters there are predefined constants available
184
with the same names as in the Qt Documentation. These are the BUTTON_* and
185
ICON_* constants defined in the module. There are also two extra constants that
186
can be binary-ORed with button constants:
187
    BUTTONOPT_DEFAULT   Pressing enter presses this button.
188
    BUTTONOPT_ESCAPE    Pressing escape presses this button.
189
 
190
Usage examples:
191
result = messageBox(&apos;Script failed&apos;,
192
                    &apos;This script only works when you have a text frame selected.&apos;,
193
                    ICON_ERROR)
194
result = messageBox(&apos;Monkeys!&apos;, &apos;Something went ook! &lt;i&gt;Was it a monkey?&lt;/i&gt;&apos;,
195
                    ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
196
                    BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)
197
 
198
Defined button and icon constants:
199
BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO,
200
BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL,
201
ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.
202
</translation>
203
    </message>
204
    <message>
205
        <source>valueDialog(caption, message [,defaultvalue]) -&gt; string
206
 
207
Shows the common &apos;Ask for string&apos; dialog and returns its value as a string
208
Parameters: window title, text in the window and optional &apos;default&apos; value.
209
 
210
Example: valueDialog(&apos;title&apos;, &apos;text in the window&apos;, &apos;optional&apos;)
211
</source>
15354 cbradney 212
        <translation type="obsolete">valueDialog(caption, message [,defaultvalue]) -&gt; string
12918 cbradney 213
 
214
Shows the common &apos;Ask for string&apos; dialog and returns its value as a string
215
Parameters: window title, text in the window and optional &apos;default&apos; value.
216
 
217
Example: valueDialog(&apos;title&apos;, &apos;text in the window&apos;, &apos;optional&apos;)
218
</translation>
219
    </message>
220
    <message>
221
        <source>newStyleDialog() -&gt; string
222
 
223
Shows &apos;Create new paragraph style&apos; dialog. Function returns real
224
style name or None when user cancels the dialog.
225
</source>
15354 cbradney 226
        <translation type="obsolete">newStyleDialog() -&gt; string
12918 cbradney 227
 
228
Shows &apos;Create new paragraph style&apos; dialog. Function returns real
229
style name or None when user cancels the dialog.
230
</translation>
231
    </message>
232
    <message>
233
        <source>newDoc(size, margins, orientation, firstPageNumber,
234
                   unit, facingPages, firstSideLeft) -&gt; bool
235
 
236
WARNING: Obsolete procedure! Use newDocument instead.
237
 
238
Creates a new document and returns true if successful. The parameters have the
239
following meaning:
240
 
241
    size = A tuple (width, height) describing the size of the document. You can
242
    use predefined constants named PAPER_&lt;paper_type&gt; e.g. PAPER_A4 etc.
243
 
244
    margins = A tuple (left, right, top, bottom) describing the document
245
    margins
246
 
247
    orientation = the page orientation - constants PORTRAIT, LANDSCAPE
248
 
249
    firstPageNumer = is the number of the first page in the document used for
250
    pagenumbering. While you&apos;ll usually want 1, it&apos;s useful to have higher
251
    numbers if you&apos;re creating a document in several parts.
252
 
253
    unit: this value sets the measurement units used by the document. Use a
254
    predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS,
255
    UNIT_PICAS, UNIT_POINTS.
256
 
257
    facingPages = FACINGPAGES, NOFACINGPAGES
258
 
259
    firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT
260
 
261
The values for width, height and the margins are expressed in the given unit
262
for the document. PAPER_* constants are expressed in points. If your document
263
is not in points, make sure to account for this.
264
 
265
example: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS,
266
                FACINGPAGES, FIRSTPAGERIGHT)
267
</source>
15354 cbradney 268
        <translation type="obsolete">newDoc(size, margins, orientation, firstPageNumber,
12918 cbradney 269
                   unit, facingPages, firstSideLeft) -&gt; bool
270
 
271
WARNING: Obsolete procedure! Use newDocument instead.
272
 
273
Creates a new document and returns true if successful. The parameters have the
274
following meaning:
275
 
276
    size = A tuple (width, height) describing the size of the document. You can
277
    use predefined constants named PAPER_&lt;paper_type&gt; e.g. PAPER_A4 etc.
278
 
279
    margins = A tuple (left, right, top, bottom) describing the document
280
    margins
281
 
282
    orientation = the page orientation - constants PORTRAIT, LANDSCAPE
283
 
284
    firstPageNumer = is the number of the first page in the document used for
285
    pagenumbering. While you&apos;ll usually want 1, it&apos;s useful to have higher
286
    numbers if you&apos;re creating a document in several parts.
287
 
288
    unit: this value sets the measurement units used by the document. Use a
289
    predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS,
290
    UNIT_PICAS, UNIT_POINTS.
291
 
292
    facingPages = FACINGPAGES, NOFACINGPAGES
293
 
294
    firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT
295
 
296
The values for width, height and the margins are expressed in the given unit
297
for the document. PAPER_* constants are expressed in points. If your document
298
is not in points, make sure to account for this.
299
 
300
example: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS,
301
                FACINGPAGES, FIRSTPAGERIGHT)
302
</translation>
303
    </message>
304
    <message>
12456 jghali 305
        <source>closeDoc()
9498 cbradney 306
 
12456 jghali 307
Closes the current document without prompting to save.
9498 cbradney 308
 
12456 jghali 309
May throw NoDocOpenError if there is no document to close
9498 cbradney 310
</source>
15354 cbradney 311
        <translation type="obsolete">closeDoc()
9498 cbradney 312
 
12456 jghali 313
Closes the current document without prompting to save.
9498 cbradney 314
 
12456 jghali 315
May throw NoDocOpenError if there is no document to close
9498 cbradney 316
</translation>
317
    </message>
318
    <message>
12918 cbradney 319
        <source>haveDoc() -&gt; bool
320
 
321
Returns true if there is a document open.
322
</source>
15354 cbradney 323
        <translation type="obsolete">haveDoc() -&gt; bool
12918 cbradney 324
 
325
Returns true if there is a document open.
326
</translation>
327
    </message>
328
    <message>
329
        <source>openDoc(&quot;name&quot;)
330
 
331
Opens the document &quot;name&quot;.
332
 
333
May raise ScribusError if the document could not be opened.
334
</source>
15354 cbradney 335
        <translation type="obsolete">openDoc(&quot;name&quot;)
12918 cbradney 336
 
337
Opens the document &quot;name&quot;.
338
 
339
May raise ScribusError if the document could not be opened.
340
</translation>
341
    </message>
342
    <message>
343
        <source>saveDoc()
344
 
345
Saves the current document with its current name, returns true if successful.
346
If the document has not already been saved, this may bring up an interactive
347
save file dialog.
348
 
349
If the save fails, there is currently no way to tell.
350
</source>
15354 cbradney 351
        <translation type="obsolete">saveDoc()
12918 cbradney 352
 
353
Saves the current document with its current name, returns true if successful.
354
If the document has not already been saved, this may bring up an interactive
355
save file dialog.
356
 
357
If the save fails, there is currently no way to tell.
358
</translation>
359
    </message>
360
    <message>
361
        <source>saveDocAs(&quot;name&quot;)
362
 
363
Saves the current document under the new name &quot;name&quot; (which may be a full or
364
relative path).
365
 
366
May raise ScribusError if the save fails.
367
</source>
15354 cbradney 368
        <translation type="obsolete">saveDocAs(&quot;name&quot;)
12918 cbradney 369
 
370
Saves the current document under the new name &quot;name&quot; (which may be a full or
371
relative path).
372
 
373
May raise ScribusError if the save fails.
374
</translation>
375
    </message>
376
    <message>
377
        <source>setMargins(lr, rr, tr, br)
378
 
14474 cbradney 379
Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br)
12918 cbradney 380
margins are given in the measurement units of the document - see UNIT_&lt;type&gt;
381
constants.
382
</source>
15354 cbradney 383
        <translation type="obsolete">setMargins(lr, rr, tr, br)
14474 cbradney 384
 
385
Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br)
386
margins are given in the measurement units of the document - see UNIT_&lt;type&gt;
387
constants.
388
</translation>
389
    </message>
390
    <message>
12918 cbradney 391
        <source>setUnit(type)
392
 
393
Changes the measurement unit of the document. Possible values for &quot;unit&quot; are
394
defined as constants UNIT_&lt;type&gt;.
395
 
396
May raise ValueError if an invalid unit is passed.
397
</source>
15354 cbradney 398
        <translation type="obsolete">setUnit(type)
12918 cbradney 399
 
400
Changes the measurement unit of the document. Possible values for &quot;unit&quot; are
401
defined as constants UNIT_&lt;type&gt;.
402
 
403
May raise ValueError if an invalid unit is passed.
404
</translation>
405
    </message>
406
    <message>
407
        <source>getUnit() -&gt; integer (Scribus unit constant)
408
 
409
Returns the measurement units of the document. The returned value will be one
410
of the UNIT_* constants:
411
UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.
412
</source>
15354 cbradney 413
        <translation type="obsolete">getUnit() -&gt; integer (Scribus unit constant)
12918 cbradney 414
 
415
Returns the measurement units of the document. The returned value will be one
416
of the UNIT_* constants:
417
UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.
418
</translation>
419
    </message>
420
    <message>
421
        <source>loadStylesFromFile(&quot;filename&quot;)
422
 
423
Loads paragraph styles from the Scribus document at &quot;filename&quot; into the
424
current document.
425
</source>
15354 cbradney 426
        <translation type="obsolete">loadStylesFromFile(&quot;filename&quot;)
12918 cbradney 427
 
428
Loads paragraph styles from the Scribus document at &quot;filename&quot; into the
429
current document.
430
</translation>
431
    </message>
432
    <message>
433
        <source>setDocType(facingPages, firstPageLeft)
434
 
435
Sets the document type. To get facing pages set the first parameter to
436
FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead.  If you want
437
to be the first page a left side set the second parameter to FIRSTPAGELEFT, for
438
a right page use FIRSTPAGERIGHT.
439
</source>
15354 cbradney 440
        <translation type="obsolete">setDocType(facingPages, firstPageLeft)
12918 cbradney 441
 
442
Sets the document type. To get facing pages set the first parameter to
443
FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead.  If you want
444
to be the first page a left side set the second parameter to FIRSTPAGELEFT, for
445
a right page use FIRSTPAGERIGHT.
446
</translation>
447
    </message>
448
    <message>
12456 jghali 449
        <source>closeMasterPage()
9498 cbradney 450
 
12456 jghali 451
Closes the currently active master page, if any, and returns editing
452
to normal. Begin editing with editMasterPage().
9498 cbradney 453
</source>
15354 cbradney 454
        <translation type="obsolete">closeMasterPage()
9498 cbradney 455
 
12456 jghali 456
Closes the currently active master page, if any, and returns editing
457
to normal. Begin editing with editMasterPage().
9498 cbradney 458
</translation>
459
    </message>
460
    <message>
12918 cbradney 461
        <source>masterPageNames()
462
 
463
Returns a list of the names of all master pages in the document.
464
</source>
15354 cbradney 465
        <translation type="obsolete">masterPageNames()
12918 cbradney 466
 
467
Returns a list of the names of all master pages in the document.
468
</translation>
469
    </message>
470
    <message>
471
        <source>editMasterPage(pageName)
472
 
473
Enables master page editing and opens the named master page
474
for editing. Finish editing with closeMasterPage().
475
</source>
15354 cbradney 476
        <translation type="obsolete">editMasterPage(pageName)
12918 cbradney 477
 
478
Enables master page editing and opens the named master page
479
for editing. Finish editing with closeMasterPage().
480
</translation>
481
    </message>
482
    <message>
483
        <source>createMasterPage(pageName)
484
 
485
Creates a new master page named pageName and opens it for
486
editing.
487
</source>
15354 cbradney 488
        <translation type="obsolete">createMasterPage(pageName)
12918 cbradney 489
 
490
開新的 pageName 的主頁, 並打開它來編輯.
491
</translation>
492
    </message>
493
    <message>
494
        <source>deleteMasterPage(pageName)
495
 
496
Delete the named master page.
497
</source>
15354 cbradney 498
        <translation type="obsolete">deleteMasterPage(pageName)
14474 cbradney 499
 
500
刪除已命名的主頁
501
</translation>
12918 cbradney 502
    </message>
503
    <message>
504
        <source>getLineColor([&quot;name&quot;]) -&gt; string
505
 
506
Returns the name of the line color of the object &quot;name&quot;.
507
If &quot;name&quot; is not given the currently selected item is used.
508
</source>
15354 cbradney 509
        <translation type="obsolete">getLineColor([&quot;name&quot;]) -&gt; string
12918 cbradney 510
 
511
Returns the name of the line colour of the object &quot;name&quot;.
512
If &quot;name&quot; is not given the currently selected item is used.
513
</translation>
514
    </message>
515
    <message>
516
        <source>getLineWidth([&quot;name&quot;]) -&gt; integer
517
 
518
Returns the line width of the object &quot;name&quot;. If &quot;name&quot;
519
is not given the currently selected Item is used.
520
</source>
15354 cbradney 521
        <translation type="obsolete">getLineWidth([&quot;name&quot;]) -&gt; integer
12918 cbradney 522
 
523
Returns the line width of the object &quot;name&quot;. If &quot;name&quot;
524
is not given the currently selected Item is used.
525
</translation>
526
    </message>
527
    <message>
528
        <source>getLineShade([&quot;name&quot;]) -&gt; integer
529
 
530
Returns the shading value of the line color of the object &quot;name&quot;.
531
If &quot;name&quot; is not given the currently selected item is used.
532
</source>
15354 cbradney 533
        <translation type="obsolete">getLineShade([&quot;name&quot;]) -&gt; integer
12918 cbradney 534
 
535
Returns the shading value of the line colour of the object &quot;name&quot;.
536
If &quot;name&quot; is not given the currently selected item is used.
537
</translation>
538
    </message>
539
    <message>
540
        <source>getLineEnd([&quot;name&quot;]) -&gt; integer (see constants)
541
 
542
Returns the line cap style of the object &quot;name&quot;. If &quot;name&quot; is not given the
543
currently selected item is used. The cap types are:
544
CAP_FLAT, CAP_ROUND, CAP_SQUARE
545
</source>
15354 cbradney 546
        <translation type="obsolete">getLineEnd([&quot;name&quot;]) -&gt; integer (see constants)
12918 cbradney 547
 
548
Returns the line cap style of the object &quot;name&quot;. If &quot;name&quot; is not given the
549
currently selected item is used. The cap types are:
550
CAP_FLAT, CAP_ROUND, CAP_SQUARE
551
</translation>
552
    </message>
553
    <message>
554
        <source>getLineStyle([&quot;name&quot;]) -&gt; integer (see constants)
555
 
556
Returns the line style of the object &quot;name&quot;. If &quot;name&quot; is not given the
557
currently selected item is used. Line style constants are:
558
LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID
559
</source>
15354 cbradney 560
        <translation type="obsolete">getLineStyle([&quot;name&quot;]) -&gt; integer (see constants)
12918 cbradney 561
 
562
Returns the line style of the object &quot;name&quot;. If &quot;name&quot; is not given the
563
currently selected item is used. Line style constants are:
564
LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID
565
</translation>
566
    </message>
567
    <message>
568
        <source>getFillShade([&quot;name&quot;]) -&gt; integer
569
 
570
Returns the shading value of the fill color of the object &quot;name&quot;.
571
If &quot;name&quot; is not given the currently selected item is used.
572
</source>
15354 cbradney 573
        <translation type="obsolete">getFillShade([&quot;name&quot;]) -&gt; integer
12918 cbradney 574
 
575
Returns the shading value of the fill colour of the object &quot;name&quot;.
576
If &quot;name&quot; is not given the currently selected item is used.
577
</translation>
578
    </message>
579
    <message>
580
        <source>getImageScale([&quot;name&quot;]) -&gt; (x,y)
581
 
582
Returns a (x, y) tuple containing the scaling values of the image frame
583
&quot;name&quot;.  If &quot;name&quot; is not given the currently selected item is used.
584
</source>
15354 cbradney 585
        <translation type="obsolete">getImageScale([&quot;name&quot;]) -&gt; (x,y)
12918 cbradney 586
 
587
Returns a (x, y) tuple containing the scaling values of the image frame
588
&quot;name&quot;.  If &quot;name&quot; is not given the currently selected item is used.
589
</translation>
590
    </message>
591
    <message>
592
        <source>getImageName([&quot;name&quot;]) -&gt; string
593
 
594
Returns the filename for the image in the image frame. If &quot;name&quot; is not
595
given the currently selected item is used.
596
</source>
15354 cbradney 597
        <translation type="obsolete">getImageName([&quot;name&quot;]) -&gt; string
12918 cbradney 598
 
599
Returns the filename for the image in the image frame. If &quot;name&quot; is not
600
given the currently selected item is used.
601
</translation>
602
    </message>
603
    <message>
604
        <source>getSize([&quot;name&quot;]) -&gt; (width,height)
605
 
606
Returns a (width, height) tuple with the size of the object &quot;name&quot;.
607
If &quot;name&quot; is not given the currently selected item is used. The size is
608
expressed in the current measurement unit of the document - see UNIT_&lt;type&gt;
609
for reference.
610
</source>
15354 cbradney 611
        <translation type="obsolete">getSize([&quot;name&quot;]) -&gt; (width,height)
12918 cbradney 612
 
613
Returns a (width, height) tuple with the size of the object &quot;name&quot;.
614
If &quot;name&quot; is not given the currently selected item is used. The size is
615
expressed in the current measurement unit of the document - see UNIT_&lt;type&gt;
616
for reference.
617
</translation>
618
    </message>
619
    <message>
620
        <source>getRotation([&quot;name&quot;]) -&gt; integer
621
 
622
Returns the rotation of the object &quot;name&quot;. The value is expressed in degrees,
623
and clockwise is positive. If &quot;name&quot; is not given the currently selected item
624
is used.
625
</source>
15354 cbradney 626
        <translation type="obsolete">getRotation([&quot;name&quot;]) -&gt; integer
12918 cbradney 627
 
628
Returns the rotation of the object &quot;name&quot;. The value is expressed in degrees,
629
and clockwise is positive. If &quot;name&quot; is not given the currently selected item
630
is used.
631
</translation>
632
    </message>
633
    <message>
634
        <source>getAllObjects() -&gt; list
635
 
636
Returns a list containing the names of all objects on the current page.
637
</source>
15354 cbradney 638
        <translation type="obsolete">getAllObjects() -&gt; list
12918 cbradney 639
 
640
Returns a list containing the names of all objects on the current page.
641
</translation>
642
    </message>
643
    <message>
644
        <source>getPropertyCType(object, property, includesuper=True)
645
 
646
Returns the name of the C type of `property&apos; of `object&apos;. See getProperty()
647
for details of arguments.
648
 
649
If `includesuper&apos; is true, search inherited properties too.
650
</source>
15354 cbradney 651
        <translation type="obsolete">getPropertyCType(object, property, includesuper=True)
12918 cbradney 652
 
653
Returns the name of the C type of `property&apos; of `object&apos;. See getProperty()
654
for details of arguments.
655
 
656
If `includesuper&apos; is true, search inherited properties too.
657
</translation>
658
    </message>
659
    <message>
660
        <source>getPropertyNames(object, includesuper=True)
661
 
662
Return a list of property names supported by `object&apos;.
663
If `includesuper&apos; is true, return properties supported
664
by parent classes as well.
665
</source>
15354 cbradney 666
        <translation type="obsolete">getPropertyNames(object, includesuper=True)
12918 cbradney 667
 
668
Return a list of property names supported by `object&apos;.
669
If `includesuper&apos; is true, return properties supported
670
by parent classes as well.
671
</translation>
672
    </message>
673
    <message>
674
        <source>getProperty(object, property)
675
 
676
Return the value of the property `property&apos; of the passed `object&apos;.
677
 
678
The `object&apos; argument may be a string, in which case the named PageItem
679
is searched for. It may also be a PyCObject, which may point to any
680
C++ QObject instance.
681
 
682
The `property&apos; argument must be a string, and is the name of the property
683
to look up on `object&apos;.
684
 
685
The return value varies depending on the type of the property.
686
</source>
15354 cbradney 687
        <translation type="obsolete">getProperty(object, property)
12918 cbradney 688
 
689
Return the value of the property `property&apos; of the passed `object&apos;.
690
 
691
The `object&apos; argument may be a string, in which case the named PageItem
692
is searched for. It may also be a PyCObject, which may point to any
693
C++ QObject instance.
694
 
695
The `property&apos; argument must be a string, and is the name of the property
696
to look up on `object&apos;.
697
 
698
The return value varies depending on the type of the property.
699
</translation>
700
    </message>
701
    <message>
702
        <source>setProperty(object, property, value)
703
 
704
Set `property&apos; of `object&apos; to `value&apos;. If `value&apos; cannot be converted to a type
705
compatible with the type of `property&apos;, an exception is raised. An exception may
706
also be raised if the underlying setter fails.
707
 
708
See getProperty() for more information.
709
</source>
15354 cbradney 710
        <translation type="obsolete">setProperty(object, property, value)
12918 cbradney 711
 
712
Set `property&apos; of `object&apos; to `value&apos;. If `value&apos; cannot be converted to a type
713
compatible with the type of `property&apos;, an exception is raised. An exception may
714
also be raised if the underlying setter fails.
715
 
716
See getProperty() for more information.
717
</translation>
718
    </message>
719
    <message>
720
        <source>moveObjectAbs(x, y [, &quot;name&quot;])
721
 
722
Moves the object &quot;name&quot; to a new location. The coordinates are expressed in
723
the current measurement unit of the document (see UNIT constants).  If &quot;name&quot;
724
is not given the currently selected item is used.  If the object &quot;name&quot;
725
belongs to a group, the whole group is moved.
726
</source>
15354 cbradney 727
        <translation type="obsolete">moveObjectAbs(x, y [, &quot;name&quot;])
12918 cbradney 728
 
729
Moves the object &quot;name&quot; to a new location. The coordinates are expressed in
730
the current measurement unit of the document (see UNIT constants).  If &quot;name&quot;
731
is not given the currently selected item is used.  If the object &quot;name&quot;
732
belongs to a group, the whole group is moved.
733
</translation>
734
    </message>
735
    <message>
736
        <source>sizeObject(width, height [, &quot;name&quot;])
737
 
738
Resizes the object &quot;name&quot; to the given width and height. If &quot;name&quot;
739
is not given the currently selected item is used.
740
</source>
15354 cbradney 741
        <translation type="obsolete">sizeObject(width, height [, &quot;name&quot;])
12918 cbradney 742
 
743
Resizes the object &quot;name&quot; to the given width and height. If &quot;name&quot;
744
is not given the currently selected item is used.
745
</translation>
746
    </message>
747
    <message>
748
        <source>getSelectedObject([nr]) -&gt; string
749
 
750
Returns the name of the selected object. &quot;nr&quot; if given indicates the number
751
of the selected object, e.g. 0 means the first selected object, 1 means the
752
second selected Object and so on.
753
</source>
15354 cbradney 754
        <translation type="obsolete">getSelectedObject([nr]) -&gt; string
12918 cbradney 755
 
756
Returns the name of the selected object. &quot;nr&quot; if given indicates the number
757
of the selected object, e.g. 0 means the first selected object, 1 means the
758
second selected Object and so on.
759
</translation>
760
    </message>
761
    <message>
762
        <source>selectionCount() -&gt; integer
763
 
764
Returns the number of selected objects.
765
</source>
15354 cbradney 766
        <translation type="obsolete">selectionCount() -&gt; integer
12918 cbradney 767
 
768
Returns the number of selected objects.
769
</translation>
770
    </message>
771
    <message>
772
        <source>selectObject(&quot;name&quot;)
773
 
774
Selects the object with the given &quot;name&quot;.
775
</source>
15354 cbradney 776
        <translation type="obsolete">selectObject(&quot;name&quot;)
12918 cbradney 777
 
778
Selects the object with the given &quot;name&quot;.
779
</translation>
780
    </message>
781
    <message>
782
        <source>deselectAll()
783
 
784
Deselects all objects in the whole document.
785
</source>
15354 cbradney 786
        <translation type="obsolete">deselectAll()
12918 cbradney 787
 
788
Deselects all objects in the whole document.
789
</translation>
790
    </message>
791
    <message>
792
        <source>groupObjects(list)
793
 
794
Groups the objects named in &quot;list&quot; together. &quot;list&quot; must contain the names
795
of the objects to be grouped. If &quot;list&quot; is not given the currently selected
796
items are used.
797
</source>
14747 cbradney 798
        <translation type="obsolete">groupObjects(list)
12918 cbradney 799
 
800
Groups the objects named in &quot;list&quot; together. &quot;list&quot; must contain the names
801
of the objects to be grouped. If &quot;list&quot; is not given the currently selected
802
items are used.
803
</translation>
804
    </message>
805
    <message>
806
        <source>unGroupObjects(&quot;name&quot;)
807
 
808
Destructs the group the object &quot;name&quot; belongs to.If &quot;name&quot; is not given the currently selected item is used.</source>
15354 cbradney 809
        <translation type="obsolete">unGroupObjects(&quot;name&quot;)
12918 cbradney 810
 
811
Destructs the group the object &quot;name&quot; belongs to.If &quot;name&quot; is not given the currently selected item is used.</translation>
812
    </message>
813
    <message>
814
        <source>scaleGroup(factor [,&quot;name&quot;])
815
 
816
Scales the group the object &quot;name&quot; belongs to. Values greater than 1 enlarge
817
the group, values smaller than 1 make the group smaller e.g a value of 0.5
818
scales the group to 50 % of its original size, a value of 1.5 scales the group
819
to 150 % of its original size.  The value for &quot;factor&quot; must be greater than
820
0. If &quot;name&quot; is not given the currently selected item is used.
821
 
822
May raise ValueError if an invalid scale factor is passed.
823
</source>
15354 cbradney 824
        <translation type="obsolete">scaleGroup(factor [,&quot;name&quot;])
12918 cbradney 825
 
826
Scales the group the object &quot;name&quot; belongs to. Values greater than 1 enlarge
827
the group, values smaller than 1 make the group smaller e.g a value of 0.5
828
scales the group to 50 % of its original size, a value of 1.5 scales the group
829
to 150 % of its original size.  The value for &quot;factor&quot; must be greater than
830
0. If &quot;name&quot; is not given the currently selected item is used.
831
 
832
May raise ValueError if an invalid scale factor is passed.
833
</translation>
834
    </message>
835
    <message>
836
        <source>loadImage(&quot;filename&quot; [, &quot;name&quot;])
837
 
838
Loads the picture &quot;picture&quot; into the image frame &quot;name&quot;. If &quot;name&quot; is
839
not given the currently selected item is used.
840
 
841
May raise WrongFrameTypeError if the target frame is not an image frame
842
</source>
15354 cbradney 843
        <translation type="obsolete">loadImage(&quot;filename&quot; [, &quot;name&quot;])
12918 cbradney 844
 
845
Loads the picture &quot;picture&quot; into the image frame &quot;name&quot;. If &quot;name&quot; is
846
not given the currently selected item is used.
847
 
848
May raise WrongFrameTypeError if the target frame is not an image frame
849
</translation>
850
    </message>
851
    <message>
852
        <source>scaleImage(x, y [, &quot;name&quot;])
853
 
854
Sets the scaling factors of the picture in the image frame &quot;name&quot;.
855
If &quot;name&quot; is not given the currently selected item is used. A number of 1
856
means 100 %.
857
 
858
May raise WrongFrameTypeError if the target frame is not an image frame
859
</source>
13279 cbradney 860
        <translation type="obsolete">scaleImage(x, y [, &quot;name&quot;])
12918 cbradney 861
 
862
Sets the scaling factors of the picture in the image frame &quot;name&quot;.
863
If &quot;name&quot; is not given the currently selected item is used. A number of 1
864
means 100 %.
865
 
866
May raise WrongFrameTypeError if the target frame is not an image frame
867
</translation>
868
    </message>
869
    <message>
870
        <source>lockObject([&quot;name&quot;]) -&gt; bool
871
 
872
Locks the object &quot;name&quot; if it&apos;s unlocked or unlock it if it&apos;s locked.
873
If &quot;name&quot; is not given the currently selected item is used. Returns true
874
if locked.
875
</source>
15354 cbradney 876
        <translation type="obsolete">lockObject([&quot;name&quot;]) -&gt; bool
12918 cbradney 877
 
878
Locks the object &quot;name&quot; if it&apos;s unlocked or unlock it if it&apos;s locked.
879
If &quot;name&quot; is not given the currently selected item is used. Returns true
880
if locked.
881
</translation>
882
    </message>
883
    <message>
884
        <source>isLocked([&quot;name&quot;]) -&gt; bool
885
 
886
Returns true if is the object &quot;name&quot; locked.  If &quot;name&quot; is not given the
887
currently selected item is used.
888
</source>
15354 cbradney 889
        <translation type="obsolete">isLocked([&quot;name&quot;]) -&gt; bool
12918 cbradney 890
 
891
Returns true if is the object &quot;name&quot; locked.  If &quot;name&quot; is not given the
892
currently selected item is used.
893
</translation>
894
    </message>
895
    <message>
896
        <source>setScaleImageToFrame(scaletoframe, proportional=None, name=&lt;selection&gt;)
897
 
898
Sets the scale to frame on the selected or specified image frame to `scaletoframe&apos;.
899
If `proportional&apos; is specified, set fixed aspect ratio scaling to `proportional&apos;.
900
Both `scaletoframe&apos; and `proportional&apos; are boolean.
901
 
902
May raise WrongFrameTypeError.
903
</source>
15354 cbradney 904
        <translation type="obsolete">setScaleImageToFrame(scaletoframe, proportional=None, name=&lt;selection&gt;)
12918 cbradney 905
 
906
Sets the scale to frame on the selected or specified image frame to `scaletoframe&apos;.
907
If `proportional&apos; is specified, set fixed aspect ratio scaling to `proportional&apos;.
908
Both `scaletoframe&apos; and `proportional&apos; are boolean.
909
 
910
May raise WrongFrameTypeError.
911
</translation>
912
    </message>
913
    <message>
914
        <source>getFontNames() -&gt; list
915
 
916
Returns a list with the names of all available fonts.
917
</source>
15354 cbradney 918
        <translation type="obsolete">getFontNames() -&gt; list
12918 cbradney 919
 
920
Returns a list with the names of all available fonts.
921
</translation>
922
    </message>
923
    <message>
924
        <source>getXFontNames() -&gt; list of tuples
925
 
926
Returns a larger font info. It&apos;s a list of the tuples with:
927
[ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ]
928
</source>
15354 cbradney 929
        <translation type="obsolete">getXFontNames() -&gt; list of tuples
12918 cbradney 930
 
931
Returns a larger font info. It&apos;s a list of the tuples with:
932
[ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ]
933
</translation>
934
    </message>
935
    <message>
936
        <source>renderFont(&quot;name&quot;, &quot;filename&quot;, &quot;sample&quot;, size, format=&quot;PPM&quot;) -&gt; bool
937
 
938
Creates an image preview of font &quot;name&quot; with given text &quot;sample&quot; and size.
939
If &quot;filename&quot; is not &quot;&quot;, image is saved into &quot;filename&quot;. Otherwise
940
image data is returned as a string. The optional &quot;format&quot; argument
941
specifies the image format to generate, and supports any format allowed
942
by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.
943
 
944
May raise NotFoundError if the specified font can&apos;t be found.
945
May raise ValueError if an empty sample or filename is passed.
946
</source>
15354 cbradney 947
        <translation type="obsolete">renderFont(&quot;name&quot;, &quot;filename&quot;, &quot;sample&quot;, size, format=&quot;PPM&quot;) -&gt; bool
12918 cbradney 948
 
949
Creates an image preview of font &quot;name&quot; with given text &quot;sample&quot; and size.
950
If &quot;filename&quot; is not &quot;&quot;, image is saved into &quot;filename&quot;. Otherwise
951
image data is returned as a string. The optional &quot;format&quot; argument
952
specifies the image format to generate, and supports any format allowed
953
by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.
954
 
955
May raise NotFoundError if the specified font can&apos;t be found.
956
May raise ValueError if an empty sample or filename is passed.
957
</translation>
958
    </message>
959
    <message>
960
        <source>getLayers() -&gt; list
961
 
962
Returns a list with the names of all defined layers.
963
</source>
15354 cbradney 964
        <translation type="obsolete">getLayers() -&gt; list
12918 cbradney 965
 
966
Returns a list with the names of all defined layers.
967
</translation>
968
    </message>
969
    <message>
970
        <source>setActiveLayer(&quot;name&quot;)
971
 
972
Sets the active layer to the layer named &quot;name&quot;.
973
 
974
May raise NotFoundError if the layer can&apos;t be found.
975
May raise ValueError if the layer name isn&apos;t acceptable.
976
</source>
15354 cbradney 977
        <translation type="obsolete">setActiveLayer(&quot;name&quot;)
12918 cbradney 978
 
979
Sets the active layer to the layer named &quot;name&quot;.
980
 
981
May raise NotFoundError if the layer can&apos;t be found.
982
May raise ValueError if the layer name isn&apos;t acceptable.
983
</translation>
984
    </message>
985
    <message>
986
        <source>getActiveLayer() -&gt; string
987
 
988
Returns the name of the current active layer.
989
</source>
15354 cbradney 990
        <translation type="obsolete">getActiveLayer() -&gt; string
12918 cbradney 991
 
992
Returns the name of the current active layer.
993
</translation>
994
    </message>
995
    <message>
996
        <source>sentToLayer(&quot;layer&quot; [, &quot;name&quot;])
997
 
998
Sends the object &quot;name&quot; to the layer &quot;layer&quot;. The layer must exist.
999
If &quot;name&quot; is not given the currently selected item is used.
1000
 
1001
May raise NotFoundError if the layer can&apos;t be found.
1002
May raise ValueError if the layer name isn&apos;t acceptable.
1003
</source>
15354 cbradney 1004
        <translation type="obsolete">sentToLayer(&quot;layer&quot; [, &quot;name&quot;])
12918 cbradney 1005
 
1006
Sends the object &quot;name&quot; to the layer &quot;layer&quot;. The layer must exist.
1007
If &quot;name&quot; is not given the currently selected item is used.
1008
 
1009
May raise NotFoundError if the layer can&apos;t be found.
1010
May raise ValueError if the layer name isn&apos;t acceptable.
1011
</translation>
1012
    </message>
1013
    <message>
1014
        <source>setLayerVisible(&quot;layer&quot;, visible)
1015
 
1016
Sets the layer &quot;layer&quot; to be visible or not. If is the visible set to false
1017
the layer is invisible.
1018
 
1019
May raise NotFoundError if the layer can&apos;t be found.
1020
May raise ValueError if the layer name isn&apos;t acceptable.
1021
</source>
15354 cbradney 1022
        <translation type="obsolete">setLayerVisible(&quot;layer&quot;, visible)
12918 cbradney 1023
 
1024
Sets the layer &quot;layer&quot; to be visible or not. If is the visible set to false
1025
the layer is invisible.
1026
 
1027
May raise NotFoundError if the layer can&apos;t be found.
1028
May raise ValueError if the layer name isn&apos;t acceptable.
1029
</translation>
1030
    </message>
1031
    <message>
1032
        <source>isLayerPrintable(&quot;layer&quot;) -&gt; bool
1033
 
1034
Returns whether the layer &quot;layer&quot; is printable or not, a value of True means
1035
that the layer &quot;layer&quot; can be printed, a value of False means that printing
1036
the layer &quot;layer&quot; is disabled.
1037
 
1038
May raise NotFoundError if the layer can&apos;t be found.
1039
May raise ValueError if the layer name isn&apos;t acceptable.
1040
</source>
15354 cbradney 1041
        <translation type="obsolete">isLayerPrintable(&quot;layer&quot;) -&gt; bool
12918 cbradney 1042
 
1043
Returns whether the layer &quot;layer&quot; is printable or not, a value of True means
1044
that the layer &quot;layer&quot; can be printed, a value of False means that printing
1045
the layer &quot;layer&quot; is disabled.
1046
 
1047
May raise NotFoundError if the layer can&apos;t be found.
1048
May raise ValueError if the layer name isn&apos;t acceptable.
1049
</translation>
1050
    </message>
1051
    <message>
1052
        <source>deleteLayer(&quot;layer&quot;)
1053
 
1054
Deletes the layer with the name &quot;layer&quot;. Nothing happens if the layer doesn&apos;t
1055
exists or if it&apos;s the only layer in the document.
1056
 
1057
May raise NotFoundError if the layer can&apos;t be found.
1058
May raise ValueError if the layer name isn&apos;t acceptable.
1059
</source>
15354 cbradney 1060
        <translation type="obsolete">deleteLayer(&quot;layer&quot;)
12918 cbradney 1061
 
1062
Deletes the layer with the name &quot;layer&quot;. Nothing happens if the layer doesn&apos;t
1063
exists or if it&apos;s the only layer in the document.
1064
 
1065
May raise NotFoundError if the layer can&apos;t be found.
1066
May raise ValueError if the layer name isn&apos;t acceptable.
1067
</translation>
1068
    </message>
1069
    <message>
1070
        <source>createLayer(layer)
1071
 
1072
Creates a new layer with the name &quot;name&quot;.
1073
 
1074
May raise ValueError if the layer name isn&apos;t acceptable.
1075
</source>
15354 cbradney 1076
        <translation type="obsolete">createLayer(layer)
12918 cbradney 1077
 
1078
Creates a new layer with the name &quot;name&quot;.
1079
 
1080
May raise ValueError if the layer name isn&apos;t acceptable.
1081
</translation>
1082
    </message>
1083
    <message>
1084
        <source>getGuiLanguage() -&gt; string
1085
 
1086
Returns a string with the -lang value.
1087
</source>
15354 cbradney 1088
        <translation type="obsolete">getGuiLanguage() -&gt; string
12918 cbradney 1089
 
1090
Returns a string with the -lang value.
1091
</translation>
1092
    </message>
1093
    <message>
1094
        <source>createEllipse(x, y, width, height, [&quot;name&quot;]) -&gt; string
1095
 
1096
Creates a new ellipse on the current page and returns its name.
1097
The coordinates are given in the current measurement units of the document
1098
(see UNIT constants). &quot;name&quot; should be a unique identifier for the object
1099
because you need this name for further referencing of that object. If &quot;name&quot;
1100
is not given Scribus will create one for you.
1101
 
1102
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1103
</source>
15354 cbradney 1104
        <translation type="obsolete">createEllipse(x, y, width, height, [&quot;name&quot;]) -&gt; string
12918 cbradney 1105
 
1106
Creates a new ellipse on the current page and returns its name.
1107
The coordinates are given in the current measurement units of the document
1108
(see UNIT constants). &quot;name&quot; should be a unique identifier for the object
1109
because you need this name for further referencing of that object. If &quot;name&quot;
1110
is not given Scribus will create one for you.
1111
 
1112
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1113
</translation>
1114
    </message>
1115
    <message>
1116
        <source>createImage(x, y, width, height, [&quot;name&quot;]) -&gt; string
1117
 
1118
Creates a new picture frame on the current page and returns its name. The
1119
coordinates are given in the current measurement units of the document.
1120
&quot;name&quot; should be a unique identifier for the object because you need this
1121
name for further access to that object. If &quot;name&quot; is not given Scribus will
1122
create one for you.
1123
 
1124
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1125
</source>
15354 cbradney 1126
        <translation type="obsolete">createImage(x, y, width, height, [&quot;name&quot;]) -&gt; string
12918 cbradney 1127
 
1128
Creates a new picture frame on the current page and returns its name. The
1129
coordinates are given in the current measurement units of the document.
1130
&quot;name&quot; should be a unique identifier for the object because you need this
1131
name for further access to that object. If &quot;name&quot; is not given Scribus will
1132
create one for you.
1133
 
1134
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1135
</translation>
1136
    </message>
1137
    <message>
1138
        <source>createText(x, y, width, height, [&quot;name&quot;]) -&gt; string
1139
 
1140
Creates a new text frame on the actual page and returns its name.
1141
The coordinates are given in the actual measurement unit of the document (see
1142
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
1143
you need this name for further referencing of that object. If &quot;name&quot; is not
1144
given Scribus will create one for you.
1145
 
1146
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1147
</source>
15354 cbradney 1148
        <translation type="obsolete">createText(x, y, width, height, [&quot;name&quot;]) -&gt; string
12918 cbradney 1149
 
1150
Creates a new text frame on the actual page and returns its name.
1151
The coordinates are given in the actual measurement unit of the document (see
1152
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
1153
you need this name for further referencing of that object. If &quot;name&quot; is not
1154
given Scribus will create one for you.
1155
 
1156
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1157
</translation>
1158
    </message>
1159
    <message>
1160
        <source>createLine(x1, y1, x2, y2, [&quot;name&quot;]) -&gt; string
1161
 
1162
Creates a new line from the point(x1, y1) to the point(x2, y2) and returns
1163
its name. The coordinates are given in the current measurement unit of the
1164
document (see UNIT constants). &quot;name&quot; should be a unique identifier for the
1165
object because you need this name for further access to that object. If
1166
&quot;name&quot; is not given Scribus will create one for you.
1167
 
1168
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1169
</source>
15354 cbradney 1170
        <translation type="obsolete">createLine(x1, y1, x2, y2, [&quot;name&quot;]) -&gt; string
12918 cbradney 1171
 
1172
Creates a new line from the point(x1, y1) to the point(x2, y2) and returns
1173
its name. The coordinates are given in the current measurement unit of the
1174
document (see UNIT constants). &quot;name&quot; should be a unique identifier for the
1175
object because you need this name for further access to that object. If
1176
&quot;name&quot; is not given Scribus will create one for you.
1177
 
1178
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1179
</translation>
1180
    </message>
1181
    <message>
1182
        <source>createPolyLine(list, [&quot;name&quot;]) -&gt; string
1183
 
1184
Creates a new polyline and returns its name. The points for the polyline are
1185
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
1186
The coordinates are given in the current measurement units of the document (see
1187
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
1188
you need this name for further access to that object. If &quot;name&quot; is not given
1189
Scribus will create one for you.
1190
 
1191
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1192
May raise ValueError if an insufficient number of points is passed or if
1193
the number of values passed don&apos;t group into points without leftovers.
1194
</source>
15354 cbradney 1195
        <translation type="obsolete">createPolyLine(list, [&quot;name&quot;]) -&gt; string
12918 cbradney 1196
 
1197
Creates a new polyline and returns its name. The points for the polyline are
1198
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
1199
The coordinates are given in the current measurement units of the document (see
1200
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
1201
you need this name for further access to that object. If &quot;name&quot; is not given
1202
Scribus will create one for you.
1203
 
1204
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1205
May raise ValueError if an insufficient number of points is passed or if
1206
the number of values passed don&apos;t group into points without leftovers.
1207
</translation>
1208
    </message>
1209
    <message>
1210
        <source>createPolygon(list, [&quot;name&quot;]) -&gt; string
1211
 
1212
Creates a new polygon and returns its name. The points for the polygon are
1213
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
1214
At least three points are required. There is no need to repeat the first point
1215
to close the polygon. The polygon is automatically closed by connecting the
1216
first and the last point.  The coordinates are given in the current measurement
1217
units of the document (see UNIT constants).  &quot;name&quot; should be a unique
1218
identifier for the object because you need this name for further access to that
1219
object. If &quot;name&quot; is not given Scribus will create one for you.
1220
 
1221
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1222
May raise ValueError if an insufficient number of points is passed or if
1223
the number of values passed don&apos;t group into points without leftovers.
1224
</source>
15354 cbradney 1225
        <translation type="obsolete">createPolygon(list, [&quot;name&quot;]) -&gt; string
12918 cbradney 1226
 
1227
Creates a new polygon and returns its name. The points for the polygon are
1228
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
1229
At least three points are required. There is no need to repeat the first point
1230
to close the polygon. The polygon is automatically closed by connecting the
1231
first and the last point.  The coordinates are given in the current measurement
1232
units of the document (see UNIT constants).  &quot;name&quot; should be a unique
1233
identifier for the object because you need this name for further access to that
1234
object. If &quot;name&quot; is not given Scribus will create one for you.
1235
 
1236
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1237
May raise ValueError if an insufficient number of points is passed or if
1238
the number of values passed don&apos;t group into points without leftovers.
1239
</translation>
1240
    </message>
1241
    <message>
12456 jghali 1242
        <source>createBezierLine(list, [&quot;name&quot;]) -&gt; string
9498 cbradney 1243
 
12456 jghali 1244
Creates a new bezier curve and returns its name. The points for the bezier
1245
curve are stored in the list &quot;list&quot; in the following order:
1246
[x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]
1247
In the points list, x and y mean the x and y coordinates of the point and kx
1248
and ky meaning the control point for the curve.  The coordinates are given in
1249
the current measurement units of the document (see UNIT constants). &quot;name&quot;
1250
should be a unique identifier for the object because you need this name for
1251
further access to that object. If &quot;name&quot; is not given Scribus will create one
1252
for you.
9498 cbradney 1253
 
12456 jghali 1254
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1255
May raise ValueError if an insufficient number of points is passed or if
1256
the number of values passed don&apos;t group into points without leftovers.
9498 cbradney 1257
</source>
15354 cbradney 1258
        <translation type="obsolete">createBezierLine(list, [&quot;name&quot;]) -&gt; string
9498 cbradney 1259
 
12456 jghali 1260
Creates a new bezier curve and returns its name. The points for the bezier
1261
curve are stored in the list &quot;list&quot; in the following order:
1262
[x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]
1263
In the points list, x and y mean the x and y coordinates of the point and kx
1264
and ky meaning the control point for the curve.  The coordinates are given in
1265
the current measurement units of the document (see UNIT constants). &quot;name&quot;
1266
should be a unique identifier for the object because you need this name for
1267
further access to that object. If &quot;name&quot; is not given Scribus will create one
1268
for you.
9498 cbradney 1269
 
12456 jghali 1270
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1271
May raise ValueError if an insufficient number of points is passed or if
1272
the number of values passed don&apos;t group into points without leftovers.
9498 cbradney 1273
</translation>
1274
    </message>
1275
    <message>
12918 cbradney 1276
        <source>createPathText(x, y, &quot;textbox&quot;, &quot;beziercurve&quot;, [&quot;name&quot;]) -&gt; string
1277
 
1278
Creates a new pathText by merging the two objects &quot;textbox&quot; and
1279
&quot;beziercurve&quot; and returns its name. The coordinates are given in the current
1280
measurement unit of the document (see UNIT constants). &quot;name&quot; should be a
1281
unique identifier for the object because you need this name for further access
1282
to that object. If &quot;name&quot; is not given Scribus will create one for you.
1283
 
1284
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1285
May raise NotFoundError if one or both of the named base object don&apos;t exist.
1286
</source>
15354 cbradney 1287
        <translation type="obsolete">createPathText(x, y, &quot;textbox&quot;, &quot;beziercurve&quot;, [&quot;name&quot;]) -&gt; string
12918 cbradney 1288
 
1289
Creates a new pathText by merging the two objects &quot;textbox&quot; and
1290
&quot;beziercurve&quot; and returns its name. The coordinates are given in the current
1291
measurement unit of the document (see UNIT constants). &quot;name&quot; should be a
1292
unique identifier for the object because you need this name for further access
1293
to that object. If &quot;name&quot; is not given Scribus will create one for you.
1294
 
1295
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1296
May raise NotFoundError if one or both of the named base object don&apos;t exist.
1297
</translation>
1298
    </message>
1299
    <message>
1300
        <source>deleteObject([&quot;name&quot;])
1301
 
1302
Deletes the item with the name &quot;name&quot;. If &quot;name&quot; is not given the currently
1303
selected item is deleted.
1304
</source>
15354 cbradney 1305
        <translation type="obsolete">deleteObject([&quot;name&quot;])
12918 cbradney 1306
 
1307
Deletes the item with the name &quot;name&quot;. If &quot;name&quot; is not given the currently
1308
selected item is deleted.
1309
</translation>
1310
    </message>
1311
    <message>
1312
        <source>objectExists([&quot;name&quot;]) -&gt; bool
1313
 
1314
Test if an object with specified name really exists in the document.
1315
The optional parameter is the object name. When no object name is given,
1316
returns True if there is something selected.
1317
</source>
15354 cbradney 1318
        <translation type="obsolete">objectExists([&quot;name&quot;]) -&gt; bool
12918 cbradney 1319
 
1320
Test if an object with specified name really exists in the document.
1321
The optional parameter is the object name. When no object name is given,
1322
returns True if there is something selected.
1323
</translation>
1324
    </message>
1325
    <message>
1326
        <source>setStyle(&quot;style&quot; [, &quot;name&quot;])
1327
 
1328
Apply the named &quot;style&quot; to the object named &quot;name&quot;. If is no object name
1329
given, it&apos;s applied on the selected object.
1330
</source>
14474 cbradney 1331
        <translation type="obsolete">setStyle(&quot;style&quot; [, &quot;name&quot;])
12918 cbradney 1332
 
1333
Apply the named &quot;style&quot; to the object named &quot;name&quot;. If is no object name
1334
given, it&apos;s applied on the selected object.
1335
</translation>
1336
    </message>
1337
    <message>
1338
        <source>getAllStyles() -&gt; list
1339
 
1340
Return a list of the names of all paragraph styles in the current document.
1341
</source>
15354 cbradney 1342
        <translation type="obsolete">getAllStyles() -&gt; list
12918 cbradney 1343
 
1344
Return a list of the names of all paragraph styles in the current document.
1345
</translation>
1346
    </message>
1347
    <message>
1348
        <source>currentPage() -&gt; integer
1349
 
1350
Returns the number of the current working page. Page numbers are counted from 1
1351
upwards, no matter what the displayed first page number of your document is.
1352
</source>
15354 cbradney 1353
        <translation type="obsolete">currentPage() -&gt; integer
12918 cbradney 1354
 
1355
Returns the number of the current working page. Page numbers are counted from 1
1356
upwards, no matter what the displayed first page number of your document is.
1357
</translation>
1358
    </message>
1359
    <message>
1360
        <source>redrawAll()
1361
 
1362
Redraws all pages.
1363
</source>
15354 cbradney 1364
        <translation type="obsolete">redrawAll()
12918 cbradney 1365
 
1366
Redraws all pages.
1367
</translation>
1368
    </message>
1369
    <message>
1370
        <source>savePageAsEPS(&quot;name&quot;)
1371
 
1372
Saves the current page as an EPS to the file &quot;name&quot;.
1373
 
1374
May raise ScribusError if the save failed.
1375
</source>
15354 cbradney 1376
        <translation type="obsolete">savePageAsEPS(&quot;name&quot;)
12918 cbradney 1377
 
1378
Saves the current page as an EPS to the file &quot;name&quot;.
1379
 
1380
May raise ScribusError if the save failed.
1381
</translation>
1382
    </message>
1383
    <message>
1384
        <source>deletePage(nr)
1385
 
1386
Deletes the given page. Does nothing if the document contains only one page.
1387
Page numbers are counted from 1 upwards, no matter what the displayed first
1388
page number is.
1389
 
1390
May raise IndexError if the page number is out of range
1391
</source>
15354 cbradney 1392
        <translation type="obsolete">deletePage(nr)
12918 cbradney 1393
 
1394
Deletes the given page. Does nothing if the document contains only one page.
1395
Page numbers are counted from 1 upwards, no matter what the displayed first
1396
page number is.
1397
 
1398
May raise IndexError if the page number is out of range
1399
</translation>
1400
    </message>
1401
    <message>
1402
        <source>pageCount() -&gt; integer
1403
 
1404
Returns the number of pages in the document.
1405
</source>
15354 cbradney 1406
        <translation type="obsolete">pageCount() -&gt; integer
12918 cbradney 1407
 
1408
Returns the number of pages in the document.
1409
</translation>
1410
    </message>
1411
    <message>
1412
        <source>getHGuides() -&gt; list
1413
 
1414
Returns a list containing positions of the horizontal guides. Values are in the
1415
document&apos;s current units - see UNIT_&lt;type&gt; constants.
1416
</source>
15354 cbradney 1417
        <translation type="obsolete">getHGuides() -&gt; list
12918 cbradney 1418
 
1419
Returns a list containing positions of the horizontal guides. Values are in the
1420
document&apos;s current units - see UNIT_&lt;type&gt; constants.
1421
</translation>
1422
    </message>
1423
    <message>
1424
        <source>setHGuides(list)
1425
 
1426
Sets horizontal guides. Input parameter must be a list of guide positions
1427
measured in the current document units - see UNIT_&lt;type&gt; constants.
1428
 
1429
Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost
1430
         setHGuides([90,250]) # replace current guides entirely
1431
</source>
15354 cbradney 1432
        <translation type="obsolete">setHGuides(list)
12918 cbradney 1433
 
1434
Sets horizontal guides. Input parameter must be a list of guide positions
1435
measured in the current document units - see UNIT_&lt;type&gt; constants.
1436
 
1437
Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost
1438
         setHGuides([90,250]) # replace current guides entirely
1439
</translation>
1440
    </message>
1441
    <message>
1442
        <source>getVGuides()
1443
 
1444
See getHGuides.
1445
</source>
15354 cbradney 1446
        <translation type="obsolete">getVGuides()
12918 cbradney 1447
 
1448
See getHGuides.
1449
</translation>
1450
    </message>
1451
    <message>
1452
        <source>setVGuides()
1453
 
1454
See setHGuides.
1455
</source>
15354 cbradney 1456
        <translation type="obsolete">setVGuides()
12918 cbradney 1457
 
1458
See setHGuides.
1459
</translation>
1460
    </message>
1461
    <message>
1462
        <source>getPageSize() -&gt; tuple
1463
 
15294 cbradney 1464
Returns a tuple with page dimensions measured in the document&apos;s current units.
1465
See UNIT_&lt;type&gt; constants and getPageMargins()
1466
</source>
1467
        <translation type="obsolete">getPageSize() -&gt; tuple
1468
 
1469
Returns a tuple with page dimensions measured in the document&apos;s current units.
1470
See UNIT_&lt;type&gt; constants and getPageMargins()
1471
</translation>
1472
    </message>
1473
    <message>
12918 cbradney 1474
        <source>getPageItems() -&gt; list
1475
 
1476
Returns a list of tuples with items on the current page. The tuple is:
1477
(name, objectType, order) E.g. [(&apos;Text1&apos;, 4, 0), (&apos;Image1&apos;, 2, 1)]
1478
means that object named &apos;Text1&apos; is a text frame (type 4) and is the first at
1479
the page...
1480
</source>
15354 cbradney 1481
        <translation type="obsolete">getPageItems() -&gt; list
12918 cbradney 1482
 
1483
Returns a list of tuples with items on the current page. The tuple is:
1484
(name, objectType, order) E.g. [(&apos;Text1&apos;, 4, 0), (&apos;Image1&apos;, 2, 1)]
1485
means that object named &apos;Text1&apos; is a text frame (type 4) and is the first at
1486
the page...
1487
</translation>
1488
    </message>
1489
    <message>
1490
        <source>getPageMargins()
1491
 
1492
Returns the page margins as a (top, left, right, bottom) tuple in the current
1493
units. See UNIT_&lt;type&gt; constants and getPageSize().
1494
</source>
15294 cbradney 1495
        <translation type="obsolete">getPageMargins()
12918 cbradney 1496
 
1497
Returns the page margins as a (top, left, right, bottom) tuple in the current
1498
units. See UNIT_&lt;type&gt; constants and getPageSize().
1499
</translation>
1500
    </message>
1501
    <message>
1502
        <source>setFillColor(&quot;color&quot;, [&quot;name&quot;])
1503
 
1504
Sets the fill color of the object &quot;name&quot; to the color &quot;color&quot;. &quot;color&quot;
1505
is the name of one of the defined colors. If &quot;name&quot; is not given the
1506
currently selected item is used.
1507
</source>
15354 cbradney 1508
        <translation type="obsolete">setFillColor(&quot;color&quot;, [&quot;name&quot;])
12918 cbradney 1509
 
1510
Sets the fill colour of the object &quot;name&quot; to the colour &quot;color&quot;. &quot;color&quot;
1511
is the name of one of the defined colours. If &quot;name&quot; is not given the
1512
currently selected item is used.
1513
</translation>
1514
    </message>
1515
    <message>
1516
        <source>setLineColor(&quot;color&quot;, [&quot;name&quot;])
1517
 
1518
Sets the line color of the object &quot;name&quot; to the color &quot;color&quot;. If &quot;name&quot;
1519
is not given the currently selected item is used.
1520
</source>
15354 cbradney 1521
        <translation type="obsolete">setLineColor(&quot;color&quot;, [&quot;name&quot;])
12918 cbradney 1522
 
1523
Sets the line colour of the object &quot;name&quot; to the colour &quot;color&quot;. If &quot;name&quot;
1524
is not given the currently selected item is used.
1525
</translation>
1526
    </message>
1527
    <message>
1528
        <source>setLineWidth(width, [&quot;name&quot;])
1529
 
1530
Sets line width of the object &quot;name&quot; to &quot;width&quot;. &quot;width&quot; must be in the
1531
range from 0.0 to 12.0 inclusive, and is measured in points. If &quot;name&quot; is not
1532
given the currently selected item is used.
1533
 
1534
May raise ValueError if the line width is out of bounds.
1535
</source>
15354 cbradney 1536
        <translation type="obsolete">setLineWidth(width, [&quot;name&quot;])
12918 cbradney 1537
 
1538
Sets line width of the object &quot;name&quot; to &quot;width&quot;. &quot;width&quot; must be in the
1539
range from 0.0 to 12.0 inclusive, and is measured in points. If &quot;name&quot; is not
1540
given the currently selected item is used.
1541
 
1542
May raise ValueError if the line width is out of bounds.
1543
</translation>
1544
    </message>
1545
    <message>
1546
        <source>setLineShade(shade, [&quot;name&quot;])
1547
 
1548
Sets the shading of the line color of the object &quot;name&quot; to &quot;shade&quot;.
1549
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
1550
(full color intensity). If &quot;name&quot; is not given the currently selected item
1551
is used.
1552
 
1553
May raise ValueError if the line shade is out of bounds.
1554
</source>
15354 cbradney 1555
        <translation type="obsolete">setLineShade(shade, [&quot;name&quot;])
12918 cbradney 1556
 
1557
Sets the shading of the line colour of the object &quot;name&quot; to &quot;shade&quot;.
1558
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
1559
(full colour intensity). If &quot;name&quot; is not given the currently selected item
1560
is used.
1561
 
1562
May raise ValueError if the line shade is out of bounds.
1563
</translation>
1564
    </message>
1565
    <message>
1566
        <source>setLineJoin(join, [&quot;name&quot;])
1567
 
1568
Sets the line join style of the object &quot;name&quot; to the style &quot;join&quot;.
1569
If &quot;name&quot; is not given the currently selected item is used. There are
1570
predefined constants for join - JOIN_&lt;type&gt;.
1571
</source>
15354 cbradney 1572
        <translation type="obsolete">setLineJoin(join, [&quot;name&quot;])
12918 cbradney 1573
 
1574
Sets the line join style of the object &quot;name&quot; to the style &quot;join&quot;.
1575
If &quot;name&quot; is not given the currently selected item is used. There are
1576
predefined constants for join - JOIN_&lt;type&gt;.
1577
</translation>
1578
    </message>
1579
    <message>
1580
        <source>setLineEnd(endtype, [&quot;name&quot;])
1581
 
1582
Sets the line cap style of the object &quot;name&quot; to the style &quot;cap&quot;.
1583
If &quot;name&quot; is not given the currently selected item is used. There are
1584
predefined constants for &quot;cap&quot; - CAP_&lt;type&gt;.
1585
</source>
15354 cbradney 1586
        <translation type="obsolete">setLineEnd(endtype, [&quot;name&quot;])
12918 cbradney 1587
 
1588
Sets the line cap style of the object &quot;name&quot; to the style &quot;cap&quot;.
1589
If &quot;name&quot; is not given the currently selected item is used. There are
1590
predefined constants for &quot;cap&quot; - CAP_&lt;type&gt;.
1591
</translation>
1592
    </message>
1593
    <message>
1594
        <source>setLineStyle(style, [&quot;name&quot;])
1595
 
1596
Sets the line style of the object &quot;name&quot; to the style &quot;style&quot;. If &quot;name&quot;
1597
is not given the currently selected item is used. There are predefined
1598
constants for &quot;style&quot; - LINE_&lt;style&gt;.
1599
</source>
15354 cbradney 1600
        <translation type="obsolete">setLineStyle(style, [&quot;name&quot;])
12918 cbradney 1601
 
1602
Sets the line style of the object &quot;name&quot; to the style &quot;style&quot;. If &quot;name&quot;
1603
is not given the currently selected item is used. There are predefined
1604
constants for &quot;style&quot; - LINE_&lt;style&gt;.
1605
</translation>
1606
    </message>
1607
    <message>
1608
        <source>setFillShade(shade, [&quot;name&quot;])
1609
 
1610
Sets the shading of the fill color of the object &quot;name&quot; to &quot;shade&quot;.
1611
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
1612
(full Color intensity). If &quot;name&quot; is not given the currently selected
1613
Item is used.
1614
 
1615
May raise ValueError if the fill shade is out of bounds.
1616
</source>
15354 cbradney 1617
        <translation type="obsolete">setFillShade(shade, [&quot;name&quot;])
12918 cbradney 1618
 
1619
Sets the shading of the fill colour of the object &quot;name&quot; to &quot;shade&quot;.
1620
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
1621
(full Colour intensity). If &quot;name&quot; is not given the currently selected
1622
Item is used.
1623
 
1624
May raise ValueError if the fill shade is out of bounds.
1625
</translation>
1626
    </message>
1627
    <message>
1628
        <source>setCornerRadius(radius, [&quot;name&quot;])
1629
 
1630
Sets the corner radius of the object &quot;name&quot;. The radius is expressed
1631
in points. If &quot;name&quot; is not given the currently selected item is used.
1632
 
1633
May raise ValueError if the corner radius is negative.
1634
</source>
15354 cbradney 1635
        <translation type="obsolete">setCornerRadius(radius, [&quot;name&quot;])
12918 cbradney 1636
 
1637
Sets the corner radius of the object &quot;name&quot;. The radius is expressed
1638
in points. If &quot;name&quot; is not given the currently selected item is used.
1639
 
1640
May raise ValueError if the corner radius is negative.
1641
</translation>
1642
    </message>
1643
    <message>
1644
        <source>setMultiLine(&quot;namedStyle&quot;, [&quot;name&quot;])
1645
 
1646
Sets the line style of the object &quot;name&quot; to the named style &quot;namedStyle&quot;.
1647
If &quot;name&quot; is not given the currently selected item is used.
1648
 
1649
May raise NotFoundError if the line style doesn&apos;t exist.
1650
</source>
15354 cbradney 1651
        <translation type="obsolete">setMultiLine(&quot;namedStyle&quot;, [&quot;name&quot;])
12918 cbradney 1652
 
1653
Sets the line style of the object &quot;name&quot; to the named style &quot;namedStyle&quot;.
1654
If &quot;name&quot; is not given the currently selected item is used.
1655
 
1656
May raise NotFoundError if the line style doesn&apos;t exist.
1657
</translation>
1658
    </message>
1659
    <message>
1660
        <source>getFont([&quot;name&quot;]) -&gt; string
1661
 
1662
Returns the font name for the text frame &quot;name&quot;. If this text frame
1663
has some text selected the value assigned to the first character
1664
of the selection is returned. If &quot;name&quot; is not given the currently
1665
selected item is used.
1666
</source>
15354 cbradney 1667
        <translation type="obsolete">getFont([&quot;name&quot;]) -&gt; string
12918 cbradney 1668
 
1669
Returns the font name for the text frame &quot;name&quot;. If this text frame
1670
has some text selected the value assigned to the first character
1671
of the selection is returned. If &quot;name&quot; is not given the currently
1672
selected item is used.
1673
</translation>
1674
    </message>
1675
    <message>
1676
        <source>getTextLength([&quot;name&quot;]) -&gt; integer
1677
 
1678
Returns the length of the text in the text frame &quot;name&quot;.
1679
If &quot;name&quot; is not given the currently selected item is used.
1680
</source>
15354 cbradney 1681
        <translation type="obsolete">getTextLength([&quot;name&quot;]) -&gt; integer
12918 cbradney 1682
 
1683
Returns the length of the text in the text frame &quot;name&quot;.
1684
If &quot;name&quot; is not given the currently selected item is used.
1685
</translation>
1686
    </message>
1687
    <message>
1688
        <source>getText([&quot;name&quot;]) -&gt; string
1689
 
1690
Returns the text of the text frame &quot;name&quot;. If this text frame has some text
1691
selected, the selected text is returned. All text in the frame, not just
1692
currently visible text, is returned. If &quot;name&quot; is not given the currently
1693
selected item is used.
1694
</source>
15354 cbradney 1695
        <translation type="obsolete">getText([&quot;name&quot;]) -&gt; string
12918 cbradney 1696
 
1697
Returns the text of the text frame &quot;name&quot;. If this text frame has some text
1698
selected, the selected text is returned. All text in the frame, not just
1699
currently visible text, is returned. If &quot;name&quot; is not given the currently
1700
selected item is used.
1701
</translation>
1702
    </message>
1703
    <message>
1704
        <source>getAllText([&quot;name&quot;]) -&gt; string
1705
 
1706
Returns the text of the text frame &quot;name&quot; and of all text frames which are
1707
linked with this frame. If this textframe has some text selected, the selected
1708
text is returned. If &quot;name&quot; is not given the currently selected item is
1709
used.
1710
</source>
15354 cbradney 1711
        <translation type="obsolete">getAllText([&quot;name&quot;]) -&gt; string
12918 cbradney 1712
 
1713
Returns the text of the text frame &quot;name&quot; and of all text frames which are
1714
linked with this frame. If this textframe has some text selected, the selected
1715
text is returned. If &quot;name&quot; is not given the currently selected item is
1716
used.
1717
</translation>
1718
    </message>
1719
    <message>
1720
        <source>getLineSpacing([&quot;name&quot;]) -&gt; float
1721
 
1722
Returns the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; expressed in
1723
points. If &quot;name&quot; is not given the currently selected item is used.
1724
</source>
15354 cbradney 1725
        <translation type="obsolete">getLineSpacing([&quot;name&quot;]) -&gt; float
12918 cbradney 1726
 
1727
Returns the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; expressed in
1728
points. If &quot;name&quot; is not given the currently selected item is used.
1729
</translation>
1730
    </message>
1731
    <message>
1732
        <source>getColumnGap([&quot;name&quot;]) -&gt; float
1733
 
1734
Returns the column gap size of the text frame &quot;name&quot; expressed in points. If
1735
&quot;name&quot; is not given the currently selected item is used.
1736
</source>
15354 cbradney 1737
        <translation type="obsolete">getColumnGap([&quot;name&quot;]) -&gt; float
12918 cbradney 1738
 
1739
Returns the column gap size of the text frame &quot;name&quot; expressed in points. If
1740
&quot;name&quot; is not given the currently selected item is used.
1741
</translation>
1742
    </message>
1743
    <message>
1744
        <source>getColumns([&quot;name&quot;]) -&gt; integer
1745
 
1746
Gets the number of columns of the text frame &quot;name&quot;. If &quot;name&quot; is not
1747
given the currently selected item is used.
1748
</source>
15354 cbradney 1749
        <translation type="obsolete">getColumns([&quot;name&quot;]) -&gt; integer
12918 cbradney 1750
 
1751
Gets the number of columns of the text frame &quot;name&quot;. If &quot;name&quot; is not
1752
given the currently selected item is used.
1753
</translation>
1754
    </message>
1755
    <message>
1756
        <source>setText(&quot;text&quot;, [&quot;name&quot;])
1757
 
1758
Sets the text of the text frame &quot;name&quot; to the text of the string &quot;text&quot;.
1759
Text must be UTF8 encoded - use e.g. unicode(text, &apos;iso-8859-2&apos;). See the FAQ
1760
for more details. If &quot;name&quot; is not given the currently selected item is
1761
used.
1762
</source>
15354 cbradney 1763
        <translation type="obsolete">setText(&quot;text&quot;, [&quot;name&quot;])
12918 cbradney 1764
 
1765
Sets the text of the text frame &quot;name&quot; to the text of the string &quot;text&quot;.
1766
Text must be UTF8 encoded - use e.g. unicode(text, &apos;iso-8859-2&apos;). See the FAQ
1767
for more details. If &quot;name&quot; is not given the currently selected item is
1768
used.
1769
</translation>
1770
    </message>
1771
    <message>
1772
        <source>setFont(&quot;font&quot;, [&quot;name&quot;])
1773
 
1774
Sets the font of the text frame &quot;name&quot; to &quot;font&quot;. If there is some text
1775
selected only the selected text is changed.  If &quot;name&quot; is not given the
1776
currently selected item is used.
1777
 
1778
May throw ValueError if the font cannot be found.
1779
</source>
15354 cbradney 1780
        <translation type="obsolete">setFont(&quot;font&quot;, [&quot;name&quot;])
12918 cbradney 1781
 
1782
Sets the font of the text frame &quot;name&quot; to &quot;font&quot;. If there is some text
1783
selected only the selected text is changed.  If &quot;name&quot; is not given the
1784
currently selected item is used.
1785
 
1786
May throw ValueError if the font cannot be found.
1787
</translation>
1788
    </message>
1789
    <message>
1790
        <source>setFontSize(size, [&quot;name&quot;])
1791
 
1792
Sets the font size of the text frame &quot;name&quot; to &quot;size&quot;. &quot;size&quot; is treated
1793
as a value in points. If there is some text selected only the selected text is
1794
changed. &quot;size&quot; must be in the range 1 to 512. If &quot;name&quot; is not given the
1795
currently selected item is used.
1796
 
1797
May throw ValueError for a font size that&apos;s out of bounds.
1798
</source>
15354 cbradney 1799
        <translation type="obsolete">setFontSize(size, [&quot;name&quot;])
12918 cbradney 1800
 
1801
Sets the font size of the text frame &quot;name&quot; to &quot;size&quot;. &quot;size&quot; is treated
1802
as a value in points. If there is some text selected only the selected text is
1803
changed. &quot;size&quot; must be in the range 1 to 512. If &quot;name&quot; is not given the
1804
currently selected item is used.
1805
 
1806
May throw ValueError for a font size that&apos;s out of bounds.
1807
</translation>
1808
    </message>
1809
    <message>
1810
        <source>setLineSpacing(size, [&quot;name&quot;])
1811
 
1812
Sets the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; to &quot;size&quot;.
1813
&quot;size&quot; is a value in points. If &quot;name&quot; is not given the currently selected
1814
item is used.
1815
 
1816
May throw ValueError if the line spacing is out of bounds.
1817
</source>
15354 cbradney 1818
        <translation type="obsolete">setLineSpacing(size, [&quot;name&quot;])
12918 cbradney 1819
 
1820
Sets the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; to &quot;size&quot;.
1821
&quot;size&quot; is a value in points. If &quot;name&quot; is not given the currently selected
1822
item is used.
1823
 
1824
May throw ValueError if the line spacing is out of bounds.
1825
</translation>
1826
    </message>
1827
    <message>
1828
        <source>setColumnGap(size, [&quot;name&quot;])
1829
 
1830
Sets the column gap of the text frame &quot;name&quot; to the value &quot;size&quot;. If
1831
&quot;name&quot; is not given the currently selected item is used.
1832
 
1833
May throw ValueError if the column gap is out of bounds (must be positive).
1834
</source>
15354 cbradney 1835
        <translation type="obsolete">setColumnGap(size, [&quot;name&quot;])
12918 cbradney 1836
 
1837
Sets the column gap of the text frame &quot;name&quot; to the value &quot;size&quot;. If
1838
&quot;name&quot; is not given the currently selected item is used.
1839
 
1840
May throw ValueError if the column gap is out of bounds (must be positive).
1841
</translation>
1842
    </message>
1843
    <message>
1844
        <source>setColumns(nr, [&quot;name&quot;])
1845
 
1846
Sets the number of columns of the text frame &quot;name&quot; to the integer &quot;nr&quot;.
1847
If &quot;name&quot; is not given the currently selected item is used.
1848
 
1849
May throw ValueError if number of columns is not at least one.
1850
</source>
15354 cbradney 1851
        <translation type="obsolete">setColumns(nr, [&quot;name&quot;])
12918 cbradney 1852
 
1853
Sets the number of columns of the text frame &quot;name&quot; to the integer &quot;nr&quot;.
1854
If &quot;name&quot; is not given the currently selected item is used.
1855
 
1856
May throw ValueError if number of columns is not at least one.
1857
</translation>
1858
    </message>
1859
    <message>
1860
        <source>setTextAlignment(align, [&quot;name&quot;])
1861
 
1862
Sets the text alignment of the text frame &quot;name&quot; to the specified alignment.
1863
If &quot;name&quot; is not given the currently selected item is used. &quot;align&quot; should
1864
be one of the ALIGN_ constants defined in this module - see dir(scribus).
1865
 
1866
May throw ValueError for an invalid alignment constant.
1867
</source>
15354 cbradney 1868
        <translation type="obsolete">setTextAlignment(align, [&quot;name&quot;])
12918 cbradney 1869
 
1870
Sets the text alignment of the text frame &quot;name&quot; to the specified alignment.
1871
If &quot;name&quot; is not given the currently selected item is used. &quot;align&quot; should
1872
be one of the ALIGN_ constants defined in this module - see dir(scribus).
1873
 
1874
May throw ValueError for an invalid alignment constant.
1875
</translation>
1876
    </message>
1877
    <message>
1878
        <source>selectText(start, count, [&quot;name&quot;])
1879
 
1880
Selects &quot;count&quot; characters of text in the text frame &quot;name&quot; starting from the
1881
character &quot;start&quot;. Character counting starts at 0. If &quot;count&quot; is zero, any
1882
text selection will be cleared.  If &quot;name&quot; is not given the currently
1883
selected item is used.
1884
 
1885
May throw IndexError if the selection is outside the bounds of the text.
1886
</source>
15354 cbradney 1887
        <translation type="obsolete">selectText(start, count, [&quot;name&quot;])
12918 cbradney 1888
 
1889
Selects &quot;count&quot; characters of text in the text frame &quot;name&quot; starting from the
1890
character &quot;start&quot;. Character counting starts at 0. If &quot;count&quot; is zero, any
1891
text selection will be cleared.  If &quot;name&quot; is not given the currently
1892
selected item is used.
1893
 
1894
May throw IndexError if the selection is outside the bounds of the text.
1895
</translation>
1896
    </message>
1897
    <message>
1898
        <source>deleteText([&quot;name&quot;])
1899
 
1900
Deletes any text in the text frame &quot;name&quot;. If there is some text selected,
1901
only the selected text will be deleted. If &quot;name&quot; is not given the currently
1902
selected item is used.
1903
</source>
15354 cbradney 1904
        <translation type="obsolete">deleteText([&quot;name&quot;])
12918 cbradney 1905
 
1906
Deletes any text in the text frame &quot;name&quot;. If there is some text selected,
1907
only the selected text will be deleted. If &quot;name&quot; is not given the currently
1908
selected item is used.
1909
</translation>
1910
    </message>
1911
    <message>
1912
        <source>setTextColor(&quot;color&quot;, [&quot;name&quot;])
1913
 
1914
Sets the text color of the text frame &quot;name&quot; to the color &quot;color&quot;. If there
1915
is some text selected only the selected text is changed. If &quot;name&quot; is not
1916
given the currently selected item is used.
1917
</source>
15354 cbradney 1918
        <translation type="obsolete">setTextColor(&quot;color&quot;, [&quot;name&quot;])
12918 cbradney 1919
 
1920
Sets the text colour of the text frame &quot;name&quot; to the colour &quot;color&quot;. If there
1921
is some text selected only the selected text is changed. If &quot;name&quot; is not
1922
given the currently selected item is used.
1923
</translation>
1924
    </message>
1925
    <message>
1926
        <source>setTextStroke(&quot;color&quot;, [&quot;name&quot;])
1927
 
1928
Set &quot;color&quot; of the text stroke. If &quot;name&quot; is not given the currently
1929
selected item is used.
1930
</source>
15354 cbradney 1931
        <translation type="obsolete">setTextStroke(&quot;color&quot;, [&quot;name&quot;])
12918 cbradney 1932
 
1933
Set &quot;color&quot; of the text stroke. If &quot;name&quot; is not given the currently
1934
selected item is used.
1935
</translation>
1936
    </message>
1937
    <message>
1938
        <source>setTextShade(shade, [&quot;name&quot;])
1939
 
1940
Sets the shading of the text color of the object &quot;name&quot; to &quot;shade&quot;. If
1941
there is some text selected only the selected text is changed. &quot;shade&quot; must
1942
be an integer value in the range from 0 (lightest) to 100 (full color
1943
intensity). If &quot;name&quot; is not given the currently selected item is
1944
used.
1945
</source>
15354 cbradney 1946
        <translation type="obsolete">setTextShade(shade, [&quot;name&quot;])
12918 cbradney 1947
 
1948
Sets the shading of the text colour of the object &quot;name&quot; to &quot;shade&quot;. If
1949
there is some text selected only the selected text is changed. &quot;shade&quot; must
1950
be an integer value in the range from 0 (lightest) to 100 (full colour
1951
intensity). If &quot;name&quot; is not given the currently selected item is
1952
used.
1953
</translation>
1954
    </message>
1955
    <message>
1956
        <source>linkTextFrames(&quot;fromname&quot;, &quot;toname&quot;)
1957
 
1958
Link two text frames. The frame named &quot;fromname&quot; is linked to the
1959
frame named &quot;toname&quot;. The target frame must be an empty text frame
1960
and must not link to or be linked from any other frames already.
1961
 
1962
May throw ScribusException if linking rules are violated.
1963
</source>
15354 cbradney 1964
        <translation type="obsolete">linkTextFrames(&quot;fromname&quot;, &quot;toname&quot;)
12918 cbradney 1965
 
1966
Link two text frames. The frame named &quot;fromname&quot; is linked to the
1967
frame named &quot;toname&quot;. The target frame must be an empty text frame
1968
and must not link to or be linked from any other frames already.
1969
 
1970
May throw ScribusException if linking rules are violated.
1971
</translation>
1972
    </message>
1973
    <message>
1974
        <source>unlinkTextFrames(&quot;name&quot;)
1975
 
1976
Remove the specified (named) object from the text frame flow/linkage. If the
1977
frame was in the middle of a chain, the previous and next frames will be
1978
connected, eg &apos;a-&gt;b-&gt;c&apos; becomes &apos;a-&gt;c&apos; when you unlinkTextFrames(b)&apos;
1979
 
1980
May throw ScribusException if linking rules are violated.
1981
</source>
15354 cbradney 1982
        <translation type="obsolete">unlinkTextFrames(&quot;name&quot;)
12918 cbradney 1983
 
1984
Remove the specified (named) object from the text frame flow/linkage. If the
1985
frame was in the middle of a chain, the previous and next frames will be
1986
connected, eg &apos;a-&gt;b-&gt;c&apos; becomes &apos;a-&gt;c&apos; when you unlinkTextFrames(b)&apos;
1987
 
1988
May throw ScribusException if linking rules are violated.
1989
</translation>
1990
    </message>
1991
    <message>
1992
        <source>traceText([&quot;name&quot;])
1993
 
1994
Convert the text frame &quot;name&quot; to outlines. If &quot;name&quot; is not given the
1995
currently selected item is used.</source>
15354 cbradney 1996
        <translation type="obsolete">traceText([&quot;name&quot;])
12918 cbradney 1997
 
1998
Convert the text frame &quot;name&quot; to outlines. If &quot;name&quot; is not given the
1999
currently selected item is used.</translation>
2000
    </message>
2001
    <message>
2002
        <source>textOverflows([&quot;name&quot;, nolinks]) -&gt; integer
2003
 
2004
Returns the actual number of overflowing characters in text frame &quot;name&quot;.
2005
If is nolinks set to non zero value it takes only one frame - it doesn&apos;t
2006
use text frame linking. Without this parameter it search all linking chain.
2007
 
2008
May raise WrongFrameTypeError if the target frame is not an text frame
2009
</source>
15354 cbradney 2010
        <translation type="obsolete">textOverflows([&quot;name&quot;, nolinks]) -&gt; integer
12918 cbradney 2011
 
2012
Returns the actual number of overflowing characters in text frame &quot;name&quot;.
2013
If is nolinks set to non zero value it takes only one frame - it doesn&apos;t
2014
use text frame linking. Without this parameter it search all linking chain.
2015
 
2016
May raise WrongFrameTypeError if the target frame is not an text frame
2017
</translation>
2018
    </message>
2019
    <message>
2020
        <source>isPDFBookmark([&quot;name&quot;]) -&gt; bool
2021
 
2022
Returns true if the text frame &quot;name&quot; is a PDF bookmark.
2023
If &quot;name&quot; is not given the currently selected item is used.
2024
 
2025
May raise WrongFrameTypeError if the target frame is not a text frame
2026
</source>
15354 cbradney 2027
        <translation type="obsolete">isPDFBookmark([&quot;name&quot;]) -&gt; bool
12918 cbradney 2028
 
2029
Returns true if the text frame &quot;name&quot; is a PDF bookmark.
2030
If &quot;name&quot; is not given the currently selected item is used.
2031
 
2032
May raise WrongFrameTypeError if the target frame is not a text frame
2033
</translation>
2034
    </message>
2035
    <message>
2036
        <source>progressReset()
2037
 
2038
Cleans up the Scribus progress bar previous settings. It is called before the
2039
new progress bar use. See progressSet.
2040
</source>
15354 cbradney 2041
        <translation type="obsolete">progressReset()
12918 cbradney 2042
 
2043
Cleans up the Scribus progress bar previous settings. It is called before the
2044
new progress bar use. See progressSet.
2045
</translation>
2046
    </message>
2047
    <message>
2048
        <source>progressTotal(max)
2049
 
2050
Sets the progress bar&apos;s maximum steps value to the specified number.
2051
See progressSet.
2052
</source>
15354 cbradney 2053
        <translation type="obsolete">progressTotal(max)
12918 cbradney 2054
 
2055
Sets the progress bar&apos;s maximum steps value to the specified number.
2056
See progressSet.
2057
</translation>
2058
    </message>
2059
    <message>
2060
        <source>progressSet(nr)
2061
 
2062
Set the progress bar position to &quot;nr&quot;, a value relative to the previously set
2063
progressTotal. The progress bar uses the concept of steps; you give it the
2064
total number of steps and the number of steps completed so far and it will
2065
display the percentage of steps that have been completed. You can specify the
2066
total number of steps with progressTotal(). The current number of steps is set
2067
with progressSet(). The progress bar can be rewound to the beginning with
2068
progressReset(). [based on info taken from Trolltech&apos;s Qt docs]
2069
</source>
15354 cbradney 2070
        <translation type="obsolete">progressSet(nr)
12918 cbradney 2071
 
2072
Set the progress bar position to &quot;nr&quot;, a value relative to the previously set
2073
progressTotal. The progress bar uses the concept of steps; you give it the
2074
total number of steps and the number of steps completed so far and it will
2075
display the percentage of steps that have been completed. You can specify the
2076
total number of steps with progressTotal(). The current number of steps is set
2077
with progressSet(). The progress bar can be rewound to the beginning with
2078
progressReset(). [based on info taken from Trolltech&apos;s Qt docs]
2079
</translation>
2080
    </message>
2081
    <message>
2082
        <source>setCursor()
2083
 
2084
[UNSUPPORTED!] This might break things, so steer clear for now.
2085
</source>
15354 cbradney 2086
        <translation type="obsolete">setCursor()
12918 cbradney 2087
 
2088
[UNSUPPORTED!] This might break things, so steer clear for now.
2089
</translation>
2090
    </message>
2091
    <message>
2092
        <source>docChanged(bool)
2093
 
2094
Enable/disable save icon in the Scribus icon bar and the Save menu item. It&apos;s
2095
useful to call this procedure when you&apos;re changing the document, because Scribus
2096
won&apos;t automatically notice when you change the document using a script.
2097
</source>
15354 cbradney 2098
        <translation type="obsolete">docChanged(bool)
12918 cbradney 2099
 
2100
Enable/disable save icon in the Scribus icon bar and the Save menu item. It&apos;s
2101
useful to call this procedure when you&apos;re changing the document, because Scribus
2102
won&apos;t automatically notice when you change the document using a script.
2103
</translation>
2104
    </message>
2105
    <message>
2106
        <source>zoomDocument(double)
2107
 
2108
Zoom the document in main GUI window. Actions have whole number
2109
values like 20.0, 100.0, etc. Zoom to Fit uses -100 as a marker.
2110
</source>
15354 cbradney 2111
        <translation type="obsolete">zoomDocument(double)
12918 cbradney 2112
 
2113
在主視窗縮放文件, 縮放值如: 20.0, 100.0 等, 縮放並符合視窗大小已 -100 為記號(為主).
2114
</translation>
2115
    </message>
2116
</context>
2117
<context>
2118
    <name>@default</name>
2119
    <message>
2120
        <source>changeColor(&quot;name&quot;, c, m, y, k)
2121
 
2122
Changes the color &quot;name&quot; to the specified CMYK value. The color value is
2123
defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black.
2124
Color components should be in the range from 0 to 255.
2125
 
2126
May raise NotFoundError if the named color wasn&apos;t found.
2127
May raise ValueError if an invalid color name is specified.
2128
</source>
2129
        <translation type="obsolete">changeColour(&quot;name&quot;, c, m, y, k)
2130
 
2131
Changes the colour &quot;name&quot; to the specified CMYK value. The colour value is
2132
defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black.
2133
Colour components should be in the range from 0 to 255.
2134
 
2135
May raise NotFoundError if the named colour wasn&apos;t found.
2136
May raise ValueError if an invalid colour name is specified.
2137
</translation>
2138
    </message>
2139
    <message>
2140
        <source>closeDoc()
2141
 
2142
Closes the current document without prompting to save.
2143
 
2144
May throw NoDocOpenError if there is no document to close
2145
</source>
2146
        <translation type="obsolete">closeDoc()
2147
 
2148
Closes the current document without prompting to save.
2149
 
2150
May throw NoDocOpenError if there is no document to close
2151
</translation>
2152
    </message>
2153
    <message>
2154
        <source>closeMasterPage()
2155
 
2156
Closes the currently active master page, if any, and returns editing
2157
to normal. Begin editing with editMasterPage().
2158
</source>
2159
        <translation type="obsolete">closeMasterPage()
2160
 
2161
Closes the currently active master page, if any, and returns editing
2162
to normal. Begin editing with editMasterPage().
2163
</translation>
2164
    </message>
2165
    <message>
2166
        <source>createBezierLine(list, [&quot;name&quot;]) -&gt; string
2167
 
2168
Creates a new bezier curve and returns its name. The points for the bezier
2169
curve are stored in the list &quot;list&quot; in the following order:
2170
[x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]
2171
In the points list, x and y mean the x and y coordinates of the point and kx
2172
and ky meaning the control point for the curve.  The coordinates are given in
2173
the current measurement units of the document (see UNIT constants). &quot;name&quot;
2174
should be a unique identifier for the object because you need this name for
2175
further access to that object. If &quot;name&quot; is not given Scribus will create one
2176
for you.
2177
 
2178
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
2179
May raise ValueError if an insufficient number of points is passed or if
2180
the number of values passed don&apos;t group into points without leftovers.
2181
</source>
2182
        <translation type="obsolete">createBezierLine(list, [&quot;name&quot;]) -&gt; string
2183
 
2184
Creates a new bezier curve and returns its name. The points for the bezier
2185
curve are stored in the list &quot;list&quot; in the following order:
2186
[x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]
2187
In the points list, x and y mean the x and y coordinates of the point and kx
2188
and ky meaning the control point for the curve.  The coordinates are given in
2189
the current measurement units of the document (see UNIT constants). &quot;name&quot;
2190
should be a unique identifier for the object because you need this name for
2191
further access to that object. If &quot;name&quot; is not given Scribus will create one
2192
for you.
2193
 
2194
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
2195
May raise ValueError if an insufficient number of points is passed or if
2196
the number of values passed don&apos;t group into points without leftovers.
2197
</translation>
2198
    </message>
2199
    <message>
12456 jghali 2200
        <source>createEllipse(x, y, width, height, [&quot;name&quot;]) -&gt; string
9498 cbradney 2201
 
12456 jghali 2202
Creates a new ellipse on the current page and returns its name.
2203
The coordinates are given in the current measurement units of the document
2204
(see UNIT constants). &quot;name&quot; should be a unique identifier for the object
2205
because you need this name for further referencing of that object. If &quot;name&quot;
2206
is not given Scribus will create one for you.
9498 cbradney 2207
 
12456 jghali 2208
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
9498 cbradney 2209
</source>
12918 cbradney 2210
        <translation type="obsolete">createEllipse(x, y, width, height, [&quot;name&quot;]) -&gt; string
9498 cbradney 2211
 
12456 jghali 2212
Creates a new ellipse on the current page and returns its name.
2213
The coordinates are given in the current measurement units of the document
2214
(see UNIT constants). &quot;name&quot; should be a unique identifier for the object
2215
because you need this name for further referencing of that object. If &quot;name&quot;
2216
is not given Scribus will create one for you.
9498 cbradney 2217
 
12456 jghali 2218
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
9498 cbradney 2219
</translation>
2220
    </message>
2221
    <message>
12456 jghali 2222
        <source>createImage(x, y, width, height, [&quot;name&quot;]) -&gt; string
9498 cbradney 2223
 
12456 jghali 2224
Creates a new picture frame on the current page and returns its name. The
2225
coordinates are given in the current measurement units of the document.
2226
&quot;name&quot; should be a unique identifier for the object because you need this
2227
name for further access to that object. If &quot;name&quot; is not given Scribus will
2228
create one for you.
9498 cbradney 2229
 
12456 jghali 2230
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
9498 cbradney 2231
</source>
12918 cbradney 2232
        <translation type="obsolete">createImage(x, y, width, height, [&quot;name&quot;]) -&gt; string
9498 cbradney 2233
 
12456 jghali 2234
Creates a new picture frame on the current page and returns its name. The
2235
coordinates are given in the current measurement units of the document.
2236
&quot;name&quot; should be a unique identifier for the object because you need this
2237
name for further access to that object. If &quot;name&quot; is not given Scribus will
2238
create one for you.
9498 cbradney 2239
 
12456 jghali 2240
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
9498 cbradney 2241
</translation>
2242
    </message>
2243
    <message>
12456 jghali 2244
        <source>createLayer(layer)
9498 cbradney 2245
 
12456 jghali 2246
Creates a new layer with the name &quot;name&quot;.
9498 cbradney 2247
 
12456 jghali 2248
May raise ValueError if the layer name isn&apos;t acceptable.
9498 cbradney 2249
</source>
12918 cbradney 2250
        <translation type="obsolete">createLayer(layer)
9498 cbradney 2251
 
12456 jghali 2252
Creates a new layer with the name &quot;name&quot;.
9498 cbradney 2253
 
12456 jghali 2254
May raise ValueError if the layer name isn&apos;t acceptable.
9498 cbradney 2255
</translation>
2256
    </message>
2257
    <message>
12456 jghali 2258
        <source>createLine(x1, y1, x2, y2, [&quot;name&quot;]) -&gt; string
9498 cbradney 2259
 
12456 jghali 2260
Creates a new line from the point(x1, y1) to the point(x2, y2) and returns
2261
its name. The coordinates are given in the current measurement unit of the
2262
document (see UNIT constants). &quot;name&quot; should be a unique identifier for the
2263
object because you need this name for further access to that object. If
2264
&quot;name&quot; is not given Scribus will create one for you.
2265
 
2266
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
9498 cbradney 2267
</source>
12918 cbradney 2268
        <translation type="obsolete">createLine(x1, y1, x2, y2, [&quot;name&quot;]) -&gt; string
9498 cbradney 2269
 
12456 jghali 2270
Creates a new line from the point(x1, y1) to the point(x2, y2) and returns
2271
its name. The coordinates are given in the current measurement unit of the
2272
document (see UNIT constants). &quot;name&quot; should be a unique identifier for the
2273
object because you need this name for further access to that object. If
2274
&quot;name&quot; is not given Scribus will create one for you.
2275
 
2276
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
9498 cbradney 2277
</translation>
2278
    </message>
2279
    <message>
12456 jghali 2280
        <source>createMasterPage(pageName)
9498 cbradney 2281
 
12456 jghali 2282
Creates a new master page named pageName and opens it for
2283
editing.
9498 cbradney 2284
</source>
12918 cbradney 2285
        <translation type="obsolete">createMasterPage(pageName)
9498 cbradney 2286
 
12456 jghali 2287
開新的 pageName 的主頁, 並打開它來編輯.
9498 cbradney 2288
</translation>
2289
    </message>
2290
    <message>
12456 jghali 2291
        <source>createPathText(x, y, &quot;textbox&quot;, &quot;beziercurve&quot;, [&quot;name&quot;]) -&gt; string
9498 cbradney 2292
 
12456 jghali 2293
Creates a new pathText by merging the two objects &quot;textbox&quot; and
2294
&quot;beziercurve&quot; and returns its name. The coordinates are given in the current
2295
measurement unit of the document (see UNIT constants). &quot;name&quot; should be a
2296
unique identifier for the object because you need this name for further access
2297
to that object. If &quot;name&quot; is not given Scribus will create one for you.
2298
 
2299
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
2300
May raise NotFoundError if one or both of the named base object don&apos;t exist.
9498 cbradney 2301
</source>
12918 cbradney 2302
        <translation type="obsolete">createPathText(x, y, &quot;textbox&quot;, &quot;beziercurve&quot;, [&quot;name&quot;]) -&gt; string
9498 cbradney 2303
 
12456 jghali 2304
Creates a new pathText by merging the two objects &quot;textbox&quot; and
2305
&quot;beziercurve&quot; and returns its name. The coordinates are given in the current
2306
measurement unit of the document (see UNIT constants). &quot;name&quot; should be a
2307
unique identifier for the object because you need this name for further access
2308
to that object. If &quot;name&quot; is not given Scribus will create one for you.
2309
 
2310
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
2311
May raise NotFoundError if one or both of the named base object don&apos;t exist.
9498 cbradney 2312
</translation>
2313
    </message>
2314
    <message>
12456 jghali 2315
        <source>createPolygon(list, [&quot;name&quot;]) -&gt; string
9498 cbradney 2316
 
12456 jghali 2317
Creates a new polygon and returns its name. The points for the polygon are
2318
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
2319
At least three points are required. There is no need to repeat the first point
2320
to close the polygon. The polygon is automatically closed by connecting the
2321
first and the last point.  The coordinates are given in the current measurement
2322
units of the document (see UNIT constants).  &quot;name&quot; should be a unique
2323
identifier for the object because you need this name for further access to that
2324
object. If &quot;name&quot; is not given Scribus will create one for you.
2325
 
2326
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
2327
May raise ValueError if an insufficient number of points is passed or if
2328
the number of values passed don&apos;t group into points without leftovers.
9498 cbradney 2329
</source>
12918 cbradney 2330
        <translation type="obsolete">createPolygon(list, [&quot;name&quot;]) -&gt; string
9498 cbradney 2331
 
12456 jghali 2332
Creates a new polygon and returns its name. The points for the polygon are
2333
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
2334
At least three points are required. There is no need to repeat the first point
2335
to close the polygon. The polygon is automatically closed by connecting the
2336
first and the last point.  The coordinates are given in the current measurement
2337
units of the document (see UNIT constants).  &quot;name&quot; should be a unique
2338
identifier for the object because you need this name for further access to that
2339
object. If &quot;name&quot; is not given Scribus will create one for you.
9498 cbradney 2340
 
12456 jghali 2341
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
2342
May raise ValueError if an insufficient number of points is passed or if
2343
the number of values passed don&apos;t group into points without leftovers.
9498 cbradney 2344
</translation>
2345
    </message>
2346
    <message>
12456 jghali 2347
        <source>createPolyLine(list, [&quot;name&quot;]) -&gt; string
9498 cbradney 2348
 
12456 jghali 2349
Creates a new polyline and returns its name. The points for the polyline are
2350
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
2351
The coordinates are given in the current measurement units of the document (see
2352
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
2353
you need this name for further access to that object. If &quot;name&quot; is not given
2354
Scribus will create one for you.
9498 cbradney 2355
 
12456 jghali 2356
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
2357
May raise ValueError if an insufficient number of points is passed or if
2358
the number of values passed don&apos;t group into points without leftovers.
9498 cbradney 2359
</source>
12918 cbradney 2360
        <translation type="obsolete">createPolyLine(list, [&quot;name&quot;]) -&gt; string
9498 cbradney 2361
 
12456 jghali 2362
Creates a new polyline and returns its name. The points for the polyline are
2363
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
2364
The coordinates are given in the current measurement units of the document (see
2365
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
2366
you need this name for further access to that object. If &quot;name&quot; is not given
2367
Scribus will create one for you.
9498 cbradney 2368
 
12456 jghali 2369
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
2370
May raise ValueError if an insufficient number of points is passed or if
2371
the number of values passed don&apos;t group into points without leftovers.
9498 cbradney 2372
</translation>
2373
    </message>
2374
    <message>
12456 jghali 2375
        <source>createText(x, y, width, height, [&quot;name&quot;]) -&gt; string
9498 cbradney 2376
 
12456 jghali 2377
Creates a new text frame on the actual page and returns its name.
2378
The coordinates are given in the actual measurement unit of the document (see
2379
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
2380
you need this name for further referencing of that object. If &quot;name&quot; is not
2381
given Scribus will create one for you.
9498 cbradney 2382
 
12456 jghali 2383
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
9498 cbradney 2384
</source>
12918 cbradney 2385
        <translation type="obsolete">createText(x, y, width, height, [&quot;name&quot;]) -&gt; string
9498 cbradney 2386
 
12456 jghali 2387
Creates a new text frame on the actual page and returns its name.
2388
The coordinates are given in the actual measurement unit of the document (see
2389
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
2390
you need this name for further referencing of that object. If &quot;name&quot; is not
2391
given Scribus will create one for you.
9498 cbradney 2392
 
12456 jghali 2393
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
9498 cbradney 2394
</translation>
2395
    </message>
2396
    <message>
12456 jghali 2397
        <source>currentPage() -&gt; integer
9498 cbradney 2398
 
12456 jghali 2399
Returns the number of the current working page. Page numbers are counted from 1
2400
upwards, no matter what the displayed first page number of your document is.
9498 cbradney 2401
</source>
12918 cbradney 2402
        <translation type="obsolete">currentPage() -&gt; integer
9498 cbradney 2403
 
12456 jghali 2404
Returns the number of the current working page. Page numbers are counted from 1
2405
upwards, no matter what the displayed first page number of your document is.
9498 cbradney 2406
</translation>
2407
    </message>
2408
    <message>
12456 jghali 2409
        <source>defineColor(&quot;name&quot;, c, m, y, k)
9498 cbradney 2410
 
12456 jghali 2411
Defines a new color &quot;name&quot;. The color Value is defined via four components:
2412
c = Cyan, m = Magenta, y = Yello and k = Black. Color components should be in
2413
the range from 0 to 255.
9498 cbradney 2414
 
12456 jghali 2415
May raise ValueError if an invalid color name is specified.
9498 cbradney 2416
</source>
12456 jghali 2417
        <translation type="obsolete">defineColor(&quot;name&quot;, c, m, y, k)
9498 cbradney 2418
 
12456 jghali 2419
Defines a new colour &quot;name&quot;. The colour Value is defined via four components:
2420
c = Cyan, m = Magenta, y = Yello and k = Black. Colour components should be in
2421
the range from 0 to 255.
9498 cbradney 2422
 
12456 jghali 2423
May raise ValueError if an invalid colour name is specified.
9498 cbradney 2424
</translation>
2425
    </message>
2426
    <message>
12456 jghali 2427
        <source>deleteColor(&quot;name&quot;, &quot;replace&quot;)
9498 cbradney 2428
 
12456 jghali 2429
Deletes the color &quot;name&quot;. Every occurence of that color is replaced by the
2430
color &quot;replace&quot;. If not specified, &quot;replace&quot; defaults to the color
2431
&quot;None&quot; - transparent.
9498 cbradney 2432
 
12456 jghali 2433
deleteColor works on the default document colors if there is no document open.
2434
In that case, &quot;replace&quot;, if specified, has no effect.
9498 cbradney 2435
 
12456 jghali 2436
May raise NotFoundError if a named color wasn&apos;t found.
2437
May raise ValueError if an invalid color name is specified.
9498 cbradney 2438
</source>
12918 cbradney 2439
        <translation type="obsolete">deleteColor(&quot;name&quot;, &quot;replace&quot;)
9498 cbradney 2440
 
12456 jghali 2441
Deletes the colour &quot;name&quot;. Every occurence of that colour is replaced by the
2442
colour &quot;replace&quot;. If not specified, &quot;replace&quot; defaults to the colour
2443
&quot;None&quot; - transparent.
9498 cbradney 2444
 
12456 jghali 2445
deleteColor works on the default document colours if there is no document open.
2446
In that case, &quot;replace&quot;, if specified, has no effect.
9498 cbradney 2447
 
12456 jghali 2448
May raise NotFoundError if a named colour wasn&apos;t found.
2449
May raise ValueError if an invalid colour name is specified.
9498 cbradney 2450
</translation>
2451
    </message>
2452
    <message>
12456 jghali 2453
        <source>deleteLayer(&quot;layer&quot;)
9498 cbradney 2454
 
12456 jghali 2455
Deletes the layer with the name &quot;layer&quot;. Nothing happens if the layer doesn&apos;t
2456
exists or if it&apos;s the only layer in the document.
2457
 
2458
May raise NotFoundError if the layer can&apos;t be found.
2459
May raise ValueError if the layer name isn&apos;t acceptable.
9498 cbradney 2460
</source>
12918 cbradney 2461
        <translation type="obsolete">deleteLayer(&quot;layer&quot;)
9498 cbradney 2462
 
12456 jghali 2463
Deletes the layer with the name &quot;layer&quot;. Nothing happens if the layer doesn&apos;t
2464
exists or if it&apos;s the only layer in the document.
2465
 
2466
May raise NotFoundError if the layer can&apos;t be found.
2467
May raise ValueError if the layer name isn&apos;t acceptable.
9498 cbradney 2468
</translation>
2469
    </message>
2470
    <message>
12456 jghali 2471
        <source>deleteMasterPage(pageName)
9498 cbradney 2472
 
12456 jghali 2473
Delete the named master page.
9498 cbradney 2474
</source>
12918 cbradney 2475
        <translation type="obsolete">deleteMasterPage(pageName)
9498 cbradney 2476
 
12456 jghali 2477
刪除已命名的主頁
9498 cbradney 2478
</translation>
2479
    </message>
2480
    <message>
12456 jghali 2481
        <source>deleteObject([&quot;name&quot;])
9498 cbradney 2482
 
12456 jghali 2483
Deletes the item with the name &quot;name&quot;. If &quot;name&quot; is not given the currently
2484
selected item is deleted.
9498 cbradney 2485
</source>
12918 cbradney 2486
        <translation type="obsolete">deleteObject([&quot;name&quot;])
9498 cbradney 2487
 
12456 jghali 2488
Deletes the item with the name &quot;name&quot;. If &quot;name&quot; is not given the currently
2489
selected item is deleted.
9498 cbradney 2490
</translation>
2491
    </message>
2492
    <message>
12456 jghali 2493
        <source>deletePage(nr)
9498 cbradney 2494
 
12456 jghali 2495
Deletes the given page. Does nothing if the document contains only one page.
2496
Page numbers are counted from 1 upwards, no matter what the displayed first
2497
page number is.
2498
 
2499
May raise IndexError if the page number is out of range
9498 cbradney 2500
</source>
12918 cbradney 2501
        <translation type="obsolete">deletePage(nr)
9498 cbradney 2502
 
12456 jghali 2503
Deletes the given page. Does nothing if the document contains only one page.
2504
Page numbers are counted from 1 upwards, no matter what the displayed first
2505
page number is.
2506
 
2507
May raise IndexError if the page number is out of range
9498 cbradney 2508
</translation>
2509
    </message>
2510
    <message>
12456 jghali 2511
        <source>deleteText([&quot;name&quot;])
9498 cbradney 2512
 
12456 jghali 2513
Deletes any text in the text frame &quot;name&quot;. If there is some text selected,
2514
only the selected text will be deleted. If &quot;name&quot; is not given the currently
2515
selected item is used.
9498 cbradney 2516
</source>
12918 cbradney 2517
        <translation type="obsolete">deleteText([&quot;name&quot;])
9498 cbradney 2518
 
12456 jghali 2519
Deletes any text in the text frame &quot;name&quot;. If there is some text selected,
2520
only the selected text will be deleted. If &quot;name&quot; is not given the currently
2521
selected item is used.
9498 cbradney 2522
</translation>
2523
    </message>
2524
    <message>
2525
        <source>deselectAll()
2526
 
2527
Deselects all objects in the whole document.
2528
</source>
12918 cbradney 2529
        <translation type="obsolete">deselectAll()
9498 cbradney 2530
 
2531
Deselects all objects in the whole document.
2532
</translation>
2533
    </message>
2534
    <message>
12456 jghali 2535
        <source>docChanged(bool)
9498 cbradney 2536
 
12456 jghali 2537
Enable/disable save icon in the Scribus icon bar and the Save menu item. It&apos;s
2538
useful to call this procedure when you&apos;re changing the document, because Scribus
2539
won&apos;t automatically notice when you change the document using a script.
9498 cbradney 2540
</source>
12918 cbradney 2541
        <translation type="obsolete">docChanged(bool)
9498 cbradney 2542
 
12456 jghali 2543
Enable/disable save icon in the Scribus icon bar and the Save menu item. It&apos;s
2544
useful to call this procedure when you&apos;re changing the document, because Scribus
2545
won&apos;t automatically notice when you change the document using a script.
9498 cbradney 2546
</translation>
2547
    </message>
2548
    <message>
12456 jghali 2549
        <source>editMasterPage(pageName)
9498 cbradney 2550
 
12456 jghali 2551
Enables master page editing and opens the named master page
2552
for editing. Finish editing with closeMasterPage().
9498 cbradney 2553
</source>
12918 cbradney 2554
        <translation type="obsolete">editMasterPage(pageName)
9498 cbradney 2555
 
12456 jghali 2556
Enables master page editing and opens the named master page
2557
for editing. Finish editing with closeMasterPage().
9498 cbradney 2558
</translation>
2559
    </message>
2560
    <message>
12456 jghali 2561
        <source>fileDialog(&quot;caption&quot;, [&quot;filter&quot;, &quot;defaultname&quot;, haspreview, issave, isdir]) -&gt; string with filename
9498 cbradney 2562
 
12456 jghali 2563
Shows a File Open dialog box with the caption &quot;caption&quot;. Files are filtered
2564
with the filter string &quot;filter&quot;. A default filename or file path can also
2565
supplied, leave this string empty when you don&apos;t want to use it.  A value of
2566
True for haspreview enables a small preview widget in the FileSelect box.  When
2567
the issave parameter is set to True the dialog acts like a &quot;Save As&quot; dialog
2568
otherwise it acts like a &quot;File Open Dialog&quot;. When the isdir parameter is True
2569
the dialog shows and returns only directories. The default for all of the
2570
opional parameters is False.
9498 cbradney 2571
 
12456 jghali 2572
The filter, if specified, takes the form &apos;comment (*.type *.type2 ...)&apos;.
2573
For example &apos;Images (*.png *.xpm *.jpg)&apos;.
9498 cbradney 2574
 
12456 jghali 2575
Refer to the Qt-Documentation for QFileDialog for details on filters.
9498 cbradney 2576
 
12456 jghali 2577
Example: fileDialog(&apos;Open input&apos;, &apos;CSV files (*.csv)&apos;)
2578
Example: fileDialog(&apos;Save report&apos;, defaultname=&apos;report.txt&apos;, issave=True)
9498 cbradney 2579
</source>
12456 jghali 2580
        <translation type="obsolete">fileDialog(&quot;caption&quot;, [&quot;filter&quot;, &quot;defaultname&quot;, haspreview, issave, isdir]) -&gt; string with filename
9498 cbradney 2581
 
12456 jghali 2582
Shows a File Open dialog box with the caption &quot;caption&quot;. Files are filtered
2583
with the filter string &quot;filter&quot;. A default filename or file path can also
2584
supplied, leave this string empty when you don&apos;t want to use it.  A value of
2585
True for haspreview enables a small preview widget in the FileSelect box.  When
2586
the issave parameter is set to True the dialog acts like a &quot;Save As&quot; dialog
2587
otherwise it acts like a &quot;File Open Dialog&quot;. When the isdir parameter is True
2588
the dialog shows and returns only directories. The default for all of the
2589
opional parameters is False.
9498 cbradney 2590
 
12456 jghali 2591
The filter, if specified, takes the form &apos;comment (*.type *.type2 ...)&apos;.
2592
For example &apos;Images (*.png *.xpm *.jpg)&apos;.
9498 cbradney 2593
 
12456 jghali 2594
Refer to the Qt-Documentation for QFileDialog for details on filters.
9498 cbradney 2595
 
12456 jghali 2596
Example: fileDialog(&apos;Open input&apos;, &apos;CSV files (*.csv)&apos;)
2597
Example: fileDialog(&apos;Save report&apos;, defaultname=&apos;report.txt&apos;, issave=True)
9498 cbradney 2598
</translation>
2599
    </message>
2600
    <message>
12456 jghali 2601
        <source>getActiveLayer() -&gt; string
9498 cbradney 2602
 
12456 jghali 2603
Returns the name of the current active layer.
9498 cbradney 2604
</source>
12918 cbradney 2605
        <translation type="obsolete">getActiveLayer() -&gt; string
9498 cbradney 2606
 
12456 jghali 2607
Returns the name of the current active layer.
9498 cbradney 2608
</translation>
2609
    </message>
2610
    <message>
12456 jghali 2611
        <source>getAllObjects() -&gt; list
9498 cbradney 2612
 
12456 jghali 2613
Returns a list containing the names of all objects on the current page.
9498 cbradney 2614
</source>
12918 cbradney 2615
        <translation type="obsolete">getAllObjects() -&gt; list
9498 cbradney 2616
 
12456 jghali 2617
Returns a list containing the names of all objects on the current page.
9498 cbradney 2618
</translation>
2619
    </message>
2620
    <message>
12456 jghali 2621
        <source>getAllStyles() -&gt; list
9498 cbradney 2622
 
12456 jghali 2623
Return a list of the names of all paragraph styles in the current document.
9498 cbradney 2624
</source>
12918 cbradney 2625
        <translation type="obsolete">getAllStyles() -&gt; list
9498 cbradney 2626
 
12456 jghali 2627
Return a list of the names of all paragraph styles in the current document.
9498 cbradney 2628
</translation>
2629
    </message>
2630
    <message>
12456 jghali 2631
        <source>getAllText([&quot;name&quot;]) -&gt; string
9498 cbradney 2632
 
12456 jghali 2633
Returns the text of the text frame &quot;name&quot; and of all text frames which are
2634
linked with this frame. If this textframe has some text selected, the selected
2635
text is returned. If &quot;name&quot; is not given the currently selected item is
2636
used.
9498 cbradney 2637
</source>
12918 cbradney 2638
        <translation type="obsolete">getAllText([&quot;name&quot;]) -&gt; string
9498 cbradney 2639
 
12456 jghali 2640
Returns the text of the text frame &quot;name&quot; and of all text frames which are
2641
linked with this frame. If this textframe has some text selected, the selected
2642
text is returned. If &quot;name&quot; is not given the currently selected item is
2643
used.
9498 cbradney 2644
</translation>
2645
    </message>
2646
    <message>
12456 jghali 2647
        <source>getChild(object, childname, ofclass=None, recursive=True)
9498 cbradney 2648
 
12456 jghali 2649
Return the first child of `object&apos; named `childname&apos;, possibly restricting
2650
the search to children of type name `ofclass&apos;. If `recursive&apos; is true,
2651
search recursively through children, grandchildren, etc.
9498 cbradney 2652
</source>
12456 jghali 2653
        <translation type="obsolete">getChild(object, childname, ofclass=None, recursive=True)
9498 cbradney 2654
 
12456 jghali 2655
Return the first child of `object&apos; named `childname&apos;, possibly restricting
2656
the search to children of type name `ofclass&apos;. If `recursive&apos; is true,
2657
search recursively through children, grandchildren, etc.
9498 cbradney 2658
</translation>
2659
    </message>
2660
    <message>
12456 jghali 2661
        <source>getChildren(object, ofclass=None, ofname=None, regexpmatch=False, recursive=True)
9498 cbradney 2662
 
12456 jghali 2663
Return a list of children of `object&apos;, possibly restricted to children
2664
of class named `ofclass&apos; or children named `ofname&apos;. If `recursive&apos; is true,
2665
search recursively through children, grandchildren, etc.
9498 cbradney 2666
 
12456 jghali 2667
See QObject::children() in the Qt docs for more information.
9498 cbradney 2668
</source>
12456 jghali 2669
        <translation type="obsolete">getChildren(object, ofclass=None, ofname=None, regexpmatch=False, recursive=True)
9498 cbradney 2670
 
12456 jghali 2671
Return a list of children of `object&apos;, possibly restricted to children
2672
of class named `ofclass&apos; or children named `ofname&apos;. If `recursive&apos; is true,
2673
search recursively through children, grandchildren, etc.
9498 cbradney 2674
 
12456 jghali 2675
See QObject::children() in the Qt docs for more information.
9498 cbradney 2676
</translation>
2677
    </message>
2678
    <message>
12456 jghali 2679
        <source>getColor(&quot;name&quot;) -&gt; tuple
9498 cbradney 2680
 
12456 jghali 2681
Returns a tuple (C, M, Y, K) containing the four color components of the
2682
color &quot;name&quot; from the current document. If no document is open, returns
2683
the value of the named color from the default document colors.
9498 cbradney 2684
 
12456 jghali 2685
May raise NotFoundError if the named color wasn&apos;t found.
2686
May raise ValueError if an invalid color name is specified.
9498 cbradney 2687
</source>
12918 cbradney 2688
        <translation type="obsolete">getColor(&quot;name&quot;) -&gt; tuple
9498 cbradney 2689
 
12456 jghali 2690
Returns a tuple (C, M, Y, K) containing the four colour components of the
2691
colour &quot;name&quot; from the current document. If no document is open, returns
2692
the value of the named colour from the default document colours.
9498 cbradney 2693
 
12456 jghali 2694
May raise NotFoundError if the named colour wasn&apos;t found.
2695
May raise ValueError if an invalid colour name is specified.
9498 cbradney 2696
</translation>
2697
    </message>
2698
    <message>
12456 jghali 2699
        <source>getColorAsRGB(&quot;name&quot;) -&gt; tuple
9498 cbradney 2700
 
12456 jghali 2701
Returns a tuple (R,G,B) containing the three color components of the
2702
color &quot;name&quot; from the current document, converted to the RGB color
2703
space. If no document is open, returns the value of the named color
2704
from the default document colors.
9498 cbradney 2705
 
12456 jghali 2706
May raise NotFoundError if the named color wasn&apos;t found.
2707
May raise ValueError if an invalid color name is specified.
9498 cbradney 2708
</source>
12918 cbradney 2709
        <translation type="obsolete">getColorAsRGB(&quot;name&quot;) -&gt; tuple
9498 cbradney 2710
 
12456 jghali 2711
Returns a tuple (R,G,B) containing the three colour components of the
2712
colour &quot;name&quot; from the current document, converted to the RGB colour
2713
space. If no document is open, returns the value of the named colour
2714
from the default document colours.
9498 cbradney 2715
 
12456 jghali 2716
May raise NotFoundError if the named colour wasn&apos;t found.
2717
May raise ValueError if an invalid colour name is specified.
9498 cbradney 2718
</translation>
2719
    </message>
2720
    <message>
12456 jghali 2721
        <source>getColorNames() -&gt; list
9498 cbradney 2722
 
12456 jghali 2723
Returns a list containing the names of all defined colors in the document.
2724
If no document is open, returns a list of the default document colors.
9498 cbradney 2725
</source>
12918 cbradney 2726
        <translation type="obsolete">
12456 jghali 2727
      getColorNames() -&gt; list
9498 cbradney 2728
 
12456 jghali 2729
      傳回檔案中所有已定義顏色名稱的列表
2730
 
2731
      </translation>
9498 cbradney 2732
    </message>
2733
    <message>
12456 jghali 2734
        <source>getColumnGap([&quot;name&quot;]) -&gt; float
9498 cbradney 2735
 
12456 jghali 2736
Returns the column gap size of the text frame &quot;name&quot; expressed in points. If
2737
&quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2738
</source>
12918 cbradney 2739
        <translation type="obsolete">getColumnGap([&quot;name&quot;]) -&gt; float
9498 cbradney 2740
 
12456 jghali 2741
Returns the column gap size of the text frame &quot;name&quot; expressed in points. If
2742
&quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2743
</translation>
2744
    </message>
2745
    <message>
12456 jghali 2746
        <source>getColumns([&quot;name&quot;]) -&gt; integer
9498 cbradney 2747
 
12456 jghali 2748
Gets the number of columns of the text frame &quot;name&quot;. If &quot;name&quot; is not
2749
given the currently selected item is used.
9498 cbradney 2750
</source>
12918 cbradney 2751
        <translation type="obsolete">getColumns([&quot;name&quot;]) -&gt; integer
9498 cbradney 2752
 
12456 jghali 2753
Gets the number of columns of the text frame &quot;name&quot;. If &quot;name&quot; is not
2754
given the currently selected item is used.
9498 cbradney 2755
</translation>
2756
    </message>
2757
    <message>
12456 jghali 2758
        <source>getCornerRadius([&quot;name&quot;]) -&gt; integer
9498 cbradney 2759
 
12456 jghali 2760
Returns the corner radius of the object &quot;name&quot;. The radius isexpressed in points. If &quot;name&quot; is not given the currentlyselected item is used.
9498 cbradney 2761
</source>
12456 jghali 2762
        <translation type="obsolete">getCornerRadius([&quot;name&quot;]) -&gt; integer
9498 cbradney 2763
 
12456 jghali 2764
Returns the corner radius of the object &quot;name&quot;. The radius isexpressed in points. If &quot;name&quot; is not given the currentlyselected item is used.
9498 cbradney 2765
</translation>
2766
    </message>
2767
    <message>
12456 jghali 2768
        <source>getFillShade([&quot;name&quot;]) -&gt; integer
9498 cbradney 2769
 
12456 jghali 2770
Returns the shading value of the fill color of the object &quot;name&quot;.
2771
If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2772
</source>
12918 cbradney 2773
        <translation type="obsolete">getFillShade([&quot;name&quot;]) -&gt; integer
9498 cbradney 2774
 
12456 jghali 2775
Returns the shading value of the fill colour of the object &quot;name&quot;.
2776
If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2777
</translation>
2778
    </message>
2779
    <message>
12456 jghali 2780
        <source>getFont([&quot;name&quot;]) -&gt; string
9498 cbradney 2781
 
12456 jghali 2782
Returns the font name for the text frame &quot;name&quot;. If this text frame
2783
has some text selected the value assigned to the first character
2784
of the selection is returned. If &quot;name&quot; is not given the currently
2785
selected item is used.
9498 cbradney 2786
</source>
12918 cbradney 2787
        <translation type="obsolete">getFont([&quot;name&quot;]) -&gt; string
9498 cbradney 2788
 
12456 jghali 2789
Returns the font name for the text frame &quot;name&quot;. If this text frame
2790
has some text selected the value assigned to the first character
2791
of the selection is returned. If &quot;name&quot; is not given the currently
2792
selected item is used.
9498 cbradney 2793
</translation>
2794
    </message>
2795
    <message>
12456 jghali 2796
        <source>getFontNames() -&gt; list
9498 cbradney 2797
 
12456 jghali 2798
Returns a list with the names of all available fonts.
9498 cbradney 2799
</source>
12918 cbradney 2800
        <translation type="obsolete">getFontNames() -&gt; list
9498 cbradney 2801
 
12456 jghali 2802
Returns a list with the names of all available fonts.
9498 cbradney 2803
</translation>
2804
    </message>
2805
    <message>
12456 jghali 2806
        <source>getGuiLanguage() -&gt; string
9498 cbradney 2807
 
12456 jghali 2808
Returns a string with the -lang value.
9498 cbradney 2809
</source>
12918 cbradney 2810
        <translation type="obsolete">getGuiLanguage() -&gt; string
9498 cbradney 2811
 
12456 jghali 2812
Returns a string with the -lang value.
9498 cbradney 2813
</translation>
2814
    </message>
2815
    <message>
12456 jghali 2816
        <source>getHGuides() -&gt; list
9498 cbradney 2817
 
12456 jghali 2818
Returns a list containing positions of the horizontal guides. Values are in the
2819
document&apos;s current units - see UNIT_&lt;type&gt; constants.
9498 cbradney 2820
</source>
12918 cbradney 2821
        <translation type="obsolete">getHGuides() -&gt; list
9498 cbradney 2822
 
12456 jghali 2823
Returns a list containing positions of the horizontal guides. Values are in the
2824
document&apos;s current units - see UNIT_&lt;type&gt; constants.
9498 cbradney 2825
</translation>
2826
    </message>
2827
    <message>
12456 jghali 2828
        <source>getImageName([&quot;name&quot;]) -&gt; string
9498 cbradney 2829
 
12456 jghali 2830
Returns the filename for the image in the image frame. If &quot;name&quot; is not
2831
given the currently selected item is used.
9498 cbradney 2832
</source>
12918 cbradney 2833
        <translation type="obsolete">getImageName([&quot;name&quot;]) -&gt; string
9498 cbradney 2834
 
12456 jghali 2835
Returns the filename for the image in the image frame. If &quot;name&quot; is not
2836
given the currently selected item is used.
9498 cbradney 2837
</translation>
2838
    </message>
2839
    <message>
12456 jghali 2840
        <source>getImageScale([&quot;name&quot;]) -&gt; (x,y)
9498 cbradney 2841
 
12456 jghali 2842
Returns a (x, y) tuple containing the scaling values of the image frame
2843
&quot;name&quot;.  If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2844
</source>
12918 cbradney 2845
        <translation type="obsolete">getImageScale([&quot;name&quot;]) -&gt; (x,y)
9498 cbradney 2846
 
12456 jghali 2847
Returns a (x, y) tuple containing the scaling values of the image frame
2848
&quot;name&quot;.  If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2849
</translation>
2850
    </message>
2851
    <message>
12456 jghali 2852
        <source>getLayers() -&gt; list
9498 cbradney 2853
 
12456 jghali 2854
Returns a list with the names of all defined layers.
9498 cbradney 2855
</source>
12918 cbradney 2856
        <translation type="obsolete">getLayers() -&gt; list
9498 cbradney 2857
 
12456 jghali 2858
Returns a list with the names of all defined layers.
9498 cbradney 2859
</translation>
2860
    </message>
2861
    <message>
12456 jghali 2862
        <source>getLineColor([&quot;name&quot;]) -&gt; string
9498 cbradney 2863
 
12456 jghali 2864
Returns the name of the line color of the object &quot;name&quot;.
2865
If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2866
</source>
12918 cbradney 2867
        <translation type="obsolete">getLineColor([&quot;name&quot;]) -&gt; string
9498 cbradney 2868
 
12456 jghali 2869
Returns the name of the line colour of the object &quot;name&quot;.
2870
If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2871
</translation>
2872
    </message>
2873
    <message>
12456 jghali 2874
        <source>getLineEnd([&quot;name&quot;]) -&gt; integer (see constants)
9498 cbradney 2875
 
12456 jghali 2876
Returns the line cap style of the object &quot;name&quot;. If &quot;name&quot; is not given the
2877
currently selected item is used. The cap types are:
2878
CAP_FLAT, CAP_ROUND, CAP_SQUARE
9498 cbradney 2879
</source>
12918 cbradney 2880
        <translation type="obsolete">getLineEnd([&quot;name&quot;]) -&gt; integer (see constants)
9498 cbradney 2881
 
12456 jghali 2882
Returns the line cap style of the object &quot;name&quot;. If &quot;name&quot; is not given the
2883
currently selected item is used. The cap types are:
2884
CAP_FLAT, CAP_ROUND, CAP_SQUARE
9498 cbradney 2885
</translation>
2886
    </message>
2887
    <message>
12456 jghali 2888
        <source>getLineJoin([&quot;name&quot;]) -&gt; integer (see contants)
9498 cbradney 2889
 
12456 jghali 2890
Returns the line join style of the object &quot;name&quot;. If &quot;name&quot; is not given
2891
the currently selected item is used.  The join types are:
2892
JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND
9498 cbradney 2893
</source>
12456 jghali 2894
        <translation type="obsolete">getLineJoin([&quot;name&quot;]) -&gt; integer (see contants)
9498 cbradney 2895
 
12456 jghali 2896
Returns the line join style of the object &quot;name&quot;. If &quot;name&quot; is not given
2897
the currently selected item is used.  The join types are:
2898
JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND
9498 cbradney 2899
</translation>
2900
    </message>
2901
    <message>
12456 jghali 2902
        <source>getLineShade([&quot;name&quot;]) -&gt; integer
9498 cbradney 2903
 
12456 jghali 2904
Returns the shading value of the line color of the object &quot;name&quot;.
2905
If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2906
</source>
12918 cbradney 2907
        <translation type="obsolete">getLineShade([&quot;name&quot;]) -&gt; integer
9498 cbradney 2908
 
12456 jghali 2909
Returns the shading value of the line colour of the object &quot;name&quot;.
2910
If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2911
</translation>
2912
    </message>
2913
    <message>
12456 jghali 2914
        <source>getLineSpacing([&quot;name&quot;]) -&gt; float
9498 cbradney 2915
 
12456 jghali 2916
Returns the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; expressed in
2917
points. If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2918
</source>
12918 cbradney 2919
        <translation type="obsolete">getLineSpacing([&quot;name&quot;]) -&gt; float
9498 cbradney 2920
 
12456 jghali 2921
Returns the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; expressed in
2922
points. If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 2923
</translation>
2924
    </message>
2925
    <message>
12456 jghali 2926
        <source>getLineStyle([&quot;name&quot;]) -&gt; integer (see constants)
9498 cbradney 2927
 
12456 jghali 2928
Returns the line style of the object &quot;name&quot;. If &quot;name&quot; is not given the
2929
currently selected item is used. Line style constants are:
2930
LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID
9498 cbradney 2931
</source>
12918 cbradney 2932
        <translation type="obsolete">getLineStyle([&quot;name&quot;]) -&gt; integer (see constants)
9498 cbradney 2933
 
12456 jghali 2934
Returns the line style of the object &quot;name&quot;. If &quot;name&quot; is not given the
2935
currently selected item is used. Line style constants are:
2936
LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID
9498 cbradney 2937
</translation>
2938
    </message>
2939
    <message>
12456 jghali 2940
        <source>getLineWidth([&quot;name&quot;]) -&gt; integer
9498 cbradney 2941
 
12456 jghali 2942
Returns the line width of the object &quot;name&quot;. If &quot;name&quot;
2943
is not given the currently selected Item is used.
9498 cbradney 2944
</source>
12918 cbradney 2945
        <translation type="obsolete">getLineWidth([&quot;name&quot;]) -&gt; integer
9498 cbradney 2946
 
12456 jghali 2947
Returns the line width of the object &quot;name&quot;. If &quot;name&quot;
2948
is not given the currently selected Item is used.
9498 cbradney 2949
</translation>
2950
    </message>
2951
    <message>
2952
        <source>getPageItems() -&gt; list
2953
 
2954
Returns a list of tuples with items on the current page. The tuple is:
2955
(name, objectType, order) E.g. [(&apos;Text1&apos;, 4, 0), (&apos;Image1&apos;, 2, 1)]
2956
means that object named &apos;Text1&apos; is a text frame (type 4) and is the first at
2957
the page...
2958
</source>
12918 cbradney 2959
        <translation type="obsolete">getPageItems() -&gt; list
9498 cbradney 2960
 
2961
Returns a list of tuples with items on the current page. The tuple is:
2962
(name, objectType, order) E.g. [(&apos;Text1&apos;, 4, 0), (&apos;Image1&apos;, 2, 1)]
2963
means that object named &apos;Text1&apos; is a text frame (type 4) and is the first at
2964
the page...
2965
</translation>
2966
    </message>
2967
    <message>
2968
        <source>getPageMargins()
2969
 
2970
Returns the page margins as a (top, left, right, bottom) tuple in the current
2971
units. See UNIT_&lt;type&gt; constants and getPageSize().
2972
</source>
12918 cbradney 2973
        <translation type="obsolete">getPageMargins()
9498 cbradney 2974
 
2975
Returns the page margins as a (top, left, right, bottom) tuple in the current
2976
units. See UNIT_&lt;type&gt; constants and getPageSize().
2977
</translation>
2978
    </message>
2979
    <message>
12456 jghali 2980
        <source>getPageSize() -&gt; tuple
9498 cbradney 2981
 
12456 jghali 2982
Returns a tuple with page dimensions measured in the document&apos;s current units.
2983
See UNIT_&lt;type&gt; constants and getPageMargins()
9498 cbradney 2984
</source>
12918 cbradney 2985
        <translation type="obsolete">getPageSize() -&gt; tuple
9498 cbradney 2986
 
12456 jghali 2987
Returns a tuple with page dimensions measured in the document&apos;s current units.
2988
See UNIT_&lt;type&gt; constants and getPageMargins()
9498 cbradney 2989
</translation>
2990
    </message>
2991
    <message>
12456 jghali 2992
        <source>getPosition([&quot;name&quot;]) -&gt; (x,y)
9498 cbradney 2993
 
12456 jghali 2994
Returns a (x, y) tuple with the position of the object &quot;name&quot;.
2995
If &quot;name&quot; is not given the currently selected item is used.The position is expressed in the actual measurement unit of the document
2996
- see UNIT_&lt;type&gt; for reference.
9498 cbradney 2997
</source>
12456 jghali 2998
        <translation type="obsolete">getPosition([&quot;name&quot;]) -&gt; (x,y)
9498 cbradney 2999
 
12456 jghali 3000
Returns a (x, y) tuple with the position of the object &quot;name&quot;.
3001
If &quot;name&quot; is not given the currently selected item is used.The position is expressed in the actual measurement unit of the document
3002
- see UNIT_&lt;type&gt; for reference.
9498 cbradney 3003
</translation>
3004
    </message>
3005
    <message>
12456 jghali 3006
        <source>getProperty(object, property)
9498 cbradney 3007
 
12456 jghali 3008
Return the value of the property `property&apos; of the passed `object&apos;.
9498 cbradney 3009
 
12456 jghali 3010
The `object&apos; argument may be a string, in which case the named PageItem
3011
is searched for. It may also be a PyCObject, which may point to any
3012
C++ QObject instance.
3013
 
3014
The `property&apos; argument must be a string, and is the name of the property
3015
to look up on `object&apos;.
3016
 
3017
The return value varies depending on the type of the property.
9498 cbradney 3018
</source>
12918 cbradney 3019
        <translation type="obsolete">getProperty(object, property)
9498 cbradney 3020
 
12456 jghali 3021
Return the value of the property `property&apos; of the passed `object&apos;.
9498 cbradney 3022
 
12456 jghali 3023
The `object&apos; argument may be a string, in which case the named PageItem
3024
is searched for. It may also be a PyCObject, which may point to any
3025
C++ QObject instance.
9498 cbradney 3026
 
12456 jghali 3027
The `property&apos; argument must be a string, and is the name of the property
3028
to look up on `object&apos;.
9498 cbradney 3029
 
12456 jghali 3030
The return value varies depending on the type of the property.
9498 cbradney 3031
</translation>
3032
    </message>
3033
    <message>
12456 jghali 3034
        <source>getPropertyCType(object, property, includesuper=True)
9498 cbradney 3035
 
12456 jghali 3036
Returns the name of the C type of `property&apos; of `object&apos;. See getProperty()
3037
for details of arguments.
3038
 
3039
If `includesuper&apos; is true, search inherited properties too.
9498 cbradney 3040
</source>
12918 cbradney 3041
        <translation type="obsolete">getPropertyCType(object, property, includesuper=True)
9498 cbradney 3042
 
12456 jghali 3043
Returns the name of the C type of `property&apos; of `object&apos;. See getProperty()
3044
for details of arguments.
3045
 
3046
If `includesuper&apos; is true, search inherited properties too.
9498 cbradney 3047
</translation>
3048
    </message>
3049
    <message>
12456 jghali 3050
        <source>getPropertyNames(object, includesuper=True)
9498 cbradney 3051
 
12456 jghali 3052
Return a list of property names supported by `object&apos;.
3053
If `includesuper&apos; is true, return properties supported
3054
by parent classes as well.
9498 cbradney 3055
</source>
12918 cbradney 3056
        <translation type="obsolete">getPropertyNames(object, includesuper=True)
9498 cbradney 3057
 
12456 jghali 3058
Return a list of property names supported by `object&apos;.
3059
If `includesuper&apos; is true, return properties supported
3060
by parent classes as well.
9498 cbradney 3061
</translation>
3062
    </message>
3063
    <message>
12456 jghali 3064
        <source>getRotation([&quot;name&quot;]) -&gt; integer
9498 cbradney 3065
 
12456 jghali 3066
Returns the rotation of the object &quot;name&quot;. The value is expressed in degrees,
3067
and clockwise is positive. If &quot;name&quot; is not given the currently selected item
3068
is used.
9498 cbradney 3069
</source>
12918 cbradney 3070
        <translation type="obsolete">getRotation([&quot;name&quot;]) -&gt; integer
9498 cbradney 3071
 
12456 jghali 3072
Returns the rotation of the object &quot;name&quot;. The value is expressed in degrees,
3073
and clockwise is positive. If &quot;name&quot; is not given the currently selected item
3074
is used.
9498 cbradney 3075
</translation>
3076
    </message>
3077
    <message>
12456 jghali 3078
        <source>getSelectedObject([nr]) -&gt; string
9498 cbradney 3079
 
12456 jghali 3080
Returns the name of the selected object. &quot;nr&quot; if given indicates the number
3081
of the selected object, e.g. 0 means the first selected object, 1 means the
3082
second selected Object and so on.
9498 cbradney 3083
</source>
12918 cbradney 3084
        <translation type="obsolete">getSelectedObject([nr]) -&gt; string
9498 cbradney 3085
 
12456 jghali 3086
Returns the name of the selected object. &quot;nr&quot; if given indicates the number
3087
of the selected object, e.g. 0 means the first selected object, 1 means the
3088
second selected Object and so on.
9498 cbradney 3089
</translation>
3090
    </message>
3091
    <message>
12456 jghali 3092
        <source>getSize([&quot;name&quot;]) -&gt; (width,height)
9498 cbradney 3093
 
12456 jghali 3094
Returns a (width, height) tuple with the size of the object &quot;name&quot;.
3095
If &quot;name&quot; is not given the currently selected item is used. The size is
3096
expressed in the current measurement unit of the document - see UNIT_&lt;type&gt;
3097
for reference.
9498 cbradney 3098
</source>
12918 cbradney 3099
        <translation type="obsolete">getSize([&quot;name&quot;]) -&gt; (width,height)
9498 cbradney 3100
 
12456 jghali 3101
Returns a (width, height) tuple with the size of the object &quot;name&quot;.
3102
If &quot;name&quot; is not given the currently selected item is used. The size is
3103
expressed in the current measurement unit of the document - see UNIT_&lt;type&gt;
3104
for reference.
9498 cbradney 3105
</translation>
3106
    </message>
3107
    <message>
12456 jghali 3108
        <source>getText([&quot;name&quot;]) -&gt; string
9498 cbradney 3109
 
12456 jghali 3110
Returns the text of the text frame &quot;name&quot;. If this text frame has some text
3111
selected, the selected text is returned. All text in the frame, not just
3112
currently visible text, is returned. If &quot;name&quot; is not given the currently
9498 cbradney 3113
selected item is used.
3114
</source>
12918 cbradney 3115
        <translation type="obsolete">getText([&quot;name&quot;]) -&gt; string
9498 cbradney 3116
 
12456 jghali 3117
Returns the text of the text frame &quot;name&quot;. If this text frame has some text
3118
selected, the selected text is returned. All text in the frame, not just
3119
currently visible text, is returned. If &quot;name&quot; is not given the currently
9498 cbradney 3120
selected item is used.
3121
</translation>
3122
    </message>
3123
    <message>
3124
        <source>getTextLength([&quot;name&quot;]) -&gt; integer
3125
 
3126
Returns the length of the text in the text frame &quot;name&quot;.
3127
If &quot;name&quot; is not given the currently selected item is used.
3128
</source>
12918 cbradney 3129
        <translation type="obsolete">getTextLength([&quot;name&quot;]) -&gt; integer
9498 cbradney 3130
 
3131
Returns the length of the text in the text frame &quot;name&quot;.
3132
If &quot;name&quot; is not given the currently selected item is used.
3133
</translation>
3134
    </message>
3135
    <message>
12456 jghali 3136
        <source>getUnit() -&gt; integer (Scribus unit constant)
9498 cbradney 3137
 
12456 jghali 3138
Returns the measurement units of the document. The returned value will be one
3139
of the UNIT_* constants:
3140
UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.
3141
</source>
12918 cbradney 3142
        <translation type="obsolete">getUnit() -&gt; integer (Scribus unit constant)
12456 jghali 3143
 
3144
Returns the measurement units of the document. The returned value will be one
3145
of the UNIT_* constants:
3146
UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.
9498 cbradney 3147
</translation>
3148
    </message>
3149
    <message>
12456 jghali 3150
        <source>getVGuides()
9498 cbradney 3151
 
12456 jghali 3152
See getHGuides.
9498 cbradney 3153
</source>
12918 cbradney 3154
        <translation type="obsolete">getVGuides()
9498 cbradney 3155
 
12456 jghali 3156
See getHGuides.
9498 cbradney 3157
</translation>
3158
    </message>
3159
    <message>
12456 jghali 3160
        <source>getXFontNames() -&gt; list of tuples
9498 cbradney 3161
 
12456 jghali 3162
Returns a larger font info. It&apos;s a list of the tuples with:
3163
[ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ]
9498 cbradney 3164
</source>
12918 cbradney 3165
        <translation type="obsolete">getXFontNames() -&gt; list of tuples
9498 cbradney 3166
 
12456 jghali 3167
Returns a larger font info. It&apos;s a list of the tuples with:
3168
[ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ]
9498 cbradney 3169
</translation>
3170
    </message>
3171
    <message>
12456 jghali 3172
        <source>gotoPage(nr)
9498 cbradney 3173
 
12456 jghali 3174
Moves to the page &quot;nr&quot; (that is, makes the current page &quot;nr&quot;). Note that
3175
gotoPage doesn&apos;t (curently) change the page the user&apos;s view is displaying, it
3176
just sets the page that script commands will operates on.
3177
 
3178
May raise IndexError if the page number is out of range.
9498 cbradney 3179
</source>
12456 jghali 3180
        <translation type="obsolete">gotoPage(nr)
9498 cbradney 3181
 
12456 jghali 3182
Moves to the page &quot;nr&quot; (that is, makes the current page &quot;nr&quot;). Note that
3183
gotoPage doesn&apos;t (curently) change the page the user&apos;s view is displaying, it
3184
just sets the page that script commands will operates on.
3185
 
3186
May raise IndexError if the page number is out of range.
9498 cbradney 3187
</translation>
3188
    </message>
3189
    <message>
12456 jghali 3190
        <source>groupObjects(list)
9498 cbradney 3191
 
12456 jghali 3192
Groups the objects named in &quot;list&quot; together. &quot;list&quot; must contain the names
3193
of the objects to be grouped. If &quot;list&quot; is not given the currently selected
3194
items are used.
3195
</source>
12918 cbradney 3196
        <translation type="obsolete">groupObjects(list)
12456 jghali 3197
 
3198
Groups the objects named in &quot;list&quot; together. &quot;list&quot; must contain the names
3199
of the objects to be grouped. If &quot;list&quot; is not given the currently selected
3200
items are used.
9498 cbradney 3201
</translation>
3202
    </message>
3203
    <message>
12456 jghali 3204
        <source>haveDoc() -&gt; bool
9498 cbradney 3205
 
12456 jghali 3206
Returns true if there is a document open.
9498 cbradney 3207
</source>
12918 cbradney 3208
        <translation type="obsolete">haveDoc() -&gt; bool
9498 cbradney 3209
 
12456 jghali 3210
Returns true if there is a document open.
9498 cbradney 3211
</translation>
3212
    </message>
3213
    <message>
3214
        <source>insertText(&quot;text&quot;, pos, [&quot;name&quot;])
3215
 
3216
Inserts the text &quot;text&quot; at the position &quot;pos&quot; into the text frame &quot;name&quot;.
3217
Text must be UTF encoded (see setText() as reference) The first character has an
3218
index of 0. Inserting at position -1 appends text to the frame. If &quot;name&quot; is
3219
not given the currently selected Item is used.
3220
 
3221
May throw IndexError for an insertion out of bounds.
3222
</source>
11652 cbradney 3223
        <translation type="obsolete">insertText(&quot;text&quot;, pos, [&quot;name&quot;])
9498 cbradney 3224
 
3225
Inserts the text &quot;text&quot; at the position &quot;pos&quot; into the text frame &quot;name&quot;.
3226
Text must be UTF encoded (see setText() as reference) The first character has an
3227
index of 0. Inserting at position -1 appends text to the frame. If &quot;name&quot; is
3228
not given the currently selected Item is used.
3229
 
3230
May throw IndexError for an insertion out of bounds.
3231
</translation>
3232
    </message>
3233
    <message>
12456 jghali 3234
        <source>isLayerPrintable(&quot;layer&quot;) -&gt; bool
9498 cbradney 3235
 
12456 jghali 3236
Returns whether the layer &quot;layer&quot; is printable or not, a value of True means
3237
that the layer &quot;layer&quot; can be printed, a value of False means that printing
3238
the layer &quot;layer&quot; is disabled.
9498 cbradney 3239
 
12456 jghali 3240
May raise NotFoundError if the layer can&apos;t be found.
3241
May raise ValueError if the layer name isn&apos;t acceptable.
9498 cbradney 3242
</source>
12918 cbradney 3243
        <translation type="obsolete">isLayerPrintable(&quot;layer&quot;) -&gt; bool
9498 cbradney 3244
 
12456 jghali 3245
Returns whether the layer &quot;layer&quot; is printable or not, a value of True means
3246
that the layer &quot;layer&quot; can be printed, a value of False means that printing
3247
the layer &quot;layer&quot; is disabled.
9498 cbradney 3248
 
12456 jghali 3249
May raise NotFoundError if the layer can&apos;t be found.
3250
May raise ValueError if the layer name isn&apos;t acceptable.
9498 cbradney 3251
</translation>
3252
    </message>
3253
    <message>
12456 jghali 3254
        <source>isLayerPrintable(&quot;layer&quot;) -&gt; bool
9498 cbradney 3255
 
12456 jghali 3256
Returns whether the layer &quot;layer&quot; is visible or not, a value of True means
3257
that the layer &quot;layer&quot; is visible, a value of False means that the layer
3258
&quot;layer&quot; is invisible.
9498 cbradney 3259
 
12456 jghali 3260
May raise NotFoundError if the layer can&apos;t be found.
3261
May raise ValueError if the layer name isn&apos;t acceptable.
9498 cbradney 3262
</source>
12456 jghali 3263
        <translation type="obsolete">isLayerPrintable(&quot;layer&quot;) -&gt; bool
9498 cbradney 3264
 
12456 jghali 3265
Returns whether the layer &quot;layer&quot; is visible or not, a value of True means
3266
that the layer &quot;layer&quot; is visible, a value of False means that the layer
3267
&quot;layer&quot; is invisible.
9498 cbradney 3268
 
12456 jghali 3269
May raise NotFoundError if the layer can&apos;t be found.
3270
May raise ValueError if the layer name isn&apos;t acceptable.
9498 cbradney 3271
</translation>
3272
    </message>
3273
    <message>
12456 jghali 3274
        <source>isLocked([&quot;name&quot;]) -&gt; bool
9498 cbradney 3275
 
12456 jghali 3276
Returns true if is the object &quot;name&quot; locked.  If &quot;name&quot; is not given the
3277
currently selected item is used.
9498 cbradney 3278
</source>
12918 cbradney 3279
        <translation type="obsolete">isLocked([&quot;name&quot;]) -&gt; bool
9498 cbradney 3280
 
12456 jghali 3281
Returns true if is the object &quot;name&quot; locked.  If &quot;name&quot; is not given the
3282
currently selected item is used.
9498 cbradney 3283
</translation>
3284
    </message>
3285
    <message>
12456 jghali 3286
        <source>isPDFBookmark([&quot;name&quot;]) -&gt; bool
9498 cbradney 3287
 
12456 jghali 3288
Returns true if the text frame &quot;name&quot; is a PDF bookmark.
3289
If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 3290
 
12456 jghali 3291
May raise WrongFrameTypeError if the target frame is not a text frame
9498 cbradney 3292
</source>
12918 cbradney 3293
        <translation type="obsolete">isPDFBookmark([&quot;name&quot;]) -&gt; bool
9498 cbradney 3294
 
12456 jghali 3295
Returns true if the text frame &quot;name&quot; is a PDF bookmark.
3296
If &quot;name&quot; is not given the currently selected item is used.
9498 cbradney 3297
 
12456 jghali 3298
May raise WrongFrameTypeError if the target frame is not a text frame
9498 cbradney 3299
</translation>
3300
    </message>
3301
    <message>
3302
        <source>linkTextFrames(&quot;fromname&quot;, &quot;toname&quot;)
3303
 
3304
Link two text frames. The frame named &quot;fromname&quot; is linked to the
3305
frame named &quot;toname&quot;. The target frame must be an empty text frame
3306
and must not link to or be linked from any other frames already.
3307
 
3308
May throw ScribusException if linking rules are violated.
3309
</source>
12918 cbradney 3310
        <translation type="obsolete">linkTextFrames(&quot;fromname&quot;, &quot;toname&quot;)
9498 cbradney 3311
 
3312
Link two text frames. The frame named &quot;fromname&quot; is linked to the
3313
frame named &quot;toname&quot;. The target frame must be an empty text frame
3314
and must not link to or be linked from any other frames already.
3315
 
3316
May throw ScribusException if linking rules are violated.
3317
</translation>
3318
    </message>
3319
    <message>
12456 jghali 3320
        <source>loadImage(&quot;filename&quot; [, &quot;name&quot;])
9498 cbradney 3321
 
12456 jghali 3322
Loads the picture &quot;picture&quot; into the image frame &quot;name&quot;. If &quot;name&quot; is
3323
not given the currently selected item is used.
9498 cbradney 3324
 
12456 jghali 3325
May raise WrongFrameTypeError if the target frame is not an image frame
9498 cbradney 3326
</source>
12918 cbradney 3327
        <translation type="obsolete">loadImage(&quot;filename&quot; [, &quot;name&quot;])
9498 cbradney 3328
 
12456 jghali 3329
Loads the picture &quot;picture&quot; into the image frame &quot;name&quot;. If &quot;name&quot; is
3330
not given the currently selected item is used.
9498 cbradney 3331
 
12456 jghali 3332
May raise WrongFrameTypeError if the target frame is not an image frame
9498 cbradney 3333
</translation>
3334
    </message>
3335
    <message>
12456 jghali 3336
        <source>loadStylesFromFile(&quot;filename&quot;)
9498 cbradney 3337
 
12456 jghali 3338
Loads paragraph styles from the Scribus document at &quot;filename&quot; into the
3339
current document.
9498 cbradney 3340
</source>
12918 cbradney 3341
        <translation type="obsolete">loadStylesFromFile(&quot;filename&quot;)
9498 cbradney 3342
 
12456 jghali 3343
Loads paragraph styles from the Scribus document at &quot;filename&quot; into the
3344
current document.
9498 cbradney 3345
</translation>
3346
    </message>
3347
    <message>
12456 jghali 3348
        <source>lockObject([&quot;name&quot;]) -&gt; bool
9498 cbradney 3349
 
12456 jghali 3350
Locks the object &quot;name&quot; if it&apos;s unlocked or unlock it if it&apos;s locked.
3351
If &quot;name&quot; is not given the currently selected item is used. Returns true
3352
if locked.
9498 cbradney 3353
</source>
12918 cbradney 3354
        <translation type="obsolete">lockObject([&quot;name&quot;]) -&gt; bool
9498 cbradney 3355
 
12456 jghali 3356
Locks the object &quot;name&quot; if it&apos;s unlocked or unlock it if it&apos;s locked.
3357
If &quot;name&quot; is not given the currently selected item is used. Returns true
3358
if locked.
9498 cbradney 3359
</translation>
3360
    </message>
3361
    <message>
12456 jghali 3362
        <source>masterPageNames()
9498 cbradney 3363
 
12456 jghali 3364
Returns a list of the names of all master pages in the document.
9498 cbradney 3365
</source>
12918 cbradney 3366
        <translation type="obsolete">masterPageNames()
9498 cbradney 3367
 
12456 jghali 3368
Returns a list of the names of all master pages in the document.
9498 cbradney 3369
</translation>
3370
    </message>
3371
    <message>
12456 jghali 3372
        <source>messageBox(&quot;caption&quot;, &quot;message&quot;,
3373
    icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT,
3374
    button2=BUTTON_NONE, button3=BUTTON_NONE) -&gt; integer
9498 cbradney 3375
 
12456 jghali 3376
Displays a message box with the title &quot;caption&quot;, the message &quot;message&quot;, and
3377
an icon &quot;icon&quot; and up to 3 buttons. By default no icon is used and a single
3378
button, OK, is displayed. Only the caption and message arguments are required,
3379
though setting an icon and appropriate button(s) is strongly
3380
recommended. The message text may contain simple HTML-like markup.
3381
 
3382
Returns the number of the button the user pressed. Button numbers start
3383
at 1.
3384
 
3385
For the icon and the button parameters there are predefined constants available
3386
with the same names as in the Qt Documentation. These are the BUTTON_* and
3387
ICON_* constants defined in the module. There are also two extra constants that
3388
can be binary-ORed with button constants:
3389
    BUTTONOPT_DEFAULT   Pressing enter presses this button.
3390
    BUTTONOPT_ESCAPE    Pressing escape presses this button.
3391
 
3392
Usage examples:
3393
result = messageBox(&apos;Script failed&apos;,
3394
                    &apos;This script only works when you have a text frame selected.&apos;,
3395
                    ICON_ERROR)
3396
result = messageBox(&apos;Monkeys!&apos;, &apos;Something went ook! &lt;i&gt;Was it a monkey?&lt;/i&gt;&apos;,
3397
                    ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
3398
                    BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)
3399
 
3400
Defined button and icon constants:
3401
BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO,
3402
BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL,
3403
ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.
9498 cbradney 3404
</source>
12918 cbradney 3405
        <translation type="obsolete">messageBox(&quot;caption&quot;, &quot;message&quot;,
12456 jghali 3406
    icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT,
3407
    button2=BUTTON_NONE, button3=BUTTON_NONE) -&gt; integer
9498 cbradney 3408
 
12456 jghali 3409
Displays a message box with the title &quot;caption&quot;, the message &quot;message&quot;, and
3410
an icon &quot;icon&quot; and up to 3 buttons. By default no icon is used and a single
3411
button, OK, is displayed. Only the caption and message arguments are required,
3412
though setting an icon and appropriate button(s) is strongly
3413
recommended. The message text may contain simple HTML-like markup.
3414
 
3415
Returns the number of the button the user pressed. Button numbers start
3416
at 1.
3417
 
3418
For the icon and the button parameters there are predefined constants available
3419
with the same names as in the Qt Documentation. These are the BUTTON_* and
3420
ICON_* constants defined in the module. There are also two extra constants that
3421
can be binary-ORed with button constants:
3422
    BUTTONOPT_DEFAULT   Pressing enter presses this button.
3423
    BUTTONOPT_ESCAPE    Pressing escape presses this button.
3424
 
3425
Usage examples:
3426
result = messageBox(&apos;Script failed&apos;,
3427
                    &apos;This script only works when you have a text frame selected.&apos;,
3428
                    ICON_ERROR)
3429
result = messageBox(&apos;Monkeys!&apos;, &apos;Something went ook! &lt;i&gt;Was it a monkey?&lt;/i&gt;&apos;,
3430
                    ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
3431
                    BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)
3432
 
3433
Defined button and icon constants:
3434
BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO,
3435
BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL,
3436
ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.
9498 cbradney 3437
</translation>
3438
    </message>
3439
    <message>
12456 jghali 3440
        <source>moveObjectAbs(x, y [, &quot;name&quot;])
9498 cbradney 3441
 
12456 jghali 3442
Moves the object &quot;name&quot; to a new location. The coordinates are expressed in
3443
the current measurement unit of the document (see UNIT constants).  If &quot;name&quot;
3444
is not given the currently selected item is used.  If the object &quot;name&quot;
3445
belongs to a group, the whole group is moved.
9498 cbradney 3446
</source>
12918 cbradney 3447
        <translation type="obsolete">moveObjectAbs(x, y [, &quot;name&quot;])
9498 cbradney 3448
 
12456 jghali 3449
Moves the object &quot;name&quot; to a new location. The coordinates are expressed in
3450
the current measurement unit of the document (see UNIT constants).  If &quot;name&quot;
3451
is not given the currently selected item is used.  If the object &quot;name&quot;
3452
belongs to a group, the whole group is moved.
9498 cbradney 3453
</translation>
3454
    </message>
3455
    <message>
3456
        <source>newDoc(size, margins, orientation, firstPageNumber,
3457
                   unit, facingPages, firstSideLeft) -&gt; bool
3458
 
3459
WARNING: Obsolete procedure! Use newDocument instead.
3460
 
3461
Creates a new document and returns true if successful. The parameters have the
3462
following meaning:
3463
 
3464
    size = A tuple (width, height) describing the size of the document. You can
3465
    use predefined constants named PAPER_&lt;paper_type&gt; e.g. PAPER_A4 etc.
3466
 
3467
    margins = A tuple (left, right, top, bottom) describing the document
3468
    margins
3469
 
3470
    orientation = the page orientation - constants PORTRAIT, LANDSCAPE
3471
 
3472
    firstPageNumer = is the number of the first page in the document used for
3473
    pagenumbering. While you&apos;ll usually want 1, it&apos;s useful to have higher
3474
    numbers if you&apos;re creating a document in several parts.
3475
 
3476
    unit: this value sets the measurement units used by the document. Use a
3477
    predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS,
3478
    UNIT_PICAS, UNIT_POINTS.
3479
 
3480
    facingPages = FACINGPAGES, NOFACINGPAGES
3481
 
3482
    firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT
3483
 
3484
The values for width, height and the margins are expressed in the given unit
3485
for the document. PAPER_* constants are expressed in points. If your document
3486
is not in points, make sure to account for this.
3487
 
3488
example: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS,
3489
                FACINGPAGES, FIRSTPAGERIGHT)
3490
</source>
12918 cbradney 3491
        <translation type="obsolete">newDoc(size, margins, orientation, firstPageNumber,
9498 cbradney 3492
                   unit, facingPages, firstSideLeft) -&gt; bool
3493
 
3494
WARNING: Obsolete procedure! Use newDocument instead.
3495
 
3496
Creates a new document and returns true if successful. The parameters have the
3497
following meaning:
3498
 
3499
    size = A tuple (width, height) describing the size of the document. You can
3500
    use predefined constants named PAPER_&lt;paper_type&gt; e.g. PAPER_A4 etc.
3501
 
3502
    margins = A tuple (left, right, top, bottom) describing the document
3503
    margins
3504
 
3505
    orientation = the page orientation - constants PORTRAIT, LANDSCAPE
3506
 
3507
    firstPageNumer = is the number of the first page in the document used for
3508
    pagenumbering. While you&apos;ll usually want 1, it&apos;s useful to have higher
3509
    numbers if you&apos;re creating a document in several parts.
3510
 
3511
    unit: this value sets the measurement units used by the document. Use a
3512
    predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS,
3513
    UNIT_PICAS, UNIT_POINTS.
3514
 
3515
    facingPages = FACINGPAGES, NOFACINGPAGES
3516
 
3517
    firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT
3518
 
3519
The values for width, height and the margins are expressed in the given unit
3520
for the document. PAPER_* constants are expressed in points. If your document
3521
is not in points, make sure to account for this.
3522
 
3523
example: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS,
3524
                FACINGPAGES, FIRSTPAGERIGHT)
3525
</translation>
3526
    </message>
3527
    <message>
12456 jghali 3528
        <source>newDocDialog() -&gt; bool
9498 cbradney 3529
 
12456 jghali 3530
Displays the &quot;New Document&quot; dialog box. Creates a new document if the user
3531
accepts the settings. Does not create a document if the user presses cancel.
3532
Returns true if a new document was created.
9498 cbradney 3533
</source>
12918 cbradney 3534
        <translation type="obsolete">newDocDialog() -&gt; bool
9498 cbradney 3535
 
12456 jghali 3536
顯示 &quot;新建檔案&quot; 對話視窗, 如果使用者接受設定值, 則開啟新的檔案. 如果使用者案取消鍵,
3537
檔案將不會新建. 如果新檔案已經新增, 傳回 &quot;真&quot;.
3538
      </translation>
9498 cbradney 3539
    </message>
3540
    <message>
12456 jghali 3541
        <source>newStyleDialog() -&gt; string
9498 cbradney 3542
 
12456 jghali 3543
Shows &apos;Create new paragraph style&apos; dialog. Function returns real
3544
style name or None when user cancels the dialog.
9498 cbradney 3545
</source>
12918 cbradney 3546
        <translation type="obsolete">newStyleDialog() -&gt; string
9498 cbradney 3547
 
12456 jghali 3548
Shows &apos;Create new paragraph style&apos; dialog. Function returns real
3549
style name or None when user cancels the dialog.
9498 cbradney 3550
</translation>
3551
    </message>
3552
    <message>
12456 jghali 3553
        <source>objectExists([&quot;name&quot;]) -&gt; bool
9498 cbradney 3554
 
12456 jghali 3555
Test if an object with specified name really exists in the document.
3556
The optional parameter is the object name. When no object name is given,
3557
returns True if there is something selected.
9498 cbradney 3558
</source>
12918 cbradney 3559
        <translation type="obsolete">objectExists([&quot;name&quot;]) -&gt; bool
9498 cbradney 3560
 
12456 jghali 3561
Test if an object with specified name really exists in the document.
3562
The optional parameter is the object name. When no object name is given,
3563
returns True if there is something selected.
9498 cbradney 3564
</translation>
3565
    </message>
3566
    <message>
12456 jghali 3567
        <source>openDoc(&quot;name&quot;)
9498 cbradney 3568
 
12456 jghali 3569
Opens the document &quot;name&quot;.
3570
 
3571
May raise ScribusError if the document could not be opened.
9498 cbradney 3572
</source>
12918 cbradney 3573
        <translation type="obsolete">openDoc(&quot;name&quot;)
9498 cbradney 3574
 
12456 jghali 3575
Opens the document &quot;name&quot;.
3576
 
3577
May raise ScribusError if the document could not be opened.
9498 cbradney 3578
</translation>
3579
    </message>
3580
    <message>
12456 jghali 3581
        <source>pageCount() -&gt; integer
9498 cbradney 3582
 
12456 jghali 3583
Returns the number of pages in the document.
9498 cbradney 3584
</source>
12918 cbradney 3585
        <translation type="obsolete">pageCount() -&gt; integer
9498 cbradney 3586
 
12456 jghali 3587
Returns the number of pages in the document.
9498 cbradney 3588
</translation>
3589
    </message>
3590
    <message>
12456 jghali 3591
        <source>progressReset()
11652 cbradney 3592
 
12456 jghali 3593
Cleans up the Scribus progress bar previous settings. It is called before the
3594
new progress bar use. See progressSet.
11652 cbradney 3595
</source>
12918 cbradney 3596
        <translation type="obsolete">progressReset()
12456 jghali 3597
 
3598
Cleans up the Scribus progress bar previous settings. It is called before the
3599
new progress bar use. See progressSet.
3600
</translation>
11652 cbradney 3601
    </message>
3602
    <message>
12456 jghali 3603
        <source>progressSet(nr)
11652 cbradney 3604
 
12456 jghali 3605
Set the progress bar position to &quot;nr&quot;, a value relative to the previously set
3606
progressTotal. The progress bar uses the concept of steps; you give it the
3607
total number of steps and the number of steps completed so far and it will
3608
display the percentage of steps that have been completed. You can specify the
3609
total number of steps with progressTotal(). The current number of steps is set
3610
with progressSet(). The progress bar can be rewound to the beginning with
3611
progressReset(). [based on info taken from Trolltech&apos;s Qt docs]
11652 cbradney 3612
</source>
12918 cbradney 3613
        <translation type="obsolete">progressSet(nr)
12456 jghali 3614
 
3615
Set the progress bar position to &quot;nr&quot;, a value relative to the previously set
3616
progressTotal. The progress bar uses the concept of steps; you give it the
3617
total number of steps and the number of steps completed so far and it will
3618
display the percentage of steps that have been completed. You can specify the
3619
total number of steps with progressTotal(). The current number of steps is set
3620
with progressSet(). The progress bar can be rewound to the beginning with
3621
progressReset(). [based on info taken from Trolltech&apos;s Qt docs]
3622
</translation>
11652 cbradney 3623
    </message>
3624
    <message>
12456 jghali 3625
        <source>progressTotal(max)
11652 cbradney 3626
 
12456 jghali 3627
Sets the progress bar&apos;s maximum steps value to the specified number.
3628
See progressSet.
11652 cbradney 3629
</source>
12918 cbradney 3630
        <translation type="obsolete">progressTotal(max)
12456 jghali 3631
 
3632
Sets the progress bar&apos;s maximum steps value to the specified number.
3633
See progressSet.
3634
</translation>
11652 cbradney 3635
    </message>
3636
    <message>
12456 jghali 3637
        <source>redrawAll()
11652 cbradney 3638
 
12456 jghali 3639
Redraws all pages.
11652 cbradney 3640
</source>
12918 cbradney 3641
        <translation type="obsolete">redrawAll()
12456 jghali 3642
 
3643
Redraws all pages.
3644
</translation>
11652 cbradney 3645
    </message>
3646
    <message>
12456 jghali 3647
        <source>renderFont(&quot;name&quot;, &quot;filename&quot;, &quot;sample&quot;, size, format=&quot;PPM&quot;) -&gt; bool
11652 cbradney 3648
 
12456 jghali 3649
Creates an image preview of font &quot;name&quot; with given text &quot;sample&quot; and size.
3650
If &quot;filename&quot; is not &quot;&quot;, image is saved into &quot;filename&quot;. Otherwise
3651
image data is returned as a string. The optional &quot;format&quot; argument
3652
specifies the image format to generate, and supports any format allowed
3653
by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.
3654
 
3655
May raise NotFoundError if the specified font can&apos;t be found.
3656
May raise ValueError if an empty sample or filename is passed.
11652 cbradney 3657
</source>
12918 cbradney 3658
        <translation type="obsolete">renderFont(&quot;name&quot;, &quot;filename&quot;, &quot;sample&quot;, size, format=&quot;PPM&quot;) -&gt; bool
12456 jghali 3659
 
3660
Creates an image preview of font &quot;name&quot; with given text &quot;sample&quot; and size.
3661
If &quot;filename&quot; is not &quot;&quot;, image is saved into &quot;filename&quot;. Otherwise
3662
image data is returned as a string. The optional &quot;format&quot; argument
3663
specifies the image format to generate, and supports any format allowed
3664
by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.
3665
 
3666
May raise NotFoundError if the specified font can&apos;t be found.
3667
May raise ValueError if an empty sample or filename is passed.
3668
</translation>
11652 cbradney 3669
    </message>
3670
    <message>
12456 jghali 3671
        <source>replaceColor(&quot;name&quot;, &quot;replace&quot;)
11652 cbradney 3672
 
12456 jghali 3673
Every occurence of the color &quot;name&quot; is replaced by the color &quot;replace&quot;.
3674
 
3675
May raise NotFoundError if a named color wasn&apos;t found.
3676
May raise ValueError if an invalid color name is specified.
11652 cbradney 3677
</source>
12918 cbradney 3678
        <translation type="obsolete">replaceColor(&quot;name&quot;, &quot;replace&quot;)
11652 cbradney 3679
 
12456 jghali 3680
Every occurence of the colour &quot;name&quot; is replaced by the colour &quot;replace&quot;.
3681
 
3682
May raise NotFoundError if a named colour wasn&apos;t found.
3683
May raise ValueError if an invalid colour name is specified.
3684
</translation>
11652 cbradney 3685
    </message>
3686
    <message>
3687
        <source>rotateObject(rot [, &quot;name&quot;])
3688
 
3689
Rotates the object &quot;name&quot; by &quot;rot&quot; degrees relatively. The object is
3690
rotated by the vertex that is currently selected as the rotation point - by
12456 jghali 3691
default, the top left vertext at zero rotation. Positive values mean counter
11652 cbradney 3692
clockwise rotation when the default rotation point is used. If &quot;name&quot; is not
3693
given the currently selected item is used.
3694
</source>
12456 jghali 3695
        <translation type="obsolete">rotateObject(rot [, &quot;name&quot;])
3696
 
3697
Rotates the object &quot;name&quot; by &quot;rot&quot; degrees relatively. The object is
3698
rotated by the vertex that is currently selected as the rotation point - by
3699
default, the top left vertext at zero rotation. Positive values mean counter
3700
clockwise rotation when the default rotation point is used. If &quot;name&quot; is not
3701
given the currently selected item is used.
3702
</translation>
11652 cbradney 3703
    </message>
3704
    <message>
12456 jghali 3705
        <source>rotateObjectAbs(rot [, &quot;name&quot;])
11652 cbradney 3706
 
12456 jghali 3707
Sets the rotation of the object &quot;name&quot; to &quot;rot&quot;. Positve values
3708
mean counter clockwise rotation. If &quot;name&quot; is not given the currently
3709
selected item is used.
3710
</source>
3711
        <translation type="obsolete">rotateObjectAbs(rot [, &quot;name&quot;])
11652 cbradney 3712
 
12456 jghali 3713
Sets the rotation of the object &quot;name&quot; to &quot;rot&quot;. Positve values
3714
mean counter clockwise rotation. If &quot;name&quot; is not given the currently
3715
selected item is used.
3716
</translation>
11652 cbradney 3717
    </message>
3718
    <message>
12456 jghali 3719
        <source>saveDoc()
11652 cbradney 3720
 
12456 jghali 3721
Saves the current document with its current name, returns true if successful.
3722
If the document has not already been saved, this may bring up an interactive
3723
save file dialog.
11652 cbradney 3724
 
12456 jghali 3725
If the save fails, there is currently no way to tell.
11652 cbradney 3726
</source>
12918 cbradney 3727
        <translation type="obsolete">saveDoc()
12456 jghali 3728
 
3729
Saves the current document with its current name, returns true if successful.
3730
If the document has not already been saved, this may bring up an interactive
3731
save file dialog.
3732
 
3733
If the save fails, there is currently no way to tell.
3734
</translation>
11652 cbradney 3735
    </message>
3736
    <message>
12456 jghali 3737
        <source>saveDocAs(&quot;author&quot;, &quot;info&quot;, &quot;description&quot;) -&gt; bool
11652 cbradney 3738
 
12456 jghali 3739
Sets the document information. &quot;Author&quot;, &quot;Info&quot;, &quot;Description&quot; are
3740
strings.
3741
</source>
3742
        <translation type="obsolete">saveDocAs(&quot;author&quot;, &quot;info&quot;, &quot;description&quot;) -&gt; bool
11652 cbradney 3743
 
12456 jghali 3744
Sets the document information. &quot;Author&quot;, &quot;Info&quot;, &quot;Description&quot; are
3745
strings.
3746
</translation>
3747
    </message>
3748
    <message>
3749
        <source>saveDocAs(&quot;name&quot;)
3750
 
3751
Saves the current document under the new name &quot;name&quot; (which may be a full or
3752
relative path).
3753
 
3754
May raise ScribusError if the save fails.
11652 cbradney 3755
</source>
12918 cbradney 3756
        <translation type="obsolete">saveDocAs(&quot;name&quot;)
12456 jghali 3757</