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