Subversion Repositories Scribus

Rev

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