Subversion Repositories Scribus

Rev

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

Rev Author Line No. Line
9729 cbradney 1
<?xml version="1.0" encoding="utf-8"?>
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"/>
4759 cbradney 1080
        <source>groupObjects(list)
1135 cbradney 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.
1085
</source>
4759 cbradney 1086
        <translation type="unfinished">groupObjects(list)
4462 cbradney 1087
 
1088
Groups the objects named in &quot;list&quot; together. &quot;list&quot; must contain the names
1089
of the objects to be grouped. If &quot;list&quot; is not given the currently selected
1090
items are used.
1091
</translation>
1135 cbradney 1092
    </message>
1093
    <message>
14474 cbradney 1094
        <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="124"/>
4759 cbradney 1095
        <source>unGroupObjects(&quot;name&quot;)
1135 cbradney 1096
 
1097
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 1098
        <translation type="unfinished">unGroupObjects(&quot;name&quot;)
4462 cbradney 1099
 
1100
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 1101
    </message>
1102
    <message>
14474 cbradney 1103
        <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="132"/>
4759 cbradney 1104
        <source>scaleGroup(factor [,&quot;name&quot;])
1135 cbradney 1105
 
1106
Scales the group the object &quot;name&quot; belongs to. Values greater than 1 enlarge
1107
the group, values smaller than 1 make the group smaller e.g a value of 0.5
1108
scales the group to 50 % of its original size, a value of 1.5 scales the group
1109
to 150 % of its original size.  The value for &quot;factor&quot; must be greater than
1110
0. If &quot;name&quot; is not given the currently selected item is used.
1111
 
1112
May raise ValueError if an invalid scale factor is passed.
1113
</source>
4759 cbradney 1114
        <translation type="unfinished">scaleGroup(factor [,&quot;name&quot;])
4462 cbradney 1115
 
1116
Scales the group the object &quot;name&quot; belongs to. Values greater than 1 enlarge
1117
the group, values smaller than 1 make the group smaller e.g a value of 0.5
1118
scales the group to 50 % of its original size, a value of 1.5 scales the group
1119
to 150 % of its original size.  The value for &quot;factor&quot; must be greater than
1120
0. If &quot;name&quot; is not given the currently selected item is used.
1121
 
1122
May raise ValueError if an invalid scale factor is passed.
1123
</translation>
1135 cbradney 1124
    </message>
1125
    <message>
14474 cbradney 1126
        <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="147"/>
4759 cbradney 1127
        <source>loadImage(&quot;filename&quot; [, &quot;name&quot;])
1135 cbradney 1128
 
1129
Loads the picture &quot;picture&quot; into the image frame &quot;name&quot;. If &quot;name&quot; is
1130
not given the currently selected item is used.
1131
 
1132
May raise WrongFrameTypeError if the target frame is not an image frame
1133
</source>
4759 cbradney 1134
        <translation type="unfinished">loadImage(&quot;filename&quot; [, &quot;name&quot;])
4462 cbradney 1135
 
1136
Loads the picture &quot;picture&quot; into the image frame &quot;name&quot;. If &quot;name&quot; is
1137
not given the currently selected item is used.
1138
 
1139
May raise WrongFrameTypeError if the target frame is not an image frame
1140
</translation>
1135 cbradney 1141
    </message>
1142
    <message>
14474 cbradney 1143
        <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="159"/>
4759 cbradney 1144
        <source>scaleImage(x, y [, &quot;name&quot;])
1135 cbradney 1145
 
14474 cbradney 1146
Sets the internal scaling factors of the picture in the image frame &quot;name&quot;.
1147
If &quot;name&quot; is not given the currently selected item is used. A number of 1
1148
means 100 %. Internal scaling factors are different from the values shown on
1149
properties palette. Note : deprecated, use setImageScale() instead.
1150
 
1151
May raise WrongFrameTypeError if the target frame is not an image frame
1152
</source>
1153
        <translation type="unfinished"></translation>
1154
    </message>
1155
    <message>
1156
        <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="173"/>
1157
        <source>setImageScale(x, y [, &quot;name&quot;])
1158
 
1135 cbradney 1159
Sets the scaling factors of the picture in the image frame &quot;name&quot;.
1160
If &quot;name&quot; is not given the currently selected item is used. A number of 1
14474 cbradney 1161
means 100 %. Scaling factors are equal to the values shown on properties palette.
1162
 
1163
May raise WrongFrameTypeError if the target frame is not an image frame
1164
</source>
1165
        <translation type="unfinished"></translation>
1166
    </message>
1167
    <message>
1168
        <source>scaleImage(x, y [, &quot;name&quot;])
1169
 
1170
Sets the scaling factors of the picture in the image frame &quot;name&quot;.
1171
If &quot;name&quot; is not given the currently selected item is used. A number of 1
1135 cbradney 1172
means 100 %.
1173
 
1174
May raise WrongFrameTypeError if the target frame is not an image frame
1175
</source>
13279 cbradney 1176
        <translation type="obsolete">scaleImage(x, y [, &quot;name&quot;])
4462 cbradney 1177
 
1178
Sets the scaling factors of the picture in the image frame &quot;name&quot;.
1179
If &quot;name&quot; is not given the currently selected item is used. A number of 1
1180
means 100 %.
1181
 
1182
May raise WrongFrameTypeError if the target frame is not an image frame
1183
</translation>
1135 cbradney 1184
    </message>
1185
    <message>
14474 cbradney 1186
        <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="186"/>
4759 cbradney 1187
        <source>lockObject([&quot;name&quot;]) -&gt; bool
1135 cbradney 1188
 
4759 cbradney 1189
Locks the object &quot;name&quot; if it&apos;s unlocked or unlock it if it&apos;s locked.
1135 cbradney 1190
If &quot;name&quot; is not given the currently selected item is used. Returns true
1191
if locked.
1192
</source>
4759 cbradney 1193
        <translation type="unfinished">lockObject([&quot;name&quot;]) -&gt; bool
4462 cbradney 1194
 
4759 cbradney 1195
Locks the object &quot;name&quot; if it&apos;s unlocked or unlock it if it&apos;s locked.
4462 cbradney 1196
If &quot;name&quot; is not given the currently selected item is used. Returns true
1197
if locked.
1198
</translation>
1135 cbradney 1199
    </message>
1200
    <message>
14474 cbradney 1201
        <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="197"/>
4759 cbradney 1202
        <source>isLocked([&quot;name&quot;]) -&gt; bool
1135 cbradney 1203
 
1204
Returns true if is the object &quot;name&quot; locked.  If &quot;name&quot; is not given the
1205
currently selected item is used.
1206
</source>
4759 cbradney 1207
        <translation type="unfinished">isLocked([&quot;name&quot;]) -&gt; bool
4462 cbradney 1208
 
1209
Returns true if is the object &quot;name&quot; locked.  If &quot;name&quot; is not given the
1210
currently selected item is used.
1211
</translation>
1135 cbradney 1212
    </message>
1213
    <message>
14474 cbradney 1214
        <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="206"/>
4759 cbradney 1215
        <source>setScaleImageToFrame(scaletoframe, proportional=None, name=&lt;selection&gt;)
4462 cbradney 1216
 
4759 cbradney 1217
Sets the scale to frame on the selected or specified image frame to `scaletoframe&apos;.
1218
If `proportional&apos; is specified, set fixed aspect ratio scaling to `proportional&apos;.
1219
Both `scaletoframe&apos; and `proportional&apos; are boolean.
4462 cbradney 1220
 
1221
May raise WrongFrameTypeError.
1222
</source>
4759 cbradney 1223
        <translation type="unfinished">setScaleImageToFrame(scaletoframe, proportional=None, name=&lt;selection&gt;)
4462 cbradney 1224
 
4759 cbradney 1225
Sets the scale to frame on the selected or specified image frame to `scaletoframe&apos;.
1226
If `proportional&apos; is specified, set fixed aspect ratio scaling to `proportional&apos;.
1227
Both `scaletoframe&apos; and `proportional&apos; are boolean.
4462 cbradney 1228
 
1229
May raise WrongFrameTypeError.
1230
</translation>
1231
    </message>
1232
    <message>
14474 cbradney 1233
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="19"/>
12918 cbradney 1234
        <source>setRedraw(bool)
1235
 
1236
Disables page redraw when bool = False, otherwise redrawing is enabled.
1237
This change will persist even after the script exits, so make sure to call
1238
setRedraw(True) in a finally: clause at the top level of your script.
1239
</source>
1240
        <translation type="unfinished"></translation>
1241
    </message>
1242
    <message>
14474 cbradney 1243
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="30"/>
4759 cbradney 1244
        <source>getFontNames() -&gt; list
1135 cbradney 1245
 
1246
Returns a list with the names of all available fonts.
1247
</source>
4759 cbradney 1248
        <translation type="unfinished">getFontNames() -&gt; list
4462 cbradney 1249
 
1250
Returns a list with the names of all available fonts.
1251
</translation>
1135 cbradney 1252
    </message>
1253
    <message>
14474 cbradney 1254
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="39"/>
4759 cbradney 1255
        <source>getXFontNames() -&gt; list of tuples
1135 cbradney 1256
 
4759 cbradney 1257
Returns a larger font info. It&apos;s a list of the tuples with:
1135 cbradney 1258
[ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ]
1259
</source>
4759 cbradney 1260
        <translation type="unfinished">getXFontNames() -&gt; list of tuples
4462 cbradney 1261
 
4759 cbradney 1262
Returns a larger font info. It&apos;s a list of the tuples with:
4462 cbradney 1263
[ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ]
1264
</translation>
1135 cbradney 1265
    </message>
1266
    <message>
14474 cbradney 1267
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="52"/>
4759 cbradney 1268
        <source>renderFont(&quot;name&quot;, &quot;filename&quot;, &quot;sample&quot;, size, format=&quot;PPM&quot;) -&gt; bool
4462 cbradney 1269
 
1270
Creates an image preview of font &quot;name&quot; with given text &quot;sample&quot; and size.
1271
If &quot;filename&quot; is not &quot;&quot;, image is saved into &quot;filename&quot;. Otherwise
1272
image data is returned as a string. The optional &quot;format&quot; argument
1273
specifies the image format to generate, and supports any format allowed
1274
by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.
1275
 
4759 cbradney 1276
May raise NotFoundError if the specified font can&apos;t be found.
4462 cbradney 1277
May raise ValueError if an empty sample or filename is passed.
1278
</source>
4759 cbradney 1279
        <translation type="unfinished">renderFont(&quot;name&quot;, &quot;filename&quot;, &quot;sample&quot;, size, format=&quot;PPM&quot;) -&gt; bool
4462 cbradney 1280
 
1281
Creates an image preview of font &quot;name&quot; with given text &quot;sample&quot; and size.
1282
If &quot;filename&quot; is not &quot;&quot;, image is saved into &quot;filename&quot;. Otherwise
1283
image data is returned as a string. The optional &quot;format&quot; argument
1284
specifies the image format to generate, and supports any format allowed
1285
by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.
1286
 
4759 cbradney 1287
May raise NotFoundError if the specified font can&apos;t be found.
4462 cbradney 1288
May raise ValueError if an empty sample or filename is passed.
1289
</translation>
1290
    </message>
1291
    <message>
14474 cbradney 1292
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="68"/>
4759 cbradney 1293
        <source>getLayers() -&gt; list
1135 cbradney 1294
 
1295
Returns a list with the names of all defined layers.
1296
</source>
4759 cbradney 1297
        <translation type="unfinished">getLayers() -&gt; list
4462 cbradney 1298
 
1299
Returns a list with the names of all defined layers.
1300
</translation>
1135 cbradney 1301
    </message>
1302
    <message>
14474 cbradney 1303
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="77"/>
4759 cbradney 1304
        <source>setActiveLayer(&quot;name&quot;)
1135 cbradney 1305
 
1306
Sets the active layer to the layer named &quot;name&quot;.
1307
 
4759 cbradney 1308
May raise NotFoundError if the layer can&apos;t be found.
1309
May raise ValueError if the layer name isn&apos;t acceptable.
1135 cbradney 1310
</source>
4759 cbradney 1311
        <translation type="unfinished">setActiveLayer(&quot;name&quot;)
4462 cbradney 1312
 
1313
Sets the active layer to the layer named &quot;name&quot;.
1314
 
4759 cbradney 1315
May raise NotFoundError if the layer can&apos;t be found.
1316
May raise ValueError if the layer name isn&apos;t acceptable.
4462 cbradney 1317
</translation>
1135 cbradney 1318
    </message>
1319
    <message>
14474 cbradney 1320
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="89"/>
4759 cbradney 1321
        <source>getActiveLayer() -&gt; string
1135 cbradney 1322
 
1323
Returns the name of the current active layer.
1324
</source>
4759 cbradney 1325
        <translation type="unfinished">getActiveLayer() -&gt; string
4462 cbradney 1326
 
1327
Returns the name of the current active layer.
1328
</translation>
1135 cbradney 1329
    </message>
1330
    <message>
14474 cbradney 1331
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="98"/>
4759 cbradney 1332
        <source>sentToLayer(&quot;layer&quot; [, &quot;name&quot;])
1135 cbradney 1333
 
1334
Sends the object &quot;name&quot; to the layer &quot;layer&quot;. The layer must exist.
1335
If &quot;name&quot; is not given the currently selected item is used.
1336
 
4759 cbradney 1337
May raise NotFoundError if the layer can&apos;t be found.
1338
May raise ValueError if the layer name isn&apos;t acceptable.
1135 cbradney 1339
</source>
4759 cbradney 1340
        <translation type="unfinished">sentToLayer(&quot;layer&quot; [, &quot;name&quot;])
4462 cbradney 1341
 
1342
Sends the object &quot;name&quot; to the layer &quot;layer&quot;. The layer must exist.
1343
If &quot;name&quot; is not given the currently selected item is used.
1344
 
4759 cbradney 1345
May raise NotFoundError if the layer can&apos;t be found.
1346
May raise ValueError if the layer name isn&apos;t acceptable.
4462 cbradney 1347
</translation>
1135 cbradney 1348
    </message>
1349
    <message>
14474 cbradney 1350
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="111"/>
4759 cbradney 1351
        <source>setLayerVisible(&quot;layer&quot;, visible)
1135 cbradney 1352
 
1353
Sets the layer &quot;layer&quot; to be visible or not. If is the visible set to false
1354
the layer is invisible.
1355
 
4759 cbradney 1356
May raise NotFoundError if the layer can&apos;t be found.
1357
May raise ValueError if the layer name isn&apos;t acceptable.
1135 cbradney 1358
</source>
4759 cbradney 1359
        <translation type="unfinished">setLayerVisible(&quot;layer&quot;, visible)
