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