Subversion Repositories Scribus

Rev

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