4462 cbradney 1360
 
1361
Sets the layer &quot;layer&quot; to be visible or not. If is the visible set to false
1362
the layer is invisible.
1363
 
4759 cbradney 1364
May raise NotFoundError if the layer can&apos;t be found.
1365
May raise ValueError if the layer name isn&apos;t acceptable.
4462 cbradney 1366
</translation>
1135 cbradney 1367
    </message>
1368
    <message>
14474 cbradney 1369
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="124"/>
4759 cbradney 1370
        <source>setLayerPrintable(&quot;layer&quot;, printable)
1135 cbradney 1371
 
12918 cbradney 1372
Sets the layer &quot;layer&quot; to be printable or not. If is the
1373
printable set to false the layer won&apos;t be printed.
1135 cbradney 1374
 
4759 cbradney 1375
May raise NotFoundError if the layer can&apos;t be found.
1376
May raise ValueError if the layer name isn&apos;t acceptable.
1135 cbradney 1377
</source>
12918 cbradney 1378
        <translation type="unfinished"></translation>
1379
    </message>
1380
    <message>
14474 cbradney 1381
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="137"/>
12918 cbradney 1382
        <source>setLayerLocked(&quot;layer&quot;, locked)
4462 cbradney 1383
 
12918 cbradney 1384
Sets the layer &quot;layer&quot; to be locked or not. If locked is set to
1385
true the layer will be locked.
4462 cbradney 1386
 
4759 cbradney 1387
May raise NotFoundError if the layer can&apos;t be found.
1388
May raise ValueError if the layer name isn&apos;t acceptable.
12918 cbradney 1389
</source>
1390
        <translation type="unfinished"></translation>
1135 cbradney 1391
    </message>
1392
    <message>
14474 cbradney 1393
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="150"/>
12918 cbradney 1394
        <source>setLayerOutlined(&quot;layer&quot;, outline)
4462 cbradney 1395
 
12918 cbradney 1396
Sets the layer &quot;layer&quot; to be locked or not. If outline is set to
1397
true the layer will be displayed outlined.
4462 cbradney 1398
 
4759 cbradney 1399
May raise NotFoundError if the layer can&apos;t be found.
1400
May raise ValueError if the layer name isn&apos;t acceptable.
4462 cbradney 1401
</source>
12918 cbradney 1402
        <translation type="unfinished"></translation>
1403
    </message>
1404
    <message>
14474 cbradney 1405
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="163"/>
12918 cbradney 1406
        <source>setLayerFlow(&quot;layer&quot;, flow)
4462 cbradney 1407
 
12918 cbradney 1408
Sets the layers &quot;layer&quot;  flowcontrol to flow. If flow is set to
1409
true text in layers above this one will flow around objects on this layer.
1410
 
1411
May raise NotFoundError if the layer can&apos;t be found.
1412
May raise ValueError if the layer name isn&apos;t acceptable.
1413
</source>
1414
        <translation type="unfinished"></translation>
1415
    </message>
1416
    <message>
14474 cbradney 1417
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="176"/>
12918 cbradney 1418
        <source>setLayerBlendmode(&quot;layer&quot;, blend)
1419
 
1420
Sets the layers &quot;layer&quot;  blendmode to blend.
1421
 
1422
May raise NotFoundError if the layer can&apos;t be found.
1423
May raise ValueError if the layer name isn&apos;t acceptable.
1424
</source>
1425
        <translation type="unfinished"></translation>
1426
    </message>
1427
    <message>
14474 cbradney 1428
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="188"/>
12918 cbradney 1429
        <source>setLayerTransparency(&quot;layer&quot;, trans)
1430
 
1431
Sets the layers &quot;layer&quot;  transparency to trans.
1432
 
1433
May raise NotFoundError if the layer can&apos;t be found.
1434
May raise ValueError if the layer name isn&apos;t acceptable.
1435
</source>
1436
        <translation type="unfinished"></translation>
1437
    </message>
1438
    <message>
14474 cbradney 1439
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="200"/>
12918 cbradney 1440
        <source>isLayerVisible(&quot;layer&quot;) -&gt; bool
1441
 
4462 cbradney 1442
Returns whether the layer &quot;layer&quot; is visible or not, a value of True means
1443
that the layer &quot;layer&quot; is visible, a value of False means that the layer
1444
&quot;layer&quot; is invisible.
1445
 
4759 cbradney 1446
May raise NotFoundError if the layer can&apos;t be found.
1447
May raise ValueError if the layer name isn&apos;t acceptable.
12918 cbradney 1448
</source>
1449
        <translation type="unfinished"></translation>
4462 cbradney 1450
    </message>
1451
    <message>
14474 cbradney 1452
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="214"/>
4759 cbradney 1453
        <source>isLayerPrintable(&quot;layer&quot;) -&gt; bool
4462 cbradney 1454
 
1455
Returns whether the layer &quot;layer&quot; is printable or not, a value of True means
1456
that the layer &quot;layer&quot; can be printed, a value of False means that printing
1457
the layer &quot;layer&quot; is disabled.
1458
 
4759 cbradney 1459
May raise NotFoundError if the layer can&apos;t be found.
1460
May raise ValueError if the layer name isn&apos;t acceptable.
4462 cbradney 1461
</source>
4759 cbradney 1462
        <translation type="unfinished">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
</translation>
1471
    </message>
1472
    <message>
14474 cbradney 1473
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="228"/>
12918 cbradney 1474
        <source>isLayerLocked(&quot;layer&quot;) -&gt; bool
1475
 
1476
Returns whether the layer &quot;layer&quot; is locked or not, a value of True means
1477
that the layer &quot;layer&quot; is editable, a value of False means that the layer
1478
&quot;layer&quot; is locked.
1479
 
1480
May raise NotFoundError if the layer can&apos;t be found.
1481
May raise ValueError if the layer name isn&apos;t acceptable.
1482
</source>
1483
        <translation type="unfinished"></translation>
1484
    </message>
1485
    <message>
14474 cbradney 1486
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="242"/>
12918 cbradney 1487
        <source>isLayerOutlined(&quot;layer&quot;) -&gt; bool
1488
 
1489
Returns whether the layer &quot;layer&quot; is outlined or not, a value of True means
1490
that the layer &quot;layer&quot; is outlined, a value of False means that the layer
1491
&quot;layer&quot; is normal.
1492
 
1493
May raise NotFoundError if the layer can&apos;t be found.
1494
May raise ValueError if the layer name isn&apos;t acceptable.
1495
</source>
1496
        <translation type="unfinished"></translation>
1497
    </message>
1498
    <message>
14474 cbradney 1499
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="256"/>
12918 cbradney 1500
        <source>isLayerFlow(&quot;layer&quot;) -&gt; bool
1501
 
1502
Returns whether text flows around objects on layer &quot;layer&quot;, a value of True means
1503
that text flows around, a value of False means that the text does not flow around.
1504
 
1505
May raise NotFoundError if the layer can&apos;t be found.
1506
May raise ValueError if the layer name isn&apos;t acceptable.
1507
</source>
1508
        <translation type="unfinished"></translation>
1509
    </message>
1510
    <message>
14474 cbradney 1511
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="269"/>
12918 cbradney 1512
        <source>getLayerBlendmode(&quot;layer&quot;) -&gt; int
1513
 
1514
Returns the &quot;layer&quot; layer blendmode,
1515
 
1516
May raise NotFoundError if the layer can&apos;t be found.
1517
May raise ValueError if the layer name isn&apos;t acceptable.
1518
</source>
1519
        <translation type="unfinished"></translation>
1520
    </message>
1521
    <message>
14474 cbradney 1522
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="281"/>
12918 cbradney 1523
        <source>getLayerTransparency(&quot;layer&quot;) -&gt; float
1524
 
1525
Returns the &quot;layer&quot; layer transparency,
1526
 
1527
May raise NotFoundError if the layer can&apos;t be found.
1528
May raise ValueError if the layer name isn&apos;t acceptable.
1529
</source>
1530
        <translation type="unfinished"></translation>
1531
    </message>
1532
    <message>
14474 cbradney 1533
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="293"/>
4759 cbradney 1534
        <source>deleteLayer(&quot;layer&quot;)
1135 cbradney 1535
 
4759 cbradney 1536
Deletes the layer with the name &quot;layer&quot;. Nothing happens if the layer doesn&apos;t
1537
exists or if it&apos;s the only layer in the document.
1135 cbradney 1538
 
4759 cbradney 1539
May raise NotFoundError if the layer can&apos;t be found.
1540
May raise ValueError if the layer name isn&apos;t acceptable.
1135 cbradney 1541
</source>
4759 cbradney 1542
        <translation type="unfinished">deleteLayer(&quot;layer&quot;)
4462 cbradney 1543
 
4759 cbradney 1544
Deletes the layer with the name &quot;layer&quot;. Nothing happens if the layer doesn&apos;t
1545
exists or if it&apos;s the only layer in the document.
4462 cbradney 1546
 
4759 cbradney 1547
May raise NotFoundError if the layer can&apos;t be found.
1548
May raise ValueError if the layer name isn&apos;t acceptable.
4462 cbradney 1549
</translation>
1135 cbradney 1550
    </message>
1551
    <message>
14474 cbradney 1552
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="306"/>
4759 cbradney 1553
        <source>createLayer(layer)
1135 cbradney 1554
 
1555
Creates a new layer with the name &quot;name&quot;.
1556
 
4759 cbradney 1557
May raise ValueError if the layer name isn&apos;t acceptable.
1135 cbradney 1558
</source>
4759 cbradney 1559
        <translation type="unfinished">createLayer(layer)
4462 cbradney 1560
 
1561
Creates a new layer with the name &quot;name&quot;.
1562
 
4759 cbradney 1563
May raise ValueError if the layer name isn&apos;t acceptable.
4462 cbradney 1564
</translation>
1135 cbradney 1565
    </message>
1566
    <message>
14474 cbradney 1567
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="317"/>
4759 cbradney 1568
        <source>getGuiLanguage() -&gt; string
1135 cbradney 1569
 
1570
Returns a string with the -lang value.
1571
</source>
4759 cbradney 1572
        <translation type="unfinished">getGuiLanguage() -&gt; string
4462 cbradney 1573
 
1574
Returns a string with the -lang value.
1575
</translation>
1135 cbradney 1576
    </message>
1577
    <message>
14474 cbradney 1578
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="326"/>
12918 cbradney 1579
        <source>moveSelectionToFront()
1580
 
1581
Moves current selection to front.
1582
</source>
1583
        <translation type="unfinished"></translation>
1584
    </message>
1585
    <message>
14474 cbradney 1586
        <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="335"/>
12918 cbradney 1587
        <source>moveSelectionToFront()
1588
 
1589
Moves current selection to back.
1590
</source>
1591
        <translation type="unfinished"></translation>
1592
    </message>
1593
    <message>
14474 cbradney 1594
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="17"/>
12918 cbradney 1595
        <source>createRect(x, y, width, height, [&quot;name&quot;]) -&gt; string
1596
 
1597
Creates a new rectangle on the current page and returns its name. The
1598
coordinates are given in the current measurement units of the document
1599
(see UNIT constants). &quot;name&quot; should be a unique identifier for the object
1600
because you need this name to reference that object in future. If &quot;name&quot;
1601
is not given Scribus will create one for you.
1602
 
1603
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1604
</source>
1605
        <translation type="unfinished"></translation>
1606
    </message>
1607
    <message>
14474 cbradney 1608
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="34"/>
4759 cbradney 1609
        <source>createEllipse(x, y, width, height, [&quot;name&quot;]) -&gt; string
1135 cbradney 1610
 
1611
Creates a new ellipse on the current page and returns its name.
1612
The coordinates are given in the current measurement units of the document
1613
(see UNIT constants). &quot;name&quot; should be a unique identifier for the object
1614
because you need this name for further referencing of that object. If &quot;name&quot;
1615
is not given Scribus will create one for you.
1616
 
4759 cbradney 1617
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1135 cbradney 1618
</source>
4759 cbradney 1619
        <translation type="unfinished">createEllipse(x, y, width, height, [&quot;name&quot;]) -&gt; string
4462 cbradney 1620
 
1621
Creates a new ellipse on the current page and returns its name.
1622
The coordinates are given in the current measurement units of the document
1623
(see UNIT constants). &quot;name&quot; should be a unique identifier for the object
1624
because you need this name for further referencing of that object. If &quot;name&quot;
1625
is not given Scribus will create one for you.
1626
 
4759 cbradney 1627
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
4462 cbradney 1628
</translation>
1135 cbradney 1629
    </message>
1630
    <message>
14474 cbradney 1631
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="51"/>
4759 cbradney 1632
        <source>createImage(x, y, width, height, [&quot;name&quot;]) -&gt; string
1135 cbradney 1633
 
1634
Creates a new picture frame on the current page and returns its name. The
1635
coordinates are given in the current measurement units of the document.
1636
&quot;name&quot; should be a unique identifier for the object because you need this
1637
name for further access to that object. If &quot;name&quot; is not given Scribus will
1638
create one for you.
1639
 
4759 cbradney 1640
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1135 cbradney 1641
</source>
4759 cbradney 1642
        <translation type="unfinished">createImage(x, y, width, height, [&quot;name&quot;]) -&gt; string
4462 cbradney 1643
 
1644
Creates a new picture frame on the current page and returns its name. The
1645
coordinates are given in the current measurement units of the document.
1646
&quot;name&quot; should be a unique identifier for the object because you need this
1647
name for further access to that object. If &quot;name&quot; is not given Scribus will
1648
create one for you.
1649
 
4759 cbradney 1650
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
4462 cbradney 1651
</translation>
1135 cbradney 1652
    </message>
1653
    <message>
14474 cbradney 1654
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="66"/>
4759 cbradney 1655
        <source>createText(x, y, width, height, [&quot;name&quot;]) -&gt; string
1135 cbradney 1656
 
