Subversion Repositories Scribus

Rev

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

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