Subversion Repositories Scribus

Rev

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