Subversion Repositories Scribus

Rev

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