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