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