Subversion Repositories Scribus

Rev

Rev 15243 | Details | Compare with Previous | Last modification | View Log | RSS feed

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