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