Subversion Repositories Scribus

Rev

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

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