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