Rev 14099 | Rev 14480 | 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"/> |
12918 | cbradney | 1091 | <source>groupObjects(list) |
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. |
||
1096 | </source> |
||
1097 | <translation type="unfinished">groupObjects(list) |
||
1098 | |||
1099 | Groups the objects named in "list" together. "list" must contain the names |
||
1100 | of the objects to be grouped. If "list" is not given the currently selected |
||
1101 | items are used. |
||
1102 | </translation> |
||
1103 | </message> |
||
1104 | <message> |
||
14474 | cbradney | 1105 | <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="124"/> |
12918 | cbradney | 1106 | <source>unGroupObjects("name") |
1107 | |||
1108 | Destructs the group the object "name" belongs to.If "name" is not given the currently selected item is used.</source> |
||
1109 | <translation type="unfinished">unGroupObjects("name") |
||
1110 | |||
1111 | Destructs the group the object "name" belongs to.If "name" is not given the currently selected item is used.</translation> |
||
1112 | </message> |
||
1113 | <message> |
||
14474 | cbradney | 1114 | <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="132"/> |
12918 | cbradney | 1115 | <source>scaleGroup(factor [,"name"]) |
1116 | |||
1117 | Scales the group the object "name" belongs to. Values greater than 1 enlarge |
||
1118 | the group, values smaller than 1 make the group smaller e.g a value of 0.5 |
||
1119 | scales the group to 50 % of its original size, a value of 1.5 scales the group |
||
1120 | to 150 % of its original size. The value for "factor" must be greater than |
||
1121 | 0. If "name" is not given the currently selected item is used. |
||
1122 | |||
1123 | May raise ValueError if an invalid scale factor is passed. |
||
1124 | </source> |
||
1125 | <translation type="unfinished">scaleGroup(factor [,"name"]) |
||
1126 | |||
1127 | Scales the group the object "name" belongs to. Values greater than 1 enlarge |
||
1128 | the group, values smaller than 1 make the group smaller e.g a value of 0.5 |
||
1129 | scales the group to 50 % of its original size, a value of 1.5 scales the group |
||
1130 | to 150 % of its original size. The value for "factor" must be greater than |
||
1131 | 0. If "name" is not given the currently selected item is used. |
||
1132 | |||
1133 | May raise ValueError if an invalid scale factor is passed. |
||
1134 | </translation> |
||
1135 | </message> |
||
1136 | <message> |
||
14474 | cbradney | 1137 | <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="147"/> |
12918 | cbradney | 1138 | <source>loadImage("filename" [, "name"]) |
1139 | |||
1140 | Loads the picture "picture" into the image frame "name". If "name" is |
||
1141 | not given the currently selected item is used. |
||
1142 | |||
1143 | May raise WrongFrameTypeError if the target frame is not an image frame |
||
1144 | </source> |
||
1145 | <translation type="unfinished">loadImage("filename" [, "name"]) |
||
1146 | |||
1147 | Loads the picture "picture" into the image frame "name". If "name" is |
||
1148 | not given the currently selected item is used. |
||
1149 | |||
1150 | May raise WrongFrameTypeError if the target frame is not an image frame |
||
1151 | </translation> |
||
1152 | </message> |
||
1153 | <message> |
||
14474 | cbradney | 1154 | <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="159"/> |
12918 | cbradney | 1155 | <source>scaleImage(x, y [, "name"]) |
1156 | |||
14474 | cbradney | 1157 | Sets the internal scaling factors of the picture in the image frame "name". |
1158 | If "name" is not given the currently selected item is used. A number of 1 |
||
1159 | means 100 %. Internal scaling factors are different from the values shown on |
||
1160 | properties palette. Note : deprecated, use setImageScale() instead. |
||
1161 | |||
1162 | May raise WrongFrameTypeError if the target frame is not an image frame |
||
1163 | </source> |
||
1164 | <translation type="unfinished"></translation> |
||
1165 | </message> |
||
1166 | <message> |
||
1167 | <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="173"/> |
||
1168 | <source>setImageScale(x, y [, "name"]) |
||
1169 | |||
12918 | cbradney | 1170 | Sets the scaling factors of the picture in the image frame "name". |
1171 | If "name" is not given the currently selected item is used. A number of 1 |
||
14474 | cbradney | 1172 | means 100 %. Scaling factors are equal to the values shown on properties palette. |
1173 | |||
1174 | May raise WrongFrameTypeError if the target frame is not an image frame |
||
1175 | </source> |
||
1176 | <translation type="unfinished"></translation> |
||
1177 | </message> |
||
1178 | <message> |
||
1179 | <source>scaleImage(x, y [, "name"]) |
||
1180 | |||
1181 | Sets the scaling factors of the picture in the image frame "name". |
||
1182 | If "name" is not given the currently selected item is used. A number of 1 |
||
12918 | cbradney | 1183 | means 100 %. |
1184 | |||
1185 | May raise WrongFrameTypeError if the target frame is not an image frame |
||
1186 | </source> |
||
13279 | cbradney | 1187 | <translation type="obsolete">scaleImage(x, y [, "name"]) |
12918 | cbradney | 1188 | |
1189 | Sets the scaling factors of the picture in the image frame "name". |
||
1190 | If "name" is not given the currently selected item is used. A number of 1 |
||
1191 | means 100 %. |
||
1192 | |||
1193 | May raise WrongFrameTypeError if the target frame is not an image frame |
||
1194 | </translation> |
||
1195 | </message> |
||
1196 | <message> |
||
14474 | cbradney | 1197 | <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="186"/> |
12918 | cbradney | 1198 | <source>lockObject(["name"]) -> bool |
1199 | |||
1200 | Locks the object "name" if it's unlocked or unlock it if it's locked. |
||
1201 | If "name" is not given the currently selected item is used. Returns true |
||
1202 | if locked. |
||
1203 | </source> |
||
1204 | <translation type="unfinished">lockObject(["name"]) -> bool |
||
1205 | |||
1206 | Locks the object "name" if it's unlocked or unlock it if it's locked. |
||
1207 | If "name" is not given the currently selected item is used. Returns true |
||
1208 | if locked. |
||
1209 | </translation> |
||
1210 | </message> |
||
1211 | <message> |
||
14474 | cbradney | 1212 | <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="197"/> |
12918 | cbradney | 1213 | <source>isLocked(["name"]) -> bool |
1214 | |||
1215 | Returns true if is the object "name" locked. If "name" is not given the |
||
1216 | currently selected item is used. |
||
1217 | </source> |
||
1218 | <translation type="unfinished">isLocked(["name"]) -> bool |
||
1219 | |||
1220 | Returns true if is the object "name" locked. If "name" is not given the |
||
1221 | currently selected item is used. |
||
1222 | </translation> |
||
1223 | </message> |
||
1224 | <message> |
||
14474 | cbradney | 1225 | <location filename="../../../scribus/plugins/scriptplugin/cmdmani.h" line="206"/> |
12918 | cbradney | 1226 | <source>setScaleImageToFrame(scaletoframe, proportional=None, name=<selection>) |
1227 | |||
1228 | Sets the scale to frame on the selected or specified image frame to `scaletoframe'. |
||
1229 | If `proportional' is specified, set fixed aspect ratio scaling to `proportional'. |
||
1230 | Both `scaletoframe' and `proportional' are boolean. |
||
1231 | |||
1232 | May raise WrongFrameTypeError. |
||
1233 | </source> |
||
1234 | <translation type="unfinished">setScaleImageToFrame(scaletoframe, proportional=None, name=<selection>) |
||
1235 | |||
1236 | Sets the scale to frame on the selected or specified image frame to `scaletoframe'. |
||
1237 | If `proportional' is specified, set fixed aspect ratio scaling to `proportional'. |
||
1238 | Both `scaletoframe' and `proportional' are boolean. |
||
1239 | |||
1240 | May raise WrongFrameTypeError. |
||
1241 | </translation> |
||
1242 | </message> |
||
1243 | <message> |
||
14474 | cbradney | 1244 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="19"/> |
1135 | cbradney | 1245 | <source>setRedraw(bool) |
1246 | |||
1247 | Disables page redraw when bool = False, otherwise redrawing is enabled. |
||
1248 | This change will persist even after the script exits, so make sure to call |
||
1249 | setRedraw(True) in a finally: clause at the top level of your script. |
||
1250 | </source> |
||
12612 | cbradney | 1251 | <translation type="unfinished">setRedraw(bool) |
6082 | mrdocs | 1252 | |
1253 | Disables page redraw when bool = False, otherwise redrawing is enabled. |
||
1254 | This change will persist even after the script exits, so make sure to call |
||
1255 | setRedraw(True) in a finally: clause at the top level of your script. |
||
1256 | </translation> |
||
1135 | cbradney | 1257 | </message> |
1258 | <message> |
||
14474 | cbradney | 1259 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="30"/> |
12918 | cbradney | 1260 | <source>getFontNames() -> list |
1261 | |||
1262 | Returns a list with the names of all available fonts. |
||
1263 | </source> |
||
1264 | <translation type="unfinished">getFontNames() -> list |
||
1265 | |||
1266 | Returns a list with the names of all available fonts. |
||
1267 | </translation> |
||
1268 | </message> |
||
1269 | <message> |
||
14474 | cbradney | 1270 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="39"/> |
12918 | cbradney | 1271 | <source>getXFontNames() -> list of tuples |
1272 | |||
1273 | Returns a larger font info. It's a list of the tuples with: |
||
1274 | [ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ] |
||
1275 | </source> |
||
1276 | <translation type="unfinished">getXFontNames() -> list of tuples |
||
1277 | |||
1278 | Returns a larger font info. It's a list of the tuples with: |
||
1279 | [ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ] |
||
1280 | </translation> |
||
1281 | </message> |
||
1282 | <message> |
||
14474 | cbradney | 1283 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="52"/> |
12918 | cbradney | 1284 | <source>renderFont("name", "filename", "sample", size, format="PPM") -> bool |
1285 | |||
1286 | Creates an image preview of font "name" with given text "sample" and size. |
||
1287 | If "filename" is not "", image is saved into "filename". Otherwise |
||
1288 | image data is returned as a string. The optional "format" argument |
||
1289 | specifies the image format to generate, and supports any format allowed |
||
1290 | by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM. |
||
1291 | |||
1292 | May raise NotFoundError if the specified font can't be found. |
||
1293 | May raise ValueError if an empty sample or filename is passed. |
||
1294 | </source> |
||
1295 | <translation type="unfinished">renderFont("name", "filename", "sample", size, format="PPM") -> bool |
||
1296 | |||
1297 | Creates an image preview of font "name" with given text "sample" and size. |
||
1298 | If "filename" is not "", image is saved into "filename". Otherwise |
||
1299 | image data is returned as a string. The optional "format" argument |
||
1300 | specifies the image format to generate, and supports any format allowed |
||
1301 | by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM. |
||
1302 | |||
1303 | May raise NotFoundError if the specified font can't be found. |
||
1304 | May raise ValueError if an empty sample or filename is passed. |
||
1305 | </translation> |
||
1306 | </message> |
||
1307 | <message> |
||
14474 | cbradney | 1308 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="68"/> |
12918 | cbradney | 1309 | <source>getLayers() -> list |
1310 | |||
1311 | Returns a list with the names of all defined layers. |
||
1312 | </source> |
||
1313 | <translation type="unfinished">getLayers() -> list |
||
1314 | |||
1315 | Returns a list with the names of all defined layers. |
||
1316 | </translation> |
||
1317 | </message> |
||
1318 | <message> |
||
14474 | cbradney | 1319 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="77"/> |
12918 | cbradney | 1320 | <source>setActiveLayer("name") |
1321 | |||
1322 | Sets the active layer to the layer named "name". |
||
1323 | |||
1324 | May raise NotFoundError if the layer can't be found. |
||
1325 | May raise ValueError if the layer name isn't acceptable. |
||
1326 | </source> |
||
1327 | <translation type="unfinished">setActiveLayer("name") |
||
1328 | |||
1329 | Sets the active layer to the layer named "name". |
||
1330 | |||
1331 | May raise NotFoundError if the layer can't be found. |
||
1332 | May raise ValueError if the layer name isn't acceptable. |
||
1333 | </translation> |
||
1334 | </message> |
||
1335 | <message> |
||
14474 | cbradney | 1336 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="89"/> |
12918 | cbradney | 1337 | <source>getActiveLayer() -> string |
1338 | |||
1339 | Returns the name of the current active layer. |
||
1340 | </source> |
||
1341 | <translation type="unfinished">getActiveLayer() -> string |
||
1342 | |||
1343 | Returns the name of the current active layer. |
||
1344 | </translation> |
||
1345 | </message> |
||
1346 | <message> |
||
14474 | cbradney | 1347 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="98"/> |
12918 | cbradney | 1348 | <source>sentToLayer("layer" [, "name"]) |
1349 | |||
1350 | Sends the object "name" to the layer "layer". The layer must exist. |
||
1351 | If "name" is not given the currently selected item is used. |
||
1352 | |||
1353 | May raise NotFoundError if the layer can't be found. |
||
1354 | May raise ValueError if the layer name isn't acceptable. |
||
1355 | </source> |
||
1356 | <translation type="unfinished">sentToLayer("layer" [, "name"]) |
||
1357 | |||
1358 | Sends the object "name" to the layer "layer". The layer must exist. |
||
1359 | If "name" is not given the currently selected item is used. |
||
1360 | |||
1361 | May raise NotFoundError if the layer can't be found. |
||
1362 | May raise ValueError if the layer name isn't acceptable. |
||
1363 | </translation> |
||
1364 | </message> |
||
1365 | <message> |
||
14474 | cbradney | 1366 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="111"/> |
12918 | cbradney | 1367 | <source>setLayerVisible("layer", visible) |
1368 | |||
1369 | Sets the layer "layer" to be visible or not. If is the visible set to false |
||
1370 | the layer is invisible. |
||
1371 | |||
1372 | May raise NotFoundError if the layer can't be found. |
||
1373 | May raise ValueError if the layer name isn't acceptable. |
||
1374 | </source> |
||
1375 | <translation type="unfinished">setLayerVisible("layer", visible) |
||
1376 | |||
1377 | Sets the layer "layer" to be visible or not. If is the visible set to false |
||
1378 | the layer is invisible. |
||
1379 | |||
1380 | May raise NotFoundError if the layer can't be found. |
||
1381 | May raise ValueError if the layer name isn't acceptable. |
||
1382 | </translation> |
||
1383 | </message> |
||
1384 | <message> |
||
14474 | cbradney | 1385 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="124"/> |
12918 | cbradney | 1386 | <source>setLayerPrintable("layer", printable) |
1387 | |||
1388 | Sets the layer "layer" to be printable or not. If is the |
||
1389 | printable set to false the layer won't be printed. |
||
1390 | |||
1391 | May raise NotFoundError if the layer can't be found. |
||
1392 | May raise ValueError if the layer name isn't acceptable. |
||
1393 | </source> |
||
1394 | <translation type="unfinished"></translation> |
||
1395 | </message> |
||
1396 | <message> |
||
14474 | cbradney | 1397 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="137"/> |
12918 | cbradney | 1398 | <source>setLayerLocked("layer", locked) |
1399 | |||
1400 | Sets the layer "layer" to be locked or not. If locked is set to |
||
1401 | true the layer will be locked. |
||
1402 | |||
1403 | May raise NotFoundError if the layer can't be found. |
||
1404 | May raise ValueError if the layer name isn't acceptable. |
||
1405 | </source> |
||
1406 | <translation type="unfinished"></translation> |
||
1407 | </message> |
||
1408 | <message> |
||
14474 | cbradney | 1409 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="150"/> |
12918 | cbradney | 1410 | <source>setLayerOutlined("layer", outline) |
1411 | |||
1412 | Sets the layer "layer" to be locked or not. If outline is set to |
||
1413 | true the layer will be displayed outlined. |
||
1414 | |||
1415 | May raise NotFoundError if the layer can't be found. |
||
1416 | May raise ValueError if the layer name isn't acceptable. |
||
1417 | </source> |
||
1418 | <translation type="unfinished"></translation> |
||
1419 | </message> |
||
1420 | <message> |
||
14474 | cbradney | 1421 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="163"/> |
12918 | cbradney | 1422 | <source>setLayerFlow("layer", flow) |
1423 | |||
1424 | Sets the layers "layer" flowcontrol to flow. If flow is set to |
||
1425 | true text in layers above this one will flow around objects on this layer. |
||
1426 | |||
1427 | May raise NotFoundError if the layer can't be found. |
||
1428 | May raise ValueError if the layer name isn't acceptable. |
||
1429 | </source> |
||
1430 | <translation type="unfinished"></translation> |
||
1431 | </message> |
||
1432 | <message> |
||
14474 | cbradney | 1433 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="176"/> |
12918 | cbradney | 1434 | <source>setLayerBlendmode("layer", blend) |
1435 | |||
1436 | Sets the layers "layer" blendmode to blend. |
||
1437 | |||
1438 | May raise NotFoundError if the layer can't be found. |
||
1439 | May raise ValueError if the layer name isn't acceptable. |
||
1440 | </source> |
||
1441 | <translation type="unfinished"></translation> |
||
1442 | </message> |
||
1443 | <message> |
||
14474 | cbradney | 1444 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="188"/> |
12918 | cbradney | 1445 | <source>setLayerTransparency("layer", trans) |
1446 | |||
1447 | Sets the layers "layer" transparency to trans. |
||
1448 | |||
1449 | May raise NotFoundError if the layer can't be found. |
||
1450 | May raise ValueError if the layer name isn't acceptable. |
||
1451 | </source> |
||
1452 | <translation type="unfinished"></translation> |
||
1453 | </message> |
||
1454 | <message> |
||
14474 | cbradney | 1455 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="200"/> |
12918 | cbradney | 1456 | <source>isLayerVisible("layer") -> bool |
1457 | |||
1458 | Returns whether the layer "layer" is visible or not, a value of True means |
||
1459 | that the layer "layer" is visible, a value of False means that the layer |
||
1460 | "layer" is invisible. |
||
1461 | |||
1462 | May raise NotFoundError if the layer can't be found. |
||
1463 | May raise ValueError if the layer name isn't acceptable. |
||
1464 | </source> |
||
1465 | <translation type="unfinished"></translation> |
||
1466 | </message> |
||
1467 | <message> |
||
14474 | cbradney | 1468 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="214"/> |
12918 | cbradney | 1469 | <source>isLayerPrintable("layer") -> bool |
1470 | |||
1471 | Returns whether the layer "layer" is printable or not, a value of True means |
||
1472 | that the layer "layer" can be printed, a value of False means that printing |
||
1473 | the layer "layer" is disabled. |
||
1474 | |||
1475 | May raise NotFoundError if the layer can't be found. |
||
1476 | May raise ValueError if the layer name isn't acceptable. |
||
1477 | </source> |
||
1478 | <translation type="unfinished">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 | </translation> |
||
1487 | </message> |
||
1488 | <message> |
||
14474 | cbradney | 1489 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="228"/> |
12918 | cbradney | 1490 | <source>isLayerLocked("layer") -> bool |
1491 | |||
1492 | Returns whether the layer "layer" is locked or not, a value of True means |
||
1493 | that the layer "layer" is editable, a value of False means that the layer |
||
1494 | "layer" is locked. |
||
1495 | |||
1496 | May raise NotFoundError if the layer can't be found. |
||
1497 | May raise ValueError if the layer name isn't acceptable. |
||
1498 | </source> |
||
1499 | <translation type="unfinished"></translation> |
||
1500 | </message> |
||
1501 | <message> |
||
14474 | cbradney | 1502 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="242"/> |
12918 | cbradney | 1503 | <source>isLayerOutlined("layer") -> bool |
1504 | |||
1505 | Returns whether the layer "layer" is outlined or not, a value of True means |
||
1506 | that the layer "layer" is outlined, a value of False means that the layer |
||
1507 | "layer" is normal. |
||
1508 | |||
1509 | May raise NotFoundError if the layer can't be found. |
||
1510 | May raise ValueError if the layer name isn't acceptable. |
||
1511 | </source> |
||
1512 | <translation type="unfinished"></translation> |
||
1513 | </message> |
||
1514 | <message> |
||
14474 | cbradney | 1515 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="256"/> |
12918 | cbradney | 1516 | <source>isLayerFlow("layer") -> bool |
1517 | |||
1518 | Returns whether text flows around objects on layer "layer", a value of True means |
||
1519 | that text flows around, a value of False means that the text does not flow around. |
||
1520 | |||
1521 | May raise NotFoundError if the layer can't be found. |
||
1522 | May raise ValueError if the layer name isn't acceptable. |
||
1523 | </source> |
||
1524 | <translation type="unfinished"></translation> |
||
1525 | </message> |
||
1526 | <message> |
||
14474 | cbradney | 1527 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="269"/> |
12918 | cbradney | 1528 | <source>getLayerBlendmode("layer") -> int |
1529 | |||
1530 | Returns the "layer" layer blendmode, |
||
1531 | |||
1532 | May raise NotFoundError if the layer can't be found. |
||
1533 | May raise ValueError if the layer name isn't acceptable. |
||
1534 | </source> |
||
1535 | <translation type="unfinished"></translation> |
||
1536 | </message> |
||
1537 | <message> |
||
14474 | cbradney | 1538 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="281"/> |
12918 | cbradney | 1539 | <source>getLayerTransparency("layer") -> float |
1540 | |||
1541 | Returns the "layer" layer transparency, |
||
1542 | |||
1543 | May raise NotFoundError if the layer can't be found. |
||
1544 | May raise ValueError if the layer name isn't acceptable. |
||
1545 | </source> |
||
1546 | <translation type="unfinished"></translation> |
||
1547 | </message> |
||
1548 | <message> |
||
14474 | cbradney | 1549 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="293"/> |
12918 | cbradney | 1550 | <source>deleteLayer("layer") |
1551 | |||
1552 | Deletes the layer with the name "layer". Nothing happens if the layer doesn't |
||
1553 | exists or if it's the only layer in the document. |
||
1554 | |||
1555 | May raise NotFoundError if the layer can't be found. |
||
1556 | May raise ValueError if the layer name isn't acceptable. |
||
1557 | </source> |
||
1558 | <translation type="unfinished">deleteLayer("layer") |
||
1559 | |||
1560 | Deletes the layer with the name "layer". Nothing happens if the layer doesn't |
||
1561 | exists or if it's the only layer in the document. |
||
1562 | |||
1563 | May raise NotFoundError if the layer can't be found. |
||
1564 | May raise ValueError if the layer name isn't acceptable. |
||
1565 | </translation> |
||
1566 | </message> |
||
1567 | <message> |
||
14474 | cbradney | 1568 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="306"/> |
12918 | cbradney | 1569 | <source>createLayer(layer) |
1570 | |||
1571 | Creates a new layer with the name "name". |
||
1572 | |||
1573 | May raise ValueError if the layer name isn't acceptable. |
||
1574 | </source> |
||
1575 | <translation type="unfinished">createLayer(layer) |
||
1576 | |||
1577 | Creates a new layer with the name "name". |
||
1578 | |||
1579 | May raise ValueError if the layer name isn't acceptable. |
||
1580 | </translation> |
||
1581 | </message> |
||
1582 | <message> |
||
14474 | cbradney | 1583 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="317"/> |
12918 | cbradney | 1584 | <source>getGuiLanguage() -> string |
1585 | |||
1586 | Returns a string with the -lang value. |
||
1587 | </source> |
||
1588 | <translation type="unfinished">getGuiLanguage() -> string |
||
1589 | |||
1590 | Returns a string with the -lang value. |
||
1591 | </translation> |
||
1592 | </message> |
||
1593 | <message> |
||
14474 | cbradney | 1594 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="326"/> |
12918 | cbradney | 1595 | <source>moveSelectionToFront() |
1596 | |||
1597 | Moves current selection to front. |
||
1598 | </source> |
||
1599 | <translation type="unfinished"></translation> |
||
1600 | </message> |
||
1601 | <message> |
||
14474 | cbradney | 1602 | <location filename="../../../scribus/plugins/scriptplugin/cmdmisc.h" line="335"/> |
12918 | cbradney | 1603 | <source>moveSelectionToFront() |
1604 | |||
1605 | Moves current selection to back. |
||
1606 | </source> |
||
1607 | <translation type="unfinished"></translation> |
||
1608 | </message> |
||
1609 | <message> |
||
14474 | cbradney | 1610 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="17"/> |
1135 | cbradney | 1611 | <source>createRect(x, y, width, height, ["name"]) -> string |
1612 | |||
1613 | Creates a new rectangle on the current page and returns its name. The |
||
1614 | coordinates are given in the current measurement units of the document |
||
1615 | (see UNIT constants). "name" should be a unique identifier for the object |
||
1616 | because you need this name to reference that object in future. If "name" |
||
1617 | is not given Scribus will create one for you. |
||
1618 | |||
1619 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1620 | </source> |
||
12612 | cbradney | 1621 | <translation type="unfinished">createRect(x, y, width, height, ["name"]) -> string |
6082 | mrdocs | 1622 | |
1623 | Creates a new rectangle on the current page and returns its name. The |
||
1624 | coordinates are given in the current measurement units of the document |
||
1625 | (see UNIT constants). "name" should be a unique identifier for the object |
||
1626 | because you need this name to reference that object in future. If "name" |
||
1627 | is not given Scribus will create one for you. |
||
1628 | |||
1629 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1630 | </translation> |
||
1135 | cbradney | 1631 | </message> |
1632 | <message> |
||
14474 | cbradney | 1633 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="34"/> |
12918 | cbradney | 1634 | <source>createEllipse(x, y, width, height, ["name"]) -> string |
1635 | |||
1636 | Creates a new ellipse on the current page and returns its name. |
||
1637 | The coordinates are given in the current measurement units of the document |
||
1638 | (see UNIT constants). "name" should be a unique identifier for the object |
||
1639 | because you need this name for further referencing of that object. If "name" |
||
1640 | is not given Scribus will create one for you. |
||
1641 | |||
1642 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1643 | </source> |
||
1644 | <translation type="unfinished">createEllipse(x, y, width, height, ["name"]) -> string |
||
1645 | |||
1646 | Creates a new ellipse on the current page and returns its name. |
||
1647 | The coordinates are given in the current measurement units of the document |
||
1648 | (see UNIT constants). "name" should be a unique identifier for the object |
||
1649 | because you need this name for further referencing of that object. If "name" |
||
1650 | is not given Scribus will create one for you. |
||
1651 | |||
1652 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1653 | </translation> |
||
1654 | </message> |
||
1655 | <message> |
||
14474 | cbradney | 1656 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="51"/> |
12918 | cbradney | 1657 | <source>createImage(x, y, width, height, ["name"]) -> string |
1658 | |||
1659 | Creates a new picture frame on the current page and returns its name. The |
||
1660 | coordinates are given in the current measurement units of the document. |
||
1661 | "name" should be a unique identifier for the object because you need this |
||
1662 | name for further access to that object. If "name" is not given Scribus will |
||
1663 | create one for you. |
||
1664 | |||
1665 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1666 | </source> |
||
1667 | <translation type="unfinished">createImage(x, y, width, height, ["name"]) -> string |
||
1668 | |||
1669 | Creates a new picture frame on the current page and returns its name. The |
||
1670 | coordinates are given in the current measurement units of the document. |
||
1671 | "name" should be a unique identifier for the object because you need this |
||
1672 | name for further access to that object. If "name" is not given Scribus will |
||
1673 | create one for you. |
||
1674 | |||
1675 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1676 | </translation> |
||
1677 | </message> |
||
1678 | <message> |
||
14474 | cbradney | 1679 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="66"/> |
12918 | cbradney | 1680 | <source>createText(x, y, width, height, ["name"]) -> string |
1681 | |||
1682 | Creates a new text frame on the actual page and returns its name. |
||
1683 | The coordinates are given in the actual measurement unit of the document (see |
||
1684 | UNIT constants). "name" should be a unique identifier for the object because |
||
1685 | you need this name for further referencing of that object. If "name" is not |
||
1686 | given Scribus will create one for you. |
||
1687 | |||
1688 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1689 | </source> |
||
1690 | <translation type="unfinished">createText(x, y, width, height, ["name"]) -> string |
||
1691 | |||
1692 | Creates a new text frame on the actual page and returns its name. |
||
1693 | The coordinates are given in the actual measurement unit of the document (see |
||
1694 | UNIT constants). "name" should be a unique identifier for the object because |
||
1695 | you need this name for further referencing of that object. If "name" is not |
||
1696 | given Scribus will create one for you. |
||
1697 | |||
1698 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1699 | </translation> |
||
1700 | </message> |
||
1701 | <message> |
||
14474 | cbradney | 1702 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="81"/> |
12918 | cbradney | 1703 | <source>createLine(x1, y1, x2, y2, ["name"]) -> string |
1704 | |||
1705 | Creates a new line from the point(x1, y1) to the point(x2, y2) and returns |
||
1706 | its name. The coordinates are given in the current measurement unit of the |
||
1707 | document (see UNIT constants). "name" should be a unique identifier for the |
||
1708 | object because you need this name for further access to that object. If |
||
1709 | "name" is not given Scribus will create one for you. |
||
1710 | |||
1711 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1712 | </source> |
||
1713 | <translation type="unfinished">createLine(x1, y1, x2, y2, ["name"]) -> string |
||
1714 | |||
1715 | Creates a new line from the point(x1, y1) to the point(x2, y2) and returns |
||
1716 | its name. The coordinates are given in the current measurement unit of the |
||
1717 | document (see UNIT constants). "name" should be a unique identifier for the |
||
1718 | object because you need this name for further access to that object. If |
||
1719 | "name" is not given Scribus will create one for you. |
||
1720 | |||
1721 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1722 | </translation> |
||
1723 | </message> |
||
1724 | <message> |
||
14474 | cbradney | 1725 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="96"/> |
12918 | cbradney | 1726 | <source>createPolyLine(list, ["name"]) -> string |
1727 | |||
1728 | Creates a new polyline and returns its name. The points for the polyline are |
||
1729 | stored in the list "list" in the following order: [x1, y1, x2, y2...xn. yn]. |
||
1730 | The coordinates are given in the current measurement units of the document (see |
||
1731 | UNIT constants). "name" should be a unique identifier for the object because |
||
1732 | you need this name for further access to that object. If "name" is not given |
||
1733 | Scribus will create one for you. |
||
1734 | |||
1735 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1736 | May raise ValueError if an insufficient number of points is passed or if |
||
1737 | the number of values passed don't group into points without leftovers. |
||
1738 | </source> |
||
1739 | <translation type="unfinished">createPolyLine(list, ["name"]) -> string |
||
1740 | |||
1741 | Creates a new polyline and returns its name. The points for the polyline are |
||
1742 | stored in the list "list" in the following order: [x1, y1, x2, y2...xn. yn]. |
||
1743 | The coordinates are given in the current measurement units of the document (see |
||
1744 | UNIT constants). "name" should be a unique identifier for the object because |
||
1745 | you need this name for further access to that object. If "name" is not given |
||
1746 | Scribus will create one for you. |
||
1747 | |||
1748 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1749 | May raise ValueError if an insufficient number of points is passed or if |
||
1750 | the number of values passed don't group into points without leftovers. |
||
1751 | </translation> |
||
1752 | </message> |
||
1753 | <message> |
||
14474 | cbradney | 1754 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="114"/> |
12918 | cbradney | 1755 | <source>createPolygon(list, ["name"]) -> string |
1756 | |||
1757 | Creates a new polygon and returns its name. The points for the polygon are |
||
1758 | stored in the list "list" in the following order: [x1, y1, x2, y2...xn. yn]. |
||
1759 | At least three points are required. There is no need to repeat the first point |
||
1760 | to close the polygon. The polygon is automatically closed by connecting the |
||
1761 | first and the last point. The coordinates are given in the current measurement |
||
1762 | units of the document (see UNIT constants). "name" should be a unique |
||
1763 | identifier for the object because you need this name for further access to that |
||
1764 | object. If "name" is not given Scribus will create one for you. |
||
1765 | |||
1766 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1767 | May raise ValueError if an insufficient number of points is passed or if |
||
1768 | the number of values passed don't group into points without leftovers. |
||
1769 | </source> |
||
1770 | <translation type="unfinished">createPolygon(list, ["name"]) -> string |
||
1771 | |||
1772 | Creates a new polygon and returns its name. The points for the polygon are |
||
1773 | stored in the list "list" in the following order: [x1, y1, x2, y2...xn. yn]. |
||
1774 | At least three points are required. There is no need to repeat the first point |
||
1775 | to close the polygon. The polygon is automatically closed by connecting the |
||
1776 | first and the last point. The coordinates are given in the current measurement |
||
1777 | units of the document (see UNIT constants). "name" should be a unique |
||
1778 | identifier for the object because you need this name for further access to that |
||
1779 | object. If "name" is not given Scribus will create one for you. |
||
1780 | |||
1781 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1782 | May raise ValueError if an insufficient number of points is passed or if |
||
1783 | the number of values passed don't group into points without leftovers. |
||
1784 | </translation> |
||
1785 | </message> |
||
1786 | <message> |
||
14474 | cbradney | 1787 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="134"/> |
12918 | cbradney | 1788 | <source>createBezierLine(list, ["name"]) -> string |
1789 | |||
1790 | Creates a new bezier curve and returns its name. The points for the bezier |
||
1791 | curve are stored in the list "list" in the following order: |
||
1792 | [x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn] |
||
1793 | In the points list, x and y mean the x and y coordinates of the point and kx |
||
1794 | and ky meaning the control point for the curve. The coordinates are given in |
||
1795 | the current measurement units of the document (see UNIT constants). "name" |
||
1796 | should be a unique identifier for the object because you need this name for |
||
1797 | further access to that object. If "name" is not given Scribus will create one |
||
1798 | for you. |
||
1799 | |||
1800 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1801 | May raise ValueError if an insufficient number of points is passed or if |
||
1802 | the number of values passed don't group into points without leftovers. |
||
1803 | </source> |
||
1804 | <translation type="unfinished">createBezierLine(list, ["name"]) -> string |
||
1805 | |||
1806 | Creates a new bezier curve and returns its name. The points for the bezier |
||
1807 | curve are stored in the list "list" in the following order: |
||
1808 | [x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn] |
||
1809 | In the points list, x and y mean the x and y coordinates of the point and kx |
||
1810 | and ky meaning the control point for the curve. The coordinates are given in |
||
1811 | the current measurement units of the document (see UNIT constants). "name" |
||
1812 | should be a unique identifier for the object because you need this name for |
||
1813 | further access to that object. If "name" is not given Scribus will create one |
||
1814 | for you. |
||
1815 | |||
1816 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1817 | May raise ValueError if an insufficient number of points is passed or if |
||
1818 | the number of values passed don't group into points without leftovers. |
||
1819 | </translation> |
||
1820 | </message> |
||
1821 | <message> |
||
14474 | cbradney | 1822 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="155"/> |
12918 | cbradney | 1823 | <source>createPathText(x, y, "textbox", "beziercurve", ["name"]) -> string |
1824 | |||
1825 | Creates a new pathText by merging the two objects "textbox" and |
||
1826 | "beziercurve" and returns its name. The coordinates are given in the current |
||
1827 | measurement unit of the document (see UNIT constants). "name" should be a |
||
1828 | unique identifier for the object because you need this name for further access |
||
1829 | to that object. If "name" is not given Scribus will create one for you. |
||
1830 | |||
1831 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1832 | May raise NotFoundError if one or both of the named base object don't exist. |
||
1833 | </source> |
||
1834 | <translation type="unfinished">createPathText(x, y, "textbox", "beziercurve", ["name"]) -> string |
||
1835 | |||
1836 | Creates a new pathText by merging the two objects "textbox" and |
||
1837 | "beziercurve" and returns its name. The coordinates are given in the current |
||
1838 | measurement unit of the document (see UNIT constants). "name" should be a |
||
1839 | unique identifier for the object because you need this name for further access |
||
1840 | to that object. If "name" is not given Scribus will create one for you. |
||
1841 | |||
1842 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
1843 | May raise NotFoundError if one or both of the named base object don't exist. |
||
1844 | </translation> |
||
1845 | </message> |
||
1846 | <message> |
||
14474 | cbradney | 1847 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="173"/> |
12918 | cbradney | 1848 | <source>deleteObject(["name"]) |
1849 | |||
1850 | Deletes the item with the name "name". If "name" is not given the currently |
||
1851 | selected item is deleted. |
||
1852 | </source> |
||
1853 | <translation type="unfinished">deleteObject(["name"]) |
||
1854 | |||
1855 | Deletes the item with the name "name". If "name" is not given the currently |
||
1856 | selected item is deleted. |
||
1857 | </translation> |
||
1858 | </message> |
||
1859 | <message> |
||
14474 | cbradney | 1860 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="184"/> |
12918 | cbradney | 1861 | <source>textFlowMode("name" [, state]) |
1862 | |||
1863 | Enables/disables "Text Flows Around Frame" feature for object "name". |
||
1864 | Called with parameters string name and optional int "state" (0 <= state <= 3). |
||
1865 | Setting "state" to 0 will disable text flow. |
||
1866 | Setting "state" to 1 will make text flow around object frame. |
||
1867 | Setting "state" to 2 will make text flow around bounding box. |
||
1868 | Setting "state" to 3 will make text flow around contour line. |
||
1869 | If "state" is not passed, text flow is toggled. |
||
1870 | </source> |
||
1871 | <translation type="unfinished"></translation> |
||
1872 | </message> |
||
1873 | <message> |
||
14474 | cbradney | 1874 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="206"/> |
12918 | cbradney | 1875 | <source>objectExists(["name"]) -> bool |
1876 | |||
1877 | Test if an object with specified name really exists in the document. |
||
1878 | The optional parameter is the object name. When no object name is given, |
||
1879 | returns True if there is something selected. |
||
1880 | </source> |
||
1881 | <translation type="unfinished">objectExists(["name"]) -> bool |
||
1882 | |||
1883 | Test if an object with specified name really exists in the document. |
||
1884 | The optional parameter is the object name. When no object name is given, |
||
1885 | returns True if there is something selected. |
||
1886 | </translation> |
||
1887 | </message> |
||
1888 | <message> |
||
14474 | cbradney | 1889 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="223"/> |
12918 | cbradney | 1890 | <source>setStyle("style" [, "name"]) |
1891 | |||
14474 | cbradney | 1892 | Apply the named "style" to the object named "name". If object name is |
1893 | given, style is applied to the current text selection in object "name". |
||
1894 | If no object name is given, style is applied on selected object. |
||
1895 | </source> |
||
1896 | <translation type="unfinished"></translation> |
||
1897 | </message> |
||
1898 | <message> |
||
1899 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="250"/> |
||
1900 | <source>duplicateObject(["name"]) -> string |
||
1901 | |||
1902 | creates a Duplicate of the selected Object (or Selection Group). |
||
1903 | </source> |
||
1904 | <translation type="unfinished"></translation> |
||
1905 | </message> |
||
1906 | <message> |
||
1907 | <source>setStyle("style" [, "name"]) |
||
1908 | |||
12918 | cbradney | 1909 | Apply the named "style" to the object named "name". If is no object name |
1910 | given, it's applied on the selected object. |
||
1911 | </source> |
||
14474 | cbradney | 1912 | <translation type="obsolete">setStyle("style" [, "name"]) |
12918 | cbradney | 1913 | |
1914 | Apply the named "style" to the object named "name". If is no object name |
||
1915 | given, it's applied on the selected object. |
||
1916 | </translation> |
||
1917 | </message> |
||
1918 | <message> |
||
14474 | cbradney | 1919 | <location filename="../../../scribus/plugins/scriptplugin/cmdobj.h" line="238"/> |
12918 | cbradney | 1920 | <source>getAllStyles() -> list |
1921 | |||
1922 | Return a list of the names of all paragraph styles in the current document. |
||
1923 | </source> |
||
1924 | <translation type="unfinished">getAllStyles() -> list |
||
1925 | |||
1926 | Return a list of the names of all paragraph styles in the current document. |
||
1927 | </translation> |
||
1928 | </message> |
||
1929 | <message> |
||
14474 | cbradney | 1930 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="17"/> |
6082 | mrdocs | 1931 | <source>newPage(where [,"masterpage"]) |
1932 | |||
1933 | Creates a new page. If "where" is -1 the new Page is appended to the |
||
1934 | document, otherwise the new page is inserted before "where". Page numbers are |
||
1935 | counted from 1 upwards, no matter what the displayed first page number of your |
||
1936 | document is. The optional parameter "masterpage" specifies the name of the |
||
1937 | master page for the new page. |
||
1938 | |||
1939 | May raise IndexError if the page number is out of range |
||
1940 | </source> |
||
12612 | cbradney | 1941 | <translation type="unfinished">newPage(where [,"masterpage"]) |
6082 | mrdocs | 1942 | |
1943 | Creates a new page. If "where" is -1 the new Page is appended to the |
||
1944 | document, otherwise the new page is inserted before "where". Page numbers are |
||
1945 | counted from 1 upwards, no matter what the displayed first page number of your |
||
1946 | document is. The optional parameter "masterpage" specifies the name of the |
||
1947 | master page for the new page. |
||
1948 | |||
1949 | May raise IndexError if the page number is out of range |
||
1950 | </translation> |
||
1951 | </message> |
||
1952 | <message> |
||
14474 | cbradney | 1953 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="32"/> |
12918 | cbradney | 1954 | <source>currentPage() -> integer |
1955 | |||
1956 | Returns the number of the current working page. Page numbers are counted from 1 |
||
1957 | upwards, no matter what the displayed first page number of your document is. |
||
1958 | </source> |
||
1959 | <translation type="unfinished">currentPage() -> integer |
||
1960 | |||
1961 | Returns the number of the current working page. Page numbers are counted from 1 |
||
1962 | upwards, no matter what the displayed first page number of your document is. |
||
1963 | </translation> |
||
1964 | </message> |
||
1965 | <message> |
||
14474 | cbradney | 1966 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="42"/> |
12918 | cbradney | 1967 | <source>redrawAll() |
1968 | |||
1969 | Redraws all pages. |
||
1970 | </source> |
||
1971 | <translation type="unfinished">redrawAll() |
||
1972 | |||
1973 | Redraws all pages. |
||
1974 | </translation> |
||
1975 | </message> |
||
1976 | <message> |
||
14474 | cbradney | 1977 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="51"/> |
12918 | cbradney | 1978 | <source>getPageType() -> integer |
1979 | |||
1980 | Returns the type of the Page, 0 means left Page, 1 is a middle Page and 2 is a right Page |
||
1981 | </source> |
||
1982 | <translation type="unfinished"></translation> |
||
1983 | </message> |
||
1984 | <message> |
||
14474 | cbradney | 1985 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="60"/> |
12918 | cbradney | 1986 | <source>savePageAsEPS("name") |
1987 | |||
1988 | Saves the current page as an EPS to the file "name". |
||
1989 | |||
1990 | May raise ScribusError if the save failed. |
||
1991 | </source> |
||
1992 | <translation type="unfinished">savePageAsEPS("name") |
||
1993 | |||
1994 | Saves the current page as an EPS to the file "name". |
||
1995 | |||
1996 | May raise ScribusError if the save failed. |
||
1997 | </translation> |
||
1998 | </message> |
||
1999 | <message> |
||
14474 | cbradney | 2000 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="71"/> |
12918 | cbradney | 2001 | <source>deletePage(nr) |
2002 | |||
2003 | Deletes the given page. Does nothing if the document contains only one page. |
||
2004 | Page numbers are counted from 1 upwards, no matter what the displayed first |
||
2005 | page number is. |
||
2006 | |||
2007 | May raise IndexError if the page number is out of range |
||
2008 | </source> |
||
2009 | <translation type="unfinished">deletePage(nr) |
||
2010 | |||
2011 | Deletes the given page. Does nothing if the document contains only one page. |
||
2012 | Page numbers are counted from 1 upwards, no matter what the displayed first |
||
2013 | page number is. |
||
2014 | |||
2015 | May raise IndexError if the page number is out of range |
||
2016 | </translation> |
||
2017 | </message> |
||
2018 | <message> |
||
14474 | cbradney | 2019 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="84"/> |
12918 | cbradney | 2020 | <source>gotoPage(nr) |
2021 | |||
2022 | Moves to the page "nr" (that is, makes the current page "nr"). Note that |
||
2023 | gotoPage doesn't (currently) change the page the user's view is displaying, it |
||
2024 | just sets the page that script commands will operates on. |
||
2025 | |||
2026 | May raise IndexError if the page number is out of range. |
||
2027 | </source> |
||
2028 | <translation type="unfinished"></translation> |
||
2029 | </message> |
||
2030 | <message> |
||
14474 | cbradney | 2031 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="97"/> |
12918 | cbradney | 2032 | <source>pageCount() -> integer |
2033 | |||
2034 | Returns the number of pages in the document. |
||
2035 | </source> |
||
2036 | <translation type="unfinished">pageCount() -> integer |
||
2037 | |||
2038 | Returns the number of pages in the document. |
||
2039 | </translation> |
||
2040 | </message> |
||
2041 | <message> |
||
14474 | cbradney | 2042 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="106"/> |
12918 | cbradney | 2043 | <source>getHGuides() -> list |
2044 | |||
2045 | Returns a list containing positions of the horizontal guides. Values are in the |
||
2046 | document's current units - see UNIT_<type> constants. |
||
2047 | </source> |
||
2048 | <translation type="unfinished">getHGuides() -> list |
||
2049 | |||
2050 | Returns a list containing positions of the horizontal guides. Values are in the |
||
2051 | document's current units - see UNIT_<type> constants. |
||
2052 | </translation> |
||
2053 | </message> |
||
2054 | <message> |
||
14474 | cbradney | 2055 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="116"/> |
12918 | cbradney | 2056 | <source>setHGuides(list) |
2057 | |||
2058 | Sets horizontal guides. Input parameter must be a list of guide positions |
||
2059 | measured in the current document units - see UNIT_<type> constants. |
||
2060 | |||
2061 | Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost |
||
2062 | setHGuides([90,250]) # replace current guides entirely |
||
2063 | </source> |
||
2064 | <translation type="unfinished">setHGuides(list) |
||
2065 | |||
2066 | Sets horizontal guides. Input parameter must be a list of guide positions |
||
2067 | measured in the current document units - see UNIT_<type> constants. |
||
2068 | |||
2069 | Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost |
||
2070 | setHGuides([90,250]) # replace current guides entirely |
||
2071 | </translation> |
||
2072 | </message> |
||
2073 | <message> |
||
14474 | cbradney | 2074 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="129"/> |
12918 | cbradney | 2075 | <source>getVGuides() |
2076 | |||
2077 | See getHGuides. |
||
2078 | </source> |
||
2079 | <translation type="unfinished">getVGuides() |
||
2080 | |||
2081 | See getHGuides. |
||
2082 | </translation> |
||
2083 | </message> |
||
2084 | <message> |
||
14474 | cbradney | 2085 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="138"/> |
12918 | cbradney | 2086 | <source>setVGuides() |
2087 | |||
2088 | See setHGuides. |
||
2089 | </source> |
||
2090 | <translation type="unfinished">setVGuides() |
||
2091 | |||
2092 | See setHGuides. |
||
2093 | </translation> |
||
2094 | </message> |
||
2095 | <message> |
||
14474 | cbradney | 2096 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="147"/> |
12918 | cbradney | 2097 | <source>getPageSize() -> tuple |
2098 | |||
2099 | Returns a tuple with page dimensions measured in the document's current units. |
||
2100 | See UNIT_<type> constants and getPageMargins() |
||
2101 | </source> |
||
2102 | <translation type="unfinished">getPageSize() -> tuple |
||
2103 | |||
2104 | Returns a tuple with page dimensions measured in the document's current units. |
||
2105 | See UNIT_<type> constants and getPageMargins() |
||
2106 | </translation> |
||
2107 | </message> |
||
2108 | <message> |
||
14474 | cbradney | 2109 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="161"/> |
2110 | <source>getPageNSize() -> tuple |
||
2111 | |||
2112 | Returns a tuple with a particular page's size measured in the document's current units. |
||
2113 | See UNIT_<type> constants and getPageMargins() |
||
2114 | </source> |
||
2115 | <translation type="unfinished"></translation> |
||
2116 | </message> |
||
2117 | <message> |
||
2118 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="174"/> |
||
2119 | <source>getPageNMargins() -> tuple |
||
2120 | |||
2121 | Returns a tuple with a particular page's margins 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="187"/> |
||
12918 | cbradney | 2128 | <source>getPageItems() -> list |
2129 | |||
2130 | Returns a list of tuples with items on the current page. The tuple is: |
||
2131 | (name, objectType, order) E.g. [('Text1', 4, 0), ('Image1', 2, 1)] |
||
2132 | means that object named 'Text1' is a text frame (type 4) and is the first at |
||
2133 | the page... |
||
2134 | </source> |
||
2135 | <translation type="unfinished">getPageItems() -> list |
||
2136 | |||
2137 | Returns a list of tuples with items on the current page. The tuple is: |
||
2138 | (name, objectType, order) E.g. [('Text1', 4, 0), ('Image1', 2, 1)] |
||
2139 | means that object named 'Text1' is a text frame (type 4) and is the first at |
||
2140 | the page... |
||
2141 | </translation> |
||
2142 | </message> |
||
2143 | <message> |
||
14474 | cbradney | 2144 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="203"/> |
12918 | cbradney | 2145 | <source>getPageMargins() |
2146 | |||
2147 | Returns the page margins as a (top, left, right, bottom) tuple in the current |
||
2148 | units. See UNIT_<type> constants and getPageSize(). |
||
2149 | </source> |
||
2150 | <translation type="unfinished">getPageMargins() |
||
2151 | |||
2152 | Returns the page margins as a (top, left, right, bottom) tuple in the current |
||
2153 | units. See UNIT_<type> constants and getPageSize(). |
||
2154 | </translation> |
||
2155 | </message> |
||
2156 | <message> |
||
14474 | cbradney | 2157 | <location filename="../../../scribus/plugins/scriptplugin/cmdpage.h" line="216"/> |
12918 | cbradney | 2158 | <source>importPage("fromDoc", (pageList), [create, imortwhere, importwherePage]) |
2159 | |||
2160 | 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. |
||
2161 | fromDoc: string; the filename of the document to import pages from |
||
2162 | pageList: tuple with page numbers of pages to import |
||
2163 | create: number; 0 to replace existing pages, 1 (default) to insert new pages |
||
2164 | importWhere: number; the page number (of the current document) at which import the pages |
||
2165 | 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 |
||
2166 | </source> |
||
2167 | <translation type="unfinished"></translation> |
||
2168 | </message> |
||
2169 | <message> |
||
14474 | cbradney | 2170 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="17"/> |
1135 | cbradney | 2171 | <source>setGradientFill(type, "color1", shade1, "color2", shade2, ["name"]) |
2172 | |||
2173 | Sets the gradient fill of the object "name" to type. Color descriptions are |
||
2174 | the same as for setFillColor() and setFillShade(). See the constants for |
||
2175 | available types (FILL_<type>). |
||
2176 | </source> |
||
12612 | cbradney | 2177 | <translation type="unfinished">setGradientFill(type, "color1", shade1, "color2", shade2, ["name"]) |
6082 | mrdocs | 2178 | |
2179 | Sets the gradient fill of the object "name" to type. Colour descriptions are |
||
2180 | the same as for setFillColor() and setFillShade(). See the constants for |
||
2181 | available types (FILL_<type>). |
||
2182 | </translation> |
||
1135 | cbradney | 2183 | </message> |
2184 | <message> |
||
14474 | cbradney | 2185 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="28"/> |
2186 | <source>setGradientStop("color", shade, opacity, ramppoint, ["name"]) |
||
2187 | |||
2188 | Set or add a gradient stop to the gradient fill of the object "name" at position ramppoint. |
||
2189 | Color descriptions are the same as for setFillColor() and setFillShade(). setGradientFill() |
||
2190 | must have been called previously for the gradient fill to be visible. |
||
2191 | </source> |
||
2192 | <translation type="unfinished"></translation> |
||
2193 | </message> |
||
2194 | <message> |
||
2195 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="39"/> |
||
12918 | cbradney | 2196 | <source>setFillColor("color", ["name"]) |
2197 | |||
2198 | Sets the fill color of the object "name" to the color "color". "color" |
||
2199 | is the name of one of the defined colors. If "name" is not given the |
||
2200 | currently selected item is used. |
||
2201 | </source> |
||
2202 | <translation type="unfinished">setFillColor("color", ["name"]) |
||
2203 | |||
2204 | Sets the fill colour of the object "name" to the colour "color". "color" |
||
2205 | is the name of one of the defined colours. If "name" is not given the |
||
2206 | currently selected item is used. |
||
2207 | </translation> |
||
2208 | </message> |
||
2209 | <message> |
||
14474 | cbradney | 2210 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="50"/> |
12918 | cbradney | 2211 | <source>setFillTransparency(transparency, ["name"]) |
2212 | |||
2213 | Sets the fill transparency of the object "name" to transparency |
||
2214 | If "name" is not given the currently selected item is used. |
||
2215 | </source> |
||
2216 | <translation type="unfinished"></translation> |
||
2217 | </message> |
||
2218 | <message> |
||
14474 | cbradney | 2219 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="60"/> |
12918 | cbradney | 2220 | <source>setFillBlendmode(blendmode, ["name"]) |
2221 | |||
2222 | Sets the fill blendmode of the object "name" to blendmode |
||
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="70"/> |
12918 | cbradney | 2229 | <source>setLineColor("color", ["name"]) |
2230 | |||
2231 | Sets the line color of the object "name" to the color "color". If "name" |
||
2232 | is not given the currently selected item is used. |
||
2233 | </source> |
||
2234 | <translation type="unfinished">setLineColor("color", ["name"]) |
||
2235 | |||
2236 | Sets the line colour of the object "name" to the colour "color". If "name" |
||
2237 | is not given the currently selected item is used. |
||
2238 | </translation> |
||
2239 | </message> |
||
2240 | <message> |
||
14474 | cbradney | 2241 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="80"/> |
12918 | cbradney | 2242 | <source>setLineTransparency(transparency, ["name"]) |
2243 | |||
2244 | Sets the line transparency of the object "name" to transparency |
||
2245 | If "name" is not given the currently selected item is used. |
||
2246 | </source> |
||
2247 | <translation type="unfinished"></translation> |
||
2248 | </message> |
||
2249 | <message> |
||
14474 | cbradney | 2250 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="90"/> |
12918 | cbradney | 2251 | <source>setLineBlendmode(blendmode, ["name"]) |
2252 | |||
2253 | Sets the line blendmode of the object "name" to blendmode |
||
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="100"/> |
12918 | cbradney | 2260 | <source>setLineWidth(width, ["name"]) |
2261 | |||
2262 | Sets line width of the object "name" to "width". "width" must be in the |
||
2263 | range from 0.0 to 12.0 inclusive, and is measured in points. If "name" is not |
||
2264 | given the currently selected item is used. |
||
2265 | |||
2266 | May raise ValueError if the line width is out of bounds. |
||
2267 | </source> |
||
2268 | <translation type="unfinished">setLineWidth(width, ["name"]) |
||
2269 | |||
2270 | Sets line width of the object "name" to "width". "width" must be in the |
||
2271 | range from 0.0 to 12.0 inclusive, and is measured in points. If "name" is not |
||
2272 | given the currently selected item is used. |
||
2273 | |||
2274 | May raise ValueError if the line width is out of bounds. |
||
2275 | </translation> |
||
2276 | </message> |
||
2277 | <message> |
||
14474 | cbradney | 2278 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="113"/> |
12918 | cbradney | 2279 | <source>setLineShade(shade, ["name"]) |
2280 | |||
2281 | Sets the shading of the line color of the object "name" to "shade". |
||
2282 | "shade" must be an integer value in the range from 0 (lightest) to 100 |
||
2283 | (full color intensity). If "name" is not given the currently selected item |
||
2284 | is used. |
||
2285 | |||
2286 | May raise ValueError if the line shade is out of bounds. |
||
2287 | </source> |
||
2288 | <translation type="unfinished">setLineShade(shade, ["name"]) |
||
2289 | |||
2290 | Sets the shading of the line colour of the object "name" to "shade". |
||
2291 | "shade" must be an integer value in the range from 0 (lightest) to 100 |
||
2292 | (full colour 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 | </translation> |
||
2297 | </message> |
||
2298 | <message> |
||
14474 | cbradney | 2299 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="127"/> |
12918 | cbradney | 2300 | <source>setLineJoin(join, ["name"]) |
2301 | |||
2302 | Sets the line join style of the object "name" to the style "join". |
||
2303 | If "name" is not given the currently selected item is used. There are |
||
2304 | predefined constants for join - JOIN_<type>. |
||
2305 | </source> |
||
2306 | <translation type="unfinished">setLineJoin(join, ["name"]) |
||
2307 | |||
2308 | Sets the line join style of the object "name" to the style "join". |
||
2309 | If "name" is not given the currently selected item is used. There are |
||
2310 | predefined constants for join - JOIN_<type>. |
||
2311 | </translation> |
||
2312 | </message> |
||
2313 | <message> |
||
14474 | cbradney | 2314 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="138"/> |
12918 | cbradney | 2315 | <source>setLineEnd(endtype, ["name"]) |
2316 | |||
2317 | Sets the line cap style of the object "name" to the style "cap". |
||
2318 | If "name" is not given the currently selected item is used. There are |
||
2319 | predefined constants for "cap" - CAP_<type>. |
||
2320 | </source> |
||
2321 | <translation type="unfinished">setLineEnd(endtype, ["name"]) |
||
2322 | |||
2323 | Sets the line cap style of the object "name" to the style "cap". |
||
2324 | If "name" is not given the currently selected item is used. There are |
||
2325 | predefined constants for "cap" - CAP_<type>. |
||
2326 | </translation> |
||
2327 | </message> |
||
2328 | <message> |
||
14474 | cbradney | 2329 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="149"/> |
12918 | cbradney | 2330 | <source>setLineStyle(style, ["name"]) |
2331 | |||
2332 | Sets the line style of the object "name" to the style "style". If "name" |
||
2333 | is not given the currently selected item is used. There are predefined |
||
2334 | constants for "style" - LINE_<style>. |
||
2335 | </source> |
||
2336 | <translation type="unfinished">setLineStyle(style, ["name"]) |
||
2337 | |||
2338 | Sets the line style of the object "name" to the style "style". If "name" |
||
2339 | is not given the currently selected item is used. There are predefined |
||
2340 | constants for "style" - LINE_<style>. |
||
2341 | </translation> |
||
2342 | </message> |
||
2343 | <message> |
||
14474 | cbradney | 2344 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="160"/> |
12918 | cbradney | 2345 | <source>setFillShade(shade, ["name"]) |
2346 | |||
2347 | Sets the shading of the fill color of the object "name" to "shade". |
||
2348 | "shade" must be an integer value in the range from 0 (lightest) to 100 |
||
2349 | (full Color intensity). If "name" is not given the currently selected |
||
2350 | Item is used. |
||
2351 | |||
2352 | May raise ValueError if the fill shade is out of bounds. |
||
2353 | </source> |
||
2354 | <translation type="unfinished">setFillShade(shade, ["name"]) |
||
2355 | |||
2356 | Sets the shading of the fill colour of the object "name" to "shade". |
||
2357 | "shade" must be an integer value in the range from 0 (lightest) to 100 |
||
2358 | (full Colour 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 | </translation> |
||
2363 | </message> |
||
2364 | <message> |
||
14474 | cbradney | 2365 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="174"/> |
12918 | cbradney | 2366 | <source>setCornerRadius(radius, ["name"]) |
2367 | |||
2368 | Sets the corner radius of the object "name". The radius is expressed |
||
2369 | in points. If "name" is not given the currently selected item is used. |
||
2370 | |||
2371 | May raise ValueError if the corner radius is negative. |
||
2372 | </source> |
||
2373 | <translation type="unfinished">setCornerRadius(radius, ["name"]) |
||
2374 | |||
2375 | Sets the corner radius of the object "name". The radius is expressed |
||
2376 | in points. If "name" is not given the currently selected item is used. |
||
2377 | |||
2378 | May raise ValueError if the corner radius is negative. |
||
2379 | </translation> |
||
2380 | </message> |
||
2381 | <message> |
||
14474 | cbradney | 2382 | <location filename="../../../scribus/plugins/scriptplugin/cmdsetprop.h" line="186"/> |
12918 | cbradney | 2383 | <source>setMultiLine("namedStyle", ["name"]) |
2384 | |||
2385 | Sets the line style of the object "name" to the named style "namedStyle". |
||
2386 | If "name" is not given the currently selected item is used. |
||
2387 | |||
2388 | May raise NotFoundError if the line style doesn't exist. |
||
2389 | </source> |
||
2390 | <translation type="unfinished">setMultiLine("namedStyle", ["name"]) |
||
2391 | |||
2392 | Sets the line style of the object "name" to the named style "namedStyle". |
||
2393 | If "name" is not given the currently selected item is used. |
||
2394 | |||
2395 | May raise NotFoundError if the line style doesn't exist. |
||
2396 | </translation> |
||
2397 | </message> |
||
2398 | <message> |
||
14474 | cbradney | 2399 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="17"/> |
6082 | mrdocs | 2400 | <source>getFontSize(["name"]) -> float |
2401 | |||
2402 | Returns the font size in points for the text frame "name". If this text |
||
2403 | frame has some text selected the value assigned to the first character of |
||
2404 | the selection is returned. |
||
2405 | If "name" is not given the currently selected item is used. |
||
2406 | </source> |
||
12612 | cbradney | 2407 | <translation type="unfinished">getFontSize(["name"]) -> float |
6082 | mrdocs | 2408 | |
2409 | Returns the font size in points for the text frame "name". If this text |
||
2410 | frame has some text selected the value assigned to the first character of |
||
2411 | the selection is returned. |
||
2412 | If "name" is not given the currently selected item is used. |
||
2413 | </translation> |
||
2414 | </message> |
||
2415 | <message> |
||
14474 | cbradney | 2416 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="29"/> |
12918 | cbradney | 2417 | <source>getFont(["name"]) -> string |
2418 | |||
2419 | Returns the font name for the text frame "name". If this text frame |
||
2420 | has some text selected the value assigned to the first character |
||
2421 | of the selection is returned. If "name" is not given the currently |
||
2422 | selected item is used. |
||
2423 | </source> |
||
2424 | <translation type="unfinished">getFont(["name"]) -> string |
||
2425 | |||
2426 | Returns the font name for the text frame "name". If this text frame |
||
2427 | has some text selected the value assigned to the first character |
||
2428 | of the selection is returned. If "name" is not given the currently |
||
2429 | selected item is used. |
||
2430 | </translation> |
||
2431 | </message> |
||
2432 | <message> |
||
14474 | cbradney | 2433 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="41"/> |
12918 | cbradney | 2434 | <source>getTextLength(["name"]) -> integer |
2435 | |||
2436 | Returns the length of the text in the text frame "name". |
||
2437 | If "name" is not given the currently selected item is used. |
||
2438 | </source> |
||
2439 | <translation type="unfinished">getTextLength(["name"]) -> integer |
||
2440 | |||
2441 | Returns the length of the text in the text frame "name". |
||
2442 | If "name" is not given the currently selected item is used. |
||
2443 | </translation> |
||
2444 | </message> |
||
2445 | <message> |
||
14474 | cbradney | 2446 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="51"/> |
12918 | cbradney | 2447 | <source>getTextLines(["name"]) -> integer |
2448 | |||
2449 | Returns the number of lines of the text in the text frame "name". |
||
2450 | If "name" is not given the currently selected item is used. |
||
2451 | </source> |
||
2452 | <translation type="unfinished"></translation> |
||
2453 | </message> |
||
2454 | <message> |
||
14474 | cbradney | 2455 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="61"/> |
12918 | cbradney | 2456 | <source>getText(["name"]) -> string |
2457 | |||
2458 | Returns the text of the text frame "name". If this text frame has some text |
||
2459 | selected, the selected text is returned. All text in the frame, not just |
||
2460 | currently visible text, is returned. If "name" is not given the currently |
||
2461 | selected item is used. |
||
2462 | </source> |
||
2463 | <translation type="unfinished">getText(["name"]) -> string |
||
2464 | |||
2465 | Returns the text of the text frame "name". If this text frame has some text |
||
2466 | selected, the selected text is returned. All text in the frame, not just |
||
2467 | currently visible text, is returned. If "name" is not given the currently |
||
2468 | selected item is used. |
||
2469 | </translation> |
||
2470 | </message> |
||
2471 | <message> |
||
14474 | cbradney | 2472 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="73"/> |
12918 | cbradney | 2473 | <source>getAllText(["name"]) -> string |
2474 | |||
2475 | Returns the text of the text frame "name" and of all text frames which are |
||
2476 | linked with this frame. If this textframe has some text selected, the selected |
||
2477 | text is returned. If "name" is not given the currently selected item is |
||
2478 | used. |
||
2479 | </source> |
||
2480 | <translation type="unfinished">getAllText(["name"]) -> string |
||
2481 | |||
2482 | Returns the text of the text frame "name" and of all text frames which are |
||
2483 | linked with this frame. If this textframe has some text selected, the selected |
||
2484 | text is returned. If "name" is not given the currently selected item is |
||
2485 | used. |
||
2486 | </translation> |
||
2487 | </message> |
||
2488 | <message> |
||
14474 | cbradney | 2489 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="85"/> |
12918 | cbradney | 2490 | <source>getLineSpacing(["name"]) -> float |
2491 | |||
2492 | Returns the line spacing ("leading") of the text frame "name" expressed in |
||
2493 | points. If "name" is not given the currently selected item is used. |
||
2494 | </source> |
||
2495 | <translation type="unfinished">getLineSpacing(["name"]) -> float |
||
2496 | |||
2497 | Returns the line spacing ("leading") of the text frame "name" expressed in |
||
2498 | points. If "name" is not given the currently selected item is used. |
||
2499 | </translation> |
||
2500 | </message> |
||
2501 | <message> |
||
14474 | cbradney | 2502 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="95"/> |
12918 | cbradney | 2503 | <source>getTextDistances(["name"]) -> tuple |
2504 | |||
2505 | Returns the text distances of the text frame "name" expressed in points. The |
||
2506 | distances are returned as a tuple like (left, right, top, bottom). If "name" |
||
2507 | is not given the currently selected item is used. |
||
2508 | </source> |
||
2509 | <translation type="unfinished"></translation> |
||
2510 | </message> |
||
2511 | <message> |
||
14474 | cbradney | 2512 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="106"/> |
12918 | cbradney | 2513 | <source>getColumnGap(["name"]) -> float |
2514 | |||
2515 | Returns the column gap size of the text frame "name" expressed in points. If |
||
2516 | "name" is not given the currently selected item is used. |
||
2517 | </source> |
||
2518 | <translation type="unfinished">getColumnGap(["name"]) -> float |
||
2519 | |||
2520 | Returns the column gap size of the text frame "name" expressed in points. If |
||
2521 | "name" is not given the currently selected item is used. |
||
2522 | </translation> |
||
2523 | </message> |
||
2524 | <message> |
||
14474 | cbradney | 2525 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="116"/> |
12918 | cbradney | 2526 | <source>getColumns(["name"]) -> integer |
2527 | |||
2528 | Gets the number of columns of the text frame "name". If "name" is not |
||
2529 | given the currently selected item is used. |
||
2530 | </source> |
||
2531 | <translation type="unfinished">getColumns(["name"]) -> integer |
||
2532 | |||
2533 | Gets the number of columns of the text frame "name". If "name" is not |
||
2534 | given the currently selected item is used. |
||
2535 | </translation> |
||
2536 | </message> |
||
2537 | <message> |
||
14474 | cbradney | 2538 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="126"/> |
12918 | cbradney | 2539 | <source>setText("text", ["name"]) |
2540 | |||
2541 | Sets the text of the text frame "name" to the text of the string "text". |
||
2542 | Text must be UTF8 encoded - use e.g. unicode(text, 'iso-8859-2'). See the FAQ |
||
2543 | for more details. If "name" is not given the currently selected item is |
||
2544 | used. |
||
2545 | </source> |
||
2546 | <translation type="unfinished">setText("text", ["name"]) |
||
2547 | |||
2548 | Sets the text of the text frame "name" to the text of the string "text". |
||
2549 | Text must be UTF8 encoded - use e.g. unicode(text, 'iso-8859-2'). See the FAQ |
||
2550 | for more details. If "name" is not given the currently selected item is |
||
2551 | used. |
||
2552 | </translation> |
||
2553 | </message> |
||
2554 | <message> |
||
14474 | cbradney | 2555 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="138"/> |
12918 | cbradney | 2556 | <source>insertText("text", pos, ["name"]) |
2557 | |||
2558 | Inserts the text "text" at the position "pos" into the text frame "name". |
||
2559 | Text must be UTF encoded (see setText() as reference) The first character has an |
||
2560 | index of 0. Inserting text at position -1 appends it to the frame. If "name" is |
||
2561 | not given the currently selected Item is used. |
||
2562 | |||
2563 | May throw IndexError for an insertion out of bounds. |
||
2564 | </source> |
||
2565 | <translation type="unfinished"></translation> |
||
2566 | </message> |
||
2567 | <message> |
||
14474 | cbradney | 2568 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="152"/> |
12918 | cbradney | 2569 | <source>setFont("font", ["name"]) |
2570 | |||
2571 | Sets the font of the text frame "name" to "font". If there is some text |
||
2572 | selected only the selected text is changed. If "name" is not given the |
||
2573 | currently selected item is used. |
||
2574 | |||
2575 | May throw ValueError if the font cannot be found. |
||
2576 | </source> |
||
2577 | <translation type="unfinished">setFont("font", ["name"]) |
||
2578 | |||
2579 | Sets the font of the text frame "name" to "font". If there is some text |
||
2580 | selected only the selected text is changed. If "name" is not given the |
||
2581 | currently selected item is used. |
||
2582 | |||
2583 | May throw ValueError if the font cannot be found. |
||
2584 | </translation> |
||
2585 | </message> |
||
2586 | <message> |
||
14474 | cbradney | 2587 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="165"/> |
12918 | cbradney | 2588 | <source>setFontSize(size, ["name"]) |
2589 | |||
2590 | Sets the font size of the text frame "name" to "size". "size" is treated |
||
2591 | as a value in points. If there is some text selected only the selected text is |
||
2592 | changed. "size" must be in the range 1 to 512. If "name" is not given the |
||
2593 | currently selected item is used. |
||
2594 | |||
2595 | May throw ValueError for a font size that's out of bounds. |
||
2596 | </source> |
||
2597 | <translation type="unfinished">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 | </translation> |
||
2606 | </message> |
||
2607 | <message> |
||
14474 | cbradney | 2608 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="179"/> |
12918 | cbradney | 2609 | <source>setLineSpacing(size, ["name"]) |
2610 | |||
2611 | Sets the line spacing ("leading") of the text frame "name" to "size". |
||
2612 | "size" is a value in points. If "name" is not given the currently selected |
||
2613 | item is used. |
||
2614 | |||
2615 | May throw ValueError if the line spacing is out of bounds. |
||
2616 | </source> |
||
2617 | <translation type="unfinished">setLineSpacing(size, ["name"]) |
||
2618 | |||
2619 | Sets the line spacing ("leading") of the text frame "name" to "size". |
||
2620 | "size" is a value in points. If "name" is not given the currently selected |
||
2621 | item is used. |
||
2622 | |||
2623 | May throw ValueError if the line spacing is out of bounds. |
||
2624 | </translation> |
||
2625 | </message> |
||
2626 | <message> |
||
14474 | cbradney | 2627 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="192"/> |
2628 | <source>setLineSpacingMode(mode, ["name"]) |
||
2629 | |||
2630 | Sets the line spacing mode of the text frame "name" to "mode". |
||
2631 | If "name" is not given the currently selected |
||
2632 | item is used. |
||
2633 | Mode values are the same as in createParagraphStyle. |
||
2634 | |||
2635 | May throw ValueError if the mode is out of bounds. |
||
2636 | </source> |
||
2637 | <translation type="unfinished"></translation> |
||
2638 | </message> |
||
2639 | <message> |
||
2640 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="206"/> |
||
12918 | cbradney | 2641 | <source>setTextDistances(left, right, top, bottom, ["name"]) |
2642 | |||
2643 | Sets the text distances of the text frame "name" to the values "left" |
||
2644 | "right", "top" and "bottom". If "name" is not given the currently |
||
2645 | selected item is used. |
||
2646 | |||
2647 | May throw ValueError if any of the distances are out of bounds (must be positive). |
||
2648 | </source> |
||
2649 | <translation type="unfinished"></translation> |
||
2650 | </message> |
||
2651 | <message> |
||
14474 | cbradney | 2652 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="219"/> |
12918 | cbradney | 2653 | <source>setColumnGap(size, ["name"]) |
2654 | |||
2655 | Sets the column gap of the text frame "name" to the value "size". If |
||
2656 | "name" is not given the currently selected item is used. |
||
2657 | |||
2658 | May throw ValueError if the column gap is out of bounds (must be positive). |
||
2659 | </source> |
||
2660 | <translation type="unfinished">setColumnGap(size, ["name"]) |
||
2661 | |||
2662 | Sets the column gap of the text frame "name" to the value "size". If |
||
2663 | "name" is not given the currently selected item is used. |
||
2664 | |||
2665 | May throw ValueError if the column gap is out of bounds (must be positive). |
||
2666 | </translation> |
||
2667 | </message> |
||
2668 | <message> |
||
14474 | cbradney | 2669 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="231"/> |
12918 | cbradney | 2670 | <source>setColumns(nr, ["name"]) |
2671 | |||
2672 | Sets the number of columns of the text frame "name" to the integer "nr". |
||
2673 | If "name" is not given the currently selected item is used. |
||
2674 | |||
2675 | May throw ValueError if number of columns is not at least one. |
||
2676 | </source> |
||
2677 | <translation type="unfinished">setColumns(nr, ["name"]) |
||
2678 | |||
2679 | Sets the number of columns of the text frame "name" to the integer "nr". |
||
2680 | If "name" is not given the currently selected item is used. |
||
2681 | |||
2682 | May throw ValueError if number of columns is not at least one. |
||
2683 | </translation> |
||
2684 | </message> |
||
2685 | <message> |
||
14474 | cbradney | 2686 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="243"/> |
12918 | cbradney | 2687 | <source>setTextAlignment(align, ["name"]) |
2688 | |||
2689 | Sets the text alignment of the text frame "name" to the specified alignment. |
||
2690 | If "name" is not given the currently selected item is used. "align" should |
||
2691 | be one of the ALIGN_ constants defined in this module - see dir(scribus). |
||
2692 | |||
2693 | May throw ValueError for an invalid alignment constant. |
||
2694 | </source> |
||
2695 | <translation type="unfinished">setTextAlignment(align, ["name"]) |
||
2696 | |||
2697 | Sets the text alignment of the text frame "name" to the specified alignment. |
||
2698 | If "name" is not given the currently selected item is used. "align" should |
||
2699 | be one of the ALIGN_ constants defined in this module - see dir(scribus). |
||
2700 | |||
2701 | May throw ValueError for an invalid alignment constant. |
||
2702 | </translation> |
||
2703 | </message> |
||
2704 | <message> |
||
14474 | cbradney | 2705 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="256"/> |
12918 | cbradney | 2706 | <source>selectText(start, count, ["name"]) |
2707 | |||
2708 | Selects "count" characters of text in the text frame "name" starting from the |
||
2709 | character "start". Character counting starts at 0. If "count" is zero, any |
||
2710 | text selection will be cleared. If "name" is not given the currently |
||
2711 | selected item is used. |
||
2712 | |||
2713 | May throw IndexError if the selection is outside the bounds of the text. |
||
2714 | </source> |
||
2715 | <translation type="unfinished">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 | </translation> |
||
2724 | </message> |
||
2725 | <message> |
||
14474 | cbradney | 2726 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="270"/> |
12918 | cbradney | 2727 | <source>deleteText(["name"]) |
2728 | |||
2729 | Deletes any text in the text frame "name". If there is some text selected, |
||
2730 | only the selected text will be deleted. If "name" is not given the currently |
||
2731 | selected item is used. |
||
2732 | </source> |
||
2733 | <translation type="unfinished">deleteText(["name"]) |
||
2734 | |||
2735 | Deletes any text in the text frame "name". If there is some text selected, |
||
2736 | only the selected text will be deleted. If "name" is not given the currently |
||
2737 | selected item is used. |
||
2738 | </translation> |
||
2739 | </message> |
||
2740 | <message> |
||
14474 | cbradney | 2741 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="281"/> |
12918 | cbradney | 2742 | <source>setTextColor("color", ["name"]) |
2743 | |||
2744 | Sets the text color of the text frame "name" to the color "color". If there |
||
2745 | is some text selected only the selected text is changed. If "name" is not |
||
2746 | given the currently selected item is used. |
||
2747 | </source> |
||
2748 | <translation type="unfinished">setTextColor("color", ["name"]) |
||
2749 | |||
2750 | Sets the text colour of the text frame "name" to the colour "color". If there |
||
2751 | is some text selected only the selected text is changed. If "name" is not |
||
2752 | given the currently selected item is used. |
||
2753 | </translation> |
||
2754 | </message> |
||
2755 | <message> |
||
14474 | cbradney | 2756 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="292"/> |
12918 | cbradney | 2757 | <source>setTextStroke("color", ["name"]) |
2758 | |||
2759 | Set "color" of the text stroke. If "name" is not given the currently |
||
2760 | selected item is used. |
||
2761 | </source> |
||
2762 | <translation type="unfinished">setTextStroke("color", ["name"]) |
||
2763 | |||
2764 | Set "color" of the text stroke. If "name" is not given the currently |
||
2765 | selected item is used. |
||
2766 | </translation> |
||
2767 | </message> |
||
2768 | <message> |
||
14474 | cbradney | 2769 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="302"/> |
2770 | <source>setTextScalingV(scale, ["name"]) |
||
2771 | |||
2772 | Sets the vertical character scaling of the object "name" to "scale" in percent. |
||
2773 | If "name" is not given the currently selected item is used. |
||
2774 | </source> |
||
2775 | <translation type="unfinished"></translation> |
||
2776 | </message> |
||
2777 | <message> |
||
2778 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="312"/> |
||
2779 | <source>setTextScalingH(scale, ["name"]) |
||
2780 | |||
2781 | Sets the horizontal 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="322"/> |
||
12918 | cbradney | 2788 | <source>setTextShade(shade, ["name"]) |
2789 | |||
2790 | Sets the shading of the text color of the object "name" to "shade". If |
||
2791 | there is some text selected only the selected text is changed. "shade" must |
||
2792 | be an integer value in the range from 0 (lightest) to 100 (full color |
||
2793 | intensity). If "name" is not given the currently selected item is |
||
2794 | used. |
||
2795 | </source> |
||
2796 | <translation type="unfinished">setTextShade(shade, ["name"]) |
||
2797 | |||
2798 | Sets the shading of the text colour of the object "name" to "shade". If |
||
2799 | there is some text selected only the selected text is changed. "shade" must |
||
2800 | be an integer value in the range from 0 (lightest) to 100 (full colour |
||
2801 | intensity). If "name" is not given the currently selected item is |
||
2802 | used. |
||
2803 | </translation> |
||
2804 | </message> |
||
2805 | <message> |
||
14474 | cbradney | 2806 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="335"/> |
12918 | cbradney | 2807 | <source>linkTextFrames("fromname", "toname") |
2808 | |||
2809 | Link two text frames. The frame named "fromname" is linked to the |
||
2810 | frame named "toname". The target frame must be an empty text frame |
||
2811 | and must not link to or be linked from any other frames already. |
||
2812 | |||
2813 | May throw ScribusException if linking rules are violated. |
||
2814 | </source> |
||
2815 | <translation type="unfinished">linkTextFrames("fromname", "toname") |
||
2816 | |||
2817 | Link two text frames. The frame named "fromname" is linked to the |
||
2818 | frame named "toname". The target frame must be an empty text frame |
||
2819 | and must not link to or be linked from any other frames already. |
||
2820 | |||
2821 | May throw ScribusException if linking rules are violated. |
||
2822 | </translation> |
||
2823 | </message> |
||
2824 | <message> |
||
14474 | cbradney | 2825 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="352"/> |
12918 | cbradney | 2826 | <source>unlinkTextFrames("name") |
2827 | |||
2828 | Remove the specified (named) object from the text frame flow/linkage. If the |
||
2829 | frame was in the middle of a chain, the previous and next frames will be |
||
2830 | connected, eg 'a->b->c' becomes 'a->c' when you unlinkTextFrames(b)' |
||
2831 | |||
2832 | May throw ScribusException if linking rules are violated. |
||
2833 | </source> |
||
2834 | <translation type="unfinished">unlinkTextFrames("name") |
||
2835 | |||
2836 | Remove the specified (named) object from the text frame flow/linkage. If the |
||
2837 | frame was in the middle of a chain, the previous and next frames will be |
||
2838 | connected, eg 'a->b->c' becomes 'a->c' when you unlinkTextFrames(b)' |
||
2839 | |||
2840 | May throw ScribusException if linking rules are violated. |
||
2841 | </translation> |
||
2842 | </message> |
||
2843 | <message> |
||
14474 | cbradney | 2844 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="369"/> |
12918 | cbradney | 2845 | <source>traceText(["name"]) |
2846 | |||
2847 | Convert the text frame "name" to outlines. If "name" is not given the |
||
2848 | currently selected item is used.</source> |
||
2849 | <translation type="unfinished">traceText(["name"]) |
||
2850 | |||
2851 | Convert the text frame "name" to outlines. If "name" is not given the |
||
2852 | currently selected item is used.</translation> |
||
2853 | </message> |
||
2854 | <message> |
||
14474 | cbradney | 2855 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="380"/> |
12918 | cbradney | 2856 | <source>textOverflows(["name", nolinks]) -> integer |
2857 | |||
2858 | Returns the actual number of overflowing characters in text frame "name". |
||
2859 | If is nolinks set to non zero value it takes only one frame - it doesn't |
||
2860 | use text frame linking. Without this parameter it search all linking chain. |
||
2861 | |||
2862 | May raise WrongFrameTypeError if the target frame is not an text frame |
||
2863 | </source> |
||
2864 | <translation type="unfinished">textOverflows(["name", nolinks]) -> integer |
||
2865 | |||
2866 | Returns the actual number of overflowing characters in text frame "name". |
||
2867 | If is nolinks set to non zero value it takes only one frame - it doesn't |
||
2868 | use text frame linking. Without this parameter it search all linking chain. |
||
2869 | |||
2870 | May raise WrongFrameTypeError if the target frame is not an text frame |
||
2871 | </translation> |
||
2872 | </message> |
||
2873 | <message> |
||
14474 | cbradney | 2874 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="393"/> |
12918 | cbradney | 2875 | <source>hyphenateText(["name"]) -> bool |
2876 | |||
2877 | Does hyphenation on text frame "name". |
||
2878 | If "name" is not given the currently selected item is used. |
||
2879 | |||
2880 | May raise WrongFrameTypeError if the target frame is not a text frame |
||
2881 | </source> |
||
2882 | <translation type="unfinished"></translation> |
||
2883 | </message> |
||
2884 | <message> |
||
14474 | cbradney | 2885 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="407"/> |
12918 | cbradney | 2886 | <source>dehyphenateText(["name"]) -> bool |
2887 | |||
2888 | Does dehyphenation on text frame "name". |
||
2889 | If "name" is not given the currently selected item is used. |
||
2890 | |||
2891 | May raise WrongFrameTypeError if the target frame is not a text frame |
||
2892 | </source> |
||
2893 | <translation type="unfinished"></translation> |
||
2894 | </message> |
||
2895 | <message> |
||
14474 | cbradney | 2896 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="422"/> |
12918 | cbradney | 2897 | <source>setPDFBookmark("toggle", ["name"]) |
2898 | |||
2899 | Sets whether (toggle = 1) the text frame "name" is a bookmark nor not. |
||
2900 | If "name" is not given the currently selected item is used. |
||
2901 | |||
2902 | May raise WrongFrameTypeError if the target frame is not a text frame |
||
2903 | </source> |
||
2904 | <translation type="unfinished"></translation> |
||
2905 | </message> |
||
2906 | <message> |
||
14474 | cbradney | 2907 | <location filename="../../../scribus/plugins/scriptplugin/cmdtext.h" line="434"/> |
12918 | cbradney | 2908 | <source>isPDFBookmark(["name"]) -> bool |
2909 | |||
2910 | Returns true if the text frame "name" is a PDF bookmark. |
||
2911 | If "name" is not given the currently selected item is used. |
||
2912 | |||
2913 | May raise WrongFrameTypeError if the target frame is not a text frame |
||
2914 | </source> |
||
2915 | <translation type="unfinished">isPDFBookmark(["name"]) -> bool |
||
2916 | |||
2917 | Returns true if the text frame "name" is a PDF bookmark. |
||
2918 | If "name" is not given the currently selected item is used. |
||
2919 | |||
2920 | May raise WrongFrameTypeError if the target frame is not a text frame |
||
2921 | </translation> |
||
2922 | </message> |
||
2923 | <message> |
||
14474 | cbradney | 2924 | <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="17"/> |
1135 | cbradney | 2925 | <source>messagebarText("string") |
2926 | |||
2927 | Writes the "string" into the Scribus message bar (status line). The text |
||
2928 | must be UTF8 encoded or 'unicode' string(recommended). |
||
2929 | </source> |
||
12612 | cbradney | 2930 | <translation type="unfinished">messagebarText("string") |
3064 | cbradney | 2931 | |
6082 | mrdocs | 2932 | Writes the "string" into the Scribus message bar (status line). The text |
2933 | must be UTF8 encoded or 'unicode' string(recommended). |
||
2934 | </translation> |
||
3064 | cbradney | 2935 | </message> |
2936 | <message> |
||
14474 | cbradney | 2937 | <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="30"/> |
12918 | cbradney | 2938 | <source>progressReset() |
2939 | |||
2940 | Cleans up the Scribus progress bar previous settings. It is called before the |
||
2941 | new progress bar use. See progressSet. |
||
2942 | </source> |
||
2943 | <translation type="unfinished">progressReset() |
||
2944 | |||
2945 | Cleans up the Scribus progress bar previous settings. It is called before the |
||
2946 | new progress bar use. See progressSet. |
||
2947 | </translation> |
||
2948 | </message> |
||
2949 | <message> |
||
14474 | cbradney | 2950 | <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="43"/> |
12918 | cbradney | 2951 | <source>progressTotal(max) |
2952 | |||
2953 | Sets the progress bar's maximum steps value to the specified number. |
||
2954 | See progressSet. |
||
2955 | </source> |
||
2956 | <translation type="unfinished">progressTotal(max) |
||
2957 | |||
2958 | Sets the progress bar's maximum steps value to the specified number. |
||
2959 | See progressSet. |
||
2960 | </translation> |
||
2961 | </message> |
||
2962 | <message> |
||
14474 | cbradney | 2963 | <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="52"/> |
12918 | cbradney | 2964 | <source>progressSet(nr) |
2965 | |||
2966 | Set the progress bar position to "nr", a value relative to the previously set |
||
2967 | progressTotal. The progress bar uses the concept of steps; you give it the |
||
2968 | total number of steps and the number of steps completed so far and it will |
||
2969 | display the percentage of steps that have been completed. You can specify the |
||
2970 | total number of steps with progressTotal(). The current number of steps is set |
||
2971 | with progressSet(). The progress bar can be rewound to the beginning with |
||
2972 | progressReset(). [based on info taken from Trolltech's Qt docs] |
||
2973 | </source> |
||
2974 | <translation type="unfinished">progressSet(nr) |
||
2975 | |||
2976 | Set the progress bar position to "nr", a value relative to the previously set |
||
2977 | progressTotal. The progress bar uses the concept of steps; you give it the |
||
2978 | total number of steps and the number of steps completed so far and it will |
||
2979 | display the percentage of steps that have been completed. You can specify the |
||
2980 | total number of steps with progressTotal(). The current number of steps is set |
||
2981 | with progressSet(). The progress bar can be rewound to the beginning with |
||
2982 | progressReset(). [based on info taken from Trolltech's Qt docs] |
||
2983 | </translation> |
||
2984 | </message> |
||
2985 | <message> |
||
14474 | cbradney | 2986 | <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="66"/> |
12918 | cbradney | 2987 | <source>setCursor() |
2988 | |||
2989 | [UNSUPPORTED!] This might break things, so steer clear for now. |
||
2990 | </source> |
||
2991 | <translation type="unfinished">setCursor() |
||
2992 | |||
2993 | [UNSUPPORTED!] This might break things, so steer clear for now. |
||
2994 | </translation> |
||
2995 | </message> |
||
2996 | <message> |
||
14474 | cbradney | 2997 | <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="78"/> |
12918 | cbradney | 2998 | <source>docChanged(bool) |
2999 | |||
3000 | Enable/disable save icon in the Scribus icon bar and the Save menu item. It's |
||
3001 | useful to call this procedure when you're changing the document, because Scribus |
||
3002 | won't automatically notice when you change the document using a script. |
||
3003 | </source> |
||
3004 | <translation type="unfinished">docChanged(bool) |
||
3005 | |||
3006 | Enable/disable save icon in the Scribus icon bar and the Save menu item. It's |
||
3007 | useful to call this procedure when you're changing the document, because Scribus |
||
3008 | won't automatically notice when you change the document using a script. |
||
3009 | </translation> |
||
3010 | </message> |
||
3011 | <message> |
||
14474 | cbradney | 3012 | <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="91"/> |
12918 | cbradney | 3013 | <source>zoomDocument(double) |
3014 | |||
3015 | Zoom the document in main GUI window. Actions have whole number |
||
3016 | values like 20.0, 100.0, etc. Zoom to Fit uses -100 as a marker. |
||
3017 | </source> |
||
3018 | <translation type="unfinished">zoomDocument(double) |
||
3019 | |||
3020 | Zoom the document in main GUI window. Actions have whole number |
||
3021 | values like 20.0, 100.0, etc. Zoom to Fit uses -100 as a marker. |
||
3022 | </translation> |
||
3023 | </message> |
||
3024 | <message> |
||
14474 | cbradney | 3025 | <location filename="../../../scribus/plugins/scriptplugin/guiapp.h" line="103"/> |
12918 | cbradney | 3026 | <source>scrollDocument(x,y) |
3027 | |||
3028 | Scroll the document in main GUI window by x and y. |
||
3029 | </source> |
||
3030 | <translation type="unfinished"></translation> |
||
3031 | </message> |
||
3032 | <message> |
||
14474 | cbradney | 3033 | <location filename="../../../scribus/plugins/scriptplugin/cmdstyle.h" line="22"/> |
3034 | <source>createParagraphStyle(...) |
||
12918 | cbradney | 3035 | |
14474 | cbradney | 3036 | Creates a paragraph style. This function takes the following keyword parameters: |
12918 | cbradney | 3037 | |
14474 | cbradney | 3038 | "name" [required] -> specifies the name of the paragraphstyle to create |
12918 | cbradney | 3039 | |
14474 | cbradney | 3040 | linespacingmode [optional] -> specifies the linespacing mode; possible modes are: |
12918 | cbradney | 3041 | |
14474 | cbradney | 3042 | fixed linespacing: 0 |
12918 | cbradney | 3043 | |
14474 | cbradney | 3044 | automatic linespacing: 1 |
12918 | cbradney | 3045 | |
14474 | cbradney | 3046 | baseline grid linespacing: 2 |
12918 | cbradney | 3047 | |
14474 | cbradney | 3048 | linespacing [optional] -> specifies the linespacing if using fixed linespacing |
12918 | cbradney | 3049 | |
14474 | cbradney | 3050 | alignment [optional] -> specifies the alignment of the paragraph |
13279 | cbradney | 3051 | |
14474 | cbradney | 3052 | -> left: 0 |
13279 | cbradney | 3053 | |
14474 | cbradney | 3054 | -> center: 1 |
13279 | cbradney | 3055 | |
14474 | cbradney | 3056 | -> right: 2 |
13279 | cbradney | 3057 | |
14474 | cbradney | 3058 | -> justify: 3 |
3059 | |||
3060 | -> extend: 4 |
||
3061 | |||
3062 | leftmargin [optional], rightmargin [optional] -> specify the margin |
||
3063 | |||
3064 | gapbefore [optional], gapafter [optional] -> specify the gaps to the heading and following paragraphs |
||
3065 | |||
3066 | firstindent [optional] -> the indent of the first line |
||
3067 | |||
3068 | hasdropcap [optional] -> specifies if there are caps (1 = yes, 0 = no) |
||
3069 | |||
3070 | dropcaplines [optional] -> height (in lines) of the caps if used |
||
3071 | |||
3072 | dropcapoffset [optional] -> offset of the caps if used |
||
3073 | |||
3074 | "charstyle" [optional] -> char style to use |
||
3075 | |||
13279 | cbradney | 3076 | </source> |
3077 | <translation type="unfinished"></translation> |
||
3078 | </message> |
||
3079 | <message> |
||
14474 | cbradney | 3080 | <location filename="../../../scribus/plugins/scriptplugin/cmdstyle.h" line="52"/> |
3081 | <source>createCharStyle(...) |
||
13279 | cbradney | 3082 | |
14474 | cbradney | 3083 | Creates a character style. This function takes the following keyword parameters: |
13279 | cbradney | 3084 | |
14474 | cbradney | 3085 | "name" [required] -> name of the char style to create |
3086 | |||
3087 | "font" [optional] -> name of the font to use |
||
3088 | |||
3089 | fontsize [optional] -> font size to set (double) |
||
3090 | |||
3091 | "features" [optional] -> nearer typographic details can be defined by a string that might contain the following phrases comma-seperated (without spaces!): |
||
3092 | |||
3093 | -> inherit |
||
3094 | |||
3095 | -> bold |
||
3096 | |||
3097 | -> italic |
||
3098 | |||
3099 | -> underline |
||
3100 | |||
3101 | -> underlinewords |
||
3102 | |||
3103 | -> strike |
||
3104 | |||
3105 | -> superscript |
||
3106 | |||
3107 | -> subscript |
||
3108 | |||
3109 | -> outline |
||
3110 | |||
3111 | -> shadowed |
||
3112 | |||
3113 | -> allcaps |
||
3114 | |||
3115 | -> smallcaps |
||
3116 | |||
3117 | "fillcolor" [optional], "fillshade" [optional] -> specify fill options |
||
3118 | |||
3119 | "strokecolor" [optional], "strokeshade" [optional] -> specify stroke options |
||
3120 | |||
3121 | baselineoffset [optional] -> offset of the baseline |
||
3122 | |||
3123 | shadowxoffset [optional], shadowyoffset [optional] -> offset of the shadow if used |
||
3124 | |||
3125 | outlinewidth [optional] -> width of the outline if used |
||
3126 | |||
3127 | underlineoffset [optional], underlinewidth [optional] -> underline options if used |
||
3128 | |||
3129 | strikethruoffset [optional], strikethruwidth [optional] -> strikethru options if used |
||
3130 | |||
3131 | scaleh [optional], scalev [optional] -> scale of the chars |
||
3132 | |||
3133 | tracking [optional] -> tracking of the text |
||
3134 | |||
3135 | "language" [optional] -> language code |
||
3136 | |||
13279 | cbradney | 3137 | </source> |
3138 | <translation type="unfinished"></translation> |
||
3139 | </message> |
||
3140 | <message> |
||
14474 | cbradney | 3141 | <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="15"/> |
3142 | <source>placeSVG("filename", x, y) |
||
13279 | cbradney | 3143 | |
14474 | cbradney | 3144 | Places the SVG "filename" onto the current page, |
3145 | x and y specify the coordinate of the topleft corner of the SVG placed on the page |
||
13279 | cbradney | 3146 | |
14474 | cbradney | 3147 | If loading was successful, the selection contains the imported SVG |
13279 | cbradney | 3148 | </source> |
3149 | <translation type="unfinished"></translation> |
||
3150 | </message> |
||
3151 | <message> |
||
14474 | cbradney | 3152 | <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="27"/> |
3153 | <source>placeEPS("filename", x, y) |
||
13279 | cbradney | 3154 | |
14474 | cbradney | 3155 | Places the EPS "filename" onto the current page, |
3156 | x and y specify the coordinate of the topleft corner of the EPS placed on the page |
||
3157 | |||
3158 | If loading was successful, the selection contains the imported EPS |
||
13279 | cbradney | 3159 | </source> |
3160 | <translation type="unfinished"></translation> |
||
3161 | </message> |
||
3162 | <message> |
||
14474 | cbradney | 3163 | <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="39"/> |
3164 | <source>placeSXD("filename", x, y) |
||
13279 | cbradney | 3165 | |
14474 | cbradney | 3166 | Places the SXD "filename" onto the current page, |
3167 | x and y specify the coordinate of the topleft corner of the SXD placed on the page |
||
3168 | |||
3169 | If loading was successful, the selection contains the imported SXD |
||
13279 | cbradney | 3170 | </source> |
3171 | <translation type="unfinished"></translation> |
||
3172 | </message> |
||
3173 | <message> |
||
14474 | cbradney | 3174 | <location filename="../../../scribus/plugins/scriptplugin/svgimport.h" line="51"/> |
3175 | <source>placeODG("filename", x, y) |
||
13279 | cbradney | 3176 | |
14474 | cbradney | 3177 | Places the ODG "filename" onto the current page, |
3178 | x and y specify the coordinate of the topleft corner of the ODG placed on the page |
||
3179 | |||
3180 | If loading was successful, the selection contains the imported ODG |
||
13279 | cbradney | 3181 | </source> |
3182 | <translation type="unfinished"></translation> |
||
3183 | </message> |
||
12918 | cbradney | 3184 | </context> |
3185 | <context> |
||
3186 | <name>@default</name> |
||
3187 | <message> |
||
3188 | <source>getColorNames() -> list |
||
3189 | |||
3190 | Returns a list containing the names of all defined colors in the document. |
||
3191 | If no document is open, returns a list of the default document colors. |
||
3192 | </source> |
||
3193 | <translation type="obsolete">getColorNames() -> list |
||
3194 | |||
3195 | Returns a list containing the names of all defined colours in the document. |
||
3196 | If no document is open, returns a list of the default document colours. |
||
3197 | </translation> |
||
3198 | </message> |
||
3199 | <message> |
||
3200 | <source>newDocDialog() -> bool |
||
3201 | |||
3202 | Displays the "New Document" dialog box. Creates a new document if the user |
||
3203 | accepts the settings. Does not create a document if the user presses cancel. |
||
3204 | Returns true if a new document was created. |
||
3205 | </source> |
||
3206 | <translation type="obsolete">newDocDialog() -> bool |
||
3207 | |||
3208 | Displays the "New Document" dialog box. Creates a new document if the user |
||
3209 | accepts the settings. Does not create a document if the user presses cancel. |
||
3210 | Returns true if a new document was created. |
||
3211 | </translation> |
||
3212 | </message> |
||
3213 | <message> |
||
3214 | <source>getFillColor(["name"]) -> string |
||
3215 | |||
3216 | Returns the name of the fill color of the object "name". |
||
3217 | If "name" is not given the currently selected item is used. |
||
3218 | </source> |
||
3219 | <translation type="obsolete">getFillColor(["name"]) -> string |
||
3220 | |||
3221 | Returns the name of the fill colour of the object "name". |
||
3222 | If "name" is not given the currently selected item is used. |
||
3223 | </translation> |
||
3224 | </message> |
||
3225 | <message> |
||
3226 | <source>moveObject(dx, dy [, "name"]) |
||
3227 | |||
3228 | Moves the object "name" by dx and dy relative to its current position. The |
||
3229 | distances are expressed in the current measurement unit of the document (see |
||
3230 | UNIT constants). If "name" is not given the currently selected item is used. |
||
3231 | If the object "name" belongs to a group, the whole group is moved. |
||
3232 | </source> |
||
3233 | <translation type="obsolete">moveObject(dx, dy [, "name"]) |
||
3234 | |||
3235 | Moves the object "name" by dx and dy relative to its current position. The |
||
3236 | distances are expressed in the current measurement unit of the document (see |
||
3237 | UNIT constants). If "name" is not given the currently selected item is used. |
||
3238 | If the object "name" belongs to a group, the whole group is moved. |
||
3239 | </translation> |
||
3240 | </message> |
||
3241 | <message> |
||
3242 | <source>setRedraw(bool) |
||
3243 | |||
3244 | Disables page redraw when bool = False, otherwise redrawing is enabled. |
||
3245 | This change will persist even after the script exits, so make sure to call |
||
3246 | setRedraw(True) in a finally: clause at the top level of your script. |
||
3247 | </source> |
||
3248 | <translation type="obsolete">setRedraw(bool) |
||
3249 | |||
3250 | Disables page redraw when bool = False, otherwise redrawing is enabled. |
||
3251 | This change will persist even after the script exits, so make sure to call |
||
3252 | setRedraw(True) in a finally: clause at the top level of your script. |
||
3253 | </translation> |
||
3254 | </message> |
||
3255 | <message> |
||
3256 | <source>createRect(x, y, width, height, ["name"]) -> string |
||
3257 | |||
3258 | Creates a new rectangle on the current page and returns its name. The |
||
3259 | coordinates are given in the current measurement units of the document |
||
3260 | (see UNIT constants). "name" should be a unique identifier for the object |
||
3261 | because you need this name to reference that object in future. If "name" |
||
3262 | is not given Scribus will create one for you. |
||
3263 | |||
3264 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
3265 | </source> |
||
3266 | <translation type="obsolete">createRect(x, y, width, height, ["name"]) -> string |
||
3267 | |||
3268 | Creates a new rectangle on the current page and returns its name. The |
||
3269 | coordinates are given in the current measurement units of the document |
||
3270 | (see UNIT constants). "name" should be a unique identifier for the object |
||
3271 | because you need this name to reference that object in future. If "name" |
||
3272 | is not given Scribus will create one for you. |
||
3273 | |||
3274 | May raise NameExistsError if you explicitly pass a name that's already used. |
||
3275 | </translation> |
||
3276 | </message> |
||
3277 | <message> |
||
3278 | <source>newPage(where [,"masterpage"]) |
||
3279 | |||
3280 | Creates a new page. If "where" is -1 the new Page is appended to the |
||
3281 | document, otherwise the new page is inserted before "where". Page numbers are |
||
3282 | counted from 1 upwards, no matter what the displayed first page number of your |
||
3283 | document is. The optional parameter "masterpage" specifies the name of the |
||
3284 | master page for the new page. |
||
3285 | |||
3286 | May raise IndexError if the page number is out of range |
||
3287 | </source> |
||
3288 | <translation type="obsolete">newPage(where [,"masterpage"]) |
||
3289 | |||
3290 | Creates a new page. If "where" is -1 the new Page is appended to the |
||
3291 | document, otherwise the new page is inserted before "where". Page numbers are |
||
3292 | counted from 1 upwards, no matter what the displayed first page number of your |
||
3293 | document is. The optional parameter "masterpage" specifies the name of the |
||
3294 | master page for the new page. |
||
3295 | |||
3296 | May raise IndexError if the page number is out of range |
||
3297 | </translation> |
||
3298 | </message> |
||
3299 | <message> |
||
3300 | <source>setGradientFill(type, "color1", shade1, "color2", shade2, ["name"]) |
||
3301 | |||
3302 | Sets the gradient fill of the object "name" to type. Color descriptions are |
||
3303 | the same as for setFillColor() and setFillShade(). See the constants for |
||
3304 | available types (FILL_<type>). |
||
3305 | </source> |
||
3306 | <translation type="obsolete">setGradientFill(type, "color1", shade1, "color2", shade2, ["name"]) |
||
3307 | |||
3308 | Sets the gradient fill of the object "name" to type. Colour descriptions are |
||
3309 | the same as for setFillColor() and setFillShade(). See the constants for |
||
3310 | available types (FILL_<type>). |
||
3311 | </translation> |
||
3312 | </message> |
||
3313 | <message> |
||
3314 | <source>getFontSize(["name"]) -> float |
||
3315 | |||
3316 | Returns the font size in points for the text frame "name". If this text |
||
3317 | frame has some text selected the value assigned to the first character of |
||
3318 | the selection is returned. |
||
3319 | If "name" is not given the currently selected item is used. |
||
3320 | </source> |
||
3321 | <translation type="obsolete">getFontSize(["name"]) -> float |
||
3322 | |||
3323 | Returns the font size in points for the text frame "name". If this text |
||
3324 | frame has some text selected the value assigned to the first character of |
||
3325 | the selection is returned. |
||
3326 | If "name" is not given the currently selected item is used. |
||
3327 | </translation> |
||
3328 | </message> |
||
3329 | <message> |
||
3330 | <source>messagebarText("string") |
||
3331 | |||
3332 | Writes the "string" into the Scribus message bar (status line). The text |
||
3333 | must be UTF8 encoded or 'unicode' string(recommended). |
||
3334 | </source> |
||
3335 | <translation type="obsolete">messagebarText("string") |
||
3336 | |||
3337 | Writes the "string" into the Scribus message bar (status line). The text |
||
3338 | must be UTF8 encoded or 'unicode' string(recommended). |
||
3339 | </translation> |
||
3340 | </message> |
||
3341 | <message> |
||
3064 | cbradney | 3342 | <source>importSVG("string") |
3343 | |||
3344 | The "string" must be a valid filename for a SVG image. The text |
||
3345 | must be UTF8 encoded or 'unicode' string(recommended). |
||
3346 | </source> |
||
9729 | cbradney | 3347 | <translation type="obsolete">importSVG("string") |
6082 | mrdocs | 3348 | |
3349 | The "string" must be a valid filename for a SVG image. The text |
||
3350 | must be UTF8 encoded or 'unicode' string(recommended). |
||
3351 | </translation> |
||
3064 | cbradney | 3352 | </message> |
3824 | cbradney | 3353 | <message> |
3354 | <source>newDocument(size, margins, orientation, firstPageNumber, |
||
3355 | unit, pagesType, firstPageOrder) -> bool |
||
3356 | |||
3357 | Creates a new document and returns true if successful. The parameters have the |
||
3358 | following meaning: |
||
3359 | |||
3360 | size = A tuple (width, height) describing the size of the document. You can |
||
3361 | use predefined constants named PAPER_<paper_type> e.g. PAPER_A4 etc. |
||
3362 | |||
3363 | margins = A tuple (left, right, top, bottom) describing the document |
||
3364 | margins |
||
3365 | |||
3366 | orientation = the page orientation - constants PORTRAIT, LANDSCAPE |
||
3367 | |||
3368 | firstPageNumer = is the number of the first page in the document used for |
||
3369 | pagenumbering. While you'll usually want 1, it's useful to have higher |
||
3370 | numbers if you're creating a document in several parts. |
||
3371 | |||
3372 | unit: this value sets the measurement units used by the document. Use a |
||
3373 | predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS, |
||
3374 | UNIT_PICAS, UNIT_POINTS. |
||
3375 | |||
3376 | pagesType = One of the predefined constants PAGE_n. PAGE_1 is single page, |
||
3377 | PAGE_2 is for double sided documents, PAGE_3 is for 3 pages fold and |
||
3378 | PAGE_4 is 4-fold. |
||
3379 | |||
3380 | firstPageOrder = What is position of first page in the document. |
||
3381 | Indexed from 0 (0 = first). |
||
3382 | |||
3383 | The values for width, height and the margins are expressed in the given unit |
||
3384 | for the document. PAPER_* constants are expressed in points. If your document |
||
3385 | is not in points, make sure to account for this. |
||
3386 | |||
3387 | example: newDocument(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 7, UNIT_POINTS, |
||
3388 | PAGE_4, 3) |
||
3389 | |||
3390 | May raise ScribusError if is firstPageOrder bigger than allowed by pagesType. |
||
3391 | </source> |
||
6434 | cbradney | 3392 | <translation type="obsolete">newDocument(size, margins, orientation, firstPageNumber, |
6082 | mrdocs | 3393 | unit, pagesType, firstPageOrder) -> bool |
1135 | cbradney | 3394 | |
6082 | mrdocs | 3395 | Creates a new document and returns true if successful. The parameters have the |
3396 | following meaning: |
||
1135 | cbradney | 3397 | |
6082 | mrdocs | 3398 | size = A tuple (width, height) describing the size of the document. You can |
3399 | use predefined constants named PAPER_<paper_type> e.g. PAPER_A4 etc. |
||
1135 | cbradney | 3400 | |
6082 | mrdocs | 3401 | margins = A tuple (left, right, top, bottom) describing the document |
3402 | margins |
||
1135 | cbradney | 3403 | |
6082 | mrdocs | 3404 | orientation = the page orientation - constants PORTRAIT, LANDSCAPE |
1135 | cbradney | 3405 | |
6082 | mrdocs | 3406 | firstPageNumer = is the number of the first page in the document used for |
3407 | pagenumbering. While you'll usually want 1, it's useful to have higher |
||
3408 | numbers if you're creating a document in several parts. |
||
1135 | cbradney | 3409 | |
6082 | mrdocs | 3410 | unit: this value sets the measurement units used by the document. Use a |
3411 | predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS, |
||
3412 | UNIT_PICAS, UNIT_POINTS. |
||
1135 | cbradney | 3413 | |
6082 | mrdocs | 3414 | pagesType = One of the predefined constants PAGE_n. PAGE_1 is single page, |
3415 | PAGE_2 is for double sided documents, PAGE_3 is for 3 pages fold and |
||
3416 | PAGE_4 is 4-fold. |
||
1135 | cbradney | 3417 | |
6082 | mrdocs | 3418 | firstPageOrder = What is position of first page in the document. |
3419 | Indexed from 0 (0 = first). |
||
1135 | cbradney | 3420 | |
6082 | mrdocs | 3421 | The values for width, height and the margins are expressed in the given unit |
3422 | for the document. PAPER_* constants are expressed in points. If your document |
||
3423 | is not in points, make sure to account for this. |
||
1135 | cbradney | 3424 | |
6082 | mrdocs | 3425 | example: newDocument(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 7, UNIT_POINTS, |
3426 | PAGE_4, 3) |
||
1135 | cbradney | 3427 | |
6082 | mrdocs | 3428 | May raise ScribusError if is firstPageOrder bigger than allowed by pagesType. |
3429 | </translation> |
||
1135 | cbradney | 3430 | </message> |
3431 | <message> |
||
6082 | mrdocs | 3432 | <source>getColor("name") -> tuple |
1135 | cbradney | 3433 | |
6082 | mrdocs | 3434 | Returns a tuple (C, M, Y, K) containing the four color components of the |
3435 | color "name" from the current document. If no document is open, returns |
||
3436 | the value of the named color from the default document colors. |
||
1135 | cbradney | 3437 | |
6082 | mrdocs | 3438 | May raise NotFoundError if the named color wasn't found. |
3439 | May raise ValueError if an invalid color name is specified. |
||
1135 | cbradney | 3440 | </source> |
12918 | cbradney | 3441 | <translation type="obsolete">getColor("name") -> tuple |
1135 | cbradney | 3442 | |
6082 | mrdocs | 3443 | Returns a tuple (C, M, Y, K) containing the four colour components of the |
3444 | colour "name" from the current document. If no document is open, returns |
||
3445 | the value of the named colour from the default document colours. |
||
1135 | cbradney | 3446 | |
6082 | mrdocs | 3447 | May raise NotFoundError if the named colour wasn't found. |
3448 | May raise ValueError if an invalid colour name is specified. |
||
3449 | </translation> |
||
1135 | cbradney | 3450 | </message> |
3451 | <message> |
||
6082 | mrdocs | 3452 | <source>getColorAsRGB("name") -> tuple |
1135 | cbradney | 3453 | |
6082 | mrdocs | 3454 | Returns a tuple (R,G,B) containing the three color components of the |
3455 | color "name" from the current document, converted to the RGB color |
||
3456 | space. If no document is open, returns the value of the named color |
||
3457 | from the default document colors. |
||
1135 | cbradney | 3458 | |
6082 | mrdocs | 3459 | May raise NotFoundError if the named color wasn't found. |
3460 | May raise ValueError if an invalid color name is specified. |
||
1135 | cbradney | 3461 | </source> |
12918 | cbradney | 3462 | <translation type="obsolete">getColorAsRGB("name") -> tuple |
1135 | cbradney | 3463 | |
6082 | mrdocs | 3464 | Returns a tuple (R,G,B) containing the three colour components of the |
3465 | colour "name" from the current document, converted to the RGB colour |
||
3466 | space. If no document is open, returns the value of the named colour |
||
3467 | from the default document colours. |
||
1135 | cbradney | 3468 | |
6082 | mrdocs | 3469 | May raise NotFoundError if the named colour wasn't found. |
3470 | May raise ValueError if an invalid colour name is specified. |
||
3471 | </translation> |
||
1135 | cbradney | 3472 | </message> |
3473 | <message> |
||
6082 | mrdocs | 3474 | <source>changeColor("name", c, m, y, k) |
1135 | cbradney | 3475 | |
6082 | mrdocs | 3476 | Changes the color "name" to the specified CMYK value. The color value is |
3477 | defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black. |
||
3478 | Color components should be in the range from 0 to 255. |
||
1135 | cbradney | 3479 | |
6082 | mrdocs | 3480 | May raise NotFoundError if the named color wasn't found. |
3481 | May raise ValueError if an invalid color name is specified. |
||
1135 | cbradney | 3482 | </source> |
12918 | cbradney | 3483 | <translation type="obsolete">changeColour("name", c, m, y, k) |
1135 | cbradney | 3484 | |
6082 | mrdocs | 3485 | Changes the colour "name" to the specified CMYK value. The colour value is |
3486 | defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black. |
||
3487 | Colour components should be in the range from 0 to 255. |
||
1135 | cbradney | 3488 | |
6082 | mrdocs | 3489 | May raise NotFoundError if the named colour wasn't found. |
3490 | May raise ValueError if an invalid colour name is specified. |
||
3491 | </translation> |
||
1135 | cbradney | 3492 | </message> |
3493 | <message> |
||
6082 | mrdocs | 3494 | <source>defineColor("name", c, m, y, k) |
1135 | cbradney | 3495 | |
6082 | mrdocs | 3496 | Defines a new color "name". The color Value is defined via four components: |
3497 | c = Cyan, m = Magenta, y = Yello and k = Black. Color components should be in |
||
3498 | the range from 0 to 255. |
||
1135 | cbradney | 3499 | |
3500 | May raise ValueError if an invalid color name is specified. |
||
3501 | </source> |
||
7508 | cbradney | 3502 | <translation type="obsolete">defineColor("name", c, m, y, k) |
1135 | cbradney | 3503 | |
6082 | mrdocs | 3504 | Defines a new colour "name". The colour Value is defined via four components: |
3505 | c = Cyan, m = Magenta, y = Yello and k = Black. Colour components should be in |
||
3506 | the range from 0 to 255. |
||
1135 | cbradney | 3507 | |
6082 | mrdocs | 3508 | May raise ValueError if an invalid colour name is specified. |
3509 | </translation> |
||
1135 | cbradney | 3510 | </message> |
3511 | <message> |
||
3512 | <source>deleteColor("name", "replace") |
||
3513 | |||
3514 | Deletes the color "name". Every occurence of that color is replaced by the |
||
3515 | color "replace". If not specified, "replace" defaults to the color |
||
3516 | "None" - transparent. |
||
3517 | |||
3518 | deleteColor works on the default document colors if there is no document open. |
||
3519 | In that case, "replace", if specified, has no effect. |
||
3520 | |||
3521 | May raise NotFoundError if a named color wasn't found. |
||
3522 | May raise ValueError if an invalid color name is specified. |
||
3523 | </source> |
||
12918 | cbradney | 3524 | <translation type="obsolete">deleteColor("name", "replace") |
6082 | mrdocs | 3525 | |
3526 | Deletes the colour "name". Every occurence of that colour is replaced by the |
||
3527 | colour "replace". If not specified, "replace" defaults to the colour |
||
3528 | "None" - transparent. |
||
3529 | |||
3530 | deleteColor works on the default document colours if there is no document open. |
||
3531 | In that case, "replace", if specified, has no effect. |
||
3532 | |||
3533 | May raise NotFoundError if a named colour wasn't found. |
||
3534 | May raise ValueError if an invalid colour name is specified. |
||
3535 | </translation> |
||
1135 | cbradney | 3536 | </message> |
3537 | <message> |
||
3538 | <source>replaceColor("name", "replace") |
||
3539 | |||
3540 | Every occurence of the color "name" is replaced by the color "replace". |
||
3541 | |||
3542 | May raise NotFoundError if a named color wasn't found. |
||
3543 | May raise ValueError if an invalid color name is specified. |
||
3544 | </source> |
||
12918 | cbradney | 3545 | <translation type="obsolete">replaceColor("name", "replace") |
6082 | mrdocs | 3546 | |
3547 | Every occurence of the colour "name" is replaced by the colour "replace". |
||
3548 | |||
3549 | May raise NotFoundError if a named colour wasn't found. |
||
3550 | May raise ValueError if an invalid colour name is specified. |
||
3551 | </translation> |
||
1135 | cbradney | 3552 | </message> |
3553 | <message> |
||
6082 | mrdocs | 3554 | <source>fileDialog("caption", ["filter", "defaultname", haspreview, issave, isdir]) -> string with filename |
3555 | |||
3556 | Shows a File Open dialog box with the caption "caption". Files are filtered |
||
3557 | with the filter string "filter". A default filename or file path can also |
||
3558 | supplied, leave this string empty when you don't want to use it. A value of |
||
3559 | True for haspreview enables a small preview widget in the FileSelect box. When |
||
3560 | the issave parameter is set to True the dialog acts like a "Save As" dialog |
||
3561 | otherwise it acts like a "File Open Dialog". When the isdir parameter is True |
||
3562 | the dialog shows and returns only directories. The default for all of the |
||
3563 | opional parameters is False. |
||
3564 | |||
3565 | The filter, if specified, takes the form 'comment (*.type *.type2 ...)'. |
||
3566 | For example 'Images (*.png *.xpm *.jpg)'. |
||
3567 | |||
3568 | Refer to the Qt-Documentation for QFileDialog for details on filters. |
||
3569 | |||
3570 | Example: fileDialog('Open input', 'CSV files (*.csv)') |
||
3571 | Example: fileDialog('Save report', defaultname='report.txt', issave=True) |
||
3572 | </source> |
||
10842 | cbradney | 3573 | <translation type="obsolete">fileDialog("caption", ["filter", "defaultname", haspreview, issave, isdir]) -> string with filename |
6082 | mrdocs | 3574 | |
3575 | Shows a File Open dialog box with the caption "caption". Files are filtered |
||
3576 | with the filter string "filter". A default filename or file path can also |
||
3577 | supplied, leave this string empty when you don't want to use it. A value of |
||
3578 | True for haspreview enables a small preview widget in the FileSelect box. When |
||
3579 | the issave parameter is set to True the dialog acts like a "Save As" dialog |
||
3580 | otherwise it acts like a "File Open Dialog". When the isdir parameter is True |
||
3581 | the dialog shows and returns only directories. The default for all of the |
||
3582 | opional parameters is False. |
||
3583 | |||
3584 | The filter, if specified, takes the form 'comment (*.type *.type2 ...)'. |
||
3585 | For example 'Images (*.png *.xpm *.jpg)'. |
||
3586 | |||
3587 | Refer to the Qt-Documentation for QFileDialog for details on filters. |
||
3588 | |||
3589 | Example: fileDialog('Open input', 'CSV files (*.csv)') |
||
3590 | Example: fileDialog('Save report', defaultname='report.txt', issave=True) |
||
3591 | </translation> |
||
3592 | </message> |
||
3593 | <message> |
||
1135 | cbradney | 3594 | <source>messageBox("caption", "message", |
3595 | icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT, |
||
3596 | button2=BUTTON_NONE, button3=BUTTON_NONE) -> integer |
||
3597 | |||
3598 | Displays a message box with the title "caption", the message "message", and |
||
3599 | an icon "icon" and up to 3 buttons. By default no icon is used and a single |
||
3600 | button, OK, is displayed. Only the caption and message arguments are required, |
||
3601 | though setting an icon and appropriate button(s) is strongly |
||
3602 | recommended. The message text may contain simple HTML-like markup. |
||
3603 | |||
3604 | Returns the number of the button the user pressed. Button numbers start |
||
3605 | at 1. |
||
3606 | |||
3607 | For the icon and the button parameters there are predefined constants available |
||
3608 | with the same names as in the Qt Documentation. These are the BUTTON_* and |
||
3609 | ICON_* constants defined in the module. There are also two extra constants that |
||
3610 | can be binary-ORed with button constants: |
||
3611 | BUTTONOPT_DEFAULT Pressing enter presses this button. |
||
3612 | BUTTONOPT_ESCAPE Pressing escape presses this button. |
||
3613 | |||
3614 | Usage examples: |
||
3615 | result = messageBox('Script failed', |
||
3616 | 'This script only works when you have a text frame selected.', |
||
3617 | ICON_ERROR) |
||
3618 | result = messageBox('Monkeys!', 'Something went ook! <i>Was it a monkey?</i>', |
||
3619 | ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT, |
||
3620 | BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE) |
||
3621 | |||
3622 | Defined button and icon constants: |
||
3623 | BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO, |
||
3624 | BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL, |
||
3625 | ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL. |
||
3626 | </source> |
||
12918 | cbradney | 3627 | <translation type="obsolete">messageBox("caption", "message", |
6082 | mrdocs | 3628 | icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT, |
3629 | button2=BUTTON_NONE, button3=BUTTON_NONE) -> integer |
||
3630 | |||
3631 | Displays a message box with the title "caption", the message "message", and |
||
3632 | an icon "icon" and up to 3 buttons. By default no icon is used and a single |
||
3633 | button, OK, is displayed. Only the caption and message arguments are required, |
||
3634 | though setting an icon and appropriate button(s) is strongly |
||
3635 | recommended. The message text may contain simple HTML-like markup. |
||
3636 | |||
3637 | Returns the number of the button the user pressed. Button numbers start |
||
3638 | at 1. |
||
3639 | |||
3640 | For the icon and the button parameters there are predefined constants available |
||
3641 | with the same names as in the Qt Documentation. These are the BUTTON_* and |
||
3642 | ICON_* constants defined in the module. There are also two extra constants that |
||
3643 | can be binary-ORed with button constants: |
||
3644 | BUTTONOPT_DEFAULT Pressing enter presses this button. |
||
3645 | BUTTONOPT_ESCAPE Pressing escape presses this button. |
||
3646 | |||
3647 | Usage examples: |
||
3648 | result = messageBox('Script failed', |
||
3649 | 'This script only works when you have a text frame selected.', |
||
3650 | ICON_ERROR) |
||
3651 | result = messageBox('Monkeys!', 'Something went ook! <i>Was it a monkey?</i>', |
||
3652 | ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT, |
||
3653 | BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE) |
||
3654 | |||
3655 | Defined button and icon constants: |
||
3656 | BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO, |
||
3657 | BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL, |
||
3658 | ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL. |
||
3659 | </translation> |
||
1135 | cbradney | 3660 | </message> |
3661 | <message> |
||
3662 | <source>valueDialog(caption, message [,defaultvalue]) -> string |
||
3663 | |||
3664 | Shows the common 'Ask for string' dialog and returns its value as a string |
||
3665 | Parameters: window title, text in the window and optional 'default' value. |
||
3666 | |||
3667 | Example: valueDialog('title', 'text in the window', 'optional') |
||
3668 | </source> |
||
12918 | cbradney | 3669 | <translation type="obsolete">valueDialog(caption, message [,defaultvalue]) -> string |
6082 | mrdocs | 3670 | |
3671 | Shows the common 'Ask for string' dialog and returns its value as a string |
||
3672 | Parameters: window title, text in the window and optional 'default' value. |
||
3673 | |||
3674 | Example: valueDialog('title', 'text in the window', 'optional') |
||
3675 | </translation> |
||
1135 | cbradney | 3676 | </message> |
3677 | <message> |
||
3678 | <source>closeDoc() |
||
3679 | |||
3680 | Closes the current document without prompting to save. |
||
3681 | |||
3682 | May throw NoDocOpenError if there is no document to close |
||
3683 | </source> |
||
12918 | cbradney | 3684 | <translation type="obsolete">closeDoc() |
6082 | mrdocs | 3685 | |
3686 | Closes the current document without prompting to save. |
||
3687 | |||
3688 | May throw NoDocOpenError if there is no document to close |
||
3689 | </translation> |
||
1135 | cbradney | 3690 | </message> |
3691 | <message> |
||
3692 | <source>haveDoc() -> bool |
||
3693 | |||
3694 | Returns true if there is a document open. |
||
3695 | </source> |
||
12918 | cbradney | 3696 | <translation type="obsolete">haveDoc() -> bool |
6082 | mrdocs | 3697 | |
3698 | Returns true if there is a document open. |
||
3699 | </translation> |
||
1135 | cbradney | 3700 | </message> |
3701 | <message> |
||
3702 | <source>openDoc("name") |
||
3703 | |||
3704 | Opens the document "name". |
||
3705 | |||
3706 | May raise ScribusError if the document could not be opened. |
||
3707 | </source> |
||
12918 | cbradney | 3708 | <translation type="obsolete">openDoc("name") |
6082 | mrdocs | 3709 | |
3710 | Opens the document "name". |
||
3711 | |||
3712 | May raise ScribusError if the document could not be opened. |
||
3713 | </translation> |
||
1135 | cbradney | 3714 | </message> |
3715 | <message> |
||
3716 | <source>saveDoc() |
||
3717 | |||
3718 | Saves the current document with its current name, returns true if successful. |
||
3719 | If the document has not already been saved, this may bring up an interactive |
||
3720 | save file dialog. |
||
3721 | |||
3722 | If the save fails, there is currently no way to tell. |
||
3723 | </source> |
||
12918 | cbradney | 3724 | <translation type="obsolete">saveDoc() |
6082 | mrdocs | 3725 | |
3726 | Saves the current document with its current name, returns true if successful. |
||
3727 | If the document has not already been saved, this may bring up an interactive |
||
3728 | save file dialog. |
||
3729 | |||
3730 | If the save fails, there is currently no way to tell. |
||
3731 | </translation> |
||
1135 | cbradney | 3732 | </message> |
3733 | <message> |
||
3734 | <source>saveDocAs("name") |
||
3735 | |||
3736 | Saves the current document under the new name "name" (which may be a full or |
||
3737 | relative path). |
||
3738 | |||
3739 | May raise ScribusError if the save fails. |
||
3740 | </source> |
||
12918 | cbradney | 3741 | <translation type="obsolete">saveDocAs("name") |
6082 | mrdocs | 3742 | |
3743 | Saves the current document under the new name "name" (which may be a full or |
||
3744 | relative path). |
||
3745 | |||
3746 | May raise ScribusError if the save fails. |
||
3747 | </translation> |
||
1135 | cbradney | 3748 | </message> |
3749 | <message> |
||
3750 | <source>saveDocAs("author", "info", "description") -> bool |
||
3751 | |||
3752 | Sets the document information. "Author", "Info", "Description" are |
||
3753 | strings. |
||
3754 | </source> |
||
6434 | cbradney | 3755 | <translation type="obsolete">saveDocAs("author", "info", "description") -> bool |
6082 | mrdocs | 3756 | |
3757 | Sets the document information. "Author", "Info", "Description" are |
||
3758 | strings. |
||
3759 | </translation> |
||
1135 | cbradney | 3760 | </message> |
3761 | <message> |
||
3762 | <source>setMargins(lr, rr, tr, br) |
||
3763 | |||
3764 | Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br) |
||
3765 | margins are given in the measurement units of the document - see UNIT_<type> |
||
3766 | constants. |
||
3767 | </source> |
||
9729 | cbradney | 3768 | <translation type="obsolete">setMargins(lr, rr, tr, br) |
6082 | mrdocs | 3769 | |
3770 | Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br) |
||
3771 | margins are given in the measurement units of the document - see UNIT_<type> |
||
3772 | constants. |
||
3773 | </translation> |
||
1135 | cbradney | 3774 | </message> |
3775 | <message> |
||
3776 | <source>setUnit(type) |
||
3777 | |||
3778 | Changes the measurement unit of the document. Possible values for "unit" are |
||
3779 | defined as constants UNIT_<type>. |
||
3780 | |||
3781 | May raise ValueError if an invalid unit is passed. |
||
3782 | </source> |
||
12918 | cbradney | 3783 | <translation type="obsolete">setUnit(type) |
6082 | mrdocs | 3784 | |
3785 | Changes the measurement unit of the document. Possible values for "unit" are |
||
3786 | defined as constants UNIT_<type>. |
||
3787 | |||
3788 | May raise ValueError if an invalid unit is passed. |
||
3789 | </translation> |
||
1135 | cbradney | 3790 | </message> |
3791 | <message> |
||
3792 | <source>getUnit() -> integer (Scribus unit constant) |
||
3793 | |||
3794 | Returns the measurement units of the document. The returned value will be one |
||
3795 | of the UNIT_* constants: |
||
3796 | UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS. |
||
3797 | </source> |
||
12918 | cbradney | 3798 | <translation type="obsolete">getUnit() -> integer (Scribus unit constant) |
6082 | mrdocs | 3799 | |
3800 | Returns the measurement units of the document. The returned value will be one |
||
3801 | of the UNIT_* constants: |
||
3802 | UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS. |
||
3803 | </translation> |
||
1135 | cbradney | 3804 | </message> |
3805 | <message> |
||
3806 | <source>loadStylesFromFile("filename") |
||
3807 | |||
3808 | Loads paragraph styles from the Scribus document at "filename" into the |
||
3809 | current document. |
||
3810 | </source> |
||
12918 | cbradney | 3811 | <translation type="obsolete">loadStylesFromFile("filename") |
6082 | mrdocs | 3812 | |
3813 | Loads paragraph styles from the Scribus document at "filename" into the |
||
3814 | current document. |
||
3815 | </translation> |
||
1135 | cbradney | 3816 | </message> |
3817 | <message> |
||
3818 | <source>setDocType(facingPages, firstPageLeft) |
||
3819 | |||
3820 | Sets the document type. To get facing pages set the first parameter to |
||
3821 | FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want |
||
3822 | to be the first page a left side set the second parameter to FIRSTPAGELEFT, for |
||
3823 | a right page use FIRSTPAGERIGHT. |
||
3824 | </source> |
||
12918 | cbradney | 3825 | <translation type="obsolete">setDocType(facingPages, firstPageLeft) |
6082 | mrdocs | 3826 | |
3827 | Sets the document type. To get facing pages set the first parameter to |
||
3828 | FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want |
||
3829 | to be the first page a left side set the second parameter to FIRSTPAGELEFT, for |
||
3830 | a right page use FIRSTPAGERIGHT. |
||
3831 | </translation> |
||
1135 | cbradney | 3832 | </message> |
3833 | <message> |
||
3834 | <source>getLineColor(["name"]) -> string |
||
3835 | |||
3836 | Returns the name of the line color of the object "name". |
||
3837 | If "name" is not given the currently selected item is used. |
||
3838 | </source> |
||
12918 | cbradney | 3839 | <translation type="obsolete">getLineColor(["name"]) -> string |
6082 | mrdocs | 3840 | |
3841 | Returns the name of the line colour of the object "name". |
||
3842 | If "name" is not given the currently selected item is used. |
||
3843 | </translation> |
||
1135 | cbradney | 3844 | </message> |
3845 | <message> |
||
3846 | <source>getLineWidth(["name"]) -> integer |
||
3847 | |||
3848 | Returns the line width of the object "name". If "name" |
||
3849 | is not given the currently selected Item is used. |
||
3850 | </source> |
||
12918 | cbradney | 3851 | <translation type="obsolete">getLineWidth(["name"]) -> integer |
6082 | mrdocs | 3852 | |
3853 | Returns the line width of the object "name". If "name" |
||
3854 | is not given the currently selected Item is used. |
||
3855 | </translation> |
||
1135 | cbradney | 3856 | </message> |
3857 | <message> |
||
3858 | <source>getLineShade(["name"]) -> integer |
||
3859 | |||
3860 | Returns the shading value of the line color of the object "name". |
||
3861 | If "name" is not given the currently selected item is used. |
||
3862 | </source> |
||
12918 | cbradney | 3863 | <translation type="obsolete">getLineShade(["name"]) -> integer |
6082 | mrdocs | 3864 | |
3865 | Returns the shading value of the line colour of the object "name". |
||
3866 | If "name" is not given the currently selected item is used. |
||
3867 | </translation> |
||
1135 | cbradney | 3868 | </message> |
3869 | <message> |
||
3870 | <source>getLineJoin(["name"]) -> integer (see contants) |
||
3871 | |||
3872 | Returns the line join style of the object "name". If "name" is not given |
||
3873 | the currently selected item is used. The join types are: |
||
3874 | JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND |
||
3875 | </source> |
||
10842 | cbradney | 3876 | <translation type="obsolete">getLineJoin(["name"]) -> integer (see contants) |
6082 | mrdocs | 3877 | |
3878 | Returns the line join style of the object "name". If "name" is not given |
||
3879 | the currently selected item is used. The join types are: |
||
3880 | JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND |
||
3881 | </translation> |
||
1135 | cbradney | 3882 | </message> |
3883 | <message> |
||
3884 | <source>getLineEnd(["name"]) -> integer (see constants) |
||
3885 | |||
3886 | Returns the line cap style of the object "name". If "name" is not given the |
||
3887 | currently selected item is used. The cap types are: |
||
3888 | CAP_FLAT, CAP_ROUND, CAP_SQUARE |
||
3889 | </source> |
||
12918 | cbradney | 3890 | <translation type="obsolete">getLineEnd(["name"]) -> integer (see constants) |
6082 | mrdocs | 3891 | |
3892 | Returns the line cap style of the object "name". If "name" is not given the |
||
3893 | currently selected item is used. The cap types are: |
||
3894 | CAP_FLAT, CAP_ROUND, CAP_SQUARE |
||
3895 | </translation> |
||
1135 | cbradney | 3896 | </message> |
3897 | <message> |
||
3898 | <source>getLineStyle(["name"]) -> integer (see constants) |
||
3899 | |||
3900 | Returns the line style of the object "name". If "name" is not given the |
||
3901 | currently selected item is used. Line style constants are: |
||
3902 | LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID |
||
3903 | </source> |
||
12918 | cbradney | 3904 | <translation type="obsolete">getLineStyle(["name"]) -> integer (see constants) |
6082 | mrdocs | 3905 | |
3906 | Returns the line style of the object "name". If "name" is not given the |
||
3907 | currently selected item is used. Line style constants are: |
||
3908 | LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID |
||
3909 | </translation> |
||
1135 | cbradney | 3910 | </message> |
3911 | <message> |
||
3912 | <source>getFillShade(["name"]) -> integer |
||
3913 | |||
3914 | Returns the shading value of the fill color of the object "name". |
||
3915 | If "name" is not given the currently selected item is used. |
||
3916 | </source> |
||
12918 | cbradney | 3917 | <translation type="obsolete">getFillShade(["name"]) -> integer |
6082 | mrdocs | 3918 | |
3919 | Returns the shading value of the fill colour of the object "name". |
||
3920 | If "name" is not given the currently selected item is used. |
||
3921 | </translation> |
||
1135 | cbradney | 3922 | </message> |
3923 | <message> |
||
6082 | mrdocs | 3924 | <source>getCornerRadius(["name"]) -> integer |
3925 | |||
3926 | Returns the corner radius of the object "name". The radius isexpressed in points. If "name" is not given the currentlyselected item is used. |
||
3927 | </source> |
||
7508 | cbradney | 3928 | <translation type="obsolete">getCornerRadius(["name"]) -> integer |
6082 | mrdocs | 3929 | |
3930 | Returns the corner radius of the object "name". The radius isexpressed in points. If "name" is not given the currentlyselected item is used. |
||
3931 | </translation> |
||
3932 | </message> |
||
3933 | <message> |
||
1135 | cbradney | 3934 | <source>getImageScale(["name"]) -> (x,y) |
3935 | |||
3936 | Returns a (x, y) tuple containing the scaling values of the image frame |
||
3937 | "name". If "name" is not given the currently selected item is used. |
||
3938 | </source> |
||
12918 | cbradney | 3939 | <translation type="obsolete">getImageScale(["name"]) -> (x,y) |
6082 | mrdocs | 3940 | |
3941 | Returns a (x, y) tuple containing the scaling values of the image frame |
||
3942 | "name". If "name" is not given the currently selected item is used. |
||
3943 | </translation> |
||
1135 | cbradney | 3944 | </message> |
3945 | <message> |
||
3946 | <source>getImageName(["name"]) -> string |
||
3947 | |||
3948 | Returns the filename for the image in the image frame. If "name" is not |
||
3949 | given the currently selected item is used. |
||
3950 | </source> |
||
12918 | cbradney | 3951 | <translation type="obsolete">getImageName(["name"]) -> string |
6082 | mrdocs | 3952 | |
3953 | Returns the filename for the image in the image frame. If "name" is not |
||
3954 | given the currently selected item is used. |
||
3955 | </translation> |
||
1135 | cbradney | 3956 | </message> |
3957 | <message> |
||
6082 | mrdocs | 3958 | <source>getPosition(["name"]) -> (x,y) |
3959 | |||
3960 | Returns a (x, y) tuple with the position of the object "name". |
||
3961 | If "name" is not given the currently selected item is used.The position is expressed in the actual measurement unit of the document |
||
3962 | - see UNIT_<type> for reference. |
||
3963 | </source> |
||
7508 | cbradney | 3964 | <translation type="obsolete">getPosition(["name"]) -> (x,y) |
6082 | mrdocs | 3965 | |
3966 | Returns a (x, y) tuple with the position of the object "name". |
||
3967 | If "name" is not given the currently selected item is used.The position is expressed in the actual measurement unit of the document |
||
3968 | - see UNIT_<type> for reference. |
||
3969 | </translation> |
||
3970 | </message> |
||
3971 | <message> |
||
1135 | cbradney | 3972 | <source>getSize(["name"]) -> (width,height) |
3973 | |||
3974 | Returns a (width, height) tuple with the size of the object "name". |
||
3975 | If "name" is not given the currently selected item is used. The size is |
||
3976 | expressed in the current measurement unit of the document - see UNIT_<type> |
||
3977 | for reference. |
||
3978 | </source> |
||
12918 | cbradney | 3979 | <translation type="obsolete">getSize(["name"]) -> (width,height) |
6082 | mrdocs | 3980 | |
3981 | Returns a (width, height) tuple with the size of the object "name". |
||
3982 | If "name" is not given the currently selected item is used. The size is |
||
3983 | expressed in the current measurement unit of the document - see UNIT_<type> |
||
3984 | for reference. |
||
3985 | </translation> |
||
1135 | cbradney | 3986 | </message> |
3987 | <message> |
||
3988 | <source>getRotation(["name"]) -> integer |
||
3989 | |||
3990 | Returns the rotation of the object "name". The value is expressed in degrees, |
||
3991 | and clockwise is positive. If "name" is not given the currently selected item |
||
3992 | is used. |
||
3993 | </source> |
||
12918 | cbradney | 3994 | <translation type="obsolete">getRotation(["name"]) -> integer |
6082 | mrdocs | 3995 | |
3996 | Returns the rotation of the object "name". The value is expressed in degrees, |
||
3997 | and clockwise is positive. If "name" is not given the currently selected item |
||
3998 | is used. |
||
3999 | </translation> |
||
1135 | cbradney | 4000 | </message> |
4001 | <message> |
||
4002 | <source>getAllObjects() -> list |
||
4003 | |||
4004 | Returns a list containing the names of all objects on the current page. |
||
4005 | </source> |
||
12918 | cbradney | 4006 | <translation type="obsolete">getAllObjects() -> list |
6082 | mrdocs | 4007 | |
4008 | Returns a list containing the names of all objects on the current page. |
||
4009 | </translation> |
||
1135 | cbradney | 4010 | </message> |
4011 | <message> |
||
6082 | mrdocs | 4012 | <source>getPropertyCType(object, property, includesuper=True) |
4013 | |||
4014 | Returns the name of the C type of `property' of `object'. See getProperty() |
||
4015 | for details of arguments. |
||
4016 | |||
4017 | If `includesuper' is true, search inherited properties too. |
||
4018 | </source> |
||
12918 | cbradney | 4019 | <translation type="obsolete">getPropertyCType(object, property, includesuper=True) |
6082 | mrdocs | 4020 | |
4021 | Returns the name of the C type of `property' of `object'. See getProperty() |
||
4022 | for details of arguments. |
||
4023 | |||
4024 | If `includesuper' is true, search inherited properties too. |
||
4025 | </translation> |
||
4026 | </message> |
||
4027 | <message> |
||
4028 | <source>getPropertyNames(object, includesuper=True) |
||
4029 | |||
4030 | Return a list of property names supported by `object'. |
||
4031 | If `includesuper' is true, return properties supported |
||
4032 | by parent classes as well. |
||
4033 | </source> |
||
12918 | cbradney | 4034 | <translation type="obsolete">getPropertyNames(object, includesuper=True) |
6082 | mrdocs | 4035 | |
4036 | Return a list of property names supported by `object'. |
||
4037 | If `includesuper' is true, return properties supported |
||
4038 | by parent classes as well. |
||
4039 | </translation> |
||
4040 | </message> |
||
4041 | <message> |
||
4042 | <source>getProperty(object, property) |
||
4043 | |||
4044 | Return the value of the property `property' of the passed `object'. |
||
4045 | |||
4046 | The `object' argument may be a string, in which case the named PageItem |
||
4047 | is searched for. It may also be a PyCObject, which may point to any |
||
4048 | C++ QObject instance. |
||
4049 | |||
4050 | The `property' argument must be a string, and is the name of the property |
||
4051 | to look up on `object'. |
||
4052 | |||
4053 | The return value varies depending on the type of the property. |
||
4054 | </source> |
||
12918 | cbradney | 4055 | <translation type="obsolete">getProperty(object, property) |
6082 | mrdocs | 4056 | |
4057 | Return the value of the property `property' of the passed `object'. |
||
4058 | |||
4059 | The `object' argument may be a string, in which case the named PageItem |
||
4060 | is searched for. It may also be a PyCObject, which may point to any |
||
4061 | C++ QObject instance. |
||
4062 | |||
4063 | The `property' argument must be a string, and is the name of the property |
||
4064 | to look up on `object'. |
||
4065 | |||
4066 | The return value varies depending on the type of the property. |
||
4067 | </translation> |
||
4068 | </message> |
||
4069 | <message> |
||
4070 | <source>setProperty(object, property, value) |
||
4071 | |||
4072 | Set `property' of `object' to `value'. If `value' cannot be converted to a type |
||
4073 | compatible with the type of `property', an exception is raised. An exception may |
||
4074 | also be raised if the underlying setter fails. |
||
4075 | |||
4076 | See getProperty() for more information. |
||
4077 | </source> |
||
12918 | cbradney | 4078 | <translation type="obsolete">setProperty(object, property, value) |
6082 | mrdocs | 4079 | |
4080 | Set `property' of `object' to `value'. If `value' cannot be converted to a type |
||
4081 | compatible with the type of `property', an exception is raised. An exception may |
||
4082 | also be raised if the underlying setter fails. |
||
4083 | |||
4084 | See getProperty() for more information. |
||
4085 | </translation> |
||
4086 | </message> |
||
4087 | <message> |
||
4088 | <source>getChildren(object, ofclass=None, ofname=None, regexpmatch=False, recursive=True) |
||
4089 | |||
4090 | Return a list of children of `object', possibly restricted to children |
||
4091 | of class named `ofclass' or children named `ofname'. If `recursive' is true, |
||
4092 | search recursively through children, grandchildren, etc. |
||
4093 | |||
4094 |