Subversion Repositories Scribus

Rev

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

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