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