Subversion Repositories Scribus

Rev

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

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