Subversion Repositories Scribus

Rev

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

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