<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXRectangle
— FXRuby API Documentation
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Fox::FXRectangle";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (F)</a> »
<span class='title'><span class='object_link'><a href="../Fox.html" title="Fox (module)">Fox</a></span></span>
»
<span class="title">FXRectangle</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Fox::FXRectangle
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Fox::FXRectangle</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXRectangle.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Rectangle</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#h-instance_method" title="#h (instance method)">#<strong>h</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Rectangle height [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#w-instance_method" title="#w (instance method)">#<strong>w</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Rectangle width [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#x-instance_method" title="#x (instance method)">#<strong>x</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Upper left corner’s x-coordinate [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#y-instance_method" title="#y (instance method)">#<strong>y</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Upper left corner’s y-coordinate [Integer].</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#contains%3F-instance_method" title="#contains? (instance method)">#<strong>contains?</strong>(r) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return true if <em>r</em> (another FXRectangle instance) is properly contained within this rectangle.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#grow!-instance_method" title="#grow! (instance method)">#<strong>grow!</strong>(leftmargin, rightmargin, topmargin, bottommargin) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Grow the rectangle by some amount and return a reference to the rectangle.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(topleft, bottomright) ⇒ FXRectangle </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Return an initialized FXRectangle instance.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#move!-instance_method" title="#move! (instance method)">#<strong>move!</strong>(dx, dy) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Shift each of the rectangle’s corners by the amount (<em>dx</em>, <em>dy</em>) and return a reference to the rectangle.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#shrink!-instance_method" title="#shrink! (instance method)">#<strong>shrink!</strong>(leftmargin, rightmargin, topmargin, bottommargin) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Shrink the rectangle by some amount, and return a reference to the rectangle.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(topleft, bottomright) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXRectangle (class)">FXRectangle</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return an initialized FXRectangle instance.</p>
<h4 id="label-Parameters-3A">Parameters:</h4>
<dl class="rdoc-list note-list"><dt><code>topleft</code>
<dd>
<p>upper left corner’s initial position FXPoint</p>
</dd><dt><code>bottomright</code>
<dd>
<p>bottom right corner’s initial position FXPoint</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRectangle.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="h=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="h-instance_method">
#<strong>h</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Rectangle height [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRectangle.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_h'>h</span>
<span class='ivar'>@h</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="w=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="w-instance_method">
#<strong>w</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Rectangle width [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRectangle.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_w'>w</span>
<span class='ivar'>@w</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="x=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="x-instance_method">
#<strong>x</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Upper left corner’s x-coordinate [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRectangle.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_x'>x</span>
<span class='ivar'>@x</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="y=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="y-instance_method">
#<strong>y</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Upper left corner’s y-coordinate [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRectangle.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_y'>y</span>
<span class='ivar'>@y</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="contains?-instance_method">
#<strong>contains?</strong>(r) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return true if <em>r</em> (another FXRectangle instance) is properly contained within this rectangle.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRectangle.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_contains?'>contains?</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="grow!-instance_method">
#<strong>grow!</strong>(leftmargin, rightmargin, topmargin, bottommargin) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Grow the rectangle by some amount and return a reference to the rectangle.</p>
<h4 id="label-Parameters-3A">Parameters:</h4>
<dl class="rdoc-list note-list"><dt><code>leftmargin</code>
<dd>
<p>number of units to grow on the left side [Integer]</p>
</dd><dt><code>rightmargin</code>
<dd>
<p>number of units to grow on the right side [Integer]</p>
</dd><dt><code>topmargin</code>
<dd>
<p>number of units to grow on the top side [Integer]</p>
</dd><dt><code>bottommargin</code>
<dd>
<p>number of units to grow on the bottom side [Integer]</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
93</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRectangle.rb', line 93</span>
<span class='kw'>def</span> <span class='id identifier rubyid_grow!'>grow!</span><span class='lparen'>(</span><span class='id identifier rubyid_margin'>margin</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="move!-instance_method">
#<strong>move!</strong>(dx, dy) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Shift each of the rectangle’s corners by the amount (<em>dx</em>, <em>dy</em>) and return a reference to the rectangle.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRectangle.rb', line 78</span>
<span class='kw'>def</span> <span class='id identifier rubyid_move!'>move!</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="shrink!-instance_method">
#<strong>shrink!</strong>(leftmargin, rightmargin, topmargin, bottommargin) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Shrink the rectangle by some amount, and return a reference to the rectangle.</p>
<h4 id="label-Parameters-3A">Parameters:</h4>
<dl class="rdoc-list note-list"><dt><code>leftmargin</code>
<dd>
<p>number of units to shrink on the left side [Integer]</p>
</dd><dt><code>rightmargin</code>
<dd>
<p>number of units to shrink on the right side [Integer]</p>
</dd><dt><code>topmargin</code>
<dd>
<p>number of units to shrink on the top side [Integer]</p>
</dd><dt><code>bottommargin</code>
<dd>
<p>number of units to shrink on the bottom side [Integer]</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRectangle.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_shrink!'>shrink!</span><span class='lparen'>(</span><span class='id identifier rubyid_margin'>margin</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:47:53 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.2).
</div>
</div>
</body>
</html>