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