Subversion Repositories Scribus

Rev

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

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