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