Subversion Repositories Scribus

Rev

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

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