Subversion Repositories Scribus

Rev

Rev 23687 | Rev 23690 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
23224 jghali 1
<html>
2
<head>
3
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
4
        <title>Manipulating Objects</title>
5
</head>
6
<body>
7
<h2>Manipulating Objects</h2>
8
 
9
<dl>
10
 
11
<dt><a name="-combinePolygons"><strong>combinePolygons()</strong></a></dt>
12
<dd><code>combinePolygons()</code>
13
<p>Combines two or more selected polygons.</p>
23689 jghali 14
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
23224 jghali 15
 
16
<dt><a name="-copyObject"><strong>copyObject</strong>(...)</a></dt>
17
<dd><code>copyObject(["name"]) -&gt; string</code>
18
<p>copies the selected Object to the clipboard.</p></dd>
19
 
20
<dt><a name="-duplicateObject"><strong>duplicateObject</strong>(...)</a></dt>
21
<dd><code>duplicateObject(["name"]) -&gt; string</code>
22
<p>Creates a Duplicate of the selected Object (or Selection Group).</p></dd>
23
 
23687 jghali 24
<dt><a name="-getCharacterStyle"><strong>getCharacterStyle</strong></a>(...)</dt>
25
<dd><code>getCharacterStyle(["name"])</code>
23689 jghali 26
<p>Return name of character style applied to object named "name". If "name" is not given, the currently selected object is used.</p>
23687 jghali 27
<p>If current object has a text selection, the name of style applied to start of selection is returned. Otherwise the name of the item default character style is returned.</p>
23689 jghali 28
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if target frame is not a text frame.</p></dd>
23687 jghali 29
 
23686 jghali 30
<dt><a name="-getParagraphStyle"><strong>getParagraphStyle</strong></a>(...)</dt>
31
<dd><code>getParagraphStyle(["name"])</code>
23689 jghali 32
<p>Return name of paragraph style applied to object named "name". If "name" is not given, the currently selected object is used.</p>
23224 jghali 33
<p>If current object has a text selection, the name of style applied to start of selection is returned. Otherwise the name of the item default style is returned.</p>
23689 jghali 34
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if target frame is not a text frame.</p></dd>
23224 jghali 35
 
23686 jghali 36
<dt><a name="-getStyle"><strong>getStyle</strong></a>(...)</dt>
37
<dd><code>getStyle(["name"])</code>
38
<p>Deprecated. Use getParagraphStyle() instead.</p></dd>
39
 
23224 jghali 40
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
41
<dd><code>groupObjects(list)</code>
42
<p>Groups the objects named in "list" together. "list" must contain the names of the objects to be grouped. If "list" is not given the currently selected items are used.</p></dd>
43
 
44
<dt><a name="-isLocked"><strong>isLocked</strong></a>(...)</dt>
45
<dd><code>isLocked(["name"]) -&gt; bool</code>
46
<p>Returns true if is the object "name" locked.  If "name" is not given the currently selected item is used.</p></dd>
47
 
48
<dt><a name="-lockObject"><strong>lockObject</strong></a>(...)</dt>
49
<dd><code>lockObject(["name"]) -&gt; bool</code>
50
<p>Locks the object "name" if it's unlocked or unlock it if it's locked. If "name" is not given the currently selected item is used. Returns true if locked.</p></dd>
51
 
52
<dt><a name="-moveObject"><strong>moveObject</strong></a>(...)</dt>
53
<dd><code>moveObject(dx, dy [, "name"])</code>
54
<p>Moves the object "name" by dx and dy relative to its current position. The distances are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p>
23689 jghali 55
<p>If what you wish to do is to move an object to a different page or layer, it may be more efficient to do the sequence <em>copyObject(...)</em>, followed by <em>pasteObject(...)</em>, and then finally <em>deleteObject(...)</em> to delete the original.</p></dd>
23224 jghali 56
 
57
<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
58
<dd><code>moveObjectAbs(x, y [, "name"])</code>
59
<p>Moves the object "name" to a new location. The coordinates are expressed in the current measurement unit of the document (see UNIT constants).  If "name" is not given the currently selected item is used.  If the object "name" belongs to a group, the whole group is moved.</p></dd>
60
 
61
<dt><a name="-pasteObject"><strong>pasteObject</strong>(...)</a></dt>
62
<dd><code>pasteObject(["name"]) -&gt; string</code>
23689 jghali 63
<p>Pastes an Object from the clipboard. This will be used only or most sensibly following <em>copyObject(...)</em>, since otherwise there will likely be nothing in the clipboard to paste.</p></dd>
23224 jghali 64
 
65
<dt><a name="-rotateObject"><strong>rotateObject</strong></a>(...)</dt>
66
<dd><code>rotateObject(rot [, "name"])</code>
67
<p>Rotates the object "name" by "rot" degrees relatively. The object is rotated by the vertex that is currently selected as the rotation point - by default, the top left vertext at zero rotation. Positive values mean counter clockwise rotation when the default rotation point is used. If "name" is not given the currently selected item is used.</p></dd>
68
 
69
<dt><a name="-rotateObjectAbs"><strong>rotateObjectAbs</strong></a>(...)</dt>
70
<dd><code>rotateObjectAbs(rot [, "name"])</code>
71
<p>Sets the rotation of the object "name" to "rot". Positive values mean counter clockwise rotation. If "name" is not given the currently selected item is used.</p></dd>
72
 
73
<dt><a name="-scaleGroup"><strong>scaleGroup</strong></a>(...)</dt>
74
<dd><code>scaleGroup(factor [,"name"])</code>
75
<p>Scales the group the object "name" belongs to. Values greater than 1 enlarge the group, values smaller than 1 make the group smaller e.g a value of 0.5 scales the group to 50 % of its original size, a value of 1.5 scales the group to 150 % of its original size.  The value for "factor" must be greater than 0. If "name" is not given the currently selected item is used.</p>
76
<p>May raise ValueError if an invalid scale factor is passed.</p></dd>
77
 
78
<dt><a name="-setCharacterStyle"><strong>setCharacterStyle</strong></a>(...)</dt>
79
<dd><code>setCharacterStyle("style" [, "name"])</code>
23689 jghali 80
<p>Apply the named character "style" to the object named "name".</p>
81
<p>If object name is not provided, style is applied on current object selection.</p>
82
<p>If multiple objects are selected or if selected object has no text selection, style is applied on selected object(s). Otherwise style is applied to the current text selection.</p>
83
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the target frame is not a text frame.</p>
84
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if specified style name does not exist in current document.</p></dd>
23224 jghali 85
 
23686 jghali 86
<dt><a name="-setParagraphStyle"><strong>setParagraphStyle</strong></a>(...)</dt>
87
<dd><code>setParagraphStyle("style" [, "name"])</code>
23689 jghali 88
<p>Apply the named paragraph "style" to the object named "name".</p>
89
<p>If object name is not provided, style is applied on current object selection.</p>
90
<p>If multiple objects are selected or if selected object has no text selection, style is applied on selected object(s). Otherwise style is applied to the current text selection.</p>
91
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the target frame is not a text frame.</p>
92
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if specified style name does not exist in current document.</p></dd>
23686 jghali 93
 
23224 jghali 94
<dt><a name="-setScaleFrameToImage"><strong>setScaleFrameToImage</strong></a>(...)</dt>
95
<dd><code>setScaleFrameToImage([name])</code>
96
<p>Set frame size on the selected or specified image frame to image size.</p>
23689 jghali 97
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
23224 jghali 98
 
99
<dt><a name="-setScaleImageToFrame"><strong>setScaleImageToFrame</strong></a>(...)</dt>
100
<dd><code>setScaleImageToFrame(scaletoframe, proportional=None, name=&lt;selection&gt;)</code>
101
<p>Sets the scale to frame on the selected or specified image frame to `scaletoframe'. If `proportional' is specified, set fixed aspect ratio scaling to `proportional'. Both `scaletoframe' and `proportional' are boolean.</p>
23689 jghali 102
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
23224 jghali 103
 
104
<dt><a name="-setStyle"><strong>setStyle</strong></a>(...)</dt>
105
<dd><code>setStyle("style" [, "name"])</code>
23686 jghali 106
<p>Deprecated. Use setParagraphStyle() instead.</p></dd>
23224 jghali 107
 
108
<dt><a name="-sizeObject"><strong>sizeObject</strong></a>(...)</dt>
109
<dd><code>sizeObject(width, height [, "name"])</code>
110
<p>Resizes the object "name" to the given width and height. If "name" is not given the currently selected item is used.</p></dd>
111
 
23438 jghali 112
<dt><a name="-unGroupObjects"><strong>unGroupObjects</strong></a>(...)</dt>
23224 jghali 113
<dd><code>unGroupObjects("name")</code>
23689 jghali 114
<p>Destructs the group the object "name" belongs to. If "name" is not given the currently selected item is used.</p></dd>
23224 jghali 115
 
116
<dt><a name="-textFlowMode"><strong>textFlowMode</strong>(...)</a></dt>
117
<dd><code>textFlowMode("name" [, state])</code>
23689 jghali 118
<p>Enables/disables "Text Flows Around Frame" feature for object "name".</p>
119
<p>Called with parameters string name and optional int "state" (0 &lt;= state &lt;= 3). Setting "state" to 0 will disable text flow. Setting "state" to 1 will make text flow around object frame. Setting "state" to 2 will make text flow around bounding box. Setting "state" to 3 will make text flow around contour line. If "state" is not passed, text flow is toggled.</p></dd>
23224 jghali 120
 
121
</dl>
122
</body>
123
</html>