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