1657
Creates a new text frame on the actual page and returns its name.
1658
The coordinates are given in the actual measurement unit of the document (see
1659
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
1660
you need this name for further referencing of that object. If &quot;name&quot; is not
1661
given Scribus will create one for you.
1662
 
4759 cbradney 1663
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1135 cbradney 1664
</source>
4759 cbradney 1665
        <translation type="unfinished">createText(x, y, width, height, [&quot;name&quot;]) -&gt; string
4462 cbradney 1666
 
1667
Creates a new text frame on the actual page and returns its name.
1668
The coordinates are given in the actual measurement unit of the document (see
1669
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
1670
you need this name for further referencing of that object. If &quot;name&quot; is not
1671
given Scribus will create one for you.
1672
 
4759 cbradney 1673
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
4462 cbradney 1674
</translation>
1135 cbradney 1675
    </message>
1676
    <message>
14474 cbradney 1677
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="81"/>
4759 cbradney 1678
        <source>createLine(x1, y1, x2, y2, [&quot;name&quot;]) -&gt; string
1135 cbradney 1679
 
1680
Creates a new line from the point(x1, y1) to the point(x2, y2) and returns
1681
its name. The coordinates are given in the current measurement unit of the
1682
document (see UNIT constants). &quot;name&quot; should be a unique identifier for the
1683
object because you need this name for further access to that object. If
1684
&quot;name&quot; is not given Scribus will create one for you.
1685
 
4759 cbradney 1686
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1135 cbradney 1687
</source>
4759 cbradney 1688
        <translation type="unfinished">createLine(x1, y1, x2, y2, [&quot;name&quot;]) -&gt; string
4462 cbradney 1689
 
1690
Creates a new line from the point(x1, y1) to the point(x2, y2) and returns
1691
its name. The coordinates are given in the current measurement unit of the
1692
document (see UNIT constants). &quot;name&quot; should be a unique identifier for the
1693
object because you need this name for further access to that object. If
1694
&quot;name&quot; is not given Scribus will create one for you.
1695
 
4759 cbradney 1696
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
4462 cbradney 1697
</translation>
1135 cbradney 1698
    </message>
1699
    <message>
14474 cbradney 1700
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="96"/>
4759 cbradney 1701
        <source>createPolyLine(list, [&quot;name&quot;]) -&gt; string
1135 cbradney 1702
 
1703
Creates a new polyline and returns its name. The points for the polyline are
1704
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
1705
The coordinates are given in the current measurement units of the document (see
1706
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
1707
you need this name for further access to that object. If &quot;name&quot; is not given
1708
Scribus will create one for you.
1709
 
4759 cbradney 1710
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1135 cbradney 1711
May raise ValueError if an insufficient number of points is passed or if
4759 cbradney 1712
the number of values passed don&apos;t group into points without leftovers.
1135 cbradney 1713
</source>
4759 cbradney 1714
        <translation type="unfinished">createPolyLine(list, [&quot;name&quot;]) -&gt; string
4462 cbradney 1715
 
1716
Creates a new polyline and returns its name. The points for the polyline are
1717
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
1718
The coordinates are given in the current measurement units of the document (see
1719
UNIT constants). &quot;name&quot; should be a unique identifier for the object because
1720
you need this name for further access to that object. If &quot;name&quot; is not given
1721
Scribus will create one for you.
1722
 
4759 cbradney 1723
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
4462 cbradney 1724
May raise ValueError if an insufficient number of points is passed or if
4759 cbradney 1725
the number of values passed don&apos;t group into points without leftovers.
4462 cbradney 1726
</translation>
1135 cbradney 1727
    </message>
1728
    <message>
14474 cbradney 1729
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="114"/>
4759 cbradney 1730
        <source>createPolygon(list, [&quot;name&quot;]) -&gt; string
1135 cbradney 1731
 
1732
Creates a new polygon and returns its name. The points for the polygon are
1733
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
1734
At least three points are required. There is no need to repeat the first point
1735
to close the polygon. The polygon is automatically closed by connecting the
1736
first and the last point.  The coordinates are given in the current measurement
1737
units of the document (see UNIT constants).  &quot;name&quot; should be a unique
1738
identifier for the object because you need this name for further access to that
1739
object. If &quot;name&quot; is not given Scribus will create one for you.
1740
 
4759 cbradney 1741
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1135 cbradney 1742
May raise ValueError if an insufficient number of points is passed or if
4759 cbradney 1743
the number of values passed don&apos;t group into points without leftovers.
1135 cbradney 1744
</source>
4759 cbradney 1745
        <translation type="unfinished">createPolygon(list, [&quot;name&quot;]) -&gt; string
4462 cbradney 1746
 
1747
Creates a new polygon and returns its name. The points for the polygon are
1748
stored in the list &quot;list&quot; in the following order: [x1, y1, x2, y2...xn. yn].
1749
At least three points are required. There is no need to repeat the first point
1750
to close the polygon. The polygon is automatically closed by connecting the
1751
first and the last point.  The coordinates are given in the current measurement
1752
units of the document (see UNIT constants).  &quot;name&quot; should be a unique
1753
identifier for the object because you need this name for further access to that
1754
object. If &quot;name&quot; is not given Scribus will create one for you.
1755
 
4759 cbradney 1756
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
4462 cbradney 1757
May raise ValueError if an insufficient number of points is passed or if
4759 cbradney 1758
the number of values passed don&apos;t group into points without leftovers.
4462 cbradney 1759
</translation>
1135 cbradney 1760
    </message>
1761
    <message>
14474 cbradney 1762
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="134"/>
4759 cbradney 1763
        <source>createBezierLine(list, [&quot;name&quot;]) -&gt; string
1135 cbradney 1764
 
1765
Creates a new bezier curve and returns its name. The points for the bezier
1766
curve are stored in the list &quot;list&quot; in the following order:
1767
[x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]
1768
In the points list, x and y mean the x and y coordinates of the point and kx
1769
and ky meaning the control point for the curve.  The coordinates are given in
1770
the current measurement units of the document (see UNIT constants). &quot;name&quot;
1771
should be a unique identifier for the object because you need this name for
1772
further access to that object. If &quot;name&quot; is not given Scribus will create one
1773
for you.
1774
 
4759 cbradney 1775
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1135 cbradney 1776
May raise ValueError if an insufficient number of points is passed or if
4759 cbradney 1777
the number of values passed don&apos;t group into points without leftovers.
1135 cbradney 1778
</source>
4759 cbradney 1779
        <translation type="unfinished">createBezierLine(list, [&quot;name&quot;]) -&gt; string
4462 cbradney 1780
 
1781
Creates a new bezier curve and returns its name. The points for the bezier
1782
curve are stored in the list &quot;list&quot; in the following order:
1783
[x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]
1784
In the points list, x and y mean the x and y coordinates of the point and kx
1785
and ky meaning the control point for the curve.  The coordinates are given in
1786
the current measurement units of the document (see UNIT constants). &quot;name&quot;
1787
should be a unique identifier for the object because you need this name for
1788
further access to that object. If &quot;name&quot; is not given Scribus will create one
1789
for you.
1790
 
4759 cbradney 1791
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
4462 cbradney 1792
May raise ValueError if an insufficient number of points is passed or if
4759 cbradney 1793
the number of values passed don&apos;t group into points without leftovers.
4462 cbradney 1794
</translation>
1135 cbradney 1795
    </message>
1796
    <message>
14474 cbradney 1797
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="155"/>
4759 cbradney 1798
        <source>createPathText(x, y, &quot;textbox&quot;, &quot;beziercurve&quot;, [&quot;name&quot;]) -&gt; string
1135 cbradney 1799
 
1800
Creates a new pathText by merging the two objects &quot;textbox&quot; and
1801
&quot;beziercurve&quot; and returns its name. The coordinates are given in the current
1802
measurement unit of the document (see UNIT constants). &quot;name&quot; should be a
1803
unique identifier for the object because you need this name for further access
1804
to that object. If &quot;name&quot; is not given Scribus will create one for you.
1805
 
4759 cbradney 1806
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1807
May raise NotFoundError if one or both of the named base object don&apos;t exist.
1135 cbradney 1808
</source>
4759 cbradney 1809
        <translation type="unfinished">createPathText(x, y, &quot;textbox&quot;, &quot;beziercurve&quot;, [&quot;name&quot;]) -&gt; string
4462 cbradney 1810
 
1811
Creates a new pathText by merging the two objects &quot;textbox&quot; and
1812
&quot;beziercurve&quot; and returns its name. The coordinates are given in the current
1813
measurement unit of the document (see UNIT constants). &quot;name&quot; should be a
1814
unique identifier for the object because you need this name for further access
1815
to that object. If &quot;name&quot; is not given Scribus will create one for you.
1816
 
4759 cbradney 1817
May raise NameExistsError if you explicitly pass a name that&apos;s already used.
1818
May raise NotFoundError if one or both of the named base object don&apos;t exist.
4462 cbradney 1819
</translation>
1135 cbradney 1820
    </message>
1821
    <message>
14474 cbradney 1822
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="173"/>
4759 cbradney 1823
        <source>deleteObject([&quot;name&quot;])
1135 cbradney 1824
 
1825
Deletes the item with the name &quot;name&quot;. If &quot;name&quot; is not given the currently
1826
selected item is deleted.
1827
</source>
4759 cbradney 1828
        <translation type="unfinished">deleteObject([&quot;name&quot;])
4462 cbradney 1829
 
1830
Deletes the item with the name &quot;name&quot;. If &quot;name&quot; is not given the currently
1831
selected item is deleted.
1832
</translation>
1135 cbradney 1833
    </message>
1834
    <message>
14474 cbradney 1835
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="184"/>
12918 cbradney 1836
        <source>textFlowMode(&quot;name&quot; [, state])
1135 cbradney 1837
 
1838
Enables/disables &quot;Text Flows Around Frame&quot; feature for object &quot;name&quot;.
12918 cbradney 1839
Called with parameters string name and optional int &quot;state&quot; (0 &lt;= state &lt;= 3).
1840
Setting &quot;state&quot; to 0 will disable text flow.
1841
Setting &quot;state&quot; to 1 will make text flow around object frame.
1842
Setting &quot;state&quot; to 2 will make text flow around bounding box.
1843
Setting &quot;state&quot; to 3 will make text flow around contour line.
1844
If &quot;state&quot; is not passed, text flow is toggled.
1135 cbradney 1845
</source>
12918 cbradney 1846
        <translation type="unfinished"></translation>
1135 cbradney 1847
    </message>
1848
    <message>
14474 cbradney 1849
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="206"/>
4759 cbradney 1850
        <source>objectExists([&quot;name&quot;]) -&gt; bool
1135 cbradney 1851
 
1852
Test if an object with specified name really exists in the document.
1853
The optional parameter is the object name. When no object name is given,
1854
returns True if there is something selected.
1855
</source>
4759 cbradney 1856
        <translation type="unfinished">objectExists([&quot;name&quot;]) -&gt; bool
4462 cbradney 1857
 
1858
Test if an object with specified name really exists in the document.
1859
The optional parameter is the object name. When no object name is given,
1860
returns True if there is something selected.
1861
</translation>
1135 cbradney 1862
    </message>
1863
    <message>
14474 cbradney 1864
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="223"/>
4759 cbradney 1865
        <source>setStyle(&quot;style&quot; [, &quot;name&quot;])
1135 cbradney 1866
 
14474 cbradney 1867
Apply the named &quot;style&quot; to the object named &quot;name&quot;. If object name is
1868
given, style is applied to the current text selection in object &quot;name&quot;.
1869
If no object name is given, style is applied on selected object.
1870
</source>
1871
        <translation type="unfinished"></translation>
1872
    </message>
1873
    <message>
1874
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="250"/>
1875
        <source>duplicateObject([&quot;name&quot;]) -&gt; string
1876
 
1877
creates a Duplicate of the selected Object (or Selection Group).
1878
</source>
1879
        <translation type="unfinished"></translation>
1880
    </message>
1881
    <message>
1882
        <source>setStyle(&quot;style&quot; [, &quot;name&quot;])
1883
 
1135 cbradney 1884
Apply the named &quot;style&quot; to the object named &quot;name&quot;. If is no object name
4759 cbradney 1885
given, it&apos;s applied on the selected object.
1135 cbradney 1886
</source>
14474 cbradney 1887
        <translation type="obsolete">setStyle(&quot;style&quot; [, &quot;name&quot;])
4462 cbradney 1888
 
1889
Apply the named &quot;style&quot; to the object named &quot;name&quot;. If is no object name
4759 cbradney 1890
given, it&apos;s applied on the selected object.
4462 cbradney 1891
</translation>
1135 cbradney 1892
    </message>
1893
    <message>
14474 cbradney 1894
        <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="238"/>
4759 cbradney 1895
        <source>getAllStyles() -&gt; list
1135 cbradney 1896
 
1897
Return a list of the names of all paragraph styles in the current document.
1898
</source>
4759 cbradney 1899
        <translation type="unfinished">getAllStyles() -&gt; list
4462 cbradney 1900
 
1901
Return a list of the names of all paragraph styles in the current document.
1902
</translation>
1135 cbradney 1903
    </message>
1904
    <message>
14474 cbradney 1905
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="17"/>
12918 cbradney 1906
        <source>newPage(where [,&quot;masterpage&quot;])
1907
 
1908
Creates a new page. If &quot;where&quot; is -1 the new Page is appended to the
1909
document, otherwise the new page is inserted before &quot;where&quot;. Page numbers are
1910
counted from 1 upwards, no matter what the displayed first page number of your
1911
document is. The optional parameter &quot;masterpage&quot; specifies the name of the
1912
master page for the new page.
1913
 
1914
May raise IndexError if the page number is out of range
1915
</source>
1916
        <translation type="unfinished"></translation>
1917
    </message>
1918
    <message>
14474 cbradney 1919
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="32"/>
4759 cbradney 1920
        <source>currentPage() -&gt; integer
1135 cbradney 1921
 
1922
Returns the number of the current working page. Page numbers are counted from 1
1923
upwards, no matter what the displayed first page number of your document is.
1924
</source>
4759 cbradney 1925
        <translation type="unfinished">currentPage() -&gt; integer
4462 cbradney 1926
 
1927
Returns the number of the current working page. Page numbers are counted from 1
1928
upwards, no matter what the displayed first page number of your document is.
1929
</translation>
1135 cbradney 1930
    </message>
1931
    <message>
14474 cbradney 1932
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="42"/>
4759 cbradney 1933
        <source>redrawAll()
1135 cbradney 1934
 
1935
Redraws all pages.
1936
</source>
4759 cbradney 1937
        <translation type="unfinished">redrawAll()
4462 cbradney 1938
 
1939
Redraws all pages.
1940
</translation>
1135 cbradney 1941
    </message>
1942
    <message>
14474 cbradney 1943
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="51"/>
12918 cbradney 1944
        <source>getPageType() -&gt; integer
1945
 
1946
Returns the type of the Page, 0 means left Page, 1 is a middle Page and 2 is a right Page
1947
</source>
1948
        <translation type="unfinished"></translation>
1949
    </message>
1950
    <message>
14474 cbradney 1951
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="60"/>
4759 cbradney 1952
        <source>savePageAsEPS(&quot;name&quot;)
1135 cbradney 1953
 
1954
Saves the current page as an EPS to the file &quot;name&quot;.
1955
 
1956
May raise ScribusError if the save failed.
1957
</source>
4759 cbradney 1958
        <translation type="unfinished">savePageAsEPS(&quot;name&quot;)
4462 cbradney 1959
 
1960
Saves the current page as an EPS to the file &quot;name&quot;.
1961
 
1962
May raise ScribusError if the save failed.
1963
</translation>
1135 cbradney 1964
    </message>
1965
    <message>
14474 cbradney 1966
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="71"/>
4759 cbradney 1967
        <source>deletePage(nr)
1135 cbradney 1968
 
1969
Deletes the given page. Does nothing if the document contains only one page.
1970
Page numbers are counted from 1 upwards, no matter what the displayed first
1971
page number is.
1972
 
1973
May raise IndexError if the page number is out of range
1974
</source>
4759 cbradney 1975
        <translation type="unfinished">deletePage(nr)
4462 cbradney 1976
 
1977
Deletes the given page. Does nothing if the document contains only one page.
1978
Page numbers are counted from 1 upwards, no matter what the displayed first
1979
page number is.
1980
 
1981
May raise IndexError if the page number is out of range
1982
</translation>
1135 cbradney 1983
    </message>
1984
    <message>
14474 cbradney 1985
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="84"/>
4759 cbradney 1986
        <source>gotoPage(nr)
1135 cbradney 1987
 
1988
Moves to the page &quot;nr&quot; (that is, makes the current page &quot;nr&quot;). Note that
12918 cbradney 1989
gotoPage doesn&apos;t (currently) change the page the user&apos;s view is displaying, it
1135 cbradney 1990
just sets the page that script commands will operates on.
1991
 
1992
May raise IndexError if the page number is out of range.
1993
</source>
12918 cbradney 1994
        <translation type="unfinished"></translation>
1135 cbradney 1995
    </message>
1996
    <message>
14474 cbradney 1997
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="97"/>
4759 cbradney 1998
        <source>pageCount() -&gt; integer
1135 cbradney 1999
 
2000
Returns the number of pages in the document.
2001
</source>
4759 cbradney 2002
        <translation type="unfinished">pageCount() -&gt; integer
4462 cbradney 2003
 
2004
Returns the number of pages in the document.
2005
</translation>
1135 cbradney 2006
    </message>
2007
    <message>
14474 cbradney 2008
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="106"/>
4759 cbradney 2009
        <source>getHGuides() -&gt; list
1135 cbradney 2010
 
2011
Returns a list containing positions of the horizontal guides. Values are in the
4759 cbradney 2012
document&apos;s current units - see UNIT_&lt;type&gt; constants.
1135 cbradney 2013
</source>
4759 cbradney 2014
        <translation type="unfinished">getHGuides() -&gt; list
4462 cbradney 2015
 
2016
Returns a list containing positions of the horizontal guides. Values are in the
4759 cbradney 2017
document&apos;s current units - see UNIT_&lt;type&gt; constants.
4462 cbradney 2018
</translation>
1135 cbradney 2019
    </message>
2020
    <message>
14474 cbradney 2021
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="116"/>
4759 cbradney 2022
        <source>setHGuides(list)
1135 cbradney 2023
 
2024
Sets horizontal guides. Input parameter must be a list of guide positions
4759 cbradney 2025
measured in the current document units - see UNIT_&lt;type&gt; constants.
1135 cbradney 2026
 
2027
Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost
2028
         setHGuides([90,250]) # replace current guides entirely
2029
</source>
4759 cbradney 2030
        <translation type="unfinished">setHGuides(list)
4462 cbradney 2031
 
2032
Sets horizontal guides. Input parameter must be a list of guide positions
4759 cbradney 2033
measured in the current document units - see UNIT_&lt;type&gt; constants.
4462 cbradney 2034
 
2035
Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost
2036
         setHGuides([90,250]) # replace current guides entirely
2037
</translation>
1135 cbradney 2038
    </message>
2039
    <message>
14474 cbradney 2040
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="129"/>
4759 cbradney 2041
        <source>getVGuides()
1135 cbradney 2042
 
2043
See getHGuides.
2044
</source>
4759 cbradney 2045
        <translation type="unfinished">getVGuides()
4462 cbradney 2046
 
2047
See getHGuides.
2048
</translation>
1135 cbradney 2049
    </message>
2050
    <message>
14474 cbradney 2051
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="138"/>
4759 cbradney 2052
        <source>setVGuides()
1135 cbradney 2053
 
2054
See setHGuides.
2055
</source>
4759 cbradney 2056
        <translation type="unfinished">setVGuides()
4462 cbradney 2057
 
2058
See setHGuides.
2059
</translation>
1135 cbradney 2060
    </message>
2061
    <message>
14474 cbradney 2062
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="147"/>
4759 cbradney 2063
        <source>getPageSize() -&gt; tuple
1135 cbradney 2064
 
4759 cbradney 2065
Returns a tuple with page dimensions measured in the document&apos;s current units.
2066
See UNIT_&lt;type&gt; constants and getPageMargins()
1135 cbradney 2067
</source>
4759 cbradney 2068
        <translation type="unfinished">getPageSize() -&gt; tuple
4462 cbradney 2069
 
4759 cbradney 2070
Returns a tuple with page dimensions measured in the document&apos;s current units.
2071
See UNIT_&lt;type&gt; constants and getPageMargins()
4462 cbradney 2072
</translation>
1135 cbradney 2073
    </message>
2074
    <message>
14474 cbradney 2075
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="161"/>
2076
        <source>getPageNSize() -&gt; tuple
2077
 
2078
Returns a tuple with a particular page&apos;s size measured in the document&apos;s current units.
2079
See UNIT_&lt;type&gt; constants and getPageMargins()
2080
</source>
2081
        <translation type="unfinished"></translation>
2082
    </message>
2083
    <message>
2084
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="174"/>
2085
        <source>getPageNMargins() -&gt; tuple
2086
 
2087
Returns a tuple with a particular page&apos;s margins 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="187"/>
4759 cbradney 2094
        <source>getPageItems() -&gt; list
1135 cbradney 2095
 
2096
Returns a list of tuples with items on the current page. The tuple is:
4759 cbradney 2097
(name, objectType, order) E.g. [(&apos;Text1&apos;, 4, 0), (&apos;Image1&apos;, 2, 1)]
2098
means that object named &apos;Text1&apos; is a text frame (type 4) and is the first at
1135 cbradney 2099
the page...
2100
</source>
4759 cbradney 2101
        <translation type="unfinished">getPageItems() -&gt; list
4462 cbradney 2102
 
2103
Returns a list of tuples with items on the current page. The tuple is:
4759 cbradney 2104
(name, objectType, order) E.g. [(&apos;Text1&apos;, 4, 0), (&apos;Image1&apos;, 2, 1)]
2105
means that object named &apos;Text1&apos; is a text frame (type 4) and is the first at
4462 cbradney 2106
the page...
2107
</translation>
1135 cbradney 2108
    </message>
2109
    <message>
14474 cbradney 2110
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="203"/>
4759 cbradney 2111
        <source>getPageMargins()
4462 cbradney 2112
 
2113
Returns the page margins as a (top, left, right, bottom) tuple in the current
4759 cbradney 2114
units. See UNIT_&lt;type&gt; constants and getPageSize().
4462 cbradney 2115
</source>
4759 cbradney 2116
        <translation type="unfinished">getPageMargins()
4462 cbradney 2117
 
2118
Returns the page margins as a (top, left, right, bottom) tuple in the current
4759 cbradney 2119
units. See UNIT_&lt;type&gt; constants and getPageSize().
4462 cbradney 2120
</translation>
2121
    </message>
2122
    <message>
14474 cbradney 2123
        <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="216"/>
12918 cbradney 2124
        <source>importPage(&quot;fromDoc&quot;, (pageList), [create, imortwhere, importwherePage])
2125
 
2126
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.
2127
fromDoc: string; the filename of the document to import pages from
2128
pageList: tuple with page numbers of pages to import
2129
create: number; 0 to replace existing pages, 1 (default) to insert new pages
2130
importWhere: number; the page number (of the current document) at which import the pages
2131
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
2132
</source>
2133
        <translation type="unfinished"></translation>
2134
    </message>
2135
    <message>
14474 cbradney 2136
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="17"/>
12918 cbradney 2137
        <source>setGradientFill(type, &quot;color1&quot;, shade1, &quot;color2&quot;, shade2, [&quot;name&quot;])
2138
 
2139
Sets the gradient fill of the object &quot;name&quot; to type. Color descriptions are
2140
the same as for setFillColor() and setFillShade(). See the constants for
2141
available types (FILL_&lt;type&gt;).
2142
</source>
2143
        <translation type="unfinished"></translation>
2144
    </message>
2145
    <message>
14474 cbradney 2146
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="28"/>
2147
        <source>setGradientStop(&quot;color&quot;, shade, opacity, ramppoint, [&quot;name&quot;])
2148
 
2149
Set or add a gradient stop to the gradient fill of the object &quot;name&quot; at position ramppoint.
2150
Color descriptions are the same as for setFillColor() and setFillShade(). setGradientFill()
2151
must have been called previously for the gradient fill to be visible.
2152
</source>
2153
        <translation type="unfinished"></translation>
2154
    </message>
2155
    <message>
2156
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="39"/>
4759 cbradney 2157
        <source>setFillColor(&quot;color&quot;, [&quot;name&quot;])
1135 cbradney 2158
 
2159
Sets the fill color of the object &quot;name&quot; to the color &quot;color&quot;. &quot;color&quot;
2160
is the name of one of the defined colors. If &quot;name&quot; is not given the
2161
currently selected item is used.
2162
</source>
12918 cbradney 2163
        <translation type="unfinished">setFillColor(&quot;color&quot;, [&quot;name&quot;])
4462 cbradney 2164
 
2165
Sets the fill colour of the object &quot;name&quot; to the colour &quot;color&quot;. &quot;color&quot;
2166
is the name of one of the defined colours. If &quot;name&quot; is not given the
2167
currently selected item is used.
2168
</translation>
1135 cbradney 2169
    </message>
2170
    <message>
14474 cbradney 2171
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="50"/>
12918 cbradney 2172
        <source>setFillTransparency(transparency, [&quot;name&quot;])
2173
 
2174
Sets the fill transparency of the object &quot;name&quot; to transparency
2175
If &quot;name&quot; is not given the currently selected item is used.
2176
</source>
2177
        <translation type="unfinished"></translation>
2178
    </message>
2179
    <message>
14474 cbradney 2180
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="60"/>
12918 cbradney 2181
        <source>setFillBlendmode(blendmode, [&quot;name&quot;])
2182
 
2183
Sets the fill blendmode of the object &quot;name&quot; to blendmode
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="70"/>
4759 cbradney 2190
        <source>setLineColor(&quot;color&quot;, [&quot;name&quot;])
1135 cbradney 2191
 
2192
Sets the line color of the object &quot;name&quot; to the color &quot;color&quot;. If &quot;name&quot;
2193
is not given the currently selected item is used.
2194
</source>
12918 cbradney 2195
        <translation type="unfinished">setLineColor(&quot;color&quot;, [&quot;name&quot;])
4462 cbradney 2196
 
2197
Sets the line colour of the object &quot;name&quot; to the colour &quot;color&quot;. If &quot;name&quot;
2198
is not given the currently selected item is used.
2199
</translation>
1135 cbradney 2200
    </message>
2201
    <message>
14474 cbradney 2202
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="80"/>
12918 cbradney 2203
        <source>setLineTransparency(transparency, [&quot;name&quot;])
2204
 
2205
Sets the line transparency of the object &quot;name&quot; to transparency
2206
If &quot;name&quot; is not given the currently selected item is used.
2207
</source>
2208
        <translation type="unfinished"></translation>
2209
    </message>
2210
    <message>
14474 cbradney 2211
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="90"/>
12918 cbradney 2212
        <source>setLineBlendmode(blendmode, [&quot;name&quot;])
2213
 
2214
Sets the line blendmode of the object &quot;name&quot; to blendmode
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="100"/>
4759 cbradney 2221
        <source>setLineWidth(width, [&quot;name&quot;])
1135 cbradney 2222
 
2223
Sets line width of the object &quot;name&quot; to &quot;width&quot;. &quot;width&quot; must be in the
2224
range from 0.0 to 12.0 inclusive, and is measured in points. If &quot;name&quot; is not
2225
given the currently selected item is used.
2226
 
2227
May raise ValueError if the line width is out of bounds.
2228
</source>
4759 cbradney 2229
        <translation type="unfinished">setLineWidth(width, [&quot;name&quot;])
4462 cbradney 2230
 
2231
Sets line width of the object &quot;name&quot; to &quot;width&quot;. &quot;width&quot; must be in the
2232
range from 0.0 to 12.0 inclusive, and is measured in points. If &quot;name&quot; is not
2233
given the currently selected item is used.
2234
 
2235
May raise ValueError if the line width is out of bounds.
2236
</translation>
1135 cbradney 2237
    </message>
2238
    <message>
14474 cbradney 2239
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="113"/>
4759 cbradney 2240
        <source>setLineShade(shade, [&quot;name&quot;])
1135 cbradney 2241
 
2242
Sets the shading of the line color of the object &quot;name&quot; to &quot;shade&quot;.
2243
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
2244
(full color intensity). If &quot;name&quot; is not given the currently selected item
2245
is used.
2246
 
2247
May raise ValueError if the line shade is out of bounds.
2248
</source>
12918 cbradney 2249
        <translation type="unfinished">setLineShade(shade, [&quot;name&quot;])
4462 cbradney 2250
 
2251
Sets the shading of the line colour 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 colour 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
</translation>
1135 cbradney 2258
    </message>
2259
    <message>
14474 cbradney 2260
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="127"/>
4759 cbradney 2261
        <source>setLineJoin(join, [&quot;name&quot;])
1135 cbradney 2262
 
2263
Sets the line join style of the object &quot;name&quot; to the style &quot;join&quot;.
2264
If &quot;name&quot; is not given the currently selected item is used. There are
4759 cbradney 2265
predefined constants for join - JOIN_&lt;type&gt;.
1135 cbradney 2266
</source>
4759 cbradney 2267
        <translation type="unfinished">setLineJoin(join, [&quot;name&quot;])
4462 cbradney 2268
 
2269
Sets the line join style of the object &quot;name&quot; to the style &quot;join&quot;.
2270
If &quot;name&quot; is not given the currently selected item is used. There are
4759 cbradney 2271
predefined constants for join - JOIN_&lt;type&gt;.
4462 cbradney 2272
</translation>
1135 cbradney 2273
    </message>
2274
    <message>
14474 cbradney 2275
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="138"/>
4759 cbradney 2276
        <source>setLineEnd(endtype, [&quot;name&quot;])
1135 cbradney 2277
 
2278
Sets the line cap style of the object &quot;name&quot; to the style &quot;cap&quot;.
2279
If &quot;name&quot; is not given the currently selected item is used. There are
4759 cbradney 2280
predefined constants for &quot;cap&quot; - CAP_&lt;type&gt;.
1135 cbradney 2281
</source>
4759 cbradney 2282
        <translation type="unfinished">setLineEnd(endtype, [&quot;name&quot;])
4462 cbradney 2283
 
2284
Sets the line cap style of the object &quot;name&quot; to the style &quot;cap&quot;.
2285
If &quot;name&quot; is not given the currently selected item is used. There are
4759 cbradney 2286
predefined constants for &quot;cap&quot; - CAP_&lt;type&gt;.
4462 cbradney 2287
</translation>
1135 cbradney 2288
    </message>
2289
    <message>
14474 cbradney 2290
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="149"/>
4759 cbradney 2291
        <source>setLineStyle(style, [&quot;name&quot;])
1135 cbradney 2292
 
2293
Sets the line style of the object &quot;name&quot; to the style &quot;style&quot;. If &quot;name&quot;
2294
is not given the currently selected item is used. There are predefined
4759 cbradney 2295
constants for &quot;style&quot; - LINE_&lt;style&gt;.
1135 cbradney 2296
</source>
4759 cbradney 2297
        <translation type="unfinished">setLineStyle(style, [&quot;name&quot;])
4462 cbradney 2298
 
2299
Sets the line style of the object &quot;name&quot; to the style &quot;style&quot;. If &quot;name&quot;
2300
is not given the currently selected item is used. There are predefined
4759 cbradney 2301
constants for &quot;style&quot; - LINE_&lt;style&gt;.
4462 cbradney 2302
</translation>
1135 cbradney 2303
    </message>
2304
    <message>
14474 cbradney 2305
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="160"/>
4759 cbradney 2306
        <source>setFillShade(shade, [&quot;name&quot;])
1135 cbradney 2307
 
2308
Sets the shading of the fill color of the object &quot;name&quot; to &quot;shade&quot;.
2309
&quot;shade&quot; must be an integer value in the range from 0 (lightest) to 100
2310
(full Color intensity). If &quot;name&quot; is not given the currently selected
2311
Item is used.
2312
 
2313
May raise ValueError if the fill shade is out of bounds.
2314
</source>
12918 cbradney 2315
        <translation type="unfinished">setFillShade(shade, [&quot;name&quot;])
4462 cbradney 2316
 
2317
Sets the shading of the fill colour 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 Colour 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
</translation>
1135 cbradney 2324
    </message>
2325
    <message>
14474 cbradney 2326
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="174"/>
4759 cbradney 2327
        <source>setCornerRadius(radius, [&quot;name&quot;])
1135 cbradney 2328
 
2329
Sets the corner radius of the object &quot;name&quot;. The radius is expressed
2330
in points. If &quot;name&quot; is not given the currently selected item is used.
2331
 
2332
May raise ValueError if the corner radius is negative.
2333
</source>
4759 cbradney 2334
        <translation type="unfinished">setCornerRadius(radius, [&quot;name&quot;])
4462 cbradney 2335
 
2336
Sets the corner radius of the object &quot;name&quot;. The radius is expressed
2337
in points. If &quot;name&quot; is not given the currently selected item is used.
2338
 
2339
May raise ValueError if the corner radius is negative.
2340
</translation>
1135 cbradney 2341
    </message>
2342
    <message>
14474 cbradney 2343
        <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="186"/>
4759 cbradney 2344
        <source>setMultiLine(&quot;namedStyle&quot;, [&quot;name&quot;])
1135 cbradney 2345
 
2346
Sets the line style of the object &quot;name&quot; to the named style &quot;namedStyle&quot;.
2347
If &quot;name&quot; is not given the currently selected item is used.
2348
 
4759 cbradney 2349
May raise NotFoundError if the line style doesn&apos;t exist.
1135 cbradney 2350
</source>
4759 cbradney 2351
        <translation type="unfinished">setMultiLine(&quot;namedStyle&quot;, [&quot;name&quot;])
4462 cbradney 2352
 
2353
Sets the line style of the object &quot;name&quot; to the named style &quot;namedStyle&quot;.
2354
If &quot;name&quot; is not given the currently selected item is used.
2355
 
4759 cbradney 2356
May raise NotFoundError if the line style doesn&apos;t exist.
4462 cbradney 2357
</translation>
1135 cbradney 2358
    </message>
2359
    <message>
14474 cbradney 2360
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="17"/>
12918 cbradney 2361
        <source>getFontSize([&quot;name&quot;]) -&gt; float
2362
 
2363
Returns the font size in points for the text frame &quot;name&quot;. If this text
2364
frame has some text selected the value assigned to the first character of
2365
the selection is returned.
2366
If &quot;name&quot; is not given the currently selected item is used.
2367
</source>
2368
        <translation type="unfinished"></translation>
2369
    </message>
2370
    <message>
14474 cbradney 2371
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="29"/>
4759 cbradney 2372
        <source>getFont([&quot;name&quot;]) -&gt; string
1135 cbradney 2373
 
2374
Returns the font name for the text frame &quot;name&quot;. If this text frame
2375
has some text selected the value assigned to the first character
2376
of the selection is returned. If &quot;name&quot; is not given the currently
2377
selected item is used.
2378
</source>
4759 cbradney 2379
        <translation type="unfinished">getFont([&quot;name&quot;]) -&gt; string
4462 cbradney 2380
 
2381
Returns the font name for the text frame &quot;name&quot;. If this text frame
2382
has some text selected the value assigned to the first character
2383
of the selection is returned. If &quot;name&quot; is not given the currently
2384
selected item is used.
2385
</translation>
1135 cbradney 2386
    </message>
2387
    <message>
14474 cbradney 2388
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="41"/>
4759 cbradney 2389
        <source>getTextLength([&quot;name&quot;]) -&gt; integer
1135 cbradney 2390
 
2391
Returns the length of the text in the text frame &quot;name&quot;.
2392
If &quot;name&quot; is not given the currently selected item is used.
2393
</source>
4759 cbradney 2394
        <translation type="unfinished">getTextLength([&quot;name&quot;]) -&gt; integer
4462 cbradney 2395
 
2396
Returns the length of the text in the text frame &quot;name&quot;.
2397
If &quot;name&quot; is not given the currently selected item is used.
2398
</translation>
1135 cbradney 2399
    </message>
2400
    <message>
14474 cbradney 2401
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="51"/>
12918 cbradney 2402
        <source>getTextLines([&quot;name&quot;]) -&gt; integer
2403
 
2404
Returns the number of lines of the text in the text frame &quot;name&quot;.
2405
If &quot;name&quot; is not given the currently selected item is used.
2406
</source>
2407
        <translation type="unfinished"></translation>
2408
    </message>
2409
    <message>
14474 cbradney 2410
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="61"/>
4759 cbradney 2411
        <source>getText([&quot;name&quot;]) -&gt; string
1135 cbradney 2412
 
2413
Returns the text of the text frame &quot;name&quot;. If this text frame has some text
2414
selected, the selected text is returned. All text in the frame, not just
2415
currently visible text, is returned. If &quot;name&quot; is not given the currently
2416
selected item is used.
2417
</source>
4759 cbradney 2418
        <translation type="unfinished">getText([&quot;name&quot;]) -&gt; string
4462 cbradney 2419
 
2420
Returns the text of the text frame &quot;name&quot;. If this text frame has some text
2421
selected, the selected text is returned. All text in the frame, not just
2422
currently visible text, is returned. If &quot;name&quot; is not given the currently
2423
selected item is used.
2424
</translation>
1135 cbradney 2425
    </message>
2426
    <message>
14474 cbradney 2427
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="73"/>
4759 cbradney 2428
        <source>getAllText([&quot;name&quot;]) -&gt; string
1135 cbradney 2429
 
2430
Returns the text of the text frame &quot;name&quot; and of all text frames which are
2431
linked with this frame. If this textframe has some text selected, the selected
2432
text is returned. If &quot;name&quot; is not given the currently selected item is
2433
used.
2434
</source>
4759 cbradney 2435
        <translation type="unfinished">getAllText([&quot;name&quot;]) -&gt; string
4462 cbradney 2436
 
2437
Returns the text of the text frame &quot;name&quot; and of all text frames which are
2438
linked with this frame. If this textframe has some text selected, the selected
2439
text is returned. If &quot;name&quot; is not given the currently selected item is
2440
used.
2441
</translation>
1135 cbradney 2442
    </message>
2443
    <message>
14474 cbradney 2444
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="85"/>
4759 cbradney 2445
        <source>getLineSpacing([&quot;name&quot;]) -&gt; float
1135 cbradney 2446
 
2447
Returns the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; expressed in
2448
points. If &quot;name&quot; is not given the currently selected item is used.
2449
</source>
4759 cbradney 2450
        <translation type="unfinished">getLineSpacing([&quot;name&quot;]) -&gt; float
4462 cbradney 2451
 
2452
Returns the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; expressed in
2453
points. If &quot;name&quot; is not given the currently selected item is used.
2454
</translation>
1135 cbradney 2455
    </message>
2456
    <message>
14474 cbradney 2457
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="95"/>
12918 cbradney 2458
        <source>getTextDistances([&quot;name&quot;]) -&gt; tuple
2459
 
2460
Returns the text distances of the text frame &quot;name&quot; expressed in points. The
2461
distances are returned as a tuple like (left, right, top, bottom). If &quot;name&quot;
2462
is not given the currently selected item is used.
2463
</source>
2464
        <translation type="unfinished"></translation>
2465
    </message>
2466
    <message>
14474 cbradney 2467
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="106"/>
4759 cbradney 2468
        <source>getColumnGap([&quot;name&quot;]) -&gt; float
1135 cbradney 2469
 
2470
Returns the column gap size of the text frame &quot;name&quot; expressed in points. If
2471
&quot;name&quot; is not given the currently selected item is used.
2472
</source>
4759 cbradney 2473
        <translation type="unfinished">getColumnGap([&quot;name&quot;]) -&gt; float
4462 cbradney 2474
 
2475
Returns the column gap size of the text frame &quot;name&quot; expressed in points. If
2476
&quot;name&quot; is not given the currently selected item is used.
2477
</translation>
1135 cbradney 2478
    </message>
2479
    <message>
14474 cbradney 2480
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="116"/>
4759 cbradney 2481
        <source>getColumns([&quot;name&quot;]) -&gt; integer
1135 cbradney 2482
 
2483
Gets the number of columns of the text frame &quot;name&quot;. If &quot;name&quot; is not
2484
given the currently selected item is used.
2485
</source>
4759 cbradney 2486
        <translation type="unfinished">getColumns([&quot;name&quot;]) -&gt; integer
4462 cbradney 2487
 
2488
Gets the number of columns of the text frame &quot;name&quot;. If &quot;name&quot; is not
2489
given the currently selected item is used.
2490
</translation>
1135 cbradney 2491
    </message>
2492
    <message>
14474 cbradney 2493
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="126"/>
4759 cbradney 2494
        <source>setText(&quot;text&quot;, [&quot;name&quot;])
1135 cbradney 2495
 
2496
Sets the text of the text frame &quot;name&quot; to the text of the string &quot;text&quot;.
4759 cbradney 2497
Text must be UTF8 encoded - use e.g. unicode(text, &apos;iso-8859-2&apos;). See the FAQ
1135 cbradney 2498
for more details. If &quot;name&quot; is not given the currently selected item is
2499
used.
2500
</source>
4759 cbradney 2501
        <translation type="unfinished">setText(&quot;text&quot;, [&quot;name&quot;])
4462 cbradney 2502
 
2503
Sets the text of the text frame &quot;name&quot; to the text of the string &quot;text&quot;.
4759 cbradney 2504
Text must be UTF8 encoded - use e.g. unicode(text, &apos;iso-8859-2&apos;). See the FAQ
4462 cbradney 2505
for more details. If &quot;name&quot; is not given the currently selected item is
2506
used.
2507
</translation>
1135 cbradney 2508
    </message>
2509
    <message>
14474 cbradney 2510
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="138"/>
4759 cbradney 2511
        <source>insertText(&quot;text&quot;, pos, [&quot;name&quot;])
4462 cbradney 2512
 
2513
Inserts the text &quot;text&quot; at the position &quot;pos&quot; into the text frame &quot;name&quot;.
2514
Text must be UTF encoded (see setText() as reference) The first character has an
12918 cbradney 2515
index of 0. Inserting text at position -1 appends it to the frame. If &quot;name&quot; is
4462 cbradney 2516
not given the currently selected Item is used.
2517
 
2518
May throw IndexError for an insertion out of bounds.
2519
</source>
12918 cbradney 2520
        <translation type="unfinished"></translation>
4462 cbradney 2521
    </message>
2522
    <message>
14474 cbradney 2523
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="152"/>
4759 cbradney 2524
        <source>setFont(&quot;font&quot;, [&quot;name&quot;])
1135 cbradney 2525
 
2526
Sets the font of the text frame &quot;name&quot; to &quot;font&quot;. If there is some text
2527
selected only the selected text is changed.  If &quot;name&quot; is not given the
2528
currently selected item is used.
2529
 
2530
May throw ValueError if the font cannot be found.
2531
</source>
4759 cbradney 2532
        <translation type="unfinished">setFont(&quot;font&quot;, [&quot;name&quot;])
4462 cbradney 2533
 
2534
Sets the font of the text frame &quot;name&quot; to &quot;font&quot;. If there is some text
2535
selected only the selected text is changed.  If &quot;name&quot; is not given the
2536
currently selected item is used.
2537
 
2538
May throw ValueError if the font cannot be found.
2539
</translation>
1135 cbradney 2540
    </message>
2541
    <message>
14474 cbradney 2542
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="165"/>
4759 cbradney 2543
        <source>setFontSize(size, [&quot;name&quot;])
1135 cbradney 2544
 
2545
Sets the font size of the text frame &quot;name&quot; to &quot;size&quot;. &quot;size&quot; is treated
2546
as a value in points. If there is some text selected only the selected text is
2547
changed. &quot;size&quot; must be in the range 1 to 512. If &quot;name&quot; is not given the
2548
currently selected item is used.
2549
 
4759 cbradney 2550
May throw ValueError for a font size that&apos;s out of bounds.
1135 cbradney 2551
</source>
4759 cbradney 2552
        <translation type="unfinished">setFontSize(size, [&quot;name&quot;])
4462 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.
4462 cbradney 2560
</translation>
1135 cbradney 2561
    </message>
2562
    <message>
14474 cbradney 2563
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="179"/>
4759 cbradney 2564
        <source>setLineSpacing(size, [&quot;name&quot;])
1135 cbradney 2565
 
2566
Sets the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; to &quot;size&quot;.
2567
&quot;size&quot; is a value in points. If &quot;name&quot; is not given the currently selected
2568
item is used.
2569
 
2570
May throw ValueError if the line spacing is out of bounds.
2571
</source>
4759 cbradney 2572
        <translation type="unfinished">setLineSpacing(size, [&quot;name&quot;])
4462 cbradney 2573
 
2574
Sets the line spacing (&quot;leading&quot;) of the text frame &quot;name&quot; to &quot;size&quot;.
2575
&quot;size&quot; is a value in points. If &quot;name&quot; is not given the currently selected
2576
item is used.
2577
 
2578
May throw ValueError if the line spacing is out of bounds.
2579
</translation>
1135 cbradney 2580
    </message>
2581
    <message>
14474 cbradney 2582
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="192"/>
2583
        <source>setLineSpacingMode(mode, [&quot;name&quot;])
2584
 
2585
Sets the line spacing mode of the text frame &quot;name&quot; to &quot;mode&quot;.
2586
If &quot;name&quot; is not given the currently selected
2587
item is used.
2588
Mode values are the same as in createParagraphStyle.
2589
 
2590
May throw ValueError if the mode is out of bounds.
2591
</source>
2592
        <translation type="unfinished"></translation>
2593
    </message>
2594
    <message>
2595
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="206"/>
12918 cbradney 2596
        <source>setTextDistances(left, right, top, bottom, [&quot;name&quot;])
2597
 
2598
Sets the text distances of the text frame &quot;name&quot; to the values &quot;left&quot;
2599
&quot;right&quot;, &quot;top&quot; and &quot;bottom&quot;. If &quot;name&quot; is not given the currently
2600
selected item is used.
2601
 
2602
May throw ValueError if any of the distances are out of bounds (must be positive).
2603
</source>
2604
        <translation type="unfinished"></translation>
2605
    </message>
2606
    <message>
14474 cbradney 2607
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="219"/>
4759 cbradney 2608
        <source>setColumnGap(size, [&quot;name&quot;])
1135 cbradney 2609
 
2610
Sets the column gap of the text frame &quot;name&quot; to the value &quot;size&quot;. If
2611
&quot;name&quot; is not given the currently selected item is used.
2612
 
2613
May throw ValueError if the column gap is out of bounds (must be positive).
2614
</source>
4759 cbradney 2615
        <translation type="unfinished">setColumnGap(size, [&quot;name&quot;])
4462 cbradney 2616
 
2617
Sets the column gap of the text frame &quot;name&quot; to the value &quot;size&quot;. If
2618
&quot;name&quot; is not given the currently selected item is used.
2619
 
2620
May throw ValueError if the column gap is out of bounds (must be positive).
2621
</translation>
1135 cbradney 2622
    </message>
2623
    <message>
14474 cbradney 2624
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="231"/>
4759 cbradney 2625
        <source>setColumns(nr, [&quot;name&quot;])
1135 cbradney 2626
 
2627
Sets the number of columns of the text frame &quot;name&quot; to the integer &quot;nr&quot;.
2628
If &quot;name&quot; is not given the currently selected item is used.
2629
 
2630
May throw ValueError if number of columns is not at least one.
2631
</source>
4759 cbradney 2632
        <translation type="unfinished">setColumns(nr, [&quot;name&quot;])
4462 cbradney 2633
 
2634
Sets the number of columns of the text frame &quot;name&quot; to the integer &quot;nr&quot;.
2635
If &quot;name&quot; is not given the currently selected item is used.
2636
 
2637
May throw ValueError if number of columns is not at least one.
2638
</translation>
1135 cbradney 2639
    </message>
2640
    <message>
14474 cbradney 2641
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="243"/>
4759 cbradney 2642
        <source>setTextAlignment(align, [&quot;name&quot;])
1135 cbradney 2643
 
2644
Sets the text alignment of the text frame &quot;name&quot; to the specified alignment.
2645
If &quot;name&quot; is not given the currently selected item is used. &quot;align&quot; should
2646
be one of the ALIGN_ constants defined in this module - see dir(scribus).
2647
 
2648
May throw ValueError for an invalid alignment constant.
2649
</source>
4759 cbradney 2650
        <translation type="unfinished">setTextAlignment(align, [&quot;name&quot;])
4462 cbradney 2651
 
2652
Sets the text alignment of the text frame &quot;name&quot; to the specified alignment.
2653
If &quot;name&quot; is not given the currently selected item is used. &quot;align&quot; should
2654
be one of the ALIGN_ constants defined in this module - see dir(scribus).
2655
 
2656
May throw ValueError for an invalid alignment constant.
2657
</translation>
1135 cbradney 2658
    </message>
2659
    <message>
14474 cbradney 2660
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="256"/>
4759 cbradney 2661
        <source>selectText(start, count, [&quot;name&quot;])
4462 cbradney 2662
 
2663
Selects &quot;count&quot; characters of text in the text frame &quot;name&quot; starting from the
2664
character &quot;start&quot;. Character counting starts at 0. If &quot;count&quot; is zero, any
2665
text selection will be cleared.  If &quot;name&quot; is not given the currently
2666
selected item is used.
2667
 
2668
May throw IndexError if the selection is outside the bounds of the text.
2669
</source>
4759 cbradney 2670
        <translation type="unfinished">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
</translation>
2679
    </message>
2680
    <message>
14474 cbradney 2681
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="270"/>
4759 cbradney 2682
        <source>deleteText([&quot;name&quot;])
1135 cbradney 2683
 
2684
Deletes any text in the text frame &quot;name&quot;. If there is some text selected,
2685
only the selected text will be deleted. If &quot;name&quot; is not given the currently
2686
selected item is used.
2687
</source>
4759 cbradney 2688
        <translation type="unfinished">deleteText([&quot;name&quot;])
4462 cbradney 2689
 
2690
Deletes any text in the text frame &quot;name&quot;. If there is some text selected,
2691
only the selected text will be deleted. If &quot;name&quot; is not given the currently
2692
selected item is used.
2693
</translation>
1135 cbradney 2694
    </message>
2695
    <message>
14474 cbradney 2696
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="281"/>
4759 cbradney 2697
        <source>setTextColor(&quot;color&quot;, [&quot;name&quot;])
1135 cbradney 2698
 
2699
Sets the text color of the text frame &quot;name&quot; to the color &quot;color&quot;. If there
2700
is some text selected only the selected text is changed. If &quot;name&quot; is not
2701
given the currently selected item is used.
2702
</source>
12918 cbradney 2703
        <translation type="unfinished">setTextColor(&quot;color&quot;, [&quot;name&quot;])
4462 cbradney 2704
 
2705
Sets the text colour of the text frame &quot;name&quot; to the colour &quot;color&quot;. If there
2706
is some text selected only the selected text is changed. If &quot;name&quot; is not
2707
given the currently selected item is used.
2708
</translation>
1135 cbradney 2709
    </message>
2710
    <message>
14474 cbradney 2711
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="292"/>
4759 cbradney 2712
        <source>setTextStroke(&quot;color&quot;, [&quot;name&quot;])
1135 cbradney 2713
 
2714
Set &quot;color&quot; of the text stroke. If &quot;name&quot; is not given the currently
2715
selected item is used.
2716
</source>
4759 cbradney 2717
        <translation type="unfinished">setTextStroke(&quot;color&quot;, [&quot;name&quot;])
4462 cbradney 2718
 
2719
Set &quot;color&quot; of the text stroke. If &quot;name&quot; is not given the currently
2720
selected item is used.
2721
</translation>
1135 cbradney 2722
    </message>
2723
    <message>
14474 cbradney 2724
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="302"/>
2725
        <source>setTextScalingV(scale, [&quot;name&quot;])
2726
 
2727
Sets the vertical character scaling of the object &quot;name&quot; to &quot;scale&quot; in percent.
2728
If &quot;name&quot; is not given the currently selected item is used.
2729
</source>
2730
        <translation type="unfinished"></translation>
2731
    </message>
2732
    <message>
2733
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="312"/>
2734
        <source>setTextScalingH(scale, [&quot;name&quot;])
2735
 
2736
Sets the horizontal 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="322"/>
4759 cbradney 2743
        <source>setTextShade(shade, [&quot;name&quot;])
1135 cbradney 2744
 
2745
Sets the shading of the text color of the object &quot;name&quot; to &quot;shade&quot;. If
2746
there is some text selected only the selected text is changed. &quot;shade&quot; must
2747
be an integer value in the range from 0 (lightest) to 100 (full color
2748
intensity). If &quot;name&quot; is not given the currently selected item is
2749
used.
2750
</source>
12918 cbradney 2751
        <translation type="unfinished">setTextShade(shade, [&quot;name&quot;])
4462 cbradney 2752
 
2753
Sets the shading of the text colour of the object &quot;name&quot; to &quot;shade&quot;. If
2754
there is some text selected only the selected text is changed. &quot;shade&quot; must
2755
be an integer value in the range from 0 (lightest) to 100 (full colour
2756
intensity). If &quot;name&quot; is not given the currently selected item is
2757
used.
2758
</translation>
1135 cbradney 2759
    </message>
2760
    <message>
14474 cbradney 2761
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="335"/>
4759 cbradney 2762
        <source>linkTextFrames(&quot;fromname&quot;, &quot;toname&quot;)
1135 cbradney 2763
 
2764
Link two text frames. The frame named &quot;fromname&quot; is linked to the
2765
frame named &quot;toname&quot;. The target frame must be an empty text frame
2766
and must not link to or be linked from any other frames already.
2767
 
2768
May throw ScribusException if linking rules are violated.
2769
</source>
4759 cbradney 2770
        <translation type="unfinished">linkTextFrames(&quot;fromname&quot;, &quot;toname&quot;)
4462 cbradney 2771
 
2772
Link two text frames. The frame named &quot;fromname&quot; is linked to the
2773
frame named &quot;toname&quot;. The target frame must be an empty text frame
2774
and must not link to or be linked from any other frames already.
2775
 
2776
May throw ScribusException if linking rules are violated.
2777
</translation>
1135 cbradney 2778
    </message>
2779
    <message>
14474 cbradney 2780
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="352"/>
4759 cbradney 2781
        <source>unlinkTextFrames(&quot;name&quot;)
1135 cbradney 2782
 
2783
Remove the specified (named) object from the text frame flow/linkage. If the
2784
frame was in the middle of a chain, the previous and next frames will be
4759 cbradney 2785
connected, eg &apos;a-&gt;b-&gt;c&apos; becomes &apos;a-&gt;c&apos; when you unlinkTextFrames(b)&apos;
1135 cbradney 2786
 
2787
May throw ScribusException if linking rules are violated.
2788
</source>
4759 cbradney 2789
        <translation type="unfinished">unlinkTextFrames(&quot;name&quot;)
4462 cbradney 2790
 
2791
Remove the specified (named) object from the text frame flow/linkage. If the
2792
frame was in the middle of a chain, the previous and next frames will be
4759 cbradney 2793
connected, eg &apos;a-&gt;b-&gt;c&apos; becomes &apos;a-&gt;c&apos; when you unlinkTextFrames(b)&apos;
4462 cbradney 2794
 
2795
May throw ScribusException if linking rules are violated.
2796
</translation>
1135 cbradney 2797
    </message>
2798
    <message>
14474 cbradney 2799
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="369"/>
4759 cbradney 2800
        <source>traceText([&quot;name&quot;])
1135 cbradney 2801
 
2802
Convert the text frame &quot;name&quot; to outlines. If &quot;name&quot; is not given the
2803
currently selected item is used.</source>
4759 cbradney 2804
        <translation type="unfinished">traceText([&quot;name&quot;])
1135 cbradney 2805
 
4462 cbradney 2806
Convert the text frame &quot;name&quot; to outlines. If &quot;name&quot; is not given the
2807
currently selected item is used.</translation>
1135 cbradney 2808
    </message>
2809
    <message>
14474 cbradney 2810
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="380"/>
4759 cbradney 2811
        <source>textOverflows([&quot;name&quot;, nolinks]) -&gt; integer
1135 cbradney 2812
 
4462 cbradney 2813
Returns the actual number of overflowing characters in text frame &quot;name&quot;.
4759 cbradney 2814
If is nolinks set to non zero value it takes only one frame - it doesn&apos;t
4462 cbradney 2815
use text frame linking. Without this parameter it search all linking chain.
1135 cbradney 2816
 
4462 cbradney 2817
May raise WrongFrameTypeError if the target frame is not an text frame
1135 cbradney 2818
</source>
4759 cbradney 2819
        <translation type="unfinished">textOverflows([&quot;name&quot;, nolinks]) -&gt; integer
1135 cbradney 2820
 
4462 cbradney 2821
Returns the actual number of overflowing characters in text frame &quot;name&quot;.
4759 cbradney 2822
If is nolinks set to non zero value it takes only one frame - it doesn&apos;t
4462 cbradney 2823
use text frame linking. Without this parameter it search all linking chain.
1135 cbradney 2824
 
4462 cbradney 2825
May raise WrongFrameTypeError if the target frame is not an text frame
2826
</translation>
1135 cbradney 2827
    </message>
1525 cbradney 2828
    <message>
14474 cbradney 2829
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="393"/>
12918 cbradney 2830
        <source>hyphenateText([&quot;name&quot;]) -&gt; bool
1525 cbradney 2831
 
12918 cbradney 2832
Does hyphenation on text frame &quot;name&quot;.
4462 cbradney 2833
If &quot;name&quot; is not given the currently selected item is used.
1525 cbradney 2834
 
4462 cbradney 2835
May raise WrongFrameTypeError if the target frame is not a text frame
1525 cbradney 2836
</source>
12918 cbradney 2837
        <translation type="unfinished"></translation>
2838
    </message>
2839
    <message>
14474 cbradney 2840
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="407"/>
12918 cbradney 2841
        <source>dehyphenateText([&quot;name&quot;]) -&gt; bool
1525 cbradney 2842
 
12918 cbradney 2843
Does dehyphenation on text frame &quot;name&quot;.
4462 cbradney 2844
If &quot;name&quot; is not given the currently selected item is used.
1525 cbradney 2845
 
4462 cbradney 2846
May raise WrongFrameTypeError if the target frame is not a text frame
12918 cbradney 2847
</source>
2848
        <translation type="unfinished"></translation>
1525 cbradney 2849
    </message>
2850
    <message>
14474 cbradney 2851
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="422"/>
12918 cbradney 2852
        <source>setPDFBookmark(&quot;toggle&quot;, [&quot;name&quot;])
2853
 
2854
Sets whether (toggle = 1) the text frame &quot;name&quot; is a bookmark nor not.
2855
If &quot;name&quot; is not given the currently selected item is used.
2856
 
2857
May raise WrongFrameTypeError if the target frame is not a text frame
2858
</source>
2859
        <translation type="unfinished"></translation>
2860
    </message>
2861
    <message>
14474 cbradney 2862
        <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="434"/>
4759 cbradney 2863
        <source>isPDFBookmark([&quot;name&quot;]) -&gt; bool
1525 cbradney 2864
 
4462 cbradney 2865
Returns true if the text frame &quot;name&quot; is a PDF bookmark.
2866
If &quot;name&quot; is not given the currently selected item is used.
1525 cbradney 2867
 
4462 cbradney 2868
May raise WrongFrameTypeError if the target frame is not a text frame
1525 cbradney 2869
</source>
4759 cbradney 2870
        <translation type="unfinished">isPDFBookmark([&quot;name&quot;]) -&gt; bool
1525 cbradney 2871
 
4462 cbradney 2872
Returns true if the text frame &quot;name&quot; is a PDF bookmark.
2873
If &quot;name&quot; is not given the currently selected item is used.
1525 cbradney 2874
 
4462 cbradney 2875
May raise WrongFrameTypeError if the target frame is not a text frame
2876
</translation>
1525 cbradney 2877
    </message>
2878
    <message>
14474 cbradney 2879
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="17"/>
12918 cbradney 2880
        <source>messagebarText(&quot;string&quot;)
2881
 
2882
Writes the &quot;string&quot; into the Scribus message bar (status line). The text
2883
must be UTF8 encoded or &apos;unicode&apos; string(recommended).
2884
</source>
2885
        <translation type="unfinished"></translation>
2886
    </message>
2887
    <message>
14474 cbradney 2888
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="30"/>
4759 cbradney 2889
        <source>progressReset()
1525 cbradney 2890
 
4462 cbradney 2891
Cleans up the Scribus progress bar previous settings. It is called before the
2892
new progress bar use. See progressSet.
1525 cbradney 2893
</source>
4759 cbradney 2894
        <translation type="unfinished">progressReset()
1525 cbradney 2895
 
4462 cbradney 2896
Cleans up the Scribus progress bar previous settings. It is called before the
2897
new progress bar use. See progressSet.
2898
</translation>
1525 cbradney 2899
    </message>
2900
    <message>
14474 cbradney 2901
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="43"/>
4759 cbradney 2902
        <source>progressTotal(max)
1525 cbradney 2903
 
4759 cbradney 2904
Sets the progress bar&apos;s maximum steps value to the specified number.
4462 cbradney 2905
See progressSet.
1525 cbradney 2906
</source>
4759 cbradney 2907
        <translation type="unfinished">progressTotal(max)
1525 cbradney 2908
 
4759 cbradney 2909
Sets the progress bar&apos;s maximum steps value to the specified number.
4462 cbradney 2910
See progressSet.
2911
</translation>
1525 cbradney 2912
    </message>
2913
    <message>
14474 cbradney 2914
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="52"/>
4759 cbradney 2915
        <source>progressSet(nr)
1525 cbradney 2916
 
4462 cbradney 2917
Set the progress bar position to &quot;nr&quot;, a value relative to the previously set
2918
progressTotal. The progress bar uses the concept of steps; you give it the
2919
total number of steps and the number of steps completed so far and it will
2920
display the percentage of steps that have been completed. You can specify the
2921
total number of steps with progressTotal(). The current number of steps is set
2922
with progressSet(). The progress bar can be rewound to the beginning with
4759 cbradney 2923
progressReset(). [based on info taken from Trolltech&apos;s Qt docs]
1525 cbradney 2924
</source>
4759 cbradney 2925
        <translation type="unfinished">progressSet(nr)
1525 cbradney 2926
 
4462 cbradney 2927
Set the progress bar position to &quot;nr&quot;, a value relative to the previously set
2928
progressTotal. The progress bar uses the concept of steps; you give it the
2929
total number of steps and the number of steps completed so far and it will
2930
display the percentage of steps that have been completed. You can specify the
2931
total number of steps with progressTotal(). The current number of steps is set
2932
with progressSet(). The progress bar can be rewound to the beginning with
4759 cbradney 2933
progressReset(). [based on info taken from Trolltech&apos;s Qt docs]
4462 cbradney 2934
</translation>
1525 cbradney 2935
    </message>
2936
    <message>
14474 cbradney 2937
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="66"/>
4759 cbradney 2938
        <source>setCursor()
1525 cbradney 2939
 
4462 cbradney 2940
[UNSUPPORTED!] This might break things, so steer clear for now.
1525 cbradney 2941
</source>
4759 cbradney 2942
        <translation type="unfinished">setCursor()
1525 cbradney 2943
 
4462 cbradney 2944
[UNSUPPORTED!] This might break things, so steer clear for now.
2945
</translation>
1525 cbradney 2946
    </message>
2947
    <message>
14474 cbradney 2948
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="78"/>
4759 cbradney 2949
        <source>docChanged(bool)
1525 cbradney 2950
 
4759 cbradney 2951
Enable/disable save icon in the Scribus icon bar and the Save menu item. It&apos;s
2952
useful to call this procedure when you&apos;re changing the document, because Scribus
2953
won&apos;t automatically notice when you change the document using a script.
1525 cbradney 2954
</source>
4759 cbradney 2955
        <translation type="unfinished">docChanged(bool)
1525 cbradney 2956
 
4759 cbradney 2957
Enable/disable save icon in the Scribus icon bar and the Save menu item. It&apos;s
2958
useful to call this procedure when you&apos;re changing the document, because Scribus
2959
won&apos;t automatically notice when you change the document using a script.
4462 cbradney 2960
</translation>
1525 cbradney 2961
    </message>
2962
    <message>
14474 cbradney 2963
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="91"/>
12918 cbradney 2964
        <source>zoomDocument(double)
1525 cbradney 2965
 
12918 cbradney 2966
Zoom the document in main GUI window. Actions have whole number
2967
values like 20.0, 100.0, etc. Zoom to Fit uses -100 as a marker.
1525 cbradney 2968
</source>
12918 cbradney 2969
        <translation type="unfinished">zoomDocument(double)
1525 cbradney 2970
 
12918 cbradney 2971
在主图形界面窗口缩放文件。动作包括整数值如20.0,100.0,等待。缩放以-100作为记号。
4462 cbradney 2972
</translation>
1525 cbradney 2973
    </message>
2974
    <message>
14474 cbradney 2975
        <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="103"/>
12918 cbradney 2976
        <source>scrollDocument(x,y)
1525 cbradney 2977
 
12918 cbradney 2978
Scroll the document in main GUI window by x and y.
2979
</source>
2980
        <translation type="unfinished"></translation>
2981
    </message>
2982
    <message>
14474 cbradney 2983
        <location filename="../../../scribus/plugins/scriptplugin/cmdstyle.h" line="22"/>
2984
        <source>createParagraphStyle(...)
1525 cbradney 2985
 
14474 cbradney 2986
Creates a paragraph style. This function takes the following keyword parameters:
3064 cbradney 2987
 
14474 cbradney 2988
&quot;name&quot; [required] -&gt; specifies the name of the paragraphstyle to create
3064 cbradney 2989
 
14474 cbradney 2990
linespacingmode [optional] -&gt; specifies the linespacing mode; possible modes are:
3064 cbradney 2991
 
14474 cbradney 2992
fixed linespacing:          0
3064 cbradney 2993
 
14474 cbradney 2994
automatic linespacing:      1
3064 cbradney 2995
 
14474 cbradney 2996
baseline grid linespacing:  2
3064 cbradney 2997
 
14474 cbradney 2998
linespacing [optional] -&gt; specifies the linespacing if using fixed linespacing
3064 cbradney 2999
 
14474 cbradney 3000
alignment [optional] -&gt; specifies the alignment of the paragraph
13279 cbradney 3001
 
14474 cbradney 3002
-&gt; left:     0
13279 cbradney 3003
 
14474 cbradney 3004
-&gt; center:   1
13279 cbradney 3005
 
14474 cbradney 3006
-&gt; right:    2
13279 cbradney 3007
 
14474 cbradney 3008
-&gt; justify:  3
3009
 
3010
-&gt; extend:   4
3011
 
3012
leftmargin [optional], rightmargin [optional] -&gt; specify the margin
3013
 
3014
gapbefore [optional], gapafter [optional] -&gt; specify the gaps to the heading and following paragraphs
3015
 
3016
firstindent [optional] -&gt; the indent of the first line
3017
 
3018
hasdropcap [optional] -&gt; specifies if there are caps (1 = yes, 0 = no)
3019
 
3020
dropcaplines [optional] -&gt; height (in lines) of the caps if used
3021
 
3022
dropcapoffset [optional] -&gt; offset of the caps if used
3023
 
3024
&quot;charstyle&quot; [optional] -&gt; char style to use
3025
 
13279 cbradney 3026
</source>
3027
        <translation type="unfinished"></translation>
3028
    </message>
3029
    <message>
14474 cbradney 3030
        <location filename="../../../scribus/plugins/scriptplugin/cmdstyle.h" line="52"/>
3031
        <source>createCharStyle(...)
13279 cbradney 3032
 
14474 cbradney 3033
Creates a character style. This function takes the following keyword parameters:
13279 cbradney 3034
 
14474 cbradney 3035
&quot;name&quot; [required] -&gt; name of the char style to create
3036
 
3037
&quot;font&quot; [optional] -&gt; name of the font to use
3038
 
3039
fontsize [optional] -&gt; font size to set (double)
3040
 
3041
&quot;features&quot; [optional] -&gt; nearer typographic details can be defined by a string that might contain the following phrases comma-seperated (without spaces!):
3042
 
3043
-&gt; inherit
3044
 
3045
-&gt; bold
3046
 
3047
-&gt; italic
3048
 
3049
-&gt; underline
3050
 
3051
-&gt; underlinewords
3052
 
3053
-&gt; strike
3054
 
3055
-&gt; superscript
3056
 
3057
-&gt; subscript
3058
 
3059
-&gt; outline
3060
 
3061
-&gt; shadowed
3062
 
3063
-&gt; allcaps
3064
 
3065
-&gt; smallcaps
3066
 
3067
&quot;fillcolor&quot; [optional], &quot;fillshade&quot; [optional] -&gt; specify fill options
3068
 
3069
&quot;strokecolor&quot; [optional], &quot;strokeshade&quot; [optional] -&gt; specify stroke options
3070
 
3071
baselineoffset [optional] -&gt; offset of the baseline
3072
 
3073
shadowxoffset [optional], shadowyoffset [optional] -&gt; offset of the shadow if used
3074
 
3075
outlinewidth [optional] -&gt; width of the outline if used
3076
 
3077
underlineoffset [optional], underlinewidth [optional] -&gt; underline options if used
3078
 
3079
strikethruoffset [optional], strikethruwidth [optional] -&gt; strikethru options if used
3080
 
3081
scaleh [optional], scalev [optional] -&gt; scale of the chars
3082
 
3083
tracking [optional] -&gt; tracking of the text
3084
 
3085
&quot;language&quot; [optional] -&gt; language code
3086
 
13279 cbradney 3087
</source>
3088
        <translation type="unfinished"></translation>
3089
    </message>
3090
    <message>
14474 cbradney 3091
        <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="15"/>
3092
        <source>placeSVG(&quot;filename&quot;, x, y)
13279 cbradney 3093
 
14474 cbradney 3094
Places the SVG &quot;filename&quot; onto the current page,
3095
x and y specify the coordinate of the topleft corner of the SVG placed on the page
13279 cbradney 3096
 
14474 cbradney 3097
If loading was successful, the selection contains the imported SVG
13279 cbradney 3098
</source>
3099
        <translation type="unfinished"></translation>
3100
    </message>
3101
    <message>
14474 cbradney 3102
        <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="27"/>
3103
        <source>placeEPS(&quot;filename&quot;, x, y)
13279 cbradney 3104
 
14474 cbradney 3105
Places the EPS &quot;filename&quot; onto the current page,
3106
x and y specify the coordinate of the topleft corner of the EPS placed on the page
3107
 
3108
If loading was successful, the selection contains the imported EPS
13279 cbradney 3109
</source>
3110
        <translation type="unfinished"></translation>
3111
    </message>
3112
    <message>
14474 cbradney 3113
        <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="39"/>
3114
        <source>placeSXD(&quot;filename&quot;, x, y)
13279 cbradney 3115
 
14474 cbradney 3116
Places the SXD &quot;filename&quot; onto the current page,
3117
x and y specify the coordinate of the topleft corner of the SXD placed on the page
3118
 
3119
If loading was successful, the selection contains the imported SXD
13279 cbradney 3120
</source>
3121
        <translation type="unfinished"></translation>
3122
    </message>
3123
    <message>
14474 cbradney 3124
        <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="51"/>
3125
        <source>placeODG(&quot;filename&quot;, x, y)
13279 cbradney 3126
 
14474 cbradney 3127
Places the ODG &quot;filename&quot; onto the current page,
3128
x and y specify the coordinate of the topleft corner of the ODG placed on the page
3129
 
3130
If loading was successful, the selection contains the imported ODG
13279 cbradney 3131
</source>
3132
        <translation type="unfinished"></translation>
3133
    </message>
12918 cbradney 3134
</context>
3135
<context>
3136
    <name>@default</name>
3137
    <message>
3138
        <source>getColorNames() -&gt; list
3064 cbradney 3139
 
12918 cbradney 3140
Returns a list containing the names of all defined colors in the document.
3141
If no document is open, returns a list of the default document colors.
3064 cbradney 3142
</source>
12918 cbradney 3143
        <translation type="obsolete">
3144
      getColorNames() -&gt; list
3824 cbradney 3145
 
12918 cbradney 3146
      返回文档中所有预设的颜色名称的列表
3147
 
3148
      </translation>
3149
    </message>
3150
    <message>
3151
        <source>newDocDialog() -&gt; bool
3824 cbradney 3152
 
12918 cbradney 3153
Displays the &quot;New Document&quot; dialog box. Creates a new document if the user
3154
accepts the settings. Does not create a document if the user presses cancel.
3155
Returns true if a new document was created.
3156
</source>
3157
        <translation type="obsolete">
3158
      newDocDialog() -&gt; bool
3824 cbradney 3159
 
12918 cbradney 3160
      显示 &quot;新建文档&quot; 对话窗口。如果用户接受了设定,一个新文挡将被创建。如果用户按取消键,文档将不被创建。如果信文档被创建,返回真。
3161
      </translation>
3162
    </message>
3163
    <message>
3164
        <source>getColor(&quot;name&quot;) -&gt; tuple
3824 cbradney 3165
 
12918 cbradney 3166
Returns a tuple (C, M, Y, K) containing the four color components of the
3167
color &quot;name&quot; from the current document. If no document is open, returns
3168
the value of the named color from the default document colors.
3824 cbradney 3169
 
12918 cbradney 3170
May raise NotFoundError if the named color wasn&apos;t found.
3171
May raise ValueError if an invalid color name is specified.
3172
</source>
3173
        <translation type="obsolete">getColor(&quot;name&quot;) -&gt; tuple
3824 cbradney 3174
 
12918 cbradney 3175
Returns a tuple (C, M, Y, K) containing the four colour components of the
3176
colour &quot;name&quot; from the current document. If no document is open, returns
3177
the value of the named colour from the default document colours.
3824 cbradney 3178
 
12918 cbradney 3179
May raise NotFoundError if the named colour wasn&apos;t found.
3180
May raise ValueError if an invalid colour name is specified.
3181
</translation>
3182
    </message>
3183
    <message>
3184
        <source>getColorAsRGB(&quot;name&quot;) -&gt; tuple
3824 cbradney 3185
 
12918 cbradney 3186
Returns a tuple (R,G,B) containing the three color components of the
3187
color &quot;name&quot; from the current document, converted to the RGB color
3188
space. If no document is open, returns the value of the named color
3189
from the default document colors.
3824 cbradney 3190
 
12918 cbradney 3191
May raise NotFoundError if the named color wasn&apos;t found.
3192
May raise ValueError if an invalid color name is specified.
3193
</source>
3194
        <translation type="obsolete">getColorAsRGB(&quot;name&quot;) -&gt; tuple
3824 cbradney 3195
 
12918 cbradney 3196
Returns a tuple (R,G,B) containing the three colour components of the
3197
colour &quot;name&quot; from the current document, converted to the RGB colour
3198
space. If no document is open, returns the value of the named colour
3199
from the default document colours.
3824 cbradney 3200
 
12918 cbradney 3201
May raise NotFoundError if the named colour wasn&apos;t found.
3202
May raise ValueError if an invalid colour name is specified.
4462 cbradney 3203
</translation>
3824 cbradney 3204
    </message>
4141 cbradney 3205
    <message>
12918 cbradney 3206
        <source>changeColor(&quot;name&quot;, c, m, y, k)
4141 cbradney 3207
 
12918 cbradney 3208
Changes the color &quot;name&quot; to the specified CMYK value. The color value is
3209
defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black.
3210
Color components should be in the range from 0 to 255.
3211
 
3212
May raise NotFoundError if the named color wasn&apos;t found.
3213
May raise ValueError if an invalid color name is specified.
4141 cbradney 3214
</source>
12918 cbradney 3215
        <translation type="obsolete">changeColour(&quot;name&quot;, c, m, y, k)
4462 cbradney 3216
 
12918 cbradney 3217
Changes the colour &quot;name&quot; to the specified CMYK value. The colour value is
3218
defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black.
3219
Colour components should be in the range from 0 to 255.
3220
 
3221
May raise NotFoundError if the named colour wasn&apos;t found.
3222
May raise ValueError if an invalid colour name is specified.
4462 cbradney 3223
</translation>
4141 cbradney 3224
    </message>
3225
    <message>
12918 cbradney 3226
        <source>defineColor(&quot;name&quot;, c, m, y, k)
4141 cbradney 3227
 
12918 cbradney 3228
Defines a new color &quot;name&quot;. The color Value is defined via four components:
3229
c = Cyan, m = Magenta, y = Yello and k = Black. Color components should be in
3230
the range from 0 to 255.
3231
 
3232
May raise ValueError if an invalid color name is specified.
4141 cbradney 3233
</source>
12918 cbradney 3234
        <translation type="obsolete">defineColor(&quot;name&quot;, c, m, y, k)
4462 cbradney 3235
 
12918 cbradney 3236
Defines a new colour &quot;name&quot;. The colour Value is defined via four components:
3237
c = Cyan, m = Magenta, y = Yello and k = Black. Colour components should be in
3238
the range from 0 to 255.
3239
 
3240
May raise ValueError if an invalid colour name is specified.
4462 cbradney 3241
</translation>
4141 cbradney 3242
    </message>
3243
    <message>
12918 cbradney 3244
        <source>deleteColor(&quot;name&quot;, &quot;replace&quot;)
4141 cbradney 3245
 
12918 cbradney 3246
Deletes the color &quot;name&quot;. Every occurence of that color is replaced by the
3247
color &quot;replace&quot;. If not specified, &quot;replace&quot; defaults to the color
3248
&quot;None&quot; - transparent.
3249
 
3250
deleteColor works on the default document colors if there is no document open.
3251
In that case, &quot;replace&quot;, if specified, has no effect.
3252
 
3253
May raise NotFoundError if a named color wasn&apos;t found.
3254
May raise ValueError if an invalid color name is specified.
4141 cbradney 3255
</source>
12918 cbradney 3256
        <translation type="obsolete">deleteColor(&quot;name&quot;, &quot;replace&quot;)
4462 cbradney 3257
 
12918 cbradney 3258
Deletes the colour &quot;name&quot;. Every occurence of that colour is replaced by the
3259
colour &quot;replace&quot;. If not specified, &quot;replace&quot; defaults to the colour
3260
&quot;None&quot; - transparent.
3261
 
3262
deleteColor works on the default document colours if there is no document open.
3263
In that case, &quot;replace&quot;, if specified, has no effect.
3264
 
3265
May raise NotFoundError if a named colour wasn&apos;t found.
3266
May raise ValueError if an invalid colour name is specified.
4462 cbradney 3267
</translation>
4141 cbradney 3268
    </message>
3269
    <message>
12918 cbradney 3270
        <source>replaceColor(&quot;name&quot;, &quot;replace&quot;)
4141 cbradney 3271
 
12918 cbradney 3272
Every occurence of the color &quot;name&quot; is replaced by the color &quot;replace&quot;.
3273
 
3274
May raise NotFoundError if a named color wasn&apos;t found.
3275
May raise ValueError if an invalid color name is specified.
4141 cbradney 3276
</source>
12918 cbradney 3277
        <translation type="obsolete">replaceColor(&quot;name&quot;, &quot;replace&quot;)
4462 cbradney 3278
 
12918 cbradney 3279
Every occurence of the colour &quot;name&quot; is replaced by the colour &quot;replace&quot;.
3280
 
3281
May raise NotFoundError if a named colour wasn&apos;t found.
3282
May raise ValueError if an invalid colour name is specified.
4462 cbradney 3283
</translation>
4141 cbradney 3284
    </message>
3285
    <message>
12918 cbradney 3286
        <source>fileDialog(&quot;caption&quot;, [&quot;filter&quot;, &quot;defaultname&quot;, haspreview, issave, isdir]) -&gt; string with filename
4141 cbradney 3287
 
12918 cbradney 3288
Shows a File Open dialog box with the caption &quot;caption&quot;. Files are filtered
3289
with the filter string &quot;filter&quot;. A default filename or file path can also
3290
supplied, leave this string empty when you don&apos;t want to use it.  A value of
3291
True for haspreview enables a small preview widget in the FileSelect box.  When
3292
the issave parameter is set to True the dialog acts like a &quot;Save As&quot; dialog
3293
otherwise it acts like a &quot;File Open Dialog&quot;. When the isdir parameter is True
3294
the dialog shows and returns only directories. The default for all of the
3295
opional parameters is False.
3296
 
3297
The filter, if specified, takes the form &apos;comment (*.type *.type2 ...)&apos;.
3298
For example &apos;Images (*.png *.xpm *.jpg)&apos;.
3299
 
3300
Refer to the Qt-Documentation for QFileDialog for details on filters.
3301
 
3302
Example: fileDialog(&apos;Open input&apos;, &apos;CSV files (*.csv)&apos;)
3303
Example: fileDialog(&apos;Save report&apos;, defaultname=&apos;report.txt&apos;, issave=True)
4141 cbradney 3304
</source>
12918 cbradney 3305
        <translation type="obsolete">fileDialog(&quot;caption&quot;, [&quot;filter&quot;, &quot;defaultname&quot;, haspreview, issave, isdir]) -&gt; string with filename
4462 cbradney 3306
 
12918 cbradney 3307
Shows a File Open dialog box with the caption &quot;caption&quot;. Files are filtered
3308
with the filter string &quot;filter&quot;. A default filename or file path can also
3309
supplied, leave this string empty when you don&apos;t want to use it.  A value of
3310
True for haspreview enables a small preview widget in the FileSelect box.  When
3311
the issave parameter is set to True the dialog acts like a &quot;Save As&quot; dialog
3312
otherwise it acts like a &quot;File Open Dialog&quot;. When the isdir parameter is True
3313
the dialog shows and returns only directories. The default for all of the
3314
opional parameters is False.
3315
 
3316
The filter, if specified, takes the form &apos;comment (*.type *.type2 ...)&apos;.
3317
For example &apos;Images (*.png *.xpm *.jpg)&apos;.
3318
 
3319
Refer to the Qt-Documentation for QFileDialog for details on filters.
3320
 
3321
Example: fileDialog(&apos;Open input&apos;, &apos;CSV files (*.csv)&apos;)
3322
Example: fileDialog(&apos;Save report&apos;, defaultname=&apos;report.txt&apos;, issave=True)
4462 cbradney 3323
</translation>
4141 cbradney 3324
    </message>
3325
    <message>
12918 cbradney 3326
        <source>messageBox(&quot;caption&quot;, &quot;message&quot;,
3327
    icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT,
3328
    button2=BUTTON_NONE, button3=BUTTON_NONE) -&gt; integer
4141 cbradney 3329
 
12918 cbradney 3330
Displays a message box with the title &quot;caption&quot;, the message &quot;message&quot;, and
3331
an icon &quot;icon&quot; and up to 3 buttons. By default no icon is used and a single
3332
button, OK, is displayed. Only the caption and message arguments are required,
3333
though setting an icon and appropriate button(s) is strongly
3334
recommended. The message text may contain simple HTML-like markup.
3335
 
3336
Returns the number of the button the user pressed. Button numbers start
3337
at 1.
3338
 
3339
For the icon and the button parameters there are predefined constants available
3340
with the same names as in the Qt Documentation. These are the BUTTON_* and
3341
ICON_* constants defined in the module. There are also two extra constants that
3342
can be binary-ORed with button constants:
3343
    BUTTONOPT_DEFAULT   Pressing enter presses this button.
3344
    BUTTONOPT_ESCAPE    Pressing escape presses this button.
3345
 
3346
Usage examples:
3347
result = messageBox(&apos;Script failed&apos;,
3348
                    &apos;This script only works when you have a text frame selected.&apos;,
3349
                    ICON_ERROR)
3350
result = messageBox(&apos;Monkeys!&apos;, &apos;Something went ook! &lt;i&gt;Was it a monkey?&lt;/i&gt;&apos;,
3351
                    ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
3352
                    BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)
3353
 
3354
Defined button and icon constants:
3355
BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO,
3356
BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL,
3357
ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.
4141 cbradney 3358
</source>
12918 cbradney 3359
        <translation type="obsolete">messageBox(&quot;caption&quot;, &quot;message&quot;,
3360
    icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT,
3361
    button2=BUTTON_NONE, button3=BUTTON_NONE) -&gt; integer
4462 cbradney 3362
 
12918 cbradney 3363
Displays a message box with the title &quot;caption&quot;, the message &quot;message&quot;, and
3364
an icon &quot;icon&quot; and up to 3 buttons. By default no icon is used and a single
3365
button, OK, is displayed. Only the caption and message arguments are required,
3366
though setting an icon and appropriate button(s) is strongly
3367
recommended. The message text may contain simple HTML-like markup.
3368
 
3369
Returns the number of the button the user pressed. Button numbers start
3370
at 1.
3371
 
3372
For the icon and the button parameters there are predefined constants available
3373
with the same names as in the Qt Documentation. These are the BUTTON_* and
3374
ICON_* constants defined in the module. There are also two extra constants that
3375
can be binary-ORed with button constants:
3376
    BUTTONOPT_DEFAULT   Pressing enter presses this button.
3377
    BUTTONOPT_ESCAPE    Pressing escape presses this button.
3378
 
3379
Usage examples:
3380
result = messageBox(&apos;Script failed&apos;,
3381
                    &apos;This script only works when you have a text frame selected.&apos;,
3382
                    ICON_ERROR)
3383
result = messageBox(&apos;Monkeys!&apos;, &apos;Something went ook! &lt;i&gt;Was it a monkey?&lt;/i&gt;&apos;,
3384
                    ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
3385
                    BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)
3386
 
3387
Defined button and icon constants:
3388
BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO,
3389
BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL,
3390
ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.
4462 cbradney 3391
</translation>
4141 cbradney 3392
    </message>
6261 cbradney 3393
    <message>
12918 cbradney 3394
        <source>valueDialog(caption, message [,defaultvalue]) -&gt; string
6261 cbradney 3395
 
12918 cbradney 3396
Shows the common &apos;Ask for string&apos; dialog and returns its value as a string
3397
Parameters: window title, text in the window and optional &apos;default&apos; value.
3398
 
3399
Example: valueDialog(&apos;title&apos;, &apos;text in the window&apos;, &apos;optional&apos;)
6261 cbradney 3400
</source>
12918 cbradney 3401
        <translation type="obsolete">valueDialog(caption, message [,defaultvalue]) -&gt; string
3402
 
3403
Shows the common &apos;Ask for string&apos; dialog and returns its value as a string
3404
Parameters: window title, text in the window and optional &apos;default&apos; value.
3405
 
3406
Example: valueDialog(&apos;title&apos;, &apos;text in the window&apos;, &apos;optional&apos;)
3407
</translation>
6261 cbradney 3408
    </message>
3409
    <message>
12918 cbradney 3410
        <source>closeDoc()
6261 cbradney 3411
 
12918 cbradney 3412
Closes the current document without prompting to save.
3413
 
3414
May throw NoDocOpenError if there is no document to close
6261 cbradney 3415
</source>
12918 cbradney 3416
        <translation type="obsolete">closeDoc()
3417
 
3418
Closes the current document without prompting to save.
3419
 
3420
May throw NoDocOpenError if there is no document to close
3421
</translation>
6261 cbradney 3422
    </message>
3423
    <message>
12918 cbradney 3424
        <source>haveDoc() -&gt; bool