Subversion Repositories Scribus

Rev

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