Subversion Repositories Scribus

Rev

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

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