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