Subversion Repositories Scribus

Rev

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