Subversion Repositories Scribus

Rev

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

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