Subversion Repositories Scribus

Rev

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

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