Subversion Repositories Scribus

Rev

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

Rev Author Line No. Line
594 cbradney 1
<qt>
2
<title>Manipulating Objects</title>
3
<h2>Manipulating Objects</h2>
559 cbradney 4
 
5
<dl>
1002 subik 6
 
7
<dl><dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
8
<dd><tt><a href="#-groupObjects">groupObjects</a>(list)</tt>
9
<p>Groups the objects named in "list" together. "list" must contain the names
10
of the objects to be grouped. If "list" is not given the currently selected
11
items are used.</p></dd></dl>
12
 
13
<dl><dt><a name="-isLocked"><strong>isLocked</strong></a>(...)</dt>
14
<dd><tt><a href="#-isLocked">isLocked</a>(["name"]) -&gt; bool</tt>
15
<p>Returns true if is the object "name" locked.  If "name" is not given the
16
currently selected item is used.</p></dd></dl>
17
 
18
<dl><dt><a name="-lockObject"><strong>lockObject</strong></a>(...)</dt>
19
<dd><tt><a href="#-lockObject">lockObject</a>(["name"]) -&gt; bool</tt>
20
<p>Locks the object "name" if it's unlocked or unlock it if it's locked.
21
If "name" is not given the currently selected item is used. Returns true
22
if locked.</p></dd></dl>
559 cbradney 23
 
1002 subik 24
<dl><dt><a name="-moveObject"><strong>moveObject</strong></a>(...)</dt>
25
<dd><tt><a href="#-moveObject">moveObject</a>(dx, dy [, "name"])</tt>
26
<p>Moves the object "name" by dx and dy relative to its current position. The
27
distances are expressed in the current measurement unit of the document (see
28
UNIT constants). If "name" is not given the currently selected item is used.
29
If the object "name" belongs to a group, the whole group is moved.</p></dd></dl>
30
 
31
<dl><dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
32
<dd><tt><a href="#-moveObjectAbs">moveObjectAbs</a>(x, y [, "name"])</tt>
33
<p>Moves the object "name" to a new location. The coordinates are expressed in
34
the current measurement unit of the document (see UNIT constants).  If "name"
35
is not given the currently selected item is used.  If the object "name"
36
belongs to a group, the whole group is moved.</p></dd></dl>
37
 
38
<dl><dt><a name="-rotateObject"><strong>rotateObject</strong></a>(...)</dt>
39
<dd><tt><a href="#-rotateObject">rotateObject</a>(rot [, "name"])</tt>
40
<p>Rotates the object "name" by "rot" degrees relatively. The object is
41
rotated by the vertex that is currently selected as the rotation point - by
42
default, the top left vertext at zero rotation. Positive values mean counter
43
clockwise rotation when the default rotation point is used. If "name" is not
44
given the currently selected item is used.</p></dd></dl>
45
 
46
<dl><dt><a name="-rotateObjectAbs"><strong>rotateObjectAbs</strong></a>(...)</dt>
47
<dd><tt><a href="#-rotateObjectAbs">rotateObjectAbs</a>(rot [, "name"])</tt>
48
<p>Sets the rotation of the object "name" to "rot". Positive values
49
mean counter clockwise rotation. If "name" is not given the currently
50
selected item is used.</p></dd></dl>
559 cbradney 51
 
1002 subik 52
<dl><dt><a name="-scaleGroup"><strong>scaleGroup</strong></a>(...)</dt>
53
<dd><tt><a href="#-scaleGroup">scaleGroup</a>(factor [,"name"])</tt>
54
<p>Scales the group the object "name" belongs to. Values greater than 1 enlarge
55
the group, values smaller than 1 make the group smaller e.g a value of 0.5
56
scales the group to 50 % of its original size, a value of 1.5 scales the group
57
to 150 % of its original size.  The value for "factor" must be greater than
58
0. If "name" is not given the currently selected item is used.</p>
59
<p>May raise ValueError if an invalid scale factor is passed.</p></dd></dl>
60
 
61
<dl><dt><a name="-setStyle"><strong>setStyle</strong></a>(...)</dt>
62
<dd><tt><a href="#-setStyle">setStyle</a>("style" [, "name"])</tt>
63
<p>Apply the named "style" to the object named "name". If is no object name
64
given, it's applied on the selected object.</p></dd></dl>
559 cbradney 65
 
1002 subik 66
<dl><dt><a name="-sizeObject"><strong>sizeObject</strong></a>(...)</dt>
67
<dd><tt><a href="#-sizeObject">sizeObject</a>(width, height [, "name"])</tt>
68
<p>Resizes the object "name" to the given width and height. If "name"
69
is not given the currently selected item is used.</p></dd></dl>
559 cbradney 70
 
1002 subik 71
<dl><dt><a name="-unGroupObject"><strong>unGroupObject</strong></a>(...)</dt>
72
<dd><tt>unGroupObjects("name")</tt>
73
<p>Destructs the group the object "name" belongs to.If "name" is not given
74
the currently selected item is used.</p></dd></dl>
75
 
76
<dl><dt><a name="-textFlowsAroundFrame"><strong>textFlowsAroundFrame</strong></a>(...)</dt>
77
<dd><tt><a href="#-textFlowsAroundFrame">textFlowsAroundFrame</a>("name" [, state])</tt>
78
<p>Enables/disables "Text Flows Around Frame" feature for object "name".
79
Called with parameters string name and optional boolean "state". If "state"
80
is not passed, text flow is toggled.</p></dd></dl>
81
 
594 cbradney 82
</dl>
83
</qt>