<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RRTF::DocumentStyle
— 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::DocumentStyle";
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 (D)</a> »
<span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
»
<span class="title">DocumentStyle</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::DocumentStyle
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></li>
<li class="next">RRTF::DocumentStyle</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rrtf/style/document_style.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class represents styling attributes that are to be applied at the
document level.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="PORTRAIT-constant" class="">PORTRAIT =
<div class="docstring">
<div class="discussion">
<p>Definition for a document orientation setting.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='symbol'>:portrait</span></pre></dd>
<dt id="LANDSCAPE-constant" class="">LANDSCAPE =
<div class="docstring">
<div class="discussion">
<p>Definition for a document orientation setting.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='symbol'>:landscape</span></pre></dd>
<dt id="DEFAULT_LEFT_MARGIN-constant" class="">DEFAULT_LEFT_MARGIN =
<div class="docstring">
<div class="discussion">
<p>Definition for a default margin setting.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>1800</span></pre></dd>
<dt id="DEFAULT_RIGHT_MARGIN-constant" class="">DEFAULT_RIGHT_MARGIN =
<div class="docstring">
<div class="discussion">
<p>Definition for a default margin setting.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>1800</span></pre></dd>
<dt id="DEFAULT_TOP_MARGIN-constant" class="">DEFAULT_TOP_MARGIN =
<div class="docstring">
<div class="discussion">
<p>Definition for a default margin setting.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>1440</span></pre></dd>
<dt id="DEFAULT_BOTTOM_MARGIN-constant" class="">DEFAULT_BOTTOM_MARGIN =
<div class="docstring">
<div class="discussion">
<p>Definition for a default margin setting.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>1440</span></pre></dd>
<dt id="STYLESHEET_SORT_NAME-constant" class="">STYLESHEET_SORT_NAME =
<div class="docstring">
<div class="discussion">
<p>stylesheet sorting codes</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>0</span></pre></dd>
<dt id="STYLESHEET_SORT_DEFAULT-constant" class="">STYLESHEET_SORT_DEFAULT =
<div class="docstring">
<div class="discussion">
<p>stylesheet styles sorted by name</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>1</span></pre></dd>
<dt id="STYLESHEET_SORT_FONT-constant" class="">STYLESHEET_SORT_FONT =
<div class="docstring">
<div class="discussion">
<p>stylesheet styles sorted by system default</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>2</span></pre></dd>
<dt id="STYLESHEET_SORT_BASEDON-constant" class="">STYLESHEET_SORT_BASEDON =
<div class="docstring">
<div class="discussion">
<p>stylesheet styles sorted by font</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>3</span></pre></dd>
<dt id="STYLESHEET_SORT_TYPE-constant" class="">STYLESHEET_SORT_TYPE =
<div class="docstring">
<div class="discussion">
<p>stylesheet styles sorted by based-on fonts</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>4</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="#bottom_margin-instance_method" title="#bottom_margin (instance method)">#<strong>bottom_margin</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#gutter-instance_method" title="#gutter (instance method)">#<strong>gutter</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#left_margin-instance_method" title="#left_margin (instance method)">#<strong>left_margin</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#orientation-instance_method" title="#orientation (instance method)">#<strong>orientation</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#paper-instance_method" title="#paper (instance method)">#<strong>paper</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#right_margin-instance_method" title="#right_margin (instance method)">#<strong>right_margin</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stylesheet_sort-instance_method" title="#stylesheet_sort (instance method)">#<strong>stylesheet_sort</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#top_margin-instance_method" title="#top_margin (instance method)">#<strong>top_margin</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Style.html#additive-instance_method" title="RRTF::Style#additive (method)">#additive</a></span>, <span class='object_link'><a href="Style.html#auto_update-instance_method" title="RRTF::Style#auto_update (method)">#auto_update</a></span>, <span class='object_link'><a href="Style.html#based_on_style_handle-instance_method" title="RRTF::Style#based_on_style_handle (method)">#based_on_style_handle</a></span>, <span class='object_link'><a href="Style.html#handle-instance_method" title="RRTF::Style#handle (method)">#handle</a></span>, <span class='object_link'><a href="Style.html#hidden-instance_method" title="RRTF::Style#hidden (method)">#hidden</a></span>, <span class='object_link'><a href="Style.html#name-instance_method" title="RRTF::Style#name (method)">#name</a></span>, <span class='object_link'><a href="Style.html#next_style_handle-instance_method" title="RRTF::Style#next_style_handle (method)">#next_style_handle</a></span>, <span class='object_link'><a href="Style.html#primary-instance_method" title="RRTF::Style#primary (method)">#primary</a></span>, <span class='object_link'><a href="Style.html#priority-instance_method" title="RRTF::Style#priority (method)">#priority</a></span></p>
<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="#body_height-instance_method" title="#body_height (instance method)">#<strong>body_height</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method fetches the height of the available work area space for a
DocumentStyle object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#body_width-instance_method" title="#body_width (instance method)">#<strong>body_width</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method fetches the width of the available work area space for a
DocumentStyle object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {}) ⇒ DocumentStyle </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>This is a constructor for the DocumentStyle class.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#is_document_style%3F-instance_method" title="#is_document_style? (instance method)">#<strong>is_document_style?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method overrides the is_document_style? method inherited from the
Style class to always return true.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prefix-instance_method" title="#prefix (instance method)">#<strong>prefix</strong>(fonts = nil, colours = nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method generates a string containing the prefix associated with a
style object.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Style.html#is_character_style%3F-instance_method" title="RRTF::Style#is_character_style? (method)">#is_character_style?</a></span>, <span class='object_link'><a href="Style.html#is_paragraph_style%3F-instance_method" title="RRTF::Style#is_paragraph_style? (method)">#is_paragraph_style?</a></span>, <span class='object_link'><a href="Style.html#is_table_style%3F-instance_method" title="RRTF::Style#is_table_style? (method)">#is_table_style?</a></span>, <span class='object_link'><a href="Style.html#rtf_formatting-instance_method" title="RRTF::Style#rtf_formatting (method)">#rtf_formatting</a></span>, <span class='object_link'><a href="Style.html#styledef-instance_method" title="RRTF::Style#styledef (method)">#styledef</a></span>, <span class='object_link'><a href="Style.html#stylename-instance_method" title="RRTF::Style#stylename (method)">#stylename</a></span>, <span class='object_link'><a href="Style.html#suffix-instance_method" title="RRTF::Style#suffix (method)">#suffix</a></span>, <span class='object_link'><a href="Style.html#to_rtf-instance_method" title="RRTF::Style#to_rtf (method)">#to_rtf</a></span></p>
<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>(options = {}) ⇒ <tt><span class='object_link'><a href="" title="RRTF::DocumentStyle (class)">DocumentStyle</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>This is a constructor for the DocumentStyle class. This creates a document
style with a default paper setting of LETTER and portrait orientation (all
other attributes are nil).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='comment'># load default options
</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>paper_size</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="Paper.html" title="RRTF::Paper (class)">Paper</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Paper.html#LETTER-constant" title="RRTF::Paper::LETTER (constant)">LETTER</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>left_margin</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="#DEFAULT_LEFT_MARGIN-constant" title="RRTF::DocumentStyle::DEFAULT_LEFT_MARGIN (constant)">DEFAULT_LEFT_MARGIN</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>right_margin</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="#DEFAULT_RIGHT_MARGIN-constant" title="RRTF::DocumentStyle::DEFAULT_RIGHT_MARGIN (constant)">DEFAULT_RIGHT_MARGIN</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>top_margin</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="#DEFAULT_TOP_MARGIN-constant" title="RRTF::DocumentStyle::DEFAULT_TOP_MARGIN (constant)">DEFAULT_TOP_MARGIN</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bottom_margin</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="#DEFAULT_BOTTOM_MARGIN-constant" title="RRTF::DocumentStyle::DEFAULT_BOTTOM_MARGIN (constant)">DEFAULT_BOTTOM_MARGIN</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>gutter</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>orientation</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="#PORTRAIT-constant" title="RRTF::DocumentStyle::PORTRAIT (constant)">PORTRAIT</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>stylesheet_sort</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="#STYLESHEET_SORT_DEFAULT-constant" title="RRTF::DocumentStyle::STYLESHEET_SORT_DEFAULT (constant)">STYLESHEET_SORT_DEFAULT</a></span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='ivar'>@paper</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>paper_size</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@left_margin</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>left_margin</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@right_margin</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>right_margin</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@top_margin</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>top_margin</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@bottom_margin</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bottom_margin</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@gutter</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>gutter</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@orientation</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>orientation</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@stylesheet_sort</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>stylesheet_sort</span><span class='tstring_end'>"</span></span><span class='rparen'>)</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="bottom_margin=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="bottom_margin-instance_method">
#<strong>bottom_margin</strong> ⇒ <tt>Object</tt>
</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">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bottom_margin'>bottom_margin</span>
<span class='ivar'>@bottom_margin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="gutter=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="gutter-instance_method">
#<strong>gutter</strong> ⇒ <tt>Object</tt>
</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">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_gutter'>gutter</span>
<span class='ivar'>@gutter</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="left_margin=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="left_margin-instance_method">
#<strong>left_margin</strong> ⇒ <tt>Object</tt>
</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">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_left_margin'>left_margin</span>
<span class='ivar'>@left_margin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="orientation=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="orientation-instance_method">
#<strong>orientation</strong> ⇒ <tt>Object</tt>
</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">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_orientation'>orientation</span>
<span class='ivar'>@orientation</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="paper=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="paper-instance_method">
#<strong>paper</strong> ⇒ <tt>Object</tt>
</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">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_paper'>paper</span>
<span class='ivar'>@paper</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="right_margin=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="right_margin-instance_method">
#<strong>right_margin</strong> ⇒ <tt>Object</tt>
</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">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_right_margin'>right_margin</span>
<span class='ivar'>@right_margin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="stylesheet_sort=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="stylesheet_sort-instance_method">
#<strong>stylesheet_sort</strong> ⇒ <tt>Object</tt>
</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">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stylesheet_sort'>stylesheet_sort</span>
<span class='ivar'>@stylesheet_sort</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="top_margin=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="top_margin-instance_method">
#<strong>top_margin</strong> ⇒ <tt>Object</tt>
</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">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_top_margin'>top_margin</span>
<span class='ivar'>@top_margin</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="body_height-instance_method">
#<strong>body_height</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method fetches the height of the available work area space for a
DocumentStyle object.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
108
109
110
111
112
113
114</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 108</span>
<span class='kw'>def</span> <span class='id identifier rubyid_body_height'>body_height</span>
<span class='kw'>if</span> <span class='id identifier rubyid_orientation'>orientation</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#PORTRAIT-constant" title="RRTF::DocumentStyle::PORTRAIT (constant)">PORTRAIT</a></span></span>
<span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@top_margin</span> <span class='op'>+</span> <span class='ivar'>@bottom_margin</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@top_margin</span> <span class='op'>+</span> <span class='ivar'>@bottom_margin</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="body_width-instance_method">
#<strong>body_width</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method fetches the width of the available work area space for a
DocumentStyle object.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98
99
100
101
102
103
104</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 98</span>
<span class='kw'>def</span> <span class='id identifier rubyid_body_width'>body_width</span>
<span class='kw'>if</span> <span class='id identifier rubyid_orientation'>orientation</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#PORTRAIT-constant" title="RRTF::DocumentStyle::PORTRAIT (constant)">PORTRAIT</a></span></span>
<span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@left_margin</span> <span class='op'>+</span> <span class='ivar'>@right_margin</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@left_margin</span> <span class='op'>+</span> <span class='ivar'>@right_margin</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="is_document_style?-instance_method">
#<strong>is_document_style?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method overrides the is_document_style? method inherited from the
Style class to always return true.</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">
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_is_document_style?'>is_document_style?</span>
<span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="prefix-instance_method">
#<strong>prefix</strong>(fonts = nil, colours = nil) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method generates a string containing the prefix associated with a
style object.</p>
<h4 id="label-Parameters">Parameters</h4>
<dl class="rdoc-list note-list"><dt>document
<dd>
<p>A reference to the document using the style.</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 75</span>
<span class='kw'>def</span> <span class='id identifier rubyid_prefix'>prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_fonts'>fonts</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_colours'>colours</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\stylesortmethod</span><span class='embexpr_beg'>#{</span><span class='ivar'>@stylesheet_sort</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@stylesheet_sort</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>if</span> <span class='id identifier rubyid_orientation'>orientation</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#LANDSCAPE-constant" title="RRTF::DocumentStyle::LANDSCAPE (constant)">LANDSCAPE</a></span></span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\paperw</span><span class='embexpr_beg'>#{</span><span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\paperh</span><span class='embexpr_beg'>#{</span><span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\paperw</span><span class='embexpr_beg'>#{</span><span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\paperh</span><span class='embexpr_beg'>#{</span><span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\margl</span><span class='embexpr_beg'>#{</span><span class='ivar'>@left_margin</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@left_margin</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\margr</span><span class='embexpr_beg'>#{</span><span class='ivar'>@right_margin</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@right_margin</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\margt</span><span class='embexpr_beg'>#{</span><span class='ivar'>@top_margin</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@top_margin</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\margb</span><span class='embexpr_beg'>#{</span><span class='ivar'>@bottom_margin</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@bottom_margin</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\gutter</span><span class='embexpr_beg'>#{</span><span class='ivar'>@gutter</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@gutter</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>\sectd\lndscpsxn</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='ivar'>@orientation</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#LANDSCAPE-constant" title="RRTF::DocumentStyle::LANDSCAPE (constant)">LANDSCAPE</a></span></span>
<span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jul 24 15:49:02 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>