Subversion Repositories Scribus

Rev

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

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