Subversion Repositories Scribus

Rev

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