Subversion Repositories Scribus

Rev

Rev 14099 | Go to most recent revision | Details | Last modification | View Log | RSS feed

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