Subversion Repositories Scribus

Rev

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