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