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