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