Subversion Repositories Scribus

Rev

Rev 15243 | 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
 
15294 cbradney 2461
Returns a tuple with document page dimensions measured in the document&apos;s current units.
13851 cbradney 2462
See UNIT_&lt;type&gt; constants and getPageMargins()
2463
</source>
15294 cbradney 2464
        <translation type="unfinished"></translation>
13851 cbradney 2465
    </message>
2466
    <message>
14474 cbradney 2467
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="161"/>
15294 cbradney 2468
        <source>getPageNSize(nr) -&gt; tuple
14474 cbradney 2469
 
2470
Returns a tuple with a particular page&apos;s size measured in the document&apos;s current units.
2471
See UNIT_&lt;type&gt; constants and getPageMargins()
2472
</source>
2473
        <translation type="unfinished"></translation>
2474
    </message>
2475
    <message>
2476
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="174"/>
15294 cbradney 2477
        <source>getPageMargins()
14474 cbradney 2478
 
15294 cbradney 2479
Returns the document page margins as a (top, left, right, bottom) tuple in the document&apos;s current
2480
units. See UNIT_&lt;type&gt; constants and getPageSize().
2481
</source>
2482
        <translation type="unfinished"></translation>
2483
    </message>
2484
    <message>
2485
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="187"/>
2486
        <source>getPageNMargins(nr) -&gt; tuple
2487
 
14474 cbradney 2488
Returns a tuple with a particular page&apos;s margins measured in the document&apos;s current units.
2489
See UNIT_&lt;type&gt; constants and getPageMargins()
2490
</source>
2491
        <translation type="unfinished"></translation>
2492
    </message>
2493
    <message>
15294 cbradney 2494
        <source>getPageSize() -&gt; tuple
2495
 
2496
Returns a tuple with page dimensions measured in the document&apos;s current units.
2497
See UNIT_&lt;type&gt; constants and getPageMargins()
2498
</source>
2499
        <translation type="obsolete">getPageSize() -&gt; tuple
2500
 
2501
Returns a tuple with page dimensions measured in the document&apos;s current units.
2502
See UNIT_&lt;type&gt; constants and getPageMargins()
2503
</translation>
2504
    </message>
2505
    <message>
2506
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="200"/>
13851 cbradney 2507
        <source>getPageItems() -&gt; list
2508
 
2509
Returns a list of tuples with items on the current page. The tuple is:
2510
(name, objectType, order) E.g. [(&apos;Text1&apos;, 4, 0), (&apos;Image1&apos;, 2, 1)]
2511
means that object named &apos;Text1&apos; is a text frame (type 4) and is the first at
2512
the page...
2513
</source>
14474 cbradney 2514
        <translation type="unfinished">getPageItems() -&gt; list
13851 cbradney 2515
 
2516
Returns a list of tuples with items on the current page. The tuple is:
2517
(name, objectType, order) E.g. [(&apos;Text1&apos;, 4, 0), (&apos;Image1&apos;, 2, 1)]
2518
means that object named &apos;Text1&apos; is a text frame (type 4) and is the first at
2519
the page...
2520
</translation>
2521
    </message>
2522
    <message>
2523
        <source>getPageMargins()
2524
 
2525
Returns the page margins as a (top, left, right, bottom) tuple in the current
2526
units. See UNIT_&lt;type&gt; constants and getPageSize().
2527
</source>
15294 cbradney 2528
        <translation type="obsolete">getPageMargins()
13851 cbradney 2529
 
2530
Returns the page margins as a (top, left, right, bottom) tuple in the current
2531
units. See UNIT_&lt;type&gt; constants and getPageSize().
2532
</translation>
2533
    </message>
2534
    <message>
14474 cbradney 2535
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="216"/>
13851 cbradney 2536
        <source>importPage(&quot;fromDoc&quot;, (pageList), [create, imortwhere, importwherePage])
2537
 
2538
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.
2539
fromDoc: string; the filename of the document to import pages from
2540
pageList: tuple with page numbers of pages to import
2541
create: number; 0 to replace existing pages, 1 (default) to insert new pages
2542
importWhere: number; the page number (of the current document) at which import the pages
2543
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
2544
</source>
14474 cbradney 2545
        <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 2546
    </message>
2547
    <message>
14474 cbradney 2548
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="17"/>
13851 cbradney 2549
        <source>setGradientFill(type, &quot;color1&quot;, shade1, &quot;color2&quot;, shade2, [&quot;name&quot;])
2550
 
2551
Sets the gradient fill of the object &quot;name&quot; to type. Color descriptions are
2552
the same as for setFillColor() and setFillShade(). See the constants for
2553
available types (FILL_&lt;type&gt;).
2554
</source>
14474 cbradney 2555
        <translation type="unfinished">setGradientFill(type, &quot;colour1&quot;, shade1, &quot;colour2&quot;, shade2, [&quot;name&quot;])
13851 cbradney 2556
 
2557
Sets the gradient fill of the object &quot;name&quot; to type. Colour descriptions are
2558
the same as for setFillColor() and setFillShade(). See the constants for
2559
available types (FILL_&lt;type&gt;).
2560
</translation>
2561
    </message>
2562
    <message>
14474 cbradney 2563
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="28"/>
2564
        <source>setGradientStop(&quot;color&quot;, shade, opacity, ramppoint, [&quot;name&quot;])
2565
 
2566
Set or add a gradient stop to the gradient fill of the object &quot;name&quot; at position ramppoint.
2567
Color descriptions are the same as for setFillColor() and setFillShade(). setGradientFill()
2568
must have been called previously for the gradient fill to be visible.
2569
</source>
2570
        <translation type="unfinished"></translation>
2571
    </message>
2572
    <message>
2573
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="39"/>
13851 cbradney 2574
        <source>setFillColor(&quot;color&quot;, [&quot;name&quot;])
2575
 
2576
Sets the fill color of the object &quot;name&quot; to the color &quot;color&quot;. &quot;color&quot;
2577
is the name of one of the defined colors. If &quot;name&quot; is not given the
2578
currently selected item is used.
2579
</source>
14474 cbradney 2580
        <translation type="unfinished">setFillColor(&quot;color&quot;, [&quot;name&quot;])
13851 cbradney 2581
 
2582
Sets the fill colour of the object &quot;name&quot; to the colour &quot;color&quot;. &quot;color&quot;
2583
is the name of one of the defined colours. If &quot;name&quot; is not given the
2584
currently selected item is used.
2585
</translation>
2586
    </message>
2587
    <message>
14474 cbradney 2588
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="50"/>
13851 cbradney 2589
        <source>setFillTransparency(transparency, [&quot;name&quot;])
2590
 
2591
Sets the fill transparency of the object &quot;name&quot; to transparency
2592
If &quot;name&quot; is not given the currently selected item is used.
2593
</source>
14474 cbradney 2594
        <translation type="unfinished">setFillTransparency(transparency, [&quot;name&quot;])
13851 cbradney 2595
 
2596
Sets the fill transparency of the object &quot;name&quot; to transparency
2597
If &quot;name&quot; is not given the currently selected item is used.
2598
</translation>
2599
    </message>
2600
    <message>
14474 cbradney 2601
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="60"/>
13851 cbradney 2602
        <source>setFillBlendmode(blendmode, [&quot;name&quot;])
2603
 
2604
Sets the fill blendmode of the object &quot;name&quot; to blendmode
2605
If &quot;name&quot; is not given the currently selected item is used.
2606
</source>
14474 cbradney 2607
        <translation type="unfinished">setFillBlendmode(blendmode, [&quot;name&quot;])
13851 cbradney 2608
 
2609
Sets the fill blendmode of the object &quot;name&quot; to blendmode
2610
If &quot;name&quot; is not given the currently selected item is used.
2611
</translation>
2612
    </message>
2613
    <message>
14474 cbradney 2614
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="70"/>
13851 cbradney 2615
        <source>setLineColor(&quot;color&quot;, [&quot;name&quot;])
2616
 
2617
Sets the line color of the object &quot;name&quot; to the color &quot;color&quot;. If &quot;name&quot;
2618
is not given the currently selected item is used.
2619
</source>
14474 cbradney 2620
        <translation type="unfinished">setLineColor(&quot;color&quot;, [&quot;name&quot;])
13851 cbradney 2621
 
2622
Sets the line colour of the object &quot;name&quot; to the colour &quot;color&quot;. If &quot;name&quot;
2623
is not given the currently selected item is used.
2624
</translation>
2625
    </message>
2626
    <message>
14474 cbradney 2627
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="80"/>
13851 cbradney 2628
        <source>setLineTransparency(transparency, [&quot;name&quot;])
2629
 
2630
Sets the line transparency of the object &quot;name&quot; to transparency
2631
If &quot;name&quot; is not given the currently selected item is used.
2632
</source>
14474 cbradney 2633
        <translation type="unfinished">setLineTransparency(transparency, [&quot;name&quot;])
