Subversion Repositories Scribus

Rev

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