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