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