Subversion Repositories Scribus

Rev

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