Subversion Repositories Scribus

Rev

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

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