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