Subversion Repositories Scribus

Rev

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