Subversion Repositories Scribus

Rev

Rev 17163 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
10646 cbradney 1
<html>
2
<head>
3
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
4
        <title>Setting Object Properties</title>
5
</head>
6
<body>
559 cbradney 7
<h2>Setting Object Properties</h2>
8
 
9
<dl>
1041 cbradney 10
 
11
<dt><a name="-linkTextFrames"><strong>linkTextFrames</strong></a>(...)</dt>
7440 subik 12
<dd><code>linkTextFrames("fromname", "toname")</code>
1041 cbradney 13
<p>Link two text frames. The frame named "fromname" is linked to the frame named "toname". The target frame must be an empty text frame and must not link to or be linked from any other frames already.</p>
14
<p>May throw <a href="#ScribusException">ScribusException</a> if linking rules are violated.</p></dd>
15
 
16
<dt><a name="-loadImage"><strong>loadImage</strong></a>(...)</dt>
7440 subik 17
<dd><code>loadImage("filename" [, "name"])</code>
1041 cbradney 18
<p>Loads the picture "picture" into the image frame "name". If "name" is not given the currently selected item is used.</p>
19
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the target frame is not an image frame</p></dd></dt>
559 cbradney 20
 
7440 subik 21
<dt><a name="-setFillBlendmode"><strong>setFillBlendmode</strong>(...)</a></dt>
22
<dd><code>setFillBlendmode(blendmode, ["name"])</code>
23
<p>Sets the fill blendmode of the object "name" to blendmode is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
24
 
1041 cbradney 25
<dt><a name="-setCornerRadius"><strong>setCornerRadius</strong></a>(...)</dt>
7440 subik 26
<dd><code>setCornerRadius(radius, ["name"])</code>
1041 cbradney 27
<p>Sets 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>
28
<p>May raise ValueError if the corner radius is negative.</p></dd>
559 cbradney 29
 
1041 cbradney 30
<dt><a name="-setFillColor"><strong>setFillColor</strong></a>(...)</dt>
7440 subik 31
<dd><code>setFillColor("color", ["name"])</code>
1041 cbradney 32
<p>Sets the fill color of the object "name" to the color "color". "color" is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
559 cbradney 33
 
1041 cbradney 34
<dt><a name="-setFillShade"><strong>setFillShade</strong></a>(...)</dt>
7440 subik 35
<dd><code>setFillShade(shade, ["name"])</code>
1041 cbradney 36
<p>Sets the shading of the fill color of the object "name" to "shade". "shade" must be an integer value in the range from 0 (lightest) to 100 (full Color intensity). If "name" is not given the currently selected Item is used.<p>
37
<p>May raise ValueError if the fill shade is out of bounds.</p></dd>
559 cbradney 38
 
7440 subik 39
<dt><a name="-setFillTransparency"><strong>setFillTransparency</strong>(...)</a></dt>
40
<dd><code>setFillTransparency(transparency, ["name"])</code>
41
<p>Sets the fill transparency of the object "name" to transparency is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
42
 
43
<dt><a name="-setLineBlendmode"><strong>setLineBlendmode</strong>(...)</a></dt>
44
<dd><code>setLineBlendmode(blendmode, ["name"])</code>
45
<p>Sets the line blendmode of the object "name" to blendmode is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
46
 
47
<dt><a name="-setLineTransparency"><strong>setLineTransparency</strong>(...)</a></dt>
48
<dd><code>setLineTransparency(transparency, ["name"])</code>
49
<p>Sets the line transparency of the object "name" to transparency is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
50
 
1041 cbradney 51
<dt><a name="-setGradientFill"><strong>setGradientFill</strong></a>(...)</dt>
7440 subik 52
<dd><code>setGradientFill(type, "color1", shade1, "color2", shade2, ["name"])</code>
1041 cbradney 53
<p>Sets the gradient fill of the object "name" to type. Color descriptions are the same as for <a href="#-setFillColor">setFillColor</a>() and <a href="#-setFillShade">setFillShade</a>(). See the constants for available types (FILL_&lt;type&gt;).</p></dd>
559 cbradney 54
 
13182 jghali 55
<dt><a name="-setGradientStop"><strong>setGradientStop</strong></a>(...)</dt>
56
<dd><code>setGradientStop("color", shade, opacity, ramppoint, ["name"])</code>
57
<p>Set or add a gradient stop to the gradient fill of the object \"name\" at position ramppoint. Color descriptions are the same as for <a href="#-setFillColor">setFillColor</a>() and <a href="#-setFillShade">setFillShade</a>(). setGradientFill() must have been called previously for the gradient fill to be visible.</p></dd>
58
 
1041 cbradney 59
<dt><a name="-setLineCap"><strong>setLineCap</strong></a>(...)</dt>
15507 jghali 60
<dd><code>setLineCap(captype, ["name"])</code>
1041 cbradney 61
<p>Sets the line cap style of the object "name" to the style "cap". If "name" is not given the currently selected item is used. There are predefined constants for "cap" - CAP_&lt;type&gt;.</p></dd>
62
 
63
<dt><a name="-setLineColor"><strong>setLineColor</strong></a>(...)</dt>
7440 subik 64
<dd><code>setLineColor("color", ["name"])</code>
1041 cbradney 65
<p>Sets the line color of the object "name" to the color "color". If "name" is not given the currently selected item is used.</p></dd>
559 cbradney 66
 
1041 cbradney 67
<dt><a name="-setMultiLine"><strong>setMultiLine</strong></a>(...)</dt>
7440 subik 68
<dd><code>setMultiLine("namedStyle", ["name"])</code>
1041 cbradney 69
<p>Sets the line style of the object "name" to the named style "namedStyle". If "name" is not given the currently selected item is used.</p>
70
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the line style doesn't exist.</p></dd>
559 cbradney 71
 
1041 cbradney 72
<dt><a name="-setLineJoin"><strong>setLineJoin</strong></a>(...)</dt>
7440 subik 73
<dd><code>setLineJoin(join, ["name"])</code>
1041 cbradney 74
<p>Sets the line join style of the object "name" to the style "join". If "name" is not given the currently selected item is used. There are predefined constants for join - JOIN_&lt;type&gt;.</p></dd>
75
 
76
<dt><a name="-setLineShade"><strong>setLineShade</strong></a>(...)</dt>
7440 subik 77
<dd><code>setLineShade(shade, ["name"])</code>
1041 cbradney 78
<p>Sets the shading of the line color of the object "name" to "shade". "shade" must be an integer value in the range from 0 (lightest) to 100 (full color intensity). If "name" is not given the currently selected item is used.</p>
79
<p>May raise ValueError if the line shade is out of bounds.</p></dd>
559 cbradney 80
 
1041 cbradney 81
<dt><a name="-setLineStyle"><strong>setLineStyle</strong></a>(...)</dt>
7440 subik 82
<dd><code>setLineStyle(style, ["name"])</code>
1041 cbradney 83
<p>Sets the line style of the object "name" to the style "style". If "name" is not given the currently selected item is used. There are predefined constants for "style" - LINE_&lt;style&gt;.</p></dd>
84
 
85
<dt><a name="-setLineWidth"><strong>setLineWidth</strong></a>(...)</dt>
7440 subik 86
<dd><code>setLineWidth(width, ["name"])</code>
1041 cbradney 87
<p>Sets line width of the object "name" to "width". "width" must be in the range from 0.0 to 12.0 inclusive, and is measured in points. If "name" is not given the currently selected item is used.</p>
88
<p>May raise ValueError if the line width is out of bounds.</p></dd>
89
 
19076 gpittman 90
<dt><a name="-scaleImage"><strong><em>scaleImage</em></strong></a>(...)</dt>
7440 subik 91
<dd><code>scaleImage(x, y [, "name"])</code>
19076 gpittman 92
<p><b>Do not use this command, since it no longer works. Use setImageScale instead.</b></p></dd>
7440 subik 93
 
13081 jghali 94
<dt><a name="-setImageScale"><strong>setImageScale</strong></a>(...)</dt>
95
<dd><code>setImageScale(x, y [, "name"])</code>
96
<p>Sets the scaling factors of the picture in the image frame "name". If "name" is not given the currently selected item is used. A number of 1 means 100 %. Scaling factors are equal to the values shown on properties palette.</p>
97
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the target frame is not an image frame</p></dd>
98
 
14977 jghali 99
<dt><a name="-setImageOffset"><strong>setImageOffset</strong></a>(...)</dt>
100
<dd><code>setImageOffset(x, y [, "name"])</code>
14979 jghali 101
<p>Sets the position of the picture in the image frame "name". If "name" is not given the currently selected item is used. The specified offset values are equal to the values shown on properties palette when point unit is used.</p>
14977 jghali 102
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the target frame is not an image frame</p></dd>
103
 
1041 cbradney 104
<dt><a name="-traceText"><strong>traceText</strong></a>(...)</dt>
7440 subik 105
<dd><code>traceText(["name"])</code>
1041 cbradney 106
<p>Convert the text frame "name" to outlines. If "name" is not given the currently selected item is used.</p></dd>
559 cbradney 107
 
1041 cbradney 108
<dt><a name="-unlinkTextFrames"><strong>unlinkTextFrames</strong></a>(...)</dt>
7440 subik 109
<dd><code>unlinkTextFrames("name")</code>
1041 cbradney 110
<p>Remove the specified (named) object from the text frame flow/linkage. If the frame was in the middle of a chain, the previous and next frames will be connected, eg 'a-&gt;b-&gt;c' becomes 'a-&gt;c' when you <a href="#-unlinkTextFrames">unlinkTextFrames</a>(b)'</p>
111
<p>May throw <a href="#ScribusException">ScribusException</a> if linking rules are violated.</p></dd>
559 cbradney 112
 
597 cbradney 113
</dl>
10646 cbradney 114
</body>
115
</html>