Subversion Repositories Scribus

Rev

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

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