/
rvggroup.html
305 lines (227 loc) · 8.46 KB
/
rvggroup.html
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1st March 2005), see www.w3.org" />
<title>RMagick: RVG Reference: RVG::Group Class</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
<meta name="Copyright" content=
"Copyright (C) 2005 by Timothy P. Hunter" />
<link rel="stylesheet" type="text/css" href="css/doc.css" />
<script type="text/javascript" src="scripts/doc.js">
</script>
<script type="text/javascript">
//<![CDATA[
//]]>
</script>
<style type="text/css">
/*<![CDATA[*/
}
/*]]>*/
</style>
</head>
<body>
<h6 id="header">RMagick User's Guide and Reference</h6>
<div class="nav">
« <a href="rvg.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"rvgimage.html">Next</a> »
</div>
<h1>class RVG::Group <span class="superclass"><
Object</span></h1>
<div id="toc">
<h2>Table of Contents</h2>
<h3>class methods</h3>
<ul>
<li><a href="#new">new</a></li>
</ul>
<h3>attributes</h3>
<ul>
<li><a href="#desc">desc, desc=</a></li>
<li><a href="#metadata">metadata, metadata=</a></li>
<li><a href="#title">title, title=</a></li>
</ul>
<h3>instance methods</h3>
<ul>
<li><a href="#g">g</a></li>
<li><a href="#image">image</a></li>
<li><a href="#rvg">rvg</a></li>
<li><a href="#text">text</a></li>
<li><a href="#use">use</a></li>
</ul>
<h3>shared methods</h3>
<p>In addition to the methods listed above, <code>class
RVG::Group</code> also implements the <a href=
"rvgstyle.html">styles</a> method, the <a href=
"rvgshape.html">shape methods</a> and the <a href=
"rvgxform.html">transform methods</a>.</p>
</div>
<h2 class="methods">class methods</h2>
<div class="sig">
<h3 id="new">new</h3>
<p><span class="arg">RVG::Group</span>.new [ <span class=
"arg">{ |<span class="arg">self</span>| drawing method calls
}</span> ] -> <span class="arg">aGroup</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Drawing objects defined within a group share the transforms
and styles defined on the group. Groups can be nested
arbitrarily deep. <code>RVG::Group.new</code> is commonly
invoked within another group or RVG object by calling the
<code>g</code> method (<a href="rvg.html#RVG_g">RVG#g</a>, <a href="#g">RVG::Group#g</a>) , which nests the group within the target
object.</p>
<p><code>RVG::Group.new</code> yields to a block if one is
present, passing <code>self</code> as an argument.</p>
<h4>Returns</h4>
<p>An <code>RVG::Group</code> object</p>
<h4>Example</h4>
<p>See the tutorial for examples of the most common uses of
groups. In this example, I use RVG::Group.new to construct a
"stand-alone" group that is then referenced in multiple calls
to the <a href="rvguse.html">use</a> method.</p>
<p><a href="javascript:popup('group.rb.html')"><img src=
"ex/group.gif" title="Click to see the example script" alt=
"group example" /></a></p>
<h4>See also</h4>
<p><a href="rvg.html">RVG</a></p>
</div>
<h2 class="methods">attributes</h2>
<div class="sig">
<h3 id="desc">desc, desc=</h3>
<p><span class="arg">group</span>.desc -> <span class=
"arg">aString</span><br />
<span class="arg">group</span>.desc = <span class=
"arg">aString</span></p>
</div>
<div class="desc">
<h4>Description</h4>Use the <code>desc</code> attribute to
assign a text description to the group.
</div>
<div class="sig">
<h3 id="metadata">metadata, metadata=</h3>
<p><span class="arg">group</span>.metadata -> <span class=
"arg">aString</span><br />
<span class="arg">group</span>.metadata = <span class=
"arg">aString</span></p>
</div>
<div class="desc">
<h4>Description</h4>Use the <code>metadata</code> attribute to
assign additional metadata to the group.
</div>
<div class="sig">
<h3 id="RVG_title">title, title=</h3>
<p><span class="arg">group</span>.title -> <span class=
"arg">aString</span><br />
<span class="arg">group</span>.title = <span class=
"arg">aString</span></p>
</div>
<div class="desc">
<h4>Description</h4>Use the <code>title</code> attribute to
assign a title to the group.
</div>
<h2 class="methods">instance methods</h2>
<div class="sig">
<h3 id='g'>g</h3>
<p><span class="arg">group.</span>g [{|<span class=
"arg">grp</span>| ...}] -> <span class=
"arg">aGroup</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Calls <a href="#new">new</a> to construct a new group and
nests it within the target group. Yields to a block if one is
present, passing the new group as an argument.</p>
<h4>Returns</h4>
<p>Returns the new group, so other methods in this class can be
chained to this method.</p>
</div>
<div class="sig">
<h3 id='image'>image</h3>
<p><span class="arg">group.</span>image(<span class=
"arg">raster_image</span>, <span class="arg">width</span>=nil,
<span class="arg">height</span>=nil, <span class=
"arg">x</span>=0, <span class="arg">y</span>=0) ->
<span class="arg">anImage</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Calls <a href="rvgimage.html#new">RVG::Image.new</a> to
construct an image and adds it to the group.</p>
<h4>Returns</h4>
<p>Returns the new image, so <code>RVG::Image</code> methods
can be chained to this method.</p>
</div>
<div class="sig">
<h3 id="rvg">rvg</h3>
<p><span class="arg">group</span>.rvg(<span class=
"arg">width</span>, <span class="arg">height</span>,
<span class="arg">x</span>=0, <span class="arg">y</span>=0)
[{|<span class="arg">new_rvg</span>| ...}] -> <span class=
"arg">anRVG</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Calls <a href="rvg.html#RVG_new">RVG.new</a> to construct a
new RVG object and adds it to the group. See the <a href=
"rvg.html#RVG_rvg">rvg</a> method in the RVG class.</p>
<h4>Returns</h4>
<p>The <code>RVG</code> object, so other <code>RVG</code>
methods can be chained to this method.</p>
</div>
<div class="sig">
<h3 id='text'>text</h3>
<p><span class="arg">group.</span>text(<span class=
"arg">x</span>=0, <span class="arg">y</span>=0, <span class=
"arg">text</span>=nil) [{|<span class="arg">aText</span>| ...}]
-> <span class="arg">aText</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Calls <a href="rvgtext.html#new">RVG::Text.new</a> to
construct a text object and adds it to the group. Yields to a
block if one is present, passing the new text object as an
argument.</p>
<h4>Returns</h4>
<p>The <code>RVG::Text</code> object, so other
<code>RVG::Text</code> methods can be chained to this
method.</p>
</div>
<div class="sig">
<h3 id="use">use</h3>
<p><span class="arg">group</span>.use(<span class=
"arg">obj</span>, <span class="arg">x</span>=0, <span class=
"arg">y</span>=0, <span class="arg">width</span>=nil,
<span class="arg">height</span>=nil) -> <span class=
"arg">aUse</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Calls <a href="rvguse.html#new">RVG::Use.new</a> to
constructs a <code>use</code> object and adds it to the RVG
object.</p>
<p>When the referenced argument is an RVG object, <span class=
"arg">width</span> and <span class="arg">height</span> can be
used to specify the width and height of the viewport. If
present and non-nil, these arguments override any width and
height specified when the RVG object was created. You must
specify the viewport size either when creating the RVG object
or when referencing it with <code>use</code>.</p>
<h4>Example</h4>
<p>See <a href="rvguse.html#new">RVG::Use.new</a></p>
<h4>Returns</h4>
<p>The <code>RVG::Use</code> object, so other
<code>RVG::Use</code> methods can be chained to this
method.</p>
</div>
<p class="spacer"> </p>
<div class="nav">
« <a href="rvg.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href="rvgimage.html">Next</a>
»
</div>
</body>
</html>