File: scripterapi-getobjprop.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 (64 lines) | stat: -rw-r--r-- 4,574 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
58
59
60
61
62
63
64
<qt>
<title>Getting Object Properties</title>
<h2>Getting Object Properties</h2>

<dl>

<dt><a name="-getCornerRadius"><strong>getCornerRadius</strong></a>(...)</dt>
<dd><code><a href="#-getCornerRadius">getCornerRadius</a>(["name"]) -&gt; integer</code>
<p>Returns the corner radius of the object "name". The radius is expressed in points. If "name" is not given the currently selected item is used.</p></dd>

<dt><a name="-getFillColor"><strong>getFillColor</strong></a>(...)</dt>
<dd><code><a href="#-getFillColor">getFillColor</a>(["name"]) -&gt; string</code>
<p>Returns the name of the fill color of the object "name". If "name" is not given the currently selected item is used.</p></dd>

<dt><a name="-getFillShade"><strong>getFillShade</strong></a>(...)</dt>
<dd><code><a href="#-getFillShade">getFillShade</a>(["name"]) -&gt; integer</code>
<p>Returns the shading value of the fill color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
	
<dt><a name="-getImageFile"><strong>getImageFile</strong></a>(...)</dt>
<dd><code>getImageName(["name"]) -&gt; string</code>
<p>Returns the filename for the image in the image frame. If "name" is not given the currently selected item is used.</p></dd>
 
<dt><a name="-getImageScale"><strong>getImageScale</strong></a>(...)</dt>
<dd><code><a href="#-getImageScale">getImageScale</a>(["name"]) -&gt; (x,y)</code>
<p>Returns a (x, y) tuple containing the scaling values of the image frame "name".  If "name" is not given the currently selected item is used.</p></dd>

<dt><a name="-getLineCap"><strong>getLineCap</strong></a>(...)</dt>
<dd><code>getLineEnd(["name"]) -&gt; integer (see constants)</code>
<p>Returns the line cap style of the object "name". If "name" is not given the currently selected item is used. The cap types are: CAP_FLAT, CAP_ROUND, CAP_SQUARE</p></dd>

<dt><a name="-getLineColor"><strong>getLineColor</strong></a>(...)</dt>
<dd><code><a href="#-getLineColor">getLineColor</a>(["name"]) -&gt; string</code>
<p>Returns the name of the line color of the object "name". If "name" is not given the currently selected item is used.</p></dd>

<dt><a name="-getLineJoin"><strong>getLineJoin</strong></a>(...)</dt>
<dd><code><a href="#-getLineJoin">getLineJoin</a>(["name"]) -&gt; integer (see contants)</code>
<p>Returns the line join style of the object "name". If "name" is not given the currently selected item is used.  The join types are: JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND</p></dd>

<dt><a name="-getLineShade"><strong>getLineShade</strong></a>(...)</dt>
<dd><code><a href="#-getLineShade">getLineShade</a>(["name"]) -&gt; integer</code>
<p>Returns the shading value of the line color of the object "name". If "name" is not given the currently selected item is used.</p></dd>

<dt><a name="-getLineStyle"><strong>getLineStyle</strong></a>(...)</dt>
<dd><code><a href="#-getLineStyle">getLineStyle</a>(["name"]) -&gt; integer (see constants)</code>
<p>Returns the line style of the object "name". If "name" is not given the currently selected item is used. Line style constants are: LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID</p></dd>

<dt><a name="-getLineWidth"><strong>getLineWidth</strong></a>(...)</dt>
<dd><code><a href="#-getLineWidth">getLineWidth</a>(["name"]) -&gt; integer</code>
<p>Returns the line width of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
	
<dt><a name="-getPosition"><strong>getPosition</strong></a>(...)</dt>
<dd><code><a href="#-getPosition">getPosition</a>(["name"]) -&gt; (x,y)</code>
<p>Returns a (x, y) tuple with the position of the object "name". If "name" is not given the currently selected item is used. The position is expressed in the actual measurement unit of the document - see UNIT_&lt;type&gt; for reference.</p></dd>

<dt><a name="-getRotation"><strong>getRotation</strong></a>(...)</dt>
<dd><code><a href="#-getRotation">getRotation</a>(["name"]) -&gt; integer</code>
<p>Returns the rotation of the object "name". The value is expressed in degrees, and clockwise is positive. If "name" is not given the currently selected item is used.</p></dd>

<dt><a name="-getSize"><strong>getSize</strong></a>(...)</dt>
<dd><code><a href="#-getSize">getSize</a>(["name"]) -&gt; (width,height)</code>
<p>Returns a (width, height) tuple with the size of the object "name". If "name" is not given the currently selected item is used. The size is expressed in the current measurement unit of the document - see UNIT_&lt;type&gt; for reference.</p></dd>
    
</dl>
</qt>