Skip to content

Commit dbc23f9

Browse files
Watson1978Watson1978
authored
Update documents (#7)
rmagick/rmagick#1402
1 parent dd079f7 commit dbc23f9

27 files changed

+23110
-24673
lines changed

‎comtasks.html

Lines changed: 225 additions & 250 deletions
Large diffs are not rendered by default.

‎constants.html

Lines changed: 908 additions & 1009 deletions
Large diffs are not rendered by default.

‎draw.html

Lines changed: 2072 additions & 2185 deletions
Large diffs are not rendered by default.

‎ilist.html

Lines changed: 1362 additions & 1449 deletions
Large diffs are not rendered by default.

‎image1.html

Lines changed: 3143 additions & 3246 deletions
Large diffs are not rendered by default.

‎image2.html

Lines changed: 2446 additions & 2453 deletions
Large diffs are not rendered by default.

‎image3.html

Lines changed: 3020 additions & 3142 deletions
Large diffs are not rendered by default.

‎imageattrs.html

Lines changed: 1050 additions & 1075 deletions
Large diffs are not rendered by default.

‎imusage.html

Lines changed: 386 additions & 422 deletions
Large diffs are not rendered by default.

‎index.html

Lines changed: 317 additions & 349 deletions
Large diffs are not rendered by default.

‎info.html

Lines changed: 995 additions & 1083 deletions
Large diffs are not rendered by default.

‎magick.html

Lines changed: 310 additions & 348 deletions
Large diffs are not rendered by default.

‎optequiv.html

Lines changed: 1815 additions & 2019 deletions
Large diffs are not rendered by default.

‎rvg.html

Lines changed: 644 additions & 695 deletions
Large diffs are not rendered by default.

‎rvgclip.html

Lines changed: 199 additions & 220 deletions
Large diffs are not rendered by default.

‎rvggroup.html

Lines changed: 205 additions & 224 deletions
Large diffs are not rendered by default.

‎rvgimage.html

Lines changed: 179 additions & 211 deletions
Large diffs are not rendered by default.

‎rvgpattern.html

Lines changed: 305 additions & 359 deletions
Large diffs are not rendered by default.

‎rvgshape.html

Lines changed: 283 additions & 301 deletions
Large diffs are not rendered by default.

‎rvgstyle.html

Lines changed: 191 additions & 212 deletions
Large diffs are not rendered by default.

‎rvgtext.html

Lines changed: 336 additions & 365 deletions
Large diffs are not rendered by default.

‎rvgtspan.html

Lines changed: 165 additions & 182 deletions
Large diffs are not rendered by default.

‎rvgtut.html

Lines changed: 377 additions & 424 deletions
Large diffs are not rendered by default.

‎rvguse.html

Lines changed: 118 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -1,145 +1,121 @@
1-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
32

43
<html xmlns="http://www.w3.org/1999/xhtml">
5-
<head>
6-
<meta name="generator" content=
7-
"HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
8-
9-
<title>RMagick 5.2.0: RVG Reference: RVG::Use Class</title>
10-
<meta http-equiv="Content-Type" content=
11-
"text/html; charset=us-ascii" />
12-
<meta name="GENERATOR" content="Quanta Plus" />
13-
<meta name="Copyright" content=
14-
"Copyright (C) 2006 by Timothy P. Hunter" />
15-
<link rel="stylesheet" type="text/css" href="css/doc.css" />
16-
<script type="text/javascript" src="scripts/doc.js">
17-
</script>
18-
<script type="text/javascript">
19-
//<![CDATA[
20-
//]]>
21-
</script>
22-
<style type="text/css">
23-
/*<![CDATA[*/
24-
}
25-
/*]]>*/
26-
</style>
27-
</head>
28-
29-
<body>
30-
<h6 id="header">RMagick 5.2.0 User's Guide and Reference</h6>
31-
32-
<div class="nav">
33-
&laquo;&nbsp;<a href="rvgtspan.html">Prev</a> | <a href=
34-
"index.html">Contents</a> | <a href=
35-
"rvgstyle.html">Next</a>&nbsp;&raquo;
36-
</div>
37-
38-
<h1>class RVG::Use <span class="superclass">&lt;
39-
Object</span></h1>
40-
41-
<div id="toc">
42-
<h2>Table of Contents</h2>
43-
44-
<h3>class methods</h3>
45-
46-
<ul>
47-
<li><a href="#new">new</a></li>
48-
</ul>
49-
50-
<h3>shared methods</h3>
51-
52-
<p>This class implements the <a href="rvgstyle.html">styles</a>
53-
method and the <a href="rvgxform.html">transform
54-
methods</a>.</p>
55-
</div>
56-
57-
<h2 class="methods">class methods</h2>
58-
59-
<div class="sig">
60-
<h3 id="new">new</h3>
61-
62-
<p>RVG::Use.new(<span class="arg">obj</span>, <span class=
63-
"arg">x</span>=0, <span class="arg">y</span>=0, <span class=
64-
"arg">width</span>=nil, <span class=
65-
"arg">height</span>=nil)-&gt; <em>use</em></p>
66-
</div>
67-
68-
<div class="desc">
69-
<h4>Description</h4>
70-
71-
<p>This method is usually invoked indirectly via the
72-
<code>use</code> method in the <a href=
73-
"rvg.html#RVG_use">RVG</a>, <a href=
74-
"rvgclip.html#use">RVG::ClipPath</a>, <a href=
75-
"rvggroup.html#use">RVG::Group</a>, and <a href=
76-
"rvgpattern.html#use">RVG::Pattern</a> classes.</p>
77-
78-
<p>The use object is similar to a group. Any styles specified
79-
on the use will propagate to the referenced object. However,
80-
styles on the referenced object will override the styles
81-
specified on the RVG::Use object.</p>
82-
83-
<h4>Arguments</h4>
84-
85-
<dl>
86-
<dt>obj</dt>
87-
88-
<dd>The object to be re-used. This is typically a <a href=
89-
"rvggroup.html#new">group</a> or <a href=
90-
"rvg.html#RVG_new">RVG object</a> but can also be any
91-
<a href="rvgshape.html">shape</a>, <a href=
92-
"rvgtext.html#new">text</a>, or <a href=
93-
"rvgimage.html#new">raster image</a>, or even another
94-
<code>use</code>.</dd>
95-
96-
<dt>x, y</dt>
97-
98-
<dd>These arguments can be used to specify an additional
99-
<strong>translate</strong> transformation to be applied to
100-
the object within the user coordinate system.</dd>
101-
102-
<dt>width, height</dt>
103-
104-
<dd>The width and height of the rectangular region in which
105-
this object is placed. These arguments are ignored unless
106-
object is an RVG object. In this case, the values of
107-
<span class="arg">width</span> and <span class=
108-
"arg">height</span> override the values of the width and
109-
height arguments that were specified when the RVG object was
110-
created.</dd>
111-
</dl>
112-
113-
<h4>Example</h4>
114-
115-
<p><strong>A simple 'use' on a 'rect'</strong><a href=
116-
"javascript:popup('Use01.rb.html')"><img src="ex/Use01.gif"
117-
title="Click to see the example script" alt=
118-
"use example" /></a></p>
119-
120-
<p><strong>What happens when a 'use' has chained transform
121-
methods</strong><a href=
122-
"javascript:popup('Use03.rb.html')"><img src="ex/Use03.gif"
123-
title="Click to see the example script" alt=
124-
"use example" /></a></p>
125-
126-
<p><strong>What happens when a 'use' has a chained 'style'
127-
method</strong><a href=
128-
"javascript:popup('Use02.rb.html')"><img src="ex/Use02.gif"
129-
title="Click to see the example script" alt=
130-
"use example" /></a></p>
131-
132-
<p>Also see the example for <a href=
133-
"rvg.html#RVG_new">RVG.new</a> and the example for <a href=
134-
"rvggroup.html#new">RVG::Group.new</a>.</p>
135-
</div>
136-
137-
<p class="spacer">&nbsp;</p>
138-
139-
<div class="nav">
140-
&laquo;&nbsp;<a href="rvgtspan.html">Prev</a> | <a href=
141-
"index.html">Contents</a> | <a href=
142-
"rvgstyle.html">Next</a>&nbsp;&raquo;
143-
</div>
144-
</body>
4+
<head>
5+
<meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
6+
7+
<title>RMagick 5.2.0: RVG Reference: RVG::Use Class</title>
8+
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
9+
<meta name="GENERATOR" content="Quanta Plus" />
10+
<meta name="Copyright" content="Copyright (C) 2006 by Timothy P. Hunter" />
11+
<link rel="stylesheet" type="text/css" href="css/doc.css" />
12+
<script type="text/javascript" src="scripts/doc.js"></script>
13+
<script type="text/javascript">
14+
//<![CDATA[
15+
//]]>
16+
</script>
17+
<style type="text/css">
18+
/*<![CDATA[*/
19+
}
20+
/*]]>*/
21+
</style>
22+
</head>
23+
24+
<body>
25+
<h6 id="header">RMagick 5.2.0 User's Guide and Reference</h6>
26+
27+
<div class="nav">&laquo;&nbsp;<a href="rvgtspan.html">Prev</a> | <a href="index.html">Contents</a> | <a href="rvgstyle.html">Next</a>&nbsp;&raquo;</div>
28+
29+
<h1>class RVG::Use <span class="superclass">&lt; Object</span></h1>
30+
31+
<div id="toc">
32+
<h2>Table of Contents</h2>
33+
34+
<h3>class methods</h3>
35+
36+
<ul>
37+
<li><a href="#new">new</a></li>
38+
</ul>
39+
40+
<h3>shared methods</h3>
41+
42+
<p>This class implements the <a href="rvgstyle.html">styles</a> method and the <a href="rvgxform.html">transform methods</a>.</p>
43+
</div>
44+
45+
<h2 class="methods">class methods</h2>
46+
47+
<div class="sig">
48+
<h3 id="new">new</h3>
49+
50+
<p>
51+
RVG::Use.new(<span class="arg">obj</span>, <span class="arg">x</span>=0, <span class="arg">y</span>=0, <span class="arg">width</span>=nil,
52+
<span class="arg">height</span>=nil)-&gt; <em>use</em>
53+
</p>
54+
</div>
55+
56+
<div class="desc">
57+
<h4>Description</h4>
58+
59+
<p>
60+
This method is usually invoked indirectly via the
61+
<code>use</code> method in the <a href="rvg.html#RVG_use">RVG</a>, <a href="rvgclip.html#use">RVG::ClipPath</a>,
62+
<a href="rvggroup.html#use">RVG::Group</a>, and <a href="rvgpattern.html#use">RVG::Pattern</a> classes.
63+
</p>
64+
65+
<p>
66+
The use object is similar to a group. Any styles specified on the use will propagate to the referenced object. However, styles on the referenced object
67+
will override the styles specified on the RVG::Use object.
68+
</p>
69+
70+
<h4>Arguments</h4>
71+
72+
<dl>
73+
<dt>obj</dt>
74+
75+
<dd>
76+
The object to be re-used. This is typically a
77+
<a href="rvggroup.html#new">group</a> or <a href="rvg.html#RVG_new">RVG object</a> but can also be any <a href="rvgshape.html">shape</a>,
78+
<a href="rvgtext.html#new">text</a>, or <a href="rvgimage.html#new">raster image</a>, or even another <code>use</code>.
79+
</dd>
80+
81+
<dt>x, y</dt>
82+
83+
<dd>
84+
These arguments can be used to specify an additional
85+
<strong>translate</strong> transformation to be applied to the object within the user coordinate system.
86+
</dd>
87+
88+
<dt>width, height</dt>
89+
90+
<dd>
91+
The width and height of the rectangular region in which this object is placed. These arguments are ignored unless object is an RVG object. In this
92+
case, the values of <span class="arg">width</span> and <span class="arg">height</span> override the values of the width and height arguments that were
93+
specified when the RVG object was created.
94+
</dd>
95+
</dl>
96+
97+
<h4>Example</h4>
98+
99+
<p>
100+
<strong>A simple 'use' on a 'rect'</strong
101+
><a href="javascript:popup('Use01.rb.html')"><img src="ex/Use01.gif" title="Click to see the example script" alt="use example" /></a>
102+
</p>
103+
104+
<p>
105+
<strong>What happens when a 'use' has chained transform methods</strong
106+
><a href="javascript:popup('Use03.rb.html')"><img src="ex/Use03.gif" title="Click to see the example script" alt="use example" /></a>
107+
</p>
108+
109+
<p>
110+
<strong>What happens when a 'use' has a chained 'style' method</strong
111+
><a href="javascript:popup('Use02.rb.html')"><img src="ex/Use02.gif" title="Click to see the example script" alt="use example" /></a>
112+
</p>
113+
114+
<p>Also see the example for <a href="rvg.html#RVG_new">RVG.new</a> and the example for <a href="rvggroup.html#new">RVG::Group.new</a>.</p>
115+
</div>
116+
117+
<p class="spacer">&nbsp;</p>
118+
119+
<div class="nav">&laquo;&nbsp;<a href="rvgtspan.html">Prev</a> | <a href="index.html">Contents</a> | <a href="rvgstyle.html">Next</a>&nbsp;&raquo;</div>
120+
</body>
145121
</html>

0 commit comments

Comments
 (0)