Subversion Repositories Scribus

Rev

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