File: scripterapi-manobj.html

package info (click to toggle)
scribus-doc 1.2.1-2
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 2,920 kB
  • ctags: 374
  • sloc: makefile: 387; xml: 110
file content (57 lines) | stat: -rw-r--r-- 4,444 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<qt>
<title>Manipulating Objects</title>
<h2>Manipulating Objects</h2>

<dl>

<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
<dd><code><a href="#-groupObjects">groupObjects</a>(list)</code>
<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>

<dt><a name="-isLocked"><strong>isLocked</strong></a>(...)</dt>
<dd><code><a href="#-isLocked">isLocked</a>(["name"]) -&gt; bool</code>
<p>Returns true if is the object "name" locked.  If "name" is not given the currently selected item is used.</p></dd>

<dt><a name="-lockObject"><strong>lockObject</strong></a>(...)</dt>
<dd><code><a href="#-lockObject">lockObject</a>(["name"]) -&gt; bool</code>
<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>
	
<dt><a name="-moveObject"><strong>moveObject</strong></a>(...)</dt>
<dd><code><a href="#-moveObject">moveObject</a>(dx, dy [, "name"])</code>
<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>

<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
<dd><code><a href="#-moveObjectAbs">moveObjectAbs</a>(x, y [, "name"])</code>
<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>

<dt><a name="-rotateObject"><strong>rotateObject</strong></a>(...)</dt>
<dd><code><a href="#-rotateObject">rotateObject</a>(rot [, "name"])</code>
<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>

<dt><a name="-rotateObjectAbs"><strong>rotateObjectAbs</strong></a>(...)</dt>
<dd><code><a href="#-rotateObjectAbs">rotateObjectAbs</a>(rot [, "name"])</code>
<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>
	
<dt><a name="-scaleGroup"><strong>scaleGroup</strong></a>(...)</dt>
<dd><code><a href="#-scaleGroup">scaleGroup</a>(factor [,"name"])</code>
<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>
<p>May raise ValueError if an invalid scale factor is passed.</p></dd>

<dt><a name="-setStyle"><strong>setStyle</strong></a>(...)</dt>
<dd><code><a href="#-setStyle">setStyle</a>("style" [, "name"])</code>
<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>
	
<dt><a name="-sizeObject"><strong>sizeObject</strong></a>(...)</dt>
<dd><code><a href="#-sizeObject">sizeObject</a>(width, height [, "name"])</code>
<p>Resizes the object "name" to the given width and height. If "name" is not given the currently selected item is used.</p></dd>
	
<dt><a name="-unGroupObject"><strong>unGroupObject</strong></a>(...)</dt>
<dd><code>unGroupObjects("name")</code>
<p>Destructs the group the object "name" belongs to.If "name" is not given the currently selected item is used.</p></dd>

<dt><a name="-textFlowsAroundFrame"><strong>textFlowsAroundFrame</strong></a>(...)</dt>
<dd><code><a href="#-textFlowsAroundFrame">textFlowsAroundFrame</a>("name" [, state])</code>
<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>

</dl>
</qt>