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