13851 cbradney 2634
 
2635
Sets the line transparency of the object &quot;name&quot; to transparency
2636
If &quot;name&quot; is not given the currently selected item is used.
2637
</translation>
2638
    </message>
2639
    <message>
14474 cbradney 2640
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="90"/>
13851 cbradney 2641
        <source>setLineBlendmode(blendmode, [&quot;name&quot;])
2642
 
2643
Sets the line blendmode of the object &quot;name&quot; to blendmode
2644
If &quot;name&quot; is not given the currently selected item is used.
2645
</source>
14474 cbradney 2646
        <translation type="unfinished">setLineBlendmode(blendmode, [&quot;name&quot;])
13851 cbradney 2647
 
2648
Sets the line blendmode of the object &quot;name&quot; to blendmode
2649
If &quot;name&quot; is not given the currently selected item is used.
2650
</translation>
2651
    </message>
2652
    <message>
14474 cbradney 2653
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="100"/>
13851 cbradney 2654
        <source>setLineWidth(width, [&quot;name&quot;])
2655
 
2656
Sets line width of the object &quot;name&quot; to &quot;width&quot;. &quot;width&quot; must be in the
2657
range from 0.0 to 12.0 inclusive, and is measured in points. If &quot;name&quot; is not
2658
given the currently selected item is used.
2659
 
2660
May raise ValueError if the line width is out of bounds.
2661
</source>
14474 cbradney 2662
        <translation type="unfinished">setLineWidth(width, [&quot;name&quot;])
13851 cbradney 2663
 
2664
Sets line width of the object &quot;name&quot; to &quot;width&quot;. &quot;width&quot; must be in the
2665
range from 0.0 to 12.0 inclusive, and is measured in points. If &quot;name&quot; is not
2666
given the currently selected item is used.
2667
 
2668
May raise ValueError if the line width is out of bounds.
2669
</translation>
2670
    </message>
2671
    <message>
14474 cbradney 2672
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="113"/>
13851 cbradney 2673
        <source>setLineShade(shade, [&quot;name&quot;])
2674
 
2675
Sets the shading of the line color of the object &quot;name&quot; to &quot;shade&quot;.
2676
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
2677
(full color intensity). If &quot;name&quot; is not given the currently selected item
2678
is used.
2679
 
2680
May raise ValueError if the line shade is out of bounds.
2681
</source>
14474 cbradney 2682
        <translation type="unfinished">setLineShade(shade, [&quot;name&quot;])
13851 cbradney 2683
 
2684
Sets the shading of the line colour of the object &quot;name&quot; to &quot;shade&quot;.
2685
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
2686
(full colour intensity). If &quot;name&quot; is not given the currently selected item
2687
is used.
2688
 
2689
May raise ValueError if the line shade is out of bounds.
2690
</translation>
2691
    </message>
2692
    <message>
14474 cbradney 2693
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="127"/>
13851 cbradney 2694
        <source>setLineJoin(join, [&quot;name&quot;])
2695
 
2696
Sets the line join style of the object &quot;name&quot; to the style &quot;join&quot;.
2697
If &quot;name&quot; is not given the currently selected item is used. There are
2698
predefined constants for join - JOIN_&lt;type&gt;.
2699
</source>
14474 cbradney 2700
        <translation type="unfinished">setLineJoin(join, [&quot;name&quot;])
13851 cbradney 2701
 
2702
Sets the line join style of the object &quot;name&quot; to the style &quot;join&quot;.
2703
If &quot;name&quot; is not given the currently selected item is used. There are
2704
predefined constants for join - JOIN_&lt;type&gt;.
2705
</translation>
2706
    </message>
2707
    <message>
14474 cbradney 2708
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="138"/>
13851 cbradney 2709
        <source>setLineEnd(endtype, [&quot;name&quot;])
2710
 
2711
Sets the line cap style of the object &quot;name&quot; to the style &quot;cap&quot;.
2712
If &quot;name&quot; is not given the currently selected item is used. There are
2713
predefined constants for &quot;cap&quot; - CAP_&lt;type&gt;.
2714
</source>
14474 cbradney 2715
        <translation type="unfinished">setLineEnd(endtype, [&quot;name&quot;])
13851 cbradney 2716
 
2717
Sets the line cap style of the object &quot;name&quot; to the style &quot;cap&quot;.
2718
If &quot;name&quot; is not given the currently selected item is used. There are
2719
predefined constants for &quot;cap&quot; - CAP_&lt;type&gt;.
2720
</translation>
2721
    </message>
2722
    <message>
14474 cbradney 2723
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="149"/>
13851 cbradney 2724
        <source>setLineStyle(style, [&quot;name&quot;])
2725
 
2726
Sets the line style of the object &quot;name&quot; to the style &quot;style&quot;. If &quot;name&quot;
2727
is not given the currently selected item is used. There are predefined
2728
constants for &quot;style&quot; - LINE_&lt;style&gt;.
2729
</source>
14474 cbradney 2730
        <translation type="unfinished">setLineStyle(style, [&quot;name&quot;])
13851 cbradney 2731
 
2732
Sets the line style of the object &quot;name&quot; to the style &quot;style&quot;. If &quot;name&quot;
2733
is not given the currently selected item is used. There are predefined
2734
constants for &quot;style&quot; - LINE_&lt;style&gt;.
2735
</translation>
2736
    </message>
2737
    <message>
14474 cbradney 2738
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="160"/>
13851 cbradney 2739
        <source>setFillShade(shade, [&quot;name&quot;])
2740
 
2741
Sets the shading of the fill color of the object &quot;name&quot; to &quot;shade&quot;.
2742
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
2743
(full Color intensity). If &quot;name&quot; is not given the currently selected
2744
Item is used.
2745
 
2746
May raise ValueError if the fill shade is out of bounds.
2747
</source>
14474 cbradney 2748
        <translation type="unfinished">setFillShade(shade, [&quot;name&quot;])
13851 cbradney 2749
 
2750
Sets the shading of the fill colour of the object &quot;name&quot; to &quot;shade&quot;.
2751
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
2752
(full Colour intensity). If &quot;name&quot; is not given the currently selected
2753
Item is used.
2754
 
2755
May raise ValueError if the fill shade is out of bounds.
2756
</translation>
2757
    </message>
2758
    <message>
14474 cbradney 2759
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="174"/>
13851 cbradney 2760
        <source>setCornerRadius(radius, [&quot;name&quot;])
2761
 
2762
Sets the corner radius of the object &quot;name&quot;. The radius is expressed
2763
in points. If &quot;name&quot; is not given the currently selected item is used.
2764
 
2765
May raise ValueError if the corner radius is negative.
2766
</source>
14474 cbradney 2767
        <translation type="unfinished">setCornerRadius(radius, [&quot;name&quot;])
13851 cbradney 2768
 
2769
Sets the corner radius of the object &quot;name&quot;. The radius is expressed
2770
in points. If &quot;name&quot; is not given the currently selected item is used.
2771
 
2772
May raise ValueError if the corner radius is negative.
2773
</translation>
2774
    </message>
2775
    <message>
14474 cbradney 2776
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="186"/>
13851 cbradney 2777
        <source>setMultiLine(&quot;namedStyle&quot;, [&quot;name&quot;])
2778
 
2779
Sets the line style of the object &quot;name&quot; to the named style &quot;namedStyle&quot;.
2780
If &quot;name&quot; is not given the currently selected item is used.
2781
 
2782
May raise NotFoundError if the line style doesn&apos;t exist.
2783
</source>
14474 cbradney 2784
        <translation type="unfinished">setMultiLine(&quot;namedStyle&quot;, [&quot;name&quot;])
13851 cbradney 2785
 
2786
Sets the line style of the object &quot;name&quot; to the named style &quot;namedStyle&quot;.
2787
If &quot;name&quot; is not given the currently selected item is used.
2788
 
2789
May raise NotFoundError if the line style doesn&apos;t exist.
2790
</translation>
2791
    </message>
2792
    <message>
14474 cbradney 2793
        <location filename="../../../scribus/plugins/scriptplugin/cmdstyle.h" line="22"/>
13851 cbradney 2794
        <source>createParagraphStyle(...)
2795
 
2796
Creates a paragraph style. This function takes the following keyword parameters:
2797
 
2798
&quot;name&quot; [required] -&gt; specifies the name of the paragraphstyle to create
2799
 
2800
linespacingmode [optional] -&gt; specifies the linespacing mode; possible modes are:
2801
 
2802
fixed linespacing:          0
2803
 
2804
automatic linespacing:      1
2805
 
2806
baseline grid linespacing:  2
2807
 
2808
linespacing [optional] -&gt; specifies the linespacing if using fixed linespacing
2809
 
