Subversion Repositories Scribus

Rev

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