<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RRTF::Paper
— Documentation by YARD 0.9.9
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "RRTF::Paper";
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 (P)</a> »
<span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
»
<span class="title">Paper</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: RRTF::Paper
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">RRTF::Paper</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rrtf/paper.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class represents a definition for a paper size and provides a set of
class constants for common paper sizes. An instance of the Paper class is
considered immutable after creation.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="A0-constant" class="">A0 =
<div class="docstring">
<div class="discussion">
<p>Definition of an international paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A0</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>47685</span><span class='comma'>,</span> <span class='int'>67416</span><span class='rparen'>)</span></pre></dd>
<dt id="A1-constant" class="">A1 =
<div class="docstring">
<div class="discussion">
<p>Definition of an international paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A1</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>33680</span><span class='comma'>,</span> <span class='int'>47685</span><span class='rparen'>)</span></pre></dd>
<dt id="A2-constant" class="">A2 =
<div class="docstring">
<div class="discussion">
<p>Definition of an international paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A2</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>23814</span><span class='comma'>,</span> <span class='int'>33680</span><span class='rparen'>)</span></pre></dd>
<dt id="A3-constant" class="">A3 =
<div class="docstring">
<div class="discussion">
<p>Definition of an international paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A3</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>16840</span><span class='comma'>,</span> <span class='int'>23814</span><span class='rparen'>)</span></pre></dd>
<dt id="A4-constant" class="">A4 =
<div class="docstring">
<div class="discussion">
<p>Definition of an international paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A4</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>11907</span><span class='comma'>,</span> <span class='int'>16840</span><span class='rparen'>)</span></pre></dd>
<dt id="A5-constant" class="">A5 =
<div class="docstring">
<div class="discussion">
<p>Definition of an international paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A5</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>8392</span><span class='comma'>,</span> <span class='int'>11907</span><span class='rparen'>)</span></pre></dd>
<dt id="LETTER-constant" class="">LETTER =
<div class="docstring">
<div class="discussion">
<p>Definition of a US paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Letter</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>12247</span><span class='comma'>,</span> <span class='int'>15819</span><span class='rparen'>)</span></pre></dd>
<dt id="LEGAL-constant" class="">LEGAL =
<div class="docstring">
<div class="discussion">
<p>Definition of a US paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Legal</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>12247</span><span class='comma'>,</span> <span class='int'>20185</span><span class='rparen'>)</span></pre></dd>
<dt id="EXECUTIVE-constant" class="">EXECUTIVE =
<div class="docstring">
<div class="discussion">
<p>Definition of a US paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Executive</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>10773</span><span class='comma'>,</span> <span class='int'>14402</span><span class='rparen'>)</span></pre></dd>
<dt id="LEDGER_TABLOID-constant" class="">LEDGER_TABLOID =
<div class="docstring">
<div class="discussion">
<p>Definition of a US paper constant.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Paper</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="RRTF::Paper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Ledger/Tabloid</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>15819</span><span class='comma'>,</span> <span class='int'>24494</span><span class='rparen'>)</span></pre></dd>
</dl>
<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="#height-instance_method" title="#height (instance method)">#<strong>height</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#width-instance_method" title="#width (instance method)">#<strong>width</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, width, height) ⇒ Paper </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>This is the constructor for the Paper class.</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>(name, width, height) ⇒ <tt><span class='object_link'><a href="" title="RRTF::Paper (class)">Paper</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>This is the constructor for the Paper class. All dimension parameters to
this method are in twips.</p>
<h4 id="label-Parameters">Parameters</h4>
<dl class="rdoc-list note-list"><dt>name
<dd>
<p>The name for the paper object.</p>
</dd><dt>width
<dd>
<p>The width of the paper in portrait mode.</p>
</dd><dt>height
<dd>
<p>The height of the paper in portrait mode.</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/paper.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_width'>width</span><span class='comma'>,</span> <span class='id identifier rubyid_height'>height</span><span class='rparen'>)</span>
<span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@width</span> <span class='op'>=</span> <span class='id identifier rubyid_width'>width</span>
<span class='ivar'>@height</span> <span class='op'>=</span> <span class='id identifier rubyid_height'>height</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=""></span>
<div class="method_details first">
<h3 class="signature first" id="height-instance_method">
#<strong>height</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/paper.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_height'>height</span>
<span class='ivar'>@height</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
#<strong>name</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/paper.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="width-instance_method">
#<strong>width</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/paper.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_width'>width</span>
<span class='ivar'>@width</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jul 24 15:49:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.3.3).
</div>
</div>
</body>
</html>