2810
alignment [optional] -&gt; specifies the alignment of the paragraph
2811
 
2812
-&gt; left:     0
2813
 
2814
-&gt; center:   1
2815
 
2816
-&gt; right:    2
2817
 
2818
-&gt; justify:  3
2819
 
2820
-&gt; extend:   4
2821
 
2822
leftmargin [optional], rightmargin [optional] -&gt; specify the margin
2823
 
2824
gapbefore [optional], gapafter [optional] -&gt; specify the gaps to the heading and following paragraphs
2825
 
2826
firstindent [optional] -&gt; the indent of the first line
2827
 
2828
hasdropcap [optional] -&gt; specifies if there are caps (1 = yes, 0 = no)
2829
 
2830
dropcaplines [optional] -&gt; height (in lines) of the caps if used
2831
 
2832
dropcapoffset [optional] -&gt; offset of the caps if used
2833
 
2834
&quot;charstyle&quot; [optional] -&gt; char style to use
2835
 
2836
</source>
14474 cbradney 2837
        <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 2838
    </message>
2839
    <message>
14474 cbradney 2840
        <location filename="../../../scribus/plugins/scriptplugin/cmdstyle.h" line="52"/>
13851 cbradney 2841
        <source>createCharStyle(...)
2842
 
2843
Creates a character style. This function takes the following keyword parameters:
2844
 
2845
&quot;name&quot; [required] -&gt; name of the char style to create
2846
 
2847
&quot;font&quot; [optional] -&gt; name of the font to use
2848
 
2849
fontsize [optional] -&gt; font size to set (double)
2850
 
2851
&quot;features&quot; [optional] -&gt; nearer typographic details can be defined by a string that might contain the following phrases comma-seperated (without spaces!):
2852
 
2853
-&gt; inherit
2854
 
2855
-&gt; bold
2856
 
2857
-&gt; italic
2858
 
2859
-&gt; underline
2860
 
2861
-&gt; underlinewords
2862
 
2863
-&gt; strike
2864
 
2865
-&gt; superscript
2866
 
2867
-&gt; subscript
2868
 
2869
-&gt; outline
2870
 
2871
-&gt; shadowed
2872
 
2873
-&gt; allcaps
2874
 
2875
-&gt; smallcaps
2876
 
2877
&quot;fillcolor&quot; [optional], &quot;fillshade&quot; [optional] -&gt; specify fill options
2878
 
2879
&quot;strokecolor&quot; [optional], &quot;strokeshade&quot; [optional] -&gt; specify stroke options
2880
 
2881
baselineoffset [optional] -&gt; offset of the baseline
2882
 
2883
shadowxoffset [optional], shadowyoffset [optional] -&gt; offset of the shadow if used
2884
 
2885
outlinewidth [optional] -&gt; width of the outline if used
2886
 
2887
underlineoffset [optional], underlinewidth [optional] -&gt; underline options if used
2888
 
2889
strikethruoffset [optional], strikethruwidth [optional] -&gt; strikethru options if used
2890
 
2891
scaleh [optional], scalev [optional] -&gt; scale of the chars
2892
 
2893
tracking [optional] -&gt; tracking of the text
2894
 
2895
&quot;language&quot; [optional] -&gt; language code
2896
 
2897
</source>
14474 cbradney 2898
        <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 2899
    </message>
2900
    <message>
14474 cbradney 2901
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="17"/>
13851 cbradney 2902
        <source>getFontSize([&quot;name&quot;]) -&gt; float
2903
 
2904
Returns the font size in points for the text frame &quot;name&quot;. If this text
2905
frame has some text selected the value assigned to the first character of
2906
the selection is returned.
2907
If &quot;name&quot; is not given the currently selected item is used.
2908
</source>
14474 cbradney 2909
        <translation type="unfinished">getFontSize([&quot;name&quot;]) -&gt; float
13851 cbradney 2910
 
2911
Returns the font size in points for the text frame &quot;name&quot;. If this text
2912
frame has some text selected the value assigned to the first character of
2913
the selection is returned.
2914
If &quot;name&quot; is not given the currently selected item is used.
2915
</translation>
2916
    </message>
2917
    <message>
14474 cbradney 2918
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="29"/>
13851 cbradney 2919
        <source>getFont([&quot;name&quot;]) -&gt; string
2920
 
2921
Returns the font name for the text frame &quot;name&quot;. If this text frame
2922
has some text selected the value assigned to the first character
2923
of the selection is returned. If &quot;name&quot; is not given the currently
2924
selected item is used.
2925
</source>
14474 cbradney 2926
        <translation type="unfinished">getFont([&quot;name&quot;]) -&gt; string
13851 cbradney 2927
 
2928
Returns the font name for the text frame &quot;name&quot;. If this text frame
2929
has some text selected the value assigned to the first character
2930
of the selection is returned. If &quot;name&quot; is not given the currently
2931
selected item is used.
2932
</translation>
2933
    </message>
2934
    <message>
14474 cbradney 2935
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="41"/>
13851 cbradney 2936
        <source>getTextLength([&quot;name&quot;]) -&gt; integer
2937
 
2938
Returns the length of the text in the text frame &quot;name&quot;.
2939
If &quot;name&quot; is not given the currently selected item is used.
2940
</source>
14474 cbradney 2941
        <translation type="unfinished">getTextLength([&quot;name&quot;]) -&gt; integer
13851 cbradney 2942
 
2943
Returns the length of the text in the text frame &quot;name&quot;.
2944
If &quot;name&quot; is not given the currently selected item is used.
2945
</translation>
2946
    </message>
2947
    <message>
14474 cbradney 2948
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="51"/>
13851 cbradney 2949
        <source>getTextLines([&quot;name&quot;]) -&gt; integer
2950
 
2951
Returns the number of lines of the text in the text frame &quot;name&quot;.
2952
If &quot;name&quot; is not given the currently selected item is used.
2953
</source>
14474 cbradney 2954
        <translation type="unfinished">getTextLines([&quot;name&quot;]) -&gt; integer
13851 cbradney 2955
 
2956
Returns the number of lines of the text in the text frame &quot;name&quot;.
2957
If &quot;name&quot; is not given the currently selected item is used.
2958
</translation>
2959
    </message>
2960
    <message>
14474 cbradney 2961
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="61"/>
13851 cbradney 2962
        <source>getText([&quot;name&quot;]) -&gt; string
2963
 
2964
Returns the text of the text frame &quot;name&quot;. If this text frame has some text
2965
selected, the selected text is returned. All text in the frame, not just
2966
currently visible text, is returned. If &quot;name&quot; is not given the currently
2967
selected item is used.
2968
</source>
14474 cbradney 2969
        <translation type="unfinished">getText([&quot;name&quot;]) -&gt; string
13851 cbradney 2970
 
2971
Returns the text of the text frame &quot;name&quot;. If this text frame has some text
2972
selected, the selected text is returned. All text in the frame, not just
2973
currently visible text, is returned. If &quot;name&quot; is not given the currently
2974
selected item is used.
2975
</translation>
2976
    </message>
2977
    <message>
14474 cbradney 2978
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="73"/>
13851 cbradney 2979
        <source>getAllText([&quot;name&quot;]) -&gt; string
2980
 
2981
Returns the text of the text frame &quot;name&quot; and of all text frames which are
2982
linked with this frame. If this textframe has some text selected, the selected
2983
text is returned. If &quot;name&quot; is not given the currently selected item is
2984
used.
2985
</source>
14474 cbradney 2986
        <translation type="unfinished">getAllText([&quot;name&quot;]) -&gt; string
13851 cbradney 2987
 
2988
Returns the text of the text frame &quot;name&quot; and of all text frames which are
2989
linked with this frame. If this textframe has some text selected, the selected
2990
text is returned. If &quot;name&quot; is not given the currently selected item is
2991
used.
2992
</translation>
2993
    </message>
2994
    <message>
14474 cbradney 2995
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="85"/>
13851 cbradney 2996
        <source>getLineSpacing([&quot;name&quot;]) -&gt; float
2997
 
2998
Returns the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; expressed in
2999
points. If &quot;name&quot; is not given the currently selected item is used.
3000
</source>
14474 cbradney 3001
        <translation type="unfinished">getLineSpacing([&quot;name&quot;]) -&gt; float
13851 cbradney 3002
 
3003
Returns the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; expressed in
3004
points. If &quot;name&quot; is not given the currently selected item is used.
3005
</translation>
3006
    </message>
3007
    <message>
14474 cbradney 3008
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="95"/>
13851 cbradney 3009
        <source>getTextDistances([&quot;name&quot;]) -&gt; tuple
3010
 
3011
Returns the text distances of the text frame &quot;name&quot; expressed in points. The
3012
distances are returned as a tuple like (left, right, top, bottom). If &quot;name&quot;
3013
is not given the currently selected item is used.
3014
</source>
14474 cbradney 3015
        <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 3016
    </message>
3017
    <message>
14474 cbradney 3018
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="106"/>
13851 cbradney 3019
        <source>getColumnGap([&quot;name&quot;]) -&gt; float
3020
 
3021
Returns the column gap size of the text frame &quot;name&quot; expressed in points. If
3022
&quot;name&quot; is not given the currently selected item is used.
3023
</source>
14474 cbradney 3024
        <translation type="unfinished">getColumnGap([&quot;name&quot;]) -&gt; float
13851 cbradney 3025
 
3026
Returns the column gap size of the text frame &quot;name&quot; expressed in points. If
3027
&quot;name&quot; is not given the currently selected item is used.
3028
</translation>
3029
    </message>
3030
    <message>
14474 cbradney 3031
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="116"/>
13851 cbradney 3032
        <source>getColumns([&quot;name&quot;]) -&gt; integer
3033
 
3034
Gets the number of columns of the text frame &quot;name&quot;. If &quot;name&quot; is not
3035
given the currently selected item is used.
3036
</source>
14474 cbradney 3037
        <translation type="unfinished">getColumns([&quot;name&quot;]) -&gt; integer
13851 cbradney 3038
 
3039
Gets the number of columns of the text frame &quot;name&quot;. If &quot;name&quot; is not
3040
given the currently selected item is used.
3041
</translation>
3042
    </message>
3043
    <message>
14474 cbradney 3044
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="126"/>
13851 cbradney 3045
        <source>setText(&quot;text&quot;, [&quot;name&quot;])
3046
 
3047
Sets the text of the text frame &quot;name&quot; to the text of the string &quot;text&quot;.
3048
Text must be UTF8 encoded - use e.g. unicode(text, &apos;iso-8859-2&apos;). See the FAQ
3049
for more details. If &quot;name&quot; is not given the currently selected item is
3050
used.
3051
</source>
14474 cbradney 3052
        <translation type="unfinished">setText(&quot;text&quot;, [&quot;name&quot;])
13851 cbradney 3053
 
3054
Sets the text of the text frame &quot;name&quot; to the text of the string &quot;text&quot;.
3055
Text must be UTF8 encoded - use e.g. unicode(text, &apos;iso-8859-2&apos;). See the FAQ
3056
for more details. If &quot;name&quot; is not given the currently selected item is
3057
used.
3058
</translation>
3059
    </message>
3060
    <message>
14474 cbradney 3061
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="138"/>
13851 cbradney 3062
        <source>insertText(&quot;text&quot;, pos, [&quot;name&quot;])
3063
 
3064
Inserts the text &quot;text&quot; at the position &quot;pos&quot; into the text frame &quot;name&quot;.
3065
Text must be UTF encoded (see setText() as reference) The first character has an
3066
index of 0. Inserting text at position -1 appends it to the frame. If &quot;name&quot; is
3067
not given the currently selected Item is used.
3068
 
3069
May throw IndexError for an insertion out of bounds.
3070
</source>
14474 cbradney 3071
        <translation type="unfinished">insertText(&quot;text&quot;, pos, [&quot;name&quot;])
13851 cbradney 3072
 
3073
Inserts the text &quot;text&quot; at the position &quot;pos&quot; into the text frame &quot;name&quot;.
3074
Text must be UTF encoded (see setText() as reference) The first character has an
3075
index of 0. Inserting text at position -1 appends it to the frame. If &quot;name&quot; is
3076
not given the currently selected Item is used.
3077
 
3078
May throw IndexError for an insertion out of bounds.
3079
</translation>
3080
    </message>
3081
    <message>
14474 cbradney 3082
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="152"/>
13851 cbradney 3083
        <source>setFont(&quot;font&quot;, [&quot;name&quot;])
3084
 
3085
Sets the font of the text frame &quot;name&quot; to &quot;font&quot;. If there is some text
3086
selected only the selected text is changed.  If &quot;name&quot; is not given the
3087
currently selected item is used.
3088
 
3089
May throw ValueError if the font cannot be found.
3090
</source>
14474 cbradney 3091
        <translation type="unfinished">setFont(&quot;font&quot;, [&quot;name&quot;])
13851 cbradney 3092
 
3093
Sets the font of the text frame &quot;name&quot; to &quot;font&quot;. If there is some text
3094
selected only the selected text is changed.  If &quot;name&quot; is not given the
3095
currently selected item is used.
3096
 
3097
May throw ValueError if the font cannot be found.
3098
</translation>
3099
    </message>
3100
    <message>
14474 cbradney 3101
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="165"/>
13851 cbradney 3102
        <source>setFontSize(size, [&quot;name&quot;])
3103
 
3104
Sets the font size of the text frame &quot;name&quot; to &quot;size&quot;. &quot;size&quot; is treated
3105
as a value in points. If there is some text selected only the selected text is
3106
changed. &quot;size&quot; must be in the range 1 to 512. If &quot;name&quot; is not given the
3107
currently selected item is used.
3108
 
3109
May throw ValueError for a font size that&apos;s out of bounds.
3110
</source>
14474 cbradney 3111
        <translation type="unfinished">setFontSize(size, [&quot;name&quot;])
13851 cbradney 3112
 
3113
Sets the font size of the text frame &quot;name&quot; to &quot;size&quot;. &quot;size&quot; is treated
3114
as a value in points. If there is some text selected only the selected text is
3115
changed. &quot;size&quot; must be in the range 1 to 512. If &quot;name&quot; is not given the
3116
currently selected item is used.
3117
 
3118
May throw ValueError for a font size that&apos;s out of bounds.
3119
</translation>
3120
    </message>
3121
    <message>
14474 cbradney 3122
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="179"/>
13851 cbradney 3123
        <source>setLineSpacing(size, [&quot;name&quot;])
3124
 
3125
Sets the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; to &quot;size&quot;.
3126
&quot;size&quot; is a value in points. If &quot;name&quot; is not given the currently selected
3127
item is used.
3128
 
3129
May throw ValueError if the line spacing is out of bounds.
3130
</source>
14474 cbradney 3131
        <translation type="unfinished">setLineSpacing(size, [&quot;name&quot;])
13851 cbradney 3132
 
3133
Sets the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; to &quot;size&quot;.
3134
&quot;size&quot; is a value in points. If &quot;name&quot; is not given the currently selected
3135
item is used.
3136
 
3137
May throw ValueError if the line spacing is out of bounds.
3138
</translation>
3139
    </message>
3140
    <message>
14474 cbradney 3141
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="192"/>
3142
        <source>setLineSpacingMode(mode, [&quot;name&quot;])
3143
 
3144
Sets the line spacing mode of the text frame &quot;name&quot; to &quot;mode&quot;.
3145
If &quot;name&quot; is not given the currently selected
3146
item is used.
3147
Mode values are the same as in createParagraphStyle.
3148
 
3149
May throw ValueError if the mode is out of bounds.
3150
</source>
3151
        <translation type="unfinished"></translation>
3152
    </message>
3153
    <message>
3154
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="206"/>
13851 cbradney 3155
        <source>setTextDistances(left, right, top, bottom, [&quot;name&quot;])
3156
 
3157
Sets the text distances of the text frame &quot;name&quot; to the values &quot;left&quot;
3158
&quot;right&quot;, &quot;top&quot; and &quot;bottom&quot;. If &quot;name&quot; is not given the currently
3159
selected item is used.
3160
 
3161
May throw ValueError if any of the distances are out of bounds (must be positive).
3162
</source>
14474 cbradney 3163
        <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 3164
    </message>
3165
    <message>
14474 cbradney 3166
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="219"/>
13851 cbradney 3167
        <source>setColumnGap(size, [&quot;name&quot;])
3168
 
3169
Sets the column gap of the text frame &quot;name&quot; to the value &quot;size&quot;. If
3170
&quot;name&quot; is not given the currently selected item is used.
3171
 
3172
May throw ValueError if the column gap is out of bounds (must be positive).
3173
</source>
14474 cbradney 3174
        <translation type="unfinished">setColumnGap(size, [&quot;name&quot;])
13851 cbradney 3175
 
3176
Sets the column gap of the text frame &quot;name&quot; to the value &quot;size&quot;. If
3177
&quot;name&quot; is not given the currently selected item is used.
3178
 
3179
May throw ValueError if the column gap is out of bounds (must be positive).
3180
</translation>
3181
    </message>
3182
    <message>
14474 cbradney 3183
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="231"/>
13851 cbradney 3184
        <source>setColumns(nr, [&quot;name&quot;])
3185
 
3186
Sets the number of columns of the text frame &quot;name&quot; to the integer &quot;nr&quot;.
3187
If &quot;name&quot; is not given the currently selected item is used.
3188
 
3189
May throw ValueError if number of columns is not at least one.
3190
</source>
14474 cbradney 3191
        <translation type="unfinished">setColumns(nr, [&quot;name&quot;])
13851 cbradney 3192
 
3193
Sets the number of columns of the text frame &quot;name&quot; to the integer &quot;nr&quot;.
3194
If &quot;name&quot; is not given the currently selected item is used.
3195
 
3196
May throw ValueError if number of columns is not at least one.
3197
</translation>
3198
    </message>
3199
    <message>
14474 cbradney 3200
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="243"/>
13851 cbradney 3201
        <source>setTextAlignment(align, [&quot;name&quot;])
3202
 
3203
Sets the text alignment of the text frame &quot;name&quot; to the specified alignment.
3204
If &quot;name&quot; is not given the currently selected item is used. &quot;align&quot; should
3205
be one of the ALIGN_ constants defined in this module - see dir(scribus).
3206
 
3207
May throw ValueError for an invalid alignment constant.
3208
</source>
14474 cbradney 3209
        <translation type="unfinished">setTextAlignment(align, [&quot;name&quot;])
13851 cbradney 3210
 
3211
Sets the text alignment of the text frame &quot;name&quot; to the specified alignment.
3212
If &quot;name&quot; is not given the currently selected item is used. &quot;align&quot; should
3213
be one of the ALIGN_ constants defined in this module - see dir(scribus).
3214
 
3215
May throw ValueError for an invalid alignment constant.
3216
</translation>
3217
    </message>
3218
    <message>
14474 cbradney 3219
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="256"/>
13851 cbradney 3220
        <source>selectText(start, count, [&quot;name&quot;])
3221
 
3222
Selects &quot;count&quot; characters of text in the text frame &quot;name&quot; starting from the
3223
character &quot;start&quot;. Character counting starts at 0. If &quot;count&quot; is zero, any
3224
text selection will be cleared.  If &quot;name&quot; is not given the currently
3225
selected item is used.
3226
 
3227
May throw IndexError if the selection is outside the bounds of the text.
3228
</source>
14474 cbradney 3229
        <translation type="unfinished">selectText(start, count, [&quot;name&quot;])
13851 cbradney 3230
 
3231
Selects &quot;count&quot; characters of text in the text frame &quot;name&quot; starting from the
3232
character &quot;start&quot;. Character counting starts at 0. If &quot;count&quot; is zero, any
3233
text selection will be cleared.  If &quot;name&quot; is not given the currently
3234
selected item is used.
3235
 
3236
May throw IndexError if the selection is outside the bounds of the text.
3237
</translation>
3238
    </message>
3239
    <message>
14474 cbradney 3240
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="270"/>
13851 cbradney 3241
        <source>deleteText([&quot;name&quot;])
3242
 
3243
Deletes any text in the text frame &quot;name&quot;. If there is some text selected,
3244
only the selected text will be deleted. If &quot;name&quot; is not given the currently
3245
selected item is used.
3246
</source>
14474 cbradney 3247
        <translation type="unfinished">deleteText([&quot;name&quot;])
13851 cbradney 3248
 
3249
Deletes any text in the text frame &quot;name&quot;. If there is some text selected,
3250
only the selected text will be deleted. If &quot;name&quot; is not given the currently
3251
selected item is used.
3252
</translation>
3253
    </message>
3254
    <message>
14474 cbradney 3255
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="281"/>
13851 cbradney 3256
        <source>setTextColor(&quot;color&quot;, [&quot;name&quot;])
3257
 
3258
Sets the text color of the text frame &quot;name&quot; to the color &quot;color&quot;. If there
3259
is some text selected only the selected text is changed. If &quot;name&quot; is not
3260
given the currently selected item is used.
3261
</source>
14474 cbradney 3262
        <translation type="unfinished">setTextColor(&quot;color&quot;, [&quot;name&quot;])
13851 cbradney 3263
 
3264
Sets the text colour of the text frame &quot;name&quot; to the colour &quot;color&quot;. If there
3265
is some text selected only the selected text is changed. If &quot;name&quot; is not
3266
given the currently selected item is used.
3267
</translation>
3268
    </message>
3269
    <message>
14474 cbradney 3270
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="292"/>
13851 cbradney 3271
        <source>setTextStroke(&quot;color&quot;, [&quot;name&quot;])
3272
 
3273
Set &quot;color&quot; of the text stroke. If &quot;name&quot; is not given the currently
3274
selected item is used.
3275
</source>
14474 cbradney 3276
        <translation type="unfinished">setTextStroke(&quot;color&quot;, [&quot;name&quot;])
13851 cbradney 3277
 
3278
Set &quot;color&quot; of the text stroke. If &quot;name&quot; is not given the currently
3279
selected item is used.
3280
</translation>
3281
    </message>
3282
    <message>
14474 cbradney 3283
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="302"/>
3284
        <source>setTextScalingV(scale, [&quot;name&quot;])
3285
 
3286
Sets the vertical character scaling of the object &quot;name&quot; to &quot;scale&quot; in percent.
3287
If &quot;name&quot; is not given the currently selected item is used.
3288
</source>
3289
        <translation type="unfinished"></translation>
3290
    </message>
3291
    <message>
3292
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="312"/>
3293
        <source>setTextScalingH(scale, [&quot;name&quot;])
3294
 
3295
Sets the horizontal character scaling of the object &quot;name&quot; to &quot;scale&quot; in percent.
3296
If &quot;name&quot; is not given the currently selected item is used.
3297
</source>
3298
        <translation type="unfinished"></translation>
3299
    </message>
3300
    <message>
3301
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="322"/>
13851 cbradney 3302
        <source>setTextShade(shade, [&quot;name&quot;])
3303
 
3304
Sets the shading of the text color of the object &quot;name&quot; to &quot;shade&quot;. If
3305
there is some text selected only the selected text is changed. &quot;shade&quot; must
3306
be an integer value in the range from 0 (lightest) to 100 (full color
3307
intensity). If &quot;name&quot; is not given the currently selected item is
3308
used.
3309
</source>
14474 cbradney 3310
        <translation type="unfinished">setTextShade(shade, [&quot;name&quot;])
13851 cbradney 3311
 
3312
Sets the shading of the text colour of the object &quot;name&quot; to &quot;shade&quot;. If
3313
there is some text selected only the selected text is changed. &quot;shade&quot; must
3314
be an integer value in the range from 0 (lightest) to 100 (full colour
3315
intensity). If &quot;name&quot; is not given the currently selected item is
3316
used.
3317
</translation>
3318
    </message>
3319
    <message>
14474 cbradney 3320
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="335"/>
13851 cbradney 3321
        <source>linkTextFrames(&quot;fromname&quot;, &quot;toname&quot;)
3322
 
3323
Link two text frames. The frame named &quot;fromname&quot; is linked to the
3324
frame named &quot;toname&quot;. The target frame must be an empty text frame
3325
and must not link to or be linked from any other frames already.
3326
 
3327
May throw ScribusException if linking rules are violated.
3328
</source>
14474 cbradney 3329
        <translation type="unfinished">linkTextFrames(&quot;fromname&quot;, &quot;toname&quot;)
13851 cbradney 3330
 
3331
Link two text frames. The frame named &quot;fromname&quot; is linked to the
3332
frame named &quot;toname&quot;. The target frame must be an empty text frame
3333
and must not link to or be linked from any other frames already.
3334
 
3335
May throw ScribusException if linking rules are violated.
3336
</translation>
3337
    </message>
3338
    <message>
14474 cbradney 3339
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="352"/>
13851 cbradney 3340
        <source>unlinkTextFrames(&quot;name&quot;)
3341
 
3342
Remove the specified (named) object from the text frame flow/linkage. If the
3343
frame was in the middle of a chain, the previous and next frames will be
3344
connected, eg &apos;a-&gt;b-&gt;c&apos; becomes &apos;a-&gt;c&apos; when you unlinkTextFrames(b)&apos;
3345
 
3346
May throw ScribusException if linking rules are violated.
3347
</source>
14474 cbradney 3348
        <translation type="unfinished">unlinkTextFrames(&quot;name&quot;)
13851 cbradney 3349
 
3350
Remove the specified (named) object from the text frame flow/linkage. If the
3351
frame was in the middle of a chain, the previous and next frames will be
3352
connected, eg &apos;a-&gt;b-&gt;c&apos; becomes &apos;a-&gt;c&apos; when you unlinkTextFrames(b)&apos;
3353
 
3354
May throw ScribusException if linking rules are violated.
3355
</translation>
3356
    </message>
3357
    <message>
14474 cbradney 3358
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="369"/>
13851 cbradney 3359
        <source>traceText([&quot;name&quot;])
3360
 
3361
Convert the text frame &quot;name&quot; to outlines. If &quot;name&quot; is not given the
3362
currently selected item is used.</source>
14474 cbradney 3363
        <translation type="unfinished">traceText([&quot;name&quot;])
13851 cbradney 3364
 
3365
Convert the text frame &quot;name&quot; to outlines. If &quot;name&quot; is not given the
3366
currently selected item is used.</translation>
3367
    </message>
3368
    <message>
14474 cbradney 3369
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="380"/>
13851 cbradney 3370
        <source>textOverflows([&quot;name&quot;, nolinks]) -&gt; integer
3371
 
3372
Returns the actual number of overflowing characters in text frame &quot;name&quot;.
3373
If is nolinks set to non zero value it takes only one frame - it doesn&apos;t
3374
use text frame linking. Without this parameter it search all linking chain.
3375
 
3376
May raise WrongFrameTypeError if the target frame is not an text frame
3377
</source>
14474 cbradney 3378
        <translation type="unfinished">textOverflows([&quot;name&quot;, nolinks]) -&gt; integer
13851 cbradney 3379
 
3380
Returns the actual number of overflowing characters in text frame &quot;name&quot;.
3381
If is nolinks set to non zero value it takes only one frame - it doesn&apos;t
3382
use text frame linking. Without this parameter it search all linking chain.
3383
 
3384
May raise WrongFrameTypeError if the target frame is not an text frame
3385
</translation>
3386
    </message>
3387
    <message>
14474 cbradney 3388
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="393"/>
13851 cbradney 3389
        <source>hyphenateText([&quot;name&quot;]) -&gt; bool
3390
 
3391
Does hyphenation on text frame &quot;name&quot;.
3392
If &quot;name&quot; is not given the currently selected item is used.
3393
 
3394
May raise WrongFrameTypeError if the target frame is not a text frame
3395
</source>
14474 cbradney 3396
        <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 3397
    </message>
3398
    <message>
14474 cbradney 3399
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="407"/>
13851 cbradney 3400
        <source>dehyphenateText([&quot;name&quot;]) -&gt; bool
3401
 
3402
Does dehyphenation on text frame &quot;name&quot;.
3403
If &quot;name&quot; is not given the currently selected item is used.
3404
 
3405
May raise WrongFrameTypeError if the target frame is not a text frame
3406
</source>
14474 cbradney 3407
        <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 3408
    </message>
3409
    <message>
14474 cbradney 3410
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="422"/>
13851 cbradney 3411
        <source>setPDFBookmark(&quot;toggle&quot;, [&quot;name&quot;])
3412
 
3413
Sets whether (toggle = 1) the text frame &quot;name&quot; is a bookmark nor not.
3414
If &quot;name&quot; is not given the currently selected item is used.
3415
 
3416
May raise WrongFrameTypeError if the target frame is not a text frame
3417
</source>
14474 cbradney 3418
        <translation type="unfinished">setPDFBookmark(&quot;toggle&quot;, [&quot;name&quot;])
13851 cbradney 3419
 
3420
Sets whether (toggle = 1) the text frame &quot;name&quot; is a bookmark nor not.
3421
If &quot;name&quot; is not given the currently selected item is used.
3422
 
3423
May raise WrongFrameTypeError if the target frame is not a text frame
3424
</translation>
3425
    </message>
3426
    <message>
14474 cbradney 3427
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="434"/>
13851 cbradney 3428
        <source>isPDFBookmark([&quot;name&quot;]) -&gt; bool
3429
 
3430
Returns true if the text frame &quot;name&quot; is a PDF bookmark.
3431
If &quot;name&quot; is not given the currently selected item is used.
3432
 
3433
May raise WrongFrameTypeError if the target frame is not a text frame
3434
</source>
14474 cbradney 3435
        <translation type="unfinished">isPDFBookmark([&quot;name&quot;]) -&gt; bool
13851 cbradney 3436
 
3437
Returns true if the text frame &quot;name&quot; is a PDF bookmark.
3438
If &quot;name&quot; is not given the currently selected item is used.
3439
 
3440
May raise WrongFrameTypeError if the target frame is not a text frame
3441
</translation>
3442
    </message>
3443
    <message>
14474 cbradney 3444
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="17"/>
13851 cbradney 3445
        <source>messagebarText(&quot;string&quot;)
3446
 
3447
Writes the &quot;string&quot; into the Scribus message bar (status line). The text
3448
must be UTF8 encoded or &apos;unicode&apos; string(recommended).
3449
</source>
14474 cbradney 3450
        <translation type="unfinished">messagebarText(&quot;string&quot;)
13851 cbradney 3451
 
3452
Writes the &quot;string&quot; into the Scribus message bar (status line). The text
3453
must be UTF8 encoded or &apos;unicode&apos; string(recommended).
3454
</translation>
3455
    </message>
3456
    <message>
14474 cbradney 3457
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="30"/>
13851 cbradney 3458
        <source>progressReset()
3459
 
3460
Cleans up the Scribus progress bar previous settings. It is called before the
3461
new progress bar use. See progressSet.
3462
</source>
14474 cbradney 3463
        <translation type="unfinished">progressReset()
13851 cbradney 3464
 
3465
Cleans up the Scribus progress bar previous settings. It is called before the
3466
new progress bar use. See progressSet.
3467
</translation>
3468
    </message>
3469
    <message>
14474 cbradney 3470
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="43"/>
13851 cbradney 3471
        <source>progressTotal(max)
3472
 
3473
Sets the progress bar&apos;s maximum steps value to the specified number.
3474
See progressSet.
3475
</source>
14474 cbradney 3476
        <translation type="unfinished">progressTotal(max)
13851 cbradney 3477
 
3478
Sets the progress bar&apos;s maximum steps value to the specified number.
3479
See progressSet.
3480
</translation>
3481
    </message>
3482
    <message>
14474 cbradney 3483
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="52"/>
13851 cbradney 3484
        <source>progressSet(nr)
3485
 
3486
Set the progress bar position to &quot;nr&quot;, a value relative to the previously set
3487
progressTotal. The progress bar uses the concept of steps; you give it the
3488
total number of steps and the number of steps completed so far and it will
3489
display the percentage of steps that have been completed. You can specify the
3490
total number of steps with progressTotal(). The current number of steps is set
3491
with progressSet(). The progress bar can be rewound to the beginning with
3492
progressReset(). [based on info taken from Trolltech&apos;s Qt docs]
3493
</source>
14474 cbradney 3494
        <translation type="unfinished">progressSet(nr)
13851 cbradney 3495
 
3496
Set the progress bar position to &quot;nr&quot;, a value relative to the previously set
3497
progressTotal. The progress bar uses the concept of steps; you give it the
3498
total number of steps and the number of steps completed so far and it will
3499
display the percentage of steps that have been completed. You can specify the
3500
total number of steps with progressTotal(). The current number of steps is set
3501
with progressSet(). The progress bar can be rewound to the beginning with
3502
progressReset(). [based on info taken from Trolltech&apos;s Qt docs]
3503
</translation>
3504
    </message>
3505
    <message>
14474 cbradney 3506
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="66"/>
13851 cbradney 3507
        <source>setCursor()
3508
 
3509
[UNSUPPORTED!] This might break things, so steer clear for now.
3510
</source>
14474 cbradney 3511
        <translation type="unfinished">setCursor()
13851 cbradney 3512
 
3513
[UNSUPPORTED!] This might break things, so steer clear for now.
3514
</translation>
3515
    </message>
3516
    <message>
14474 cbradney 3517
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="78"/>
13851 cbradney 3518
        <source>docChanged(bool)
3519
 
3520
Enable/disable save icon in the Scribus icon bar and the Save menu item. It&apos;s
3521
useful to call this procedure when you&apos;re changing the document, because Scribus
3522
won&apos;t automatically notice when you change the document using a script.
3523
</source>
14474 cbradney 3524
        <translation type="unfinished">docChanged(bool)
13851 cbradney 3525
 
3526
Enable/disable save icon in the Scribus icon bar and the Save menu item. It&apos;s
3527
useful to call this procedure when you&apos;re changing the document, because Scribus
3528
won&apos;t automatically notice when you change the document using a script.
3529
</translation>
3530
    </message>
3531
    <message>
14474 cbradney 3532
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="91"/>
13851 cbradney 3533
        <source>zoomDocument(double)
3534
 
3535
Zoom the document in main GUI window. Actions have whole number
3536
values like 20.0, 100.0, etc. Zoom to Fit uses -100 as a marker.
3537
</source>
14474 cbradney 3538
        <translation type="unfinished">zoomDocument(double)
13851 cbradney 3539
 
3540
Zoom the document in main GUI window. Actions have whole number
3541
values like 20.0, 100.0, etc. Zoom to Fit uses -100 as a marker.
3542
</translation>
3543
    </message>
3544
    <message>
14474 cbradney 3545
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="103"/>
13851 cbradney 3546
        <source>scrollDocument(x,y)
3547
 
3548
Scroll the document in main GUI window by x and y.
3549
</source>
14474 cbradney 3550
        <translation type="unfinished">scrollDocument(x,y)Scroll the document in main GUI window by x and y.</translation>
13851 cbradney 3551
    </message>
3552
    <message>
14474 cbradney 3553
        <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="15"/>
15099 cbradney 3554
        <source>placeVectorFile(&quot;filename&quot;, x, y)
3555
 
3556
Places the Vectorgrapics &quot;filename&quot; onto the current page,
3557
x and y specify the coordinate of the topleft corner of the graphic placed on the page
3558
 
3559
If loading was successful, the selection contains the imported grapic
3560
</source>
3561
        <translation type="unfinished"></translation>
3562
    </message>
3563
    <message>
3564
        <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="27"/>
13851 cbradney 3565
        <source>placeSVG(&quot;filename&quot;, x, y)
3566
 
3567
Places the SVG &quot;filename&quot; onto the current page,
3568
x and y specify the coordinate of the topleft corner of the SVG placed on the page
3569
 
3570
If loading was successful, the selection contains the imported SVG
3571
</source>
14474 cbradney 3572
        <translation type="unfinished">placeSVG(&quot;filename&quot;, x, y)
13851 cbradney 3573
 
3574
Places the SVG &quot;filename&quot; onto the current page,
3575
x and y specify the coordinate of the topleft corner of the SVG placed on the page
3576
 
3577
If loading was successful, the selection contains the imported SVG
3578
</translation>
3579
    </message>
3580
    <message>
15099 cbradney 3581
        <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="39"/>
13851 cbradney 3582
        <source>placeEPS(&quot;filename&quot;, x, y)
3583
 
3584
Places the EPS &quot;filename&quot; onto the current page,
3585
x and y specify the coordinate of the topleft corner of the EPS placed on the page
3586
 
3587
If loading was successful, the selection contains the imported EPS
3588
</source>
14474 cbradney 3589
        <translation type="unfinished">placeEPS(&quot;filename&quot;, x, y)
13851 cbradney 3590
 
3591
Places the EPS &quot;filename&quot; onto the current page,
3592
x and y specify the coordinate of the topleft corner of the EPS placed on the page
3593
 
3594
If loading was successful, the selection contains the imported EPS
3595
</translation>
3596
    </message>
3597
    <message>
15099 cbradney 3598
        <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="51"/>
13851 cbradney 3599
        <source>placeSXD(&quot;filename&quot;, x, y)
3600
 
3601
Places the SXD &quot;filename&quot; onto the current page,
3602
x and y specify the coordinate of the topleft corner of the SXD placed on the page
3603
 
3604
If loading was successful, the selection contains the imported SXD
3605
</source>
14474 cbradney 3606
        <translation type="unfinished">placeSXD(&quot;filename&quot;, x, y)
13851 cbradney 3607
 
3608
Places the SXD &quot;filename&quot; onto the current page,
3609
x and y specify the coordinate of the topleft corner of the SXD placed on the page
3610
 
3611
If loading was successful, the selection contains the imported SXD
3612
</translation>
3613
    </message>
3614
    <message>
15099 cbradney 3615
        <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="63"/>
13851 cbradney 3616
        <source>placeODG(&quot;filename&quot;, x, y)
3617
 
3618
Places the ODG &quot;filename&quot; onto the current page,
3619
x and y specify the coordinate of the topleft corner of the ODG placed on the page
3620
 
3621
If loading was successful, the selection contains the imported ODG
3622
</source>
14474 cbradney 3623
        <translation type="unfinished">placeODG(&quot;filename&quot;, x, y)
13851 cbradney 3624
 
3625
Places the ODG &quot;filename&quot; onto the current page,
3626
x and y specify the coordinate of the topleft corner of the ODG placed on the page
3627
 
3628
If loading was successful, the selection contains the imported ODG
3629
</translation>
3630
    </message>
3631
</context>
3632
<context>
3633
    <name>@default</name>
3634
    <message>
3635
        <source>getColorNames() -&gt; list
3636
 
3637
Returns a list containing the names of all defined colors in the document.
3638
If no document is open, returns a list of the default document colors.
3639
</source>
3640
        <translation type="obsolete">getColorNames() -&gt; list
3641
 
3642
Returns a list containing the names of all defined colours in the document.
3643
If no document is open, returns a list of the default document colours.
3644
</translation>
3645
    </message>
3646
    <message>
3647
        <source>newDocDialog() -&gt; bool
3648
 
3649
Displays the &quot;New Document&quot; dialog box. Creates a new document if the user
3650
accepts the settings. Does not create a document if the user presses cancel.
3651
Returns true if a new document was created.
3652
</source>
3653
        <translation type="obsolete">newDocDialog() -&gt; bool
3654
 
3655
Displays the &quot;New Document&quot; dialog box. Creates a new document if the user
3656
accepts the settings. Does not create a document if the user presses cancel.
3657
Returns true if a new document was created.
3658
</translation>
3659
    </message>
3660
    <message>
3661
        <source>getFillColor([&quot;name&quot;]) -&gt; string
3662
 
3663
Returns the name of the fill color of the object &quot;name&quot;.
3664
If &quot;name&quot; is not given the currently selected item is used.
3665
</source>
3666
        <translation type="obsolete">getFillColor([&quot;name&quot;]) -&gt; string
3667
 
3668
Returns the name of the fill colour of the object &quot;name&quot;.
3669
If &quot;name&quot; is not given the currently selected item is used.
3670
</translation>
3671
    </message>
3672
    <message>
3673
        <source>moveObject(dx, dy [, &quot;name&quot;])
3674
 
3675
Moves the object &quot;name&quot; by dx and dy relative to its current position. The
3676
distances are expressed in the current measurement unit of the document (see
3677
UNIT constants). If &quot;name&quot; is not given the currently selected item is used.
3678
If the object &quot;name&quot; belongs to a group, the whole group is moved.
3679
</source>
3680
        <translation type="obsolete">moveObject(dx, dy [, &quot;name&quot;])
3681
 
3682
Moves the object &quot;name&quot; by dx and dy relative to its current position. The
3683
distances are expressed in the current measurement unit of the document (see
3684
UNIT constants). If &quot;name&quot; is not given the currently selected item is used.
3685
If the object &quot;name&quot; belongs to a group, the whole group is moved.
3686
</translation>
3687
    </message>
3688
    <message>
3689
        <source>setRedraw(bool)
3690
 
3691
Disables page redraw when bool = False, otherwise redrawing is enabled.
3692
This change will persist even after the script exits, so make sure to call
3693
setRedraw(True) in a finally: clause at the top level of your script.
3694
</source>
3695
        <translation type="obsolete">setRedraw(bool)
3696
 
3697
Disables page redraw when bool = False, otherwise redrawing is enabled.
3698
This change will persist even after the script exits, so make sure to call
3699
setRedraw(True) in a finally: clause at the top level of your script.
3700
</translation>
3701
    </message>
3702
    <message>
3703
        <source>createRect(x, y, width, height, [&quot;name&quot;]) -&gt; string
3704
 
3705
Creates a new rectangle on the current page and returns its name. The
3706
coordinates are given in the current measurement units of the document
3707
(see UNIT constants). &quot;name&quot; should be a unique identifier for the object
3708
because you need this name to reference that object in future. If &quot;name&quot;
3709
is not given Scribus will create one for you.
3710
 
3711
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
3712
</source>
3713
        <translation type="obsolete">createRect(x, y, width, height, [&quot;name&quot;]) -&gt; string
3714
 
3715
Creates a new rectangle on the current page and returns its name. The
3716
coordinates are given in the current measurement units of the document
3717
(see UNIT constants). &quot;name&quot; should be a unique identifier for the object
3718
because you need this name to reference that object in future. If &quot;name&quot;
3719
is not given Scribus will create one for you.
3720
 
3721
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
3722
</translation>
3723
    </message>
3724
    <message>
3725
        <source>newPage(where [,&quot;masterpage&quot;])
3726
 
3727
Creates a new page. If &quot;where&quot; is -1 the new Page is appended to the
3728
document, otherwise the new page is inserted before &quot;where&quot;. Page numbers are
3729
counted from 1 upwards, no matter what the displayed first page number of your
3730
document is. The optional parameter &quot;masterpage&quot; specifies the name of the
3731
master page for the new page.
3732
 
3733
May raise IndexError if the page number is out of range
3734
</source>
3735
        <translation type="obsolete">newPage(where [,&quot;masterpage&quot;])
3736
 
3737
Creates a new page. If &quot;where&quot; is -1 the new Page is appended to the
3738
document, otherwise the new page is inserted before &quot;where&quot;. Page numbers are
3739
counted from 1 upwards, no matter what the displayed first page number of your
3740
document is. The optional parameter &quot;masterpage&quot; specifies the name of the
3741
master page for the new page.
3742
 
3743
May raise IndexError if the page number is out of range
3744
</translation>
3745
    </message>
3746
    <message>
3747
        <source>setGradientFill(type, &quot;color1&quot;, shade1, &quot;color2&quot;, shade2, [&quot;name&quot;])
3748
 
3749
Sets the gradient fill of the object &quot;name&quot; to type. Color descriptions are
3750
the same as for setFillColor() and setFillShade(). See the constants for
3751
available types (FILL_&lt;type&gt;).
3752
</source>
3753
        <translation type="obsolete">setGradientFill(type, &quot;colour1&quot;, shade1, &quot;colour2&quot;, shade2, [&quot;name&quot;])
3754
 
3755
Sets the gradient fill of the object &quot;name&quot; to type. Colour descriptions are
3756
the same as for setFillColor() and setFillShade(). See the constants for
3757
available types (FILL_&lt;type&gt;).
3758
</translation>
3759
    </message>
3760
    <message>
3761
        <source>getFontSize([&quot;name&quot;]) -&gt; float
3762
 
3763
Returns the font size in points for the text frame &quot;name&quot;. If this text
3764
frame has some text selected the value assigned to the first character of
3765
the selection is returned.
3766
If &quot;name&quot; is not given the currently selected item is used.
3767
</source>
3768
        <translation type="obsolete">getFontSize([&quot;name&quot;]) -&gt; float
3769
 
3770
Returns the font size in points for the text frame &quot;name&quot;. If this text
3771
frame has some text selected the value assigned to the first character of
3772
the selection is returned.
3773
If &quot;name&quot; is not given the currently selected item is used.
3774
</translation>
3775
    </message>
3776
    <message>
3777
        <source>messagebarText(&quot;string&quot;)
3778
 
3779
Writes the &quot;string&quot; into the Scribus message bar (status line). The text
3780
must be UTF8 encoded or &apos;unicode&apos; string(recommended).
3781
</source>
3782
        <translation type="obsolete">messagebarText(&quot;string&quot;)
3783
 
3784
Writes the &quot;string&quot; into the Scribus message bar (status line). The text
3785
must be UTF8 encoded or &apos;unicode&apos; string(recommended).
3786
</translation>
3787
    </message>
3788
    <message>
3789
        <source>newDocument(size, margins, orientation, firstPageNumber,
3790
                        unit, pagesType, firstPageOrder, numPages) -&gt; bool
3791
 
3792
Creates a new document and returns true if successful. The parameters have the
3793
following meaning:
3794
 
3795
size = A tuple (width, height) describing the size of the document. You can
3796
use predefined constants named PAPER_&lt;paper_type&gt; e.g. PAPER_A4 etc.
3797
 
3798
margins = A tuple (left, right, top, bottom) describing the document
3799
margins
3800
 
3801
orientation = the page orientation - constants PORTRAIT, LANDSCAPE
3802
 
3803
firstPageNumer = is the number of the first page in the document used for
3804
pagenumbering. While you&apos;ll usually want 1, it&apos;s useful to have higher
3805
numbers if you&apos;re creating a document in several parts.
3806
 
3807
unit: this value sets the measurement units used by the document. Use a
3808
predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS,
3809
UNIT_PICAS, UNIT_POINTS.
3810
 
3811
pagesType = One of the predefined constants PAGE_n. PAGE_1 is single page,
3812
PAGE_2 is for double sided documents, PAGE_3 is for 3 pages fold and
3813
PAGE_4 is 4-fold.
3814
 
3815
firstPageOrder = What is position of first page in the document.
3816
Indexed from 0 (0 = first).
3817
 
3818
numPage = Number of pages to be created.
3819
 
3820
The values for width, height and the margins are expressed in the given unit
3821
for the document. PAPER_* constants are expressed in points. If your document
3822
is not in points, make sure to account for this.
3823
 
3824
example: newDocument(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 7, UNIT_POINTS,
3825
PAGE_4, 3, 1)
3826
 
3827
May raise ScribusError if is firstPageOrder bigger than allowed by pagesType.
3828
</source>
3829
        <translation type="obsolete">newDocument(size, margins, orientation, firstPageNumber,
3830
                        unit, pagesType, firstPageOrder, numPages) -&gt; bool
3831
 
3832
Creates a new document and returns true if successful. The parameters have the
3833
following meaning:
3834
 
3835
size = A tuple (width, height) describing the size of the document. You can
3836
use predefined constants named PAPER_&lt;paper_type&gt; e.g. PAPER_A4 etc.
3837
 
3838
margins = A tuple (left, right, top, bottom) describing the document
3839
margins
3840
 
3841
orientation = the page orientation - constants PORTRAIT, LANDSCAPE
3842
 
3843
firstPageNumer = is the number of the first page in the document used for
3844
pagenumbering. While you&apos;ll usually want 1, it&apos;s useful to have higher
3845
numbers if you&apos;re creating a document in several parts.
3846
 
3847
unit: this value sets the measurement units used by the document. Use a
3848
predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS,
3849
UNIT_PICAS, UNIT_POINTS.
3850
 
3851
pagesType = One of the predefined constants PAGE_n. PAGE_1 is single page,
3852
PAGE_2 is for double sided documents, PAGE_3 is for 3 pages fold and
3853
PAGE_4 is 4-fold.
3854
 
3855
firstPageOrder = What is position of first page in the document.
3856
Indexed from 0 (0 = first).
3857
 
3858
numPage = Number of pages to be created.
3859
 
3860
The values for width, height and the margins are expressed in the given unit
3861
for the document. PAPER_* constants are expressed in points. If your document
3862
is not in points, make sure to account for this.
3863
 
3864
example: newDocument(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 7, UNIT_POINTS,
3865
PAGE_4, 3, 1)
3866
 
3867
May raise ScribusError if is firstPageOrder bigger than allowed by pagesType.
3868
</translation>
3869
    </message>
3870
    <message>
3871
        <source>placeSVG(&quot;filename&quot;, x, y)
3872
 
3873
Places the SVG &quot;filename&quot; onto the current page,
3874
x and y specify the coordinate of the topleft corner of the SVG placed on the page
3875
 
3876
If loading was successful, the selection contains the imported SVG
3877
</source>
3878
        <translation type="obsolete">placeSVG(&quot;filename&quot;, x, y)
3879
 
3880
Places the SVG &quot;filename&quot; onto the current page,
3881
x and y specify the coordinate of the topleft corner of the SVG placed on the page
3882
 
3883
If loading was successful, the selection contains the imported SVG
3884
</translation>
3885
    </message>
3886
    <message>
3887
        <source>getColor(&quot;name&quot;) -&gt; tuple
3888
 
3889
Returns a tuple (C, M, Y, K) containing the four color components of the
3890
color &quot;name&quot; from the current document. If no document is open, returns
3891
the value of the named color from the default document colors.
3892
 
3893
May raise NotFoundError if the named color wasn&apos;t found.
3894
May raise ValueError if an invalid color name is specified.
3895
</source>
3896
        <translation type="obsolete">getColor(&quot;name&quot;) -&gt; tuple
3897
 
3898
Returns a tuple (C, M, Y, K) containing the four colour components of the
3899
colour &quot;name&quot; from the current document. If no document is open, returns
3900
the value of the named colour from the default document colours.
3901
 
3902
May raise NotFoundError if the named colour wasn&apos;t found.
3903
May raise ValueError if an invalid colour name is specified.
3904
</translation>
3905
    </message>
3906
    <message>
3907
        <source>getColorAsRGB(&quot;name&quot;) -&gt; tuple
3908
 
3909
Returns a tuple (R,G,B) containing the three color components of the
3910
color &quot;name&quot; from the current document, converted to the RGB color
3911
space. If no document is open, returns the value of the named color
3912
from the default document colors.
3913
 
3914
May raise NotFoundError if the named color wasn&apos;t found.
3915
May raise ValueError if an invalid color name is specified.
3916
</source>
3917
        <translation type="obsolete">getColorAsRGB(&quot;name&quot;) -&gt; tuple
3918
 
3919
Returns a tuple (R,G,B) containing the three colour components of the
3920
colour &quot;name&quot; from the current document, converted to the RGB colour
3921
space. If no document is open, returns the value of the named colour
3922
from the default document colours.
3923
 
3924
May raise NotFoundError if the named colour wasn&apos;t found.
3925
May raise ValueError if an invalid colour name is specified.
3926
</translation>
3927
    </message>
3928
    <message>
3929
        <source>changeColor(&quot;name&quot;, c, m, y, k)
3930
 
3931
Changes the color &quot;name&quot; to the specified CMYK value. The color value is
3932
defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black.
3933
Color components should be in the range from 0 to 255.
3934