Subversion Repositories Scribus

Rev

Rev 1006 | 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
 
1006 cbradney 7
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
8
<dd><code><a href="#-groupObjects">groupObjects</a>(list)</code>
9
<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>
1002 subik 10
 
1006 cbradney 11
<dt><a name="-isLocked"><strong>isLocked</strong></a>(...)</dt>
12
<dd><code><a href="#-isLocked">isLocked</a>(["name"]) -&gt; bool</code>
13
<p>Returns true if is the object "name" locked.  If "name" is not given the currently selected item is used.</p></dd>
1002 subik 14
 
1006 cbradney 15
<dt><a name="-lockObject"><strong>lockObject</strong></a>(...)</dt>
16
<dd><code><a href="#-lockObject">lockObject</a>(["name"]) -&gt; bool</code>
17
<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>
1388 subik 18
 
1006 cbradney 19
<dt><a name="-moveObject"><strong>moveObject</strong></a>(...)</dt>
20
<dd><code><a href="#-moveObject">moveObject</a>(dx, dy [, "name"])</code>
21
<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></dd>
1002 subik 22
 
1006 cbradney 23
<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
24
<dd><code><a href="#-moveObjectAbs">moveObjectAbs</a>(x, y [, "name"])</code>
25
<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>
1002 subik 26
 
1006 cbradney 27
<dt><a name="-rotateObject"><strong>rotateObject</strong></a>(...)</dt>
28
<dd><code><a href="#-rotateObject">rotateObject</a>(rot [, "name"])</code>
29
<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>
1002 subik 30
 
1006 cbradney 31
<dt><a name="-rotateObjectAbs"><strong>rotateObjectAbs</strong></a>(...)</dt>
32
<dd><code><a href="#-rotateObjectAbs">rotateObjectAbs</a>(rot [, "name"])</code>
33
<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>
1388 subik 34
 
1006 cbradney 35
<dt><a name="-scaleGroup"><strong>scaleGroup</strong></a>(...)</dt>
36
<dd><code><a href="#-scaleGroup">scaleGroup</a>(factor [,"name"])</code>
37
<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>
38
<p>May raise ValueError if an invalid scale factor is passed.</p></dd>
1002 subik 39
 
1006 cbradney 40
<dt><a name="-setStyle"><strong>setStyle</strong></a>(...)</dt>
41
<dd><code><a href="#-setStyle">setStyle</a>("style" [, "name"])</code>
42
<p>Apply the named "style" to the object named "name". If is no object name given, it's applied on the selected object.</p></dd>
1388 subik 43
 
1006 cbradney 44
<dt><a name="-sizeObject"><strong>sizeObject</strong></a>(...)</dt>
45
<dd><code><a href="#-sizeObject">sizeObject</a>(width, height [, "name"])</code>
46
<p>Resizes the object "name" to the given width and height. If "name" is not given the currently selected item is used.</p></dd>
1388 subik 47
 
1006 cbradney 48
<dt><a name="-unGroupObject"><strong>unGroupObject</strong></a>(...)</dt>
49
<dd><code>unGroupObjects("name")</code>
50
<p>Destructs the group the object "name" belongs to.If "name" is not given the currently selected item is used.</p></dd>
1002 subik 51
 
1006 cbradney 52
<dt><a name="-textFlowsAroundFrame"><strong>textFlowsAroundFrame</strong></a>(...)</dt>
53
<dd><code><a href="#-textFlowsAroundFrame">textFlowsAroundFrame</a>("name" [, state])</code>
54
<p>Enables/disables "Text Flows Around Frame" feature for object "name". Called with parameters string name and optional boolean "state". If "state" is not passed, text flow is toggled.</p></dd>
1002 subik 55
 
1388 subik 56
<dt><a name="-setScaleImageToFrame"><strong>setScaleImageToFrame</strong></a>(...)</dt>
57
<dd><code><a href="#-setScaleImageToFrame">setScaleImageToFrame</a>(scaletoframe, proportional=None, name=<selection>)</code>
58
<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>
59
<p>May raise WrongFrameTypeError.</p></dd>
60
 
594 cbradney 61
</dl>
62
</qt>