"SfR Fresh" - the SfR Freeware/Shareware Archive 
Member "scribus-1.3.3.12/scribus/po/scribus.sr.ts" of archive scribus-1.3.3.12.tar.gz:
As a special service "SfR Fresh" has tried to format the requested source page into HTML format using source code syntax highlighting with prefixed line numbers.
Alternatively you can here view or download the uninterpreted source code file.
That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field.
1 <!DOCTYPE TS><TS>
2 <context>
3 <name></name>
4 <message>
5 <source>getFontSize(["name"]) -> float
6
7 Returns the font size in points for the text frame "name". If this text
8 frame has some text selected the value assigned to the first character of
9 the selection is returned.
10 If "name" is not given the currently selected item is used.
11 </source>
12 <translation type="unfinished"></translation>
13 </message>
14 <message>
15 <source>getColorNames() -> list
16
17 Returns a list containing the names of all defined colors in the document.
18 If no document is open, returns a list of the default document colors.
19 </source>
20 <translation type="unfinished"></translation>
21 </message>
22 <message>
23 <source>newDocDialog() -> bool
24
25 Displays the "New Document" dialog box. Creates a new document if the user
26 accepts the settings. Does not create a document if the user presses cancel.
27 Returns true if a new document was created.
28 </source>
29 <translation type="unfinished"></translation>
30 </message>
31 <message>
32 <source>getFillColor(["name"]) -> string
33
34 Returns the name of the fill color of the object "name".
35 If "name" is not given the currently selected item is used.
36 </source>
37 <translation type="unfinished"></translation>
38 </message>
39 <message>
40 <source>moveObject(dx, dy [, "name"])
41
42 Moves the object "name" by dx and dy relative to its current position. The
43 distances are expressed in the current measurement unit of the document (see
44 UNIT constants). If "name" is not given the currently selected item is used.
45 If the object "name" belongs to a group, the whole group is moved.
46 </source>
47 <translation type="unfinished"></translation>
48 </message>
49 <message>
50 <source>setRedraw(bool)
51
52 Disables page redraw when bool = False, otherwise redrawing is enabled.
53 This change will persist even after the script exits, so make sure to call
54 setRedraw(True) in a finally: clause at the top level of your script.
55 </source>
56 <translation type="unfinished"></translation>
57 </message>
58 <message>
59 <source>createRect(x, y, width, height, ["name"]) -> string
60
61 Creates a new rectangle on the current page and returns its name. The
62 coordinates are given in the current measurement units of the document
63 (see UNIT constants). "name" should be a unique identifier for the object
64 because you need this name to reference that object in future. If "name"
65 is not given Scribus will create one for you.
66
67 May raise NameExistsError if you explicitly pass a name that's already used.
68 </source>
69 <translation type="unfinished"></translation>
70 </message>
71 <message>
72 <source>setGradientFill(type, "color1", shade1, "color2", shade2, ["name"])
73
74 Sets the gradient fill of the object "name" to type. Color descriptions are
75 the same as for setFillColor() and setFillShade(). See the constants for
76 available types (FILL_<type>).
77 </source>
78 <translation type="unfinished"></translation>
79 </message>
80 <message>
81 <source>messagebarText("string")
82
83 Writes the "string" into the Scribus message bar (status line). The text
84 must be UTF8 encoded or 'unicode' string(recommended).
85 </source>
86 <translation type="unfinished"></translation>
87 </message>
88 <message>
89 <source>newPage(where [,"masterpage"])
90
91 Creates a new page. If "where" is -1 the new Page is appended to the
92 document, otherwise the new page is inserted before "where". Page numbers are
93 counted from 1 upwards, no matter what the displayed first page number of your
94 document is. The optional parameter "masterpage" specifies the name of the
95 master page for the new page.
96
97 May raise IndexError if the page number is out of range
98 </source>
99 <translation type="unfinished"></translation>
100 </message>
101 <message>
102 <source>importSVG("string")
103
104 The "string" must be a valid filename for a SVG image. The text
105 must be UTF8 encoded or 'unicode' string(recommended).
106 </source>
107 <translation type="unfinished"></translation>
108 </message>
109 <message>
110 <source>newDocument(size, margins, orientation, firstPageNumber,
111 unit, pagesType, firstPageOrder) -> bool
112
113 Creates a new document and returns true if successful. The parameters have the
114 following meaning:
115
116 size = A tuple (width, height) describing the size of the document. You can
117 use predefined constants named PAPER_<paper_type> e.g. PAPER_A4 etc.
118
119 margins = A tuple (left, right, top, bottom) describing the document
120 margins
121
122 orientation = the page orientation - constants PORTRAIT, LANDSCAPE
123
124 firstPageNumer = is the number of the first page in the document used for
125 pagenumbering. While you'll usually want 1, it's useful to have higher
126 numbers if you're creating a document in several parts.
127
128 unit: this value sets the measurement units used by the document. Use a
129 predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS,
130 UNIT_PICAS, UNIT_POINTS.
131
132 pagesType = One of the predefined constants PAGE_n. PAGE_1 is single page,
133 PAGE_2 is for double sided documents, PAGE_3 is for 3 pages fold and
134 PAGE_4 is 4-fold.
135
136 firstPageOrder = What is position of first page in the document.
137 Indexed from 0 (0 = first).
138
139 numPage = Number of pages to be created.
140
141 The values for width, height and the margins are expressed in the given unit
142 for the document. PAPER_* constants are expressed in points. If your document
143 is not in points, make sure to account for this.
144
145 example: newDocument(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 7, UNIT_POINTS,
146 PAGE_4, 3, 1)
147
148 May raise ScribusError if is firstPageOrder bigger than allowed by pagesType.
149 </source>
150 <translation type="unfinished"></translation>
151 </message>
152 </context>
153 <context>
154 <name>@default</name>
155 <message>
156 <source>getFont(["name"]) -> string
157
158 Returns the font name for the text frame "name". If this text frame
159 has some text selected the value assigned to the first character
160 of the selection is returned. If "name" is not given the currently
161 selected item is used.
162 </source>
163 <translation type="unfinished"></translation>
164 </message>
165 <message>
166 <source>getTextLength(["name"]) -> integer
167
168 Returns the length of the text in the text frame "name".
169 If "name" is not given the currently selected item is used.
170 </source>
171 <translation type="unfinished"></translation>
172 </message>
173 <message>
174 <source>getText(["name"]) -> string
175
176 Returns the text of the text frame "name". If this text frame has some text
177 selected, the selected text is returned. All text in the frame, not just
178 currently visible text, is returned. If "name" is not given the currently
179 selected item is used.
180 </source>
181 <translation type="unfinished"></translation>
182 </message>
183 <message>
184 <source>getAllText(["name"]) -> string
185
186 Returns the text of the text frame "name" and of all text frames which are
187 linked with this frame. If this textframe has some text selected, the selected
188 text is returned. If "name" is not given the currently selected item is
189 used.
190 </source>
191 <translation type="unfinished"></translation>
192 </message>
193 <message>
194 <source>getLineSpacing(["name"]) -> float
195
196 Returns the line spacing ("leading") of the text frame "name" expressed in
197 points. If "name" is not given the currently selected item is used.
198 </source>
199 <translation type="unfinished"></translation>
200 </message>
201 <message>
202 <source>getColumnGap(["name"]) -> float
203
204 Returns the column gap size of the text frame "name" expressed in points. If
205 "name" is not given the currently selected item is used.
206 </source>
207 <translation type="unfinished"></translation>
208 </message>
209 <message>
210 <source>getColumns(["name"]) -> integer
211
212 Gets the number of columns of the text frame "name". If "name" is not
213 given the currently selected item is used.
214 </source>
215 <translation type="unfinished"></translation>
216 </message>
217 <message>
218 <source>setText("text", ["name"])
219
220 Sets the text of the text frame "name" to the text of the string "text".
221 Text must be UTF8 encoded - use e.g. unicode(text, 'iso-8859-2'). See the FAQ
222 for more details. If "name" is not given the currently selected item is
223 used.
224 </source>
225 <translation type="unfinished"></translation>
226 </message>
227 <message>
228 <source>setFont("font", ["name"])
229
230 Sets the font of the text frame "name" to "font". If there is some text
231 selected only the selected text is changed. If "name" is not given the
232 currently selected item is used.
233
234 May throw ValueError if the font cannot be found.
235 </source>
236 <translation type="unfinished"></translation>
237 </message>
238 <message>
239 <source>setFontSize(size, ["name"])
240
241 Sets the font size of the text frame "name" to "size". "size" is treated
242 as a value in points. If there is some text selected only the selected text is
243 changed. "size" must be in the range 1 to 512. If "name" is not given the
244 currently selected item is used.
245
246 May throw ValueError for a font size that's out of bounds.
247 </source>
248 <translation type="unfinished"></translation>
249 </message>
250 <message>
251 <source>setLineSpacing(size, ["name"])
252
253 Sets the line spacing ("leading") of the text frame "name" to "size".
254 "size" is a value in points. If "name" is not given the currently selected
255 item is used.
256
257 May throw ValueError if the line spacing is out of bounds.
258 </source>
259 <translation type="unfinished"></translation>
260 </message>
261 <message>
262 <source>setColumnGap(size, ["name"])
263
264 Sets the column gap of the text frame "name" to the value "size". If
265 "name" is not given the currently selected item is used.
266
267 May throw ValueError if the column gap is out of bounds (must be positive).
268 </source>
269 <translation type="unfinished"></translation>
270 </message>
271 <message>
272 <source>setColumns(nr, ["name"])
273
274 Sets the number of columns of the text frame "name" to the integer "nr".
275 If "name" is not given the currently selected item is used.
276
277 May throw ValueError if number of columns is not at least one.
278 </source>
279 <translation type="unfinished"></translation>
280 </message>
281 <message>
282 <source>setTextAlignment(align, ["name"])
283
284 Sets the text alignment of the text frame "name" to the specified alignment.
285 If "name" is not given the currently selected item is used. "align" should
286 be one of the ALIGN_ constants defined in this module - see dir(scribus).
287
288 May throw ValueError for an invalid alignment constant.
289 </source>
290 <translation type="unfinished"></translation>
291 </message>
292 <message>
293 <source>deleteText(["name"])
294
295 Deletes any text in the text frame "name". If there is some text selected,
296 only the selected text will be deleted. If "name" is not given the currently
297 selected item is used.
298 </source>
299 <translation type="unfinished"></translation>
300 </message>
301 <message>
302 <source>setTextColor("color", ["name"])
303
304 Sets the text color of the text frame "name" to the color "color". If there
305 is some text selected only the selected text is changed. If "name" is not
306 given the currently selected item is used.
307 </source>
308 <translation type="unfinished"></translation>
309 </message>
310 <message>
311 <source>setTextStroke("color", ["name"])
312
313 Set "color" of the text stroke. If "name" is not given the currently
314 selected item is used.
315 </source>
316 <translation type="unfinished"></translation>
317 </message>
318 <message>
319 <source>setTextShade(shade, ["name"])
320
321 Sets the shading of the text color of the object "name" to "shade". If
322 there is some text selected only the selected text is changed. "shade" must
323 be an integer value in the range from 0 (lightest) to 100 (full color
324 intensity). If "name" is not given the currently selected item is
325 used.
326 </source>
327 <translation type="unfinished"></translation>
328 </message>
329 <message>
330 <source>linkTextFrames("fromname", "toname")
331
332 Link two text frames. The frame named "fromname" is linked to the
333 frame named "toname". The target frame must be an empty text frame
334 and must not link to or be linked from any other frames already.
335
336 May throw ScribusException if linking rules are violated.
337 </source>
338 <translation type="unfinished"></translation>
339 </message>
340 <message>
341 <source>unlinkTextFrames("name")
342
343 Remove the specified (named) object from the text frame flow/linkage. If the
344 frame was in the middle of a chain, the previous and next frames will be
345 connected, eg 'a->b->c' becomes 'a->c' when you unlinkTextFrames(b)'
346
347 May throw ScribusException if linking rules are violated.
348 </source>
349 <translation type="unfinished"></translation>
350 </message>
351 <message>
352 <source>traceText(["name"])
353
354 Convert the text frame "name" to outlines. If "name" is not given the
355 currently selected item is used.</source>
356 <translation type="unfinished"></translation>
357 </message>
358 <message>
359 <source>getColor("name") -> tuple
360
361 Returns a tuple (C, M, Y, K) containing the four color components of the
362 color "name" from the current document. If no document is open, returns
363 the value of the named color from the default document colors.
364
365 May raise NotFoundError if the named color wasn't found.
366 May raise ValueError if an invalid color name is specified.
367 </source>
368 <translation type="unfinished"></translation>
369 </message>
370 <message>
371 <source>changeColor("name", c, m, y, k)
372
373 Changes the color "name" to the specified CMYK value. The color value is
374 defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black.
375 Color components should be in the range from 0 to 255.
376
377 May raise NotFoundError if the named color wasn't found.
378 May raise ValueError if an invalid color name is specified.
379 </source>
380 <translation type="unfinished"></translation>
381 </message>
382 <message>
383 <source>deleteColor("name", "replace")
384
385 Deletes the color "name". Every occurence of that color is replaced by the
386 color "replace". If not specified, "replace" defaults to the color
387 "None" - transparent.
388
389 deleteColor works on the default document colors if there is no document open.
390 In that case, "replace", if specified, has no effect.
391
392 May raise NotFoundError if a named color wasn't found.
393 May raise ValueError if an invalid color name is specified.
394 </source>
395 <translation type="unfinished"></translation>
396 </message>
397 <message>
398 <source>replaceColor("name", "replace")
399
400 Every occurence of the color "name" is replaced by the color "replace".
401
402 May raise NotFoundError if a named color wasn't found.
403 May raise ValueError if an invalid color name is specified.
404 </source>
405 <translation type="unfinished"></translation>
406 </message>
407 <message>
408 <source>messageBox("caption", "message",
409 icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT,
410 button2=BUTTON_NONE, button3=BUTTON_NONE) -> integer
411
412 Displays a message box with the title "caption", the message "message", and
413 an icon "icon" and up to 3 buttons. By default no icon is used and a single
414 button, OK, is displayed. Only the caption and message arguments are required,
415 though setting an icon and appropriate button(s) is strongly
416 recommended. The message text may contain simple HTML-like markup.
417
418 Returns the number of the button the user pressed. Button numbers start
419 at 1.
420
421 For the icon and the button parameters there are predefined constants available
422 with the same names as in the Qt Documentation. These are the BUTTON_* and
423 ICON_* constants defined in the module. There are also two extra constants that
424 can be binary-ORed with button constants:
425 BUTTONOPT_DEFAULT Pressing enter presses this button.
426 BUTTONOPT_ESCAPE Pressing escape presses this button.
427
428 Usage examples:
429 result = messageBox('Script failed',
430 'This script only works when you have a text frame selected.',
431 ICON_ERROR)
432 result = messageBox('Monkeys!', 'Something went ook! <i>Was it a monkey?</i>',
433 ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
434 BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)
435
436 Defined button and icon constants:
437 BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO,
438 BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL,
439 ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.
440 </source>
441 <translation type="unfinished"></translation>
442 </message>
443 <message>
444 <source>valueDialog(caption, message [,defaultvalue]) -> string
445
446 Shows the common 'Ask for string' dialog and returns its value as a string
447 Parameters: window title, text in the window and optional 'default' value.
448
449 Example: valueDialog('title', 'text in the window', 'optional')
450 </source>
451 <translation type="unfinished"></translation>
452 </message>
453 <message>
454 <source>closeDoc()
455
456 Closes the current document without prompting to save.
457
458 May throw NoDocOpenError if there is no document to close
459 </source>
460 <translation type="unfinished"></translation>
461 </message>
462 <message>
463 <source>haveDoc() -> bool
464
465 Returns true if there is a document open.
466 </source>
467 <translation type="unfinished"></translation>
468 </message>
469 <message>
470 <source>openDoc("name")
471
472 Opens the document "name".
473
474 May raise ScribusError if the document could not be opened.
475 </source>
476 <translation type="unfinished"></translation>
477 </message>
478 <message>
479 <source>saveDoc()
480
481 Saves the current document with its current name, returns true if successful.
482 If the document has not already been saved, this may bring up an interactive
483 save file dialog.
484
485 If the save fails, there is currently no way to tell.
486 </source>
487 <translation type="unfinished"></translation>
488 </message>
489 <message>
490 <source>saveDocAs("name")
491
492 Saves the current document under the new name "name" (which may be a full or
493 relative path).
494
495 May raise ScribusError if the save fails.
496 </source>
497 <translation type="unfinished"></translation>
498 </message>
499 <message>
500 <source>setMargins(lr, rr, tr, br)
501
502 Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br)
503 margins are given in the measurement units of the document - see UNIT_<type>
504 constants.
505 </source>
506 <translation type="unfinished"></translation>
507 </message>
508 <message>
509 <source>setUnit(type)
510
511 Changes the measurement unit of the document. Possible values for "unit" are
512 defined as constants UNIT_<type>.
513
514 May raise ValueError if an invalid unit is passed.
515 </source>
516 <translation type="unfinished"></translation>
517 </message>
518 <message>
519 <source>getUnit() -> integer (Scribus unit constant)
520
521 Returns the measurement units of the document. The returned value will be one
522 of the UNIT_* constants:
523 UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.
524 </source>
525 <translation type="unfinished"></translation>
526 </message>
527 <message>
528 <source>loadStylesFromFile("filename")
529
530 Loads paragraph styles from the Scribus document at "filename" into the
531 current document.
532 </source>
533 <translation type="unfinished"></translation>
534 </message>
535 <message>
536 <source>setDocType(facingPages, firstPageLeft)
537
538 Sets the document type. To get facing pages set the first parameter to
539 FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want
540 to be the first page a left side set the second parameter to FIRSTPAGELEFT, for
541 a right page use FIRSTPAGERIGHT.
542 </source>
543 <translation type="unfinished"></translation>
544 </message>
545 <message>
546 <source>getLineColor(["name"]) -> string
547
548 Returns the name of the line color of the object "name".
549 If "name" is not given the currently selected item is used.
550 </source>
551 <translation type="unfinished"></translation>
552 </message>
553 <message>
554 <source>getLineWidth(["name"]) -> integer
555
556 Returns the line width of the object "name". If "name"
557 is not given the currently selected Item is used.
558 </source>
559 <translation type="unfinished"></translation>
560 </message>
561 <message>
562 <source>getLineShade(["name"]) -> integer
563
564 Returns the shading value of the line color of the object "name".
565 If "name" is not given the currently selected item is used.
566 </source>
567 <translation type="unfinished"></translation>
568 </message>
569 <message>
570 <source>getLineJoin(["name"]) -> integer (see contants)
571
572 Returns the line join style of the object "name". If "name" is not given
573 the currently selected item is used. The join types are:
574 JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND
575 </source>
576 <translation type="unfinished"></translation>
577 </message>
578 <message>
579 <source>getLineEnd(["name"]) -> integer (see constants)
580
581 Returns the line cap style of the object "name". If "name" is not given the
582 currently selected item is used. The cap types are:
583 CAP_FLAT, CAP_ROUND, CAP_SQUARE
584 </source>
585 <translation type="unfinished"></translation>
586 </message>
587 <message>
588 <source>getLineStyle(["name"]) -> integer (see constants)
589
590 Returns the line style of the object "name". If "name" is not given the
591 currently selected item is used. Line style constants are:
592 LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID
593 </source>
594 <translation type="unfinished"></translation>
595 </message>
596 <message>
597 <source>getFillShade(["name"]) -> integer
598
599 Returns the shading value of the fill color of the object "name".
600 If "name" is not given the currently selected item is used.
601 </source>
602 <translation type="unfinished"></translation>
603 </message>
604 <message>
605 <source>getImageScale(["name"]) -> (x,y)
606
607 Returns a (x, y) tuple containing the scaling values of the image frame
608 "name". If "name" is not given the currently selected item is used.
609 </source>
610 <translation type="unfinished"></translation>
611 </message>
612 <message>
613 <source>getImageName(["name"]) -> string
614
615 Returns the filename for the image in the image frame. If "name" is not
616 given the currently selected item is used.
617 </source>
618 <translation type="unfinished"></translation>
619 </message>
620 <message>
621 <source>getSize(["name"]) -> (width,height)
622
623 Returns a (width, height) tuple with the size of the object "name".
624 If "name" is not given the currently selected item is used. The size is
625 expressed in the current measurement unit of the document - see UNIT_<type>
626 for reference.
627 </source>
628 <translation type="unfinished"></translation>
629 </message>
630 <message>
631 <source>getRotation(["name"]) -> integer
632
633 Returns the rotation of the object "name". The value is expressed in degrees,
634 and clockwise is positive. If "name" is not given the currently selected item
635 is used.
636 </source>
637 <translation type="unfinished"></translation>
638 </message>
639 <message>
640 <source>getAllObjects() -> list
641
642 Returns a list containing the names of all objects on the current page.
643 </source>
644 <translation type="unfinished"></translation>
645 </message>
646 <message>
647 <source>moveObjectAbs(x, y [, "name"])
648
649 Moves the object "name" to a new location. The coordinates are expressed in
650 the current measurement unit of the document (see UNIT constants). If "name"
651 is not given the currently selected item is used. If the object "name"
652 belongs to a group, the whole group is moved.
653 </source>
654 <translation type="unfinished"></translation>
655 </message>
656 <message>
657 <source>rotateObject(rot [, "name"])
658
659 Rotates the object "name" by "rot" degrees relatively. The object is
660 rotated by the vertex that is currently selected as the rotation point - by
661 default, the top left vertext at zero rotation. Positive values mean counter
662 clockwise rotation when the default rotation point is used. If "name" is not
663 given the currently selected item is used.
664 </source>
665 <translation type="unfinished"></translation>
666 </message>
667 <message>
668 <source>sizeObject(width, height [, "name"])
669
670 Resizes the object "name" to the given width and height. If "name"
671 is not given the currently selected item is used.
672 </source>
673 <translation type="unfinished"></translation>
674 </message>
675 <message>
676 <source>getSelectedObject([nr]) -> string
677
678 Returns the name of the selected object. "nr" if given indicates the number
679 of the selected object, e.g. 0 means the first selected object, 1 means the
680 second selected Object and so on.
681 </source>
682 <translation type="unfinished"></translation>
683 </message>
684 <message>
685 <source>selectionCount() -> integer
686
687 Returns the number of selected objects.
688 </source>
689 <translation type="unfinished"></translation>
690 </message>
691 <message>
692 <source>selectObject("name")
693
694 Selects the object with the given "name".
695 </source>
696 <translation type="unfinished"></translation>
697 </message>
698 <message>
699 <source>deselectAll()
700
701 Deselects all objects in the whole document.
702 </source>
703 <translation type="unfinished"></translation>
704 </message>
705 <message>
706 <source>groupObjects(list)
707
708 Groups the objects named in "list" together. "list" must contain the names
709 of the objects to be grouped. If "list" is not given the currently selected
710 items are used.
711 </source>
712 <translation type="unfinished"></translation>
713 </message>
714 <message>
715 <source>unGroupObjects("name")
716
717 Destructs the group the object "name" belongs to.If "name" is not given the currently selected item is used.</source>
718 <translation type="unfinished"></translation>
719 </message>
720 <message>
721 <source>scaleGroup(factor [,"name"])
722
723 Scales the group the object "name" belongs to. Values greater than 1 enlarge
724 the group, values smaller than 1 make the group smaller e.g a value of 0.5
725 scales the group to 50 % of its original size, a value of 1.5 scales the group
726 to 150 % of its original size. The value for "factor" must be greater than
727 0. If "name" is not given the currently selected item is used.
728
729 May raise ValueError if an invalid scale factor is passed.
730 </source>
731 <translation type="unfinished"></translation>
732 </message>
733 <message>
734 <source>loadImage("filename" [, "name"])
735
736 Loads the picture "picture" into the image frame "name". If "name" is
737 not given the currently selected item is used.
738
739 May raise WrongFrameTypeError if the target frame is not an image frame
740 </source>
741 <translation type="unfinished"></translation>
742 </message>
743 <message>
744 <source>scaleImage(x, y [, "name"])
745
746 Sets the scaling factors of the picture in the image frame "name".
747 If "name" is not given the currently selected item is used. A number of 1
748 means 100 %.
749
750 May raise WrongFrameTypeError if the target frame is not an image frame
751 </source>
752 <translation type="unfinished"></translation>
753 </message>
754 <message>
755 <source>lockObject(["name"]) -> bool
756
757 Locks the object "name" if it's unlocked or unlock it if it's locked.
758 If "name" is not given the currently selected item is used. Returns true
759 if locked.
760 </source>
761 <translation type="unfinished"></translation>
762 </message>
763 <message>
764 <source>isLocked(["name"]) -> bool
765
766 Returns true if is the object "name" locked. If "name" is not given the
767 currently selected item is used.
768 </source>
769 <translation type="unfinished"></translation>
770 </message>
771 <message>
772 <source>getFontNames() -> list
773
774 Returns a list with the names of all available fonts.
775 </source>
776 <translation type="unfinished"></translation>
777 </message>
778 <message>
779 <source>getXFontNames() -> list of tuples
780
781 Returns a larger font info. It's a list of the tuples with:
782 [ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ]
783 </source>
784 <translation type="unfinished"></translation>
785 </message>
786 <message>
787 <source>getLayers() -> list
788
789 Returns a list with the names of all defined layers.
790 </source>
791 <translation type="unfinished"></translation>
792 </message>
793 <message>
794 <source>setActiveLayer("name")
795
796 Sets the active layer to the layer named "name".
797
798 May raise NotFoundError if the layer can't be found.
799 May raise ValueError if the layer name isn't acceptable.
800 </source>
801 <translation type="unfinished"></translation>
802 </message>
803 <message>
804 <source>getActiveLayer() -> string
805
806 Returns the name of the current active layer.
807 </source>
808 <translation type="unfinished"></translation>
809 </message>
810 <message>
811 <source>sentToLayer("layer" [, "name"])
812
813 Sends the object "name" to the layer "layer". The layer must exist.
814 If "name" is not given the currently selected item is used.
815
816 May raise NotFoundError if the layer can't be found.
817 May raise ValueError if the layer name isn't acceptable.
818 </source>
819 <translation type="unfinished"></translation>
820 </message>
821 <message>
822 <source>setLayerVisible("layer", visible)
823
824 Sets the layer "layer" to be visible or not. If is the visible set to false
825 the layer is invisible.
826
827 May raise NotFoundError if the layer can't be found.
828 May raise ValueError if the layer name isn't acceptable.
829 </source>
830 <translation type="unfinished"></translation>
831 </message>
832 <message>
833 <source>setLayerPrintable("layer", printable)
834
835 Sets the layer "layer" to be printable or not. If is the printable set to
836 false the layer won't be printed.
837
838 May raise NotFoundError if the layer can't be found.
839 May raise ValueError if the layer name isn't acceptable.
840 </source>
841 <translation type="unfinished"></translation>
842 </message>
843 <message>
844 <source>deleteLayer("layer")
845
846 Deletes the layer with the name "layer". Nothing happens if the layer doesn't
847 exists or if it's the only layer in the document.
848
849 May raise NotFoundError if the layer can't be found.
850 May raise ValueError if the layer name isn't acceptable.
851 </source>
852 <translation type="unfinished"></translation>
853 </message>
854 <message>
855 <source>createLayer(layer)
856
857 Creates a new layer with the name "name".
858
859 May raise ValueError if the layer name isn't acceptable.
860 </source>
861 <translation type="unfinished"></translation>
862 </message>
863 <message>
864 <source>getGuiLanguage() -> string
865
866 Returns a string with the -lang value.
867 </source>
868 <translation type="unfinished"></translation>
869 </message>
870 <message>
871 <source>createEllipse(x, y, width, height, ["name"]) -> string
872
873 Creates a new ellipse on the current page and returns its name.
874 The coordinates are given in the current measurement units of the document
875 (see UNIT constants). "name" should be a unique identifier for the object
876 because you need this name for further referencing of that object. If "name"
877 is not given Scribus will create one for you.
878
879 May raise NameExistsError if you explicitly pass a name that's already used.
880 </source>
881 <translation type="unfinished"></translation>
882 </message>
883 <message>
884 <source>createImage(x, y, width, height, ["name"]) -> string
885
886 Creates a new picture frame on the current page and returns its name. The
887 coordinates are given in the current measurement units of the document.
888 "name" should be a unique identifier for the object because you need this
889 name for further access to that object. If "name" is not given Scribus will
890 create one for you.
891
892 May raise NameExistsError if you explicitly pass a name that's already used.
893 </source>
894 <translation type="unfinished"></translation>
895 </message>
896 <message>
897 <source>createText(x, y, width, height, ["name"]) -> string
898
899 Creates a new text frame on the actual page and returns its name.
900 The coordinates are given in the actual measurement unit of the document (see
901 UNIT constants). "name" should be a unique identifier for the object because
902 you need this name for further referencing of that object. If "name" is not
903 given Scribus will create one for you.
904
905 May raise NameExistsError if you explicitly pass a name that's already used.
906 </source>
907 <translation type="unfinished"></translation>
908 </message>
909 <message>
910 <source>createLine(x1, y1, x2, y2, ["name"]) -> string
911
912 Creates a new line from the point(x1, y1) to the point(x2, y2) and returns
913 its name. The coordinates are given in the current measurement unit of the
914 document (see UNIT constants). "name" should be a unique identifier for the
915 object because you need this name for further access to that object. If
916 "name" is not given Scribus will create one for you.
917
918 May raise NameExistsError if you explicitly pass a name that's already used.
919 </source>
920 <translation type="unfinished"></translation>
921 </message>
922 <message>
923 <source>createPolyLine(list, ["name"]) -> string
924
925 Creates a new polyline and returns its name. The points for the polyline are
926 stored in the list "list" in the following order: [x1, y1, x2, y2...xn. yn].
927 The coordinates are given in the current measurement units of the document (see
928 UNIT constants). "name" should be a unique identifier for the object because
929 you need this name for further access to that object. If "name" is not given
930 Scribus will create one for you.
931
932 May raise NameExistsError if you explicitly pass a name that's already used.
933 May raise ValueError if an insufficient number of points is passed or if
934 the number of values passed don't group into points without leftovers.
935 </source>
936 <translation type="unfinished"></translation>
937 </message>
938 <message>
939 <source>createPolygon(list, ["name"]) -> string
940
941 Creates a new polygon and returns its name. The points for the polygon are
942 stored in the list "list" in the following order: [x1, y1, x2, y2...xn. yn].
943 At least three points are required. There is no need to repeat the first point
944 to close the polygon. The polygon is automatically closed by connecting the
945 first and the last point. The coordinates are given in the current measurement
946 units of the document (see UNIT constants). "name" should be a unique
947 identifier for the object because you need this name for further access to that
948 object. If "name" is not given Scribus will create one for you.
949
950 May raise NameExistsError if you explicitly pass a name that's already used.
951 May raise ValueError if an insufficient number of points is passed or if
952 the number of values passed don't group into points without leftovers.
953 </source>
954 <translation type="unfinished"></translation>
955 </message>
956 <message>
957 <source>createBezierLine(list, ["name"]) -> string
958
959 Creates a new bezier curve and returns its name. The points for the bezier
960 curve are stored in the list "list" in the following order:
961 [x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]
962 In the points list, x and y mean the x and y coordinates of the point and kx
963 and ky meaning the control point for the curve. The coordinates are given in
964 the current measurement units of the document (see UNIT constants). "name"
965 should be a unique identifier for the object because you need this name for
966 further access to that object. If "name" is not given Scribus will create one
967 for you.
968
969 May raise NameExistsError if you explicitly pass a name that's already used.
970 May raise ValueError if an insufficient number of points is passed or if
971 the number of values passed don't group into points without leftovers.
972 </source>
973 <translation type="unfinished"></translation>
974 </message>
975 <message>
976 <source>createPathText(x, y, "textbox", "beziercurve", ["name"]) -> string
977
978 Creates a new pathText by merging the two objects "textbox" and
979 "beziercurve" and returns its name. The coordinates are given in the current
980 measurement unit of the document (see UNIT constants). "name" should be a
981 unique identifier for the object because you need this name for further access
982 to that object. If "name" is not given Scribus will create one for you.
983
984 May raise NameExistsError if you explicitly pass a name that's already used.
985 May raise NotFoundError if one or both of the named base object don't exist.
986 </source>
987 <translation type="unfinished"></translation>
988 </message>
989 <message>
990 <source>deleteObject(["name"])
991
992 Deletes the item with the name "name". If "name" is not given the currently
993 selected item is deleted.
994 </source>
995 <translation type="unfinished"></translation>
996 </message>
997 <message>
998 <source>textFlowsAroundFrame("name" [, state])
999
1000 Enables/disables "Text Flows Around Frame" feature for object "name".
1001 Called with parameters string name and optional boolean "state". If "state"
1002 is not passed, text flow is toggled.
1003 </source>
1004 <translation type="unfinished"></translation>
1005 </message>
1006 <message>
1007 <source>objectExists(["name"]) -> bool
1008
1009 Test if an object with specified name really exists in the document.
1010 The optional parameter is the object name. When no object name is given,
1011 returns True if there is something selected.
1012 </source>
1013 <translation type="unfinished"></translation>
1014 </message>
1015 <message>
1016 <source>setStyle("style" [, "name"])
1017
1018 Apply the named "style" to the object named "name". If is no object name
1019 given, it's applied on the selected object.
1020 </source>
1021 <translation type="unfinished"></translation>
1022 </message>
1023 <message>
1024 <source>getAllStyles() -> list
1025
1026 Return a list of the names of all paragraph styles in the current document.
1027 </source>
1028 <translation type="unfinished"></translation>
1029 </message>
1030 <message>
1031 <source>currentPage() -> integer
1032
1033 Returns the number of the current working page. Page numbers are counted from 1
1034 upwards, no matter what the displayed first page number of your document is.
1035 </source>
1036 <translation type="unfinished"></translation>
1037 </message>
1038 <message>
1039 <source>redrawAll()
1040
1041 Redraws all pages.
1042 </source>
1043 <translation type="unfinished"></translation>
1044 </message>
1045 <message>
1046 <source>savePageAsEPS("name")
1047
1048 Saves the current page as an EPS to the file "name".
1049
1050 May raise ScribusError if the save failed.
1051 </source>
1052 <translation type="unfinished"></translation>
1053 </message>
1054 <message>
1055 <source>deletePage(nr)
1056
1057 Deletes the given page. Does nothing if the document contains only one page.
1058 Page numbers are counted from 1 upwards, no matter what the displayed first
1059 page number is.
1060
1061 May raise IndexError if the page number is out of range
1062 </source>
1063 <translation type="unfinished"></translation>
1064 </message>
1065 <message>
1066 <source>gotoPage(nr)
1067
1068 Moves to the page "nr" (that is, makes the current page "nr"). Note that
1069 gotoPage doesn't (curently) change the page the user's view is displaying, it
1070 just sets the page that script commands will operates on.
1071
1072 May raise IndexError if the page number is out of range.
1073 </source>
1074 <translation type="unfinished"></translation>
1075 </message>
1076 <message>
1077 <source>pageCount() -> integer
1078
1079 Returns the number of pages in the document.
1080 </source>
1081 <translation type="unfinished"></translation>
1082 </message>
1083 <message>
1084 <source>getHGuides() -> list
1085
1086 Returns a list containing positions of the horizontal guides. Values are in the
1087 document's current units - see UNIT_<type> constants.
1088 </source>
1089 <translation type="unfinished"></translation>
1090 </message>
1091 <message>
1092 <source>setHGuides(list)
1093
1094 Sets horizontal guides. Input parameter must be a list of guide positions
1095 measured in the current document units - see UNIT_<type> constants.
1096
1097 Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost
1098 setHGuides([90,250]) # replace current guides entirely
1099 </source>
1100 <translation type="unfinished"></translation>
1101 </message>
1102 <message>
1103 <source>getVGuides()
1104
1105 See getHGuides.
1106 </source>
1107 <translation type="unfinished"></translation>
1108 </message>
1109 <message>
1110 <source>setVGuides()
1111
1112 See setHGuides.
1113 </source>
1114 <translation type="unfinished"></translation>
1115 </message>
1116 <message>
1117 <source>getPageSize() -> tuple
1118
1119 Returns a tuple with page dimensions measured in the document's current units.
1120 See UNIT_<type> constants and getPageMargins()
1121 </source>
1122 <translation type="unfinished"></translation>
1123 </message>
1124 <message>
1125 <source>getPageItems() -> list
1126
1127 Returns a list of tuples with items on the current page. The tuple is:
1128 (name, objectType, order) E.g. [('Text1', 4, 0), ('Image1', 2, 1)]
1129 means that object named 'Text1' is a text frame (type 4) and is the first at
1130 the page...
1131 </source>
1132 <translation type="unfinished"></translation>
1133 </message>
1134 <message>
1135 <source>setFillColor("color", ["name"])
1136
1137 Sets the fill color of the object "name" to the color "color". "color"
1138 is the name of one of the defined colors. If "name" is not given the
1139 currently selected item is used.
1140 </source>
1141 <translation type="unfinished"></translation>
1142 </message>
1143 <message>
1144 <source>setLineColor("color", ["name"])
1145
1146 Sets the line color of the object "name" to the color "color". If "name"
1147 is not given the currently selected item is used.
1148 </source>
1149 <translation type="unfinished"></translation>
1150 </message>
1151 <message>
1152 <source>setLineWidth(width, ["name"])
1153
1154 Sets line width of the object "name" to "width". "width" must be in the
1155 range from 0.0 to 12.0 inclusive, and is measured in points. If "name" is not
1156 given the currently selected item is used.
1157
1158 May raise ValueError if the line width is out of bounds.
1159 </source>
1160 <translation type="unfinished"></translation>
1161 </message>
1162 <message>
1163 <source>setLineShade(shade, ["name"])
1164
1165 Sets the shading of the line color of the object "name" to "shade".
1166 "shade" must be an integer value in the range from 0 (lightest) to 100
1167 (full color intensity). If "name" is not given the currently selected item
1168 is used.
1169
1170 May raise ValueError if the line shade is out of bounds.
1171 </source>
1172 <translation type="unfinished"></translation>
1173 </message>
1174 <message>
1175 <source>setLineJoin(join, ["name"])
1176
1177 Sets the line join style of the object "name" to the style "join".
1178 If "name" is not given the currently selected item is used. There are
1179 predefined constants for join - JOIN_<type>.
1180 </source>
1181 <translation type="unfinished"></translation>
1182 </message>
1183 <message>
1184 <source>setLineEnd(endtype, ["name"])
1185
1186 Sets the line cap style of the object "name" to the style "cap".
1187 If "name" is not given the currently selected item is used. There are
1188 predefined constants for "cap" - CAP_<type>.
1189 </source>
1190 <translation type="unfinished"></translation>
1191 </message>
1192 <message>
1193 <source>setLineStyle(style, ["name"])
1194
1195 Sets the line style of the object "name" to the style "style". If "name"
1196 is not given the currently selected item is used. There are predefined
1197 constants for "style" - LINE_<style>.
1198 </source>
1199 <translation type="unfinished"></translation>
1200 </message>
1201 <message>
1202 <source>setFillShade(shade, ["name"])
1203
1204 Sets the shading of the fill color of the object "name" to "shade".
1205 "shade" must be an integer value in the range from 0 (lightest) to 100
1206 (full Color intensity). If "name" is not given the currently selected
1207 Item is used.
1208
1209 May raise ValueError if the fill shade is out of bounds.
1210 </source>
1211 <translation type="unfinished"></translation>
1212 </message>
1213 <message>
1214 <source>setCornerRadius(radius, ["name"])
1215
1216 Sets the corner radius of the object "name". The radius is expressed
1217 in points. If "name" is not given the currently selected item is used.
1218
1219 May raise ValueError if the corner radius is negative.
1220 </source>
1221 <translation type="unfinished"></translation>
1222 </message>
1223 <message>
1224 <source>setMultiLine("namedStyle", ["name"])
1225
1226 Sets the line style of the object "name" to the named style "namedStyle".
1227 If "name" is not given the currently selected item is used.
1228
1229 May raise NotFoundError if the line style doesn't exist.
1230 </source>
1231 <translation type="unfinished"></translation>
1232 </message>
1233 <message>
1234 <source>progressReset()
1235
1236 Cleans up the Scribus progress bar previous settings. It is called before the
1237 new progress bar use. See progressSet.
1238 </source>
1239 <translation type="unfinished"></translation>
1240 </message>
1241 <message>
1242 <source>progressTotal(max)
1243
1244 Sets the progress bar's maximum steps value to the specified number.
1245 See progressSet.
1246 </source>
1247 <translation type="unfinished"></translation>
1248 </message>
1249 <message>
1250 <source>progressSet(nr)
1251
1252 Set the progress bar position to "nr", a value relative to the previously set
1253 progressTotal. The progress bar uses the concept of steps; you give it the
1254 total number of steps and the number of steps completed so far and it will
1255 display the percentage of steps that have been completed. You can specify the
1256 total number of steps with progressTotal(). The current number of steps is set
1257 with progressSet(). The progress bar can be rewound to the beginning with
1258 progressReset(). [based on info taken from Trolltech's Qt docs]
1259 </source>
1260 <translation type="unfinished"></translation>
1261 </message>
1262 <message>
1263 <source>setCursor()
1264
1265 [UNSUPPORTED!] This might break things, so steer clear for now.
1266 </source>
1267 <translation type="unfinished"></translation>
1268 </message>
1269 <message>
1270 <source>docChanged(bool)
1271
1272 Enable/disable save icon in the Scribus icon bar and the Save menu item. It's
1273 useful to call this procedure when you're changing the document, because Scribus
1274 won't automatically notice when you change the document using a script.
1275 </source>
1276 <translation type="unfinished"></translation>
1277 </message>
1278 <message>
1279 <source>setScaleImageToFrame(scaletoframe, proportional=None, name=<selection>)
1280
1281 Sets the scale to frame on the selected or specified image frame to `scaletoframe'.
1282 If `proportional' is specified, set fixed aspect ratio scaling to `proportional'.
1283 Both `scaletoframe' and `proportional' are boolean.
1284
1285 May raise WrongFrameTypeError.
1286 </source>
1287 <translation type="unfinished"></translation>
1288 </message>
1289 <message>
1290 <source>isLayerPrintable("layer") -> bool
1291
1292 Returns whether the layer "layer" is visible or not, a value of True means
1293 that the layer "layer" is visible, a value of False means that the layer
1294 "layer" is invisible.
1295
1296 May raise NotFoundError if the layer can't be found.
1297 May raise ValueError if the layer name isn't acceptable.
1298 </source>
1299 <translation type="unfinished"></translation>
1300 </message>
1301 <message>
1302 <source>isLayerPrintable("layer") -> bool
1303
1304 Returns whether the layer "layer" is printable or not, a value of True means
1305 that the layer "layer" can be printed, a value of False means that printing
1306 the layer "layer" is disabled.
1307
1308 May raise NotFoundError if the layer can't be found.
1309 May raise ValueError if the layer name isn't acceptable.
1310 </source>
1311 <translation type="unfinished"></translation>
1312 </message>
1313 <message>
1314 <source>getColorAsRGB("name") -> tuple
1315
1316 Returns a tuple (R,G,B) containing the three color components of the
1317 color "name" from the current document, converted to the RGB color
1318 space. If no document is open, returns the value of the named color
1319 from the default document colors.
1320
1321 May raise NotFoundError if the named color wasn't found.
1322 May raise ValueError if an invalid color name is specified.
1323 </source>
1324 <translation type="unfinished"></translation>
1325 </message>
1326 <message>
1327 <source>defineColor("name", c, m, y, k)
1328
1329 Defines a new color "name". The color Value is defined via four components:
1330 c = Cyan, m = Magenta, y = Yello and k = Black. Color components should be in
1331 the range from 0 to 255.
1332
1333 May raise ValueError if an invalid color name is specified.
1334 </source>
1335 <translation type="unfinished"></translation>
1336 </message>
1337 <message>
1338 <source>getCornerRadius(["name"]) -> integer
1339
1340 Returns the corner radius of the object "name". The radius isexpressed in points. If "name" is not given the currentlyselected item is used.
1341 </source>
1342 <translation type="unfinished"></translation>
1343 </message>
1344 <message>
1345 <source>getPosition(["name"]) -> (x,y)
1346
1347 Returns a (x, y) tuple with the position of the object "name".
1348 If "name" is not given the currently selected item is used.The position is expressed in the actual measurement unit of the document
1349 - see UNIT_<type> for reference.
1350 </source>
1351 <translation type="unfinished"></translation>
1352 </message>
1353 <message>
1354 <source>getPropertyCType(object, property, includesuper=True)
1355
1356 Returns the name of the C type of `property' of `object'. See getProperty()
1357 for details of arguments.
1358
1359 If `includesuper' is true, search inherited properties too.
1360 </source>
1361 <translation type="unfinished"></translation>
1362 </message>
1363 <message>
1364 <source>getPropertyNames(object, includesuper=True)
1365
1366 Return a list of property names supported by `object'.
1367 If `includesuper' is true, return properties supported
1368 by parent classes as well.
1369 </source>
1370 <translation type="unfinished"></translation>
1371 </message>
1372 <message>
1373 <source>getProperty(object, property)
1374
1375 Return the value of the property `property' of the passed `object'.
1376
1377 The `object' argument may be a string, in which case the named PageItem
1378 is searched for. It may also be a PyCObject, which may point to any
1379 C++ QObject instance.
1380
1381 The `property' argument must be a string, and is the name of the property
1382 to look up on `object'.
1383
1384 The return value varies depending on the type of the property.
1385 </source>
1386 <translation type="unfinished"></translation>
1387 </message>
1388 <message>
1389 <source>setProperty(object, property, value)
1390
1391 Set `property' of `object' to `value'. If `value' cannot be converted to a type
1392 compatible with the type of `property', an exception is raised. An exception may
1393 also be raised if the underlying setter fails.
1394
1395 See getProperty() for more information.
1396 </source>
1397 <translation type="unfinished"></translation>
1398 </message>
1399 <message>
1400 <source>getChildren(object, ofclass=None, ofname=None, regexpmatch=False, recursive=True)
1401
1402 Return a list of children of `object', possibly restricted to children
1403 of class named `ofclass' or children named `ofname'. If `recursive' is true,
1404 search recursively through children, grandchildren, etc.
1405
1406 See QObject::children() in the Qt docs for more information.
1407 </source>
1408 <translation type="unfinished"></translation>
1409 </message>
1410 <message>
1411 <source>getChild(object, childname, ofclass=None, recursive=True)
1412
1413 Return the first child of `object' named `childname', possibly restricting
1414 the search to children of type name `ofclass'. If `recursive' is true,
1415 search recursively through children, grandchildren, etc.
1416 </source>
1417 <translation type="unfinished"></translation>
1418 </message>
1419 <message>
1420 <source>rotateObjectAbs(rot [, "name"])
1421
1422 Sets the rotation of the object "name" to "rot". Positve values
1423 mean counter clockwise rotation. If "name" is not given the currently
1424 selected item is used.
1425 </source>
1426 <translation type="unfinished"></translation>
1427 </message>
1428 <message>
1429 <source>renderFont("name", "filename", "sample", size, format="PPM") -> bool
1430
1431 Creates an image preview of font "name" with given text "sample" and size.
1432 If "filename" is not "", image is saved into "filename". Otherwise
1433 image data is returned as a string. The optional "format" argument
1434 specifies the image format to generate, and supports any format allowed
1435 by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.
1436
1437 May raise NotFoundError if the specified font can't be found.
1438 May raise ValueError if an empty sample or filename is passed.
1439 </source>
1440 <translation type="unfinished"></translation>
1441 </message>
1442 <message>
1443 <source>selectText(start, count, ["name"])
1444
1445 Selects "count" characters of text in the text frame "name" starting from the
1446 character "start". Character counting starts at 0. If "count" is zero, any
1447 text selection will be cleared. If "name" is not given the currently
1448 selected item is used.
1449
1450 May throw IndexError if the selection is outside the bounds of the text.
1451 </source>
1452 <translation type="unfinished"></translation>
1453 </message>
1454 <message>
1455 <source>fileDialog("caption", ["filter", "defaultname", haspreview, issave, isdir]) -> string with filename
1456
1457 Shows a File Open dialog box with the caption "caption". Files are filtered
1458 with the filter string "filter". A default filename or file path can also
1459 supplied, leave this string empty when you don't want to use it. A value of
1460 True for haspreview enables a small preview widget in the FileSelect box. When
1461 the issave parameter is set to True the dialog acts like a "Save As" dialog
1462 otherwise it acts like a "File Open Dialog". When the isdir parameter is True
1463 the dialog shows and returns only directories. The default for all of the
1464 opional parameters is False.
1465
1466 The filter, if specified, takes the form 'comment (*.type *.type2 ...)'.
1467 For example 'Images (*.png *.xpm *.jpg)'.
1468
1469 Refer to the Qt-Documentation for QFileDialog for details on filters.
1470
1471 Example: fileDialog('Open input', 'CSV files (*.csv)')
1472 Example: fileDialog('Save report', defaultname='report.txt', issave=True)
1473 </source>
1474 <translation type="unfinished"></translation>
1475 </message>
1476 <message>
1477 <source>newStyleDialog() -> string
1478
1479 Shows 'Create new paragraph style' dialog. Function returns real
1480 style name or None when user cancels the dialog.
1481 </source>
1482 <translation type="unfinished"></translation>
1483 </message>
1484 <message>
1485 <source>getPageMargins()
1486
1487 Returns the page margins as a (top, left, right, bottom) tuple in the current
1488 units. See UNIT_<type> constants and getPageSize().
1489 </source>
1490 <translation type="unfinished"></translation>
1491 </message>
1492 <message>
1493 <source>insertText("text", pos, ["name"])
1494
1495 Inserts the text "text" at the position "pos" into the text frame "name".
1496 Text must be UTF encoded (see setText() as reference) The first character has an
1497 index of 0. Inserting at position -1 appends text to the frame. If "name" is
1498 not given the currently selected Item is used.
1499
1500 May throw IndexError for an insertion out of bounds.
1501 </source>
1502 <translation type="unfinished"></translation>
1503 </message>
1504 <message>
1505 <source>textOverflows(["name", nolinks]) -> integer
1506
1507 Returns the actual number of overflowing characters in text frame "name".
1508 If is nolinks set to non zero value it takes only one frame - it doesn't
1509 use text frame linking. Without this parameter it search all linking chain.
1510
1511 May raise WrongFrameTypeError if the target frame is not an text frame
1512 </source>
1513 <translation type="unfinished"></translation>
1514 </message>
1515 <message>
1516 <source>setPDFBookmark("toggle", ["name"])
1517
1518 Sets wether (toggle = 1) the text frame "name" is a bookmark nor not.
1519 If "name" is not given the currently selected item is used.
1520
1521 May raise WrongFrameTypeError if the target frame is not a text frame
1522 </source>
1523 <translation type="unfinished"></translation>
1524 </message>
1525 <message>
1526 <source>isPDFBookmark(["name"]) -> bool
1527
1528 Returns true if the text frame "name" is a PDF bookmark.
1529 If "name" is not given the currently selected item is used.
1530
1531 May raise WrongFrameTypeError if the target frame is not a text frame
1532 </source>
1533 <translation type="unfinished"></translation>
1534 </message>
1535 <message>
1536 <source>newDoc(size, margins, orientation, firstPageNumber,
1537 unit, facingPages, firstSideLeft) -> bool
1538
1539 WARNING: Obsolete procedure! Use newDocument instead.
1540
1541 Creates a new document and returns true if successful. The parameters have the
1542 following meaning:
1543
1544 size = A tuple (width, height) describing the size of the document. You can
1545 use predefined constants named PAPER_<paper_type> e.g. PAPER_A4 etc.
1546
1547 margins = A tuple (left, right, top, bottom) describing the document
1548 margins
1549
1550 orientation = the page orientation - constants PORTRAIT, LANDSCAPE
1551
1552 firstPageNumer = is the number of the first page in the document used for
1553 pagenumbering. While you'll usually want 1, it's useful to have higher
1554 numbers if you're creating a document in several parts.
1555
1556 unit: this value sets the measurement units used by the document. Use a
1557 predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS,
1558 UNIT_PICAS, UNIT_POINTS.
1559
1560 facingPages = FACINGPAGES, NOFACINGPAGES
1561
1562 firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT
1563
1564 The values for width, height and the margins are expressed in the given unit
1565 for the document. PAPER_* constants are expressed in points. If your document
1566 is not in points, make sure to account for this.
1567
1568 example: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS,
1569 FACINGPAGES, FIRSTPAGERIGHT)
1570 </source>
1571 <translation type="unfinished"></translation>
1572 </message>
1573 <message>
1574 <source>closeMasterPage()
1575
1576 Closes the currently active master page, if any, and returns editing
1577 to normal. Begin editing with editMasterPage().
1578 </source>
1579 <translation type="unfinished"></translation>
1580 </message>
1581 <message>
1582 <source>masterPageNames()
1583
1584 Returns a list of the names of all master pages in the document.
1585 </source>
1586 <translation type="unfinished"></translation>
1587 </message>
1588 <message>
1589 <source>editMasterPage(pageName)
1590
1591 Enables master page editing and opens the named master page
1592 for editing. Finish editing with closeMasterPage().
1593 </source>
1594 <translation type="unfinished"></translation>
1595 </message>
1596 <message>
1597 <source>createMasterPage(pageName)