Subversion Repositories Scribus

Rev

Rev 572 | Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
559 cbradney 1
<h2>Manipulating Objects </h2>
2
 
3
<dl>
4
        <dt>GroupObjects([list])</dt>
5
        <dd>Groups the Objects 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.</dd>
6
 
7
        <dt>MoveObject(dx, dy, ["name"])</dt>
8
        <dd>Moves the Object "name" by dx and dy relative to its origin. The Distances are expressed in the actual Measurement Unit of the Document. If "name" is not given the currently selected Item is used. If the Object "name" belongs to a Group, the whole Group is moved.</dd>
9
 
10
        <dt>MoveObjectAbs(x, y, ["name"])</dt>
11
        <dd>Moves the Object "name" to a new Location. The Coordinates are expressed in the actual Measurement Unit of the Document. If "name" is not given the currently selected Item is used. If the Object "name" belongs to a Group, the whole Group is moved.</dd>
12
 
13
        <dt>RotateObject(rot, ["name"])</dt>
14
        <dd>Rotates the Object "name" by "rot" Degrees. Positve Values mean counter clockwise Rotation. If "name" is not given the currently selected Item is used.</dd>
15
 
16
        <dt>RotateObjectAbs(rot, ["name"])</dt>
17
        <dd>Sets the Rotation of the Object "name" to "rot". Positve Values mean counter clockwise Rotation. If "name" is not given the currently selected Item is used.</dd>
18
 
19
        <dt>ScaleGroup(factor, ["name"])</dt>
20
        <dd>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 is 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.</dd>
21
 
22
        <dt>SizeObject(width, height, ["name"])</dt>
23
        <dd>Resizes the Object "name" to the given Width and Height. If "name" is not given the currently selected Item is used.</dd>
24
 
25
        <dt>UnGroupObject(["name"])</dt>
26
        <dd>Destructs the Group the Object "name" belongs to. If "name" is not given the currently selected Item is used.</dd>
27
        <dt>TextFlowsAroundFrame('objectname' [,state])</dt>
28
        <dd>Enables/disables "Text Flows Around Box" feature for object. Called with params string objectName and voluntary 1|0. When 1 set flowing to true (0 to false). When the second parameter is empty flowing is reverted. For example:
29
                <pre>
30
        objnamme = GetSelectedObject()
31
        TextFlowsAroundFrame(objname, 1) # causes the text flows around the object</pre></dd>
32
</dl>