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