<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RRTF::PageFormatting
— 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::PageFormatting";
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">PageFormatting</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>Module: RRTF::PageFormatting
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DocumentProperties.html" title="RRTF::DocumentProperties (class)">DocumentProperties</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rrtf/formatting.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Page formatting attributes and methods.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Author:</p>
<ul class="author">
<li>
<div class='inline'>
<p>Wesley Hileman</p>
</div>
</li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>1.0.0</p>
</div>
</li>
</ul>
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="PAGE_ATTRIBUTES-constant" class="">PAGE_ATTRIBUTES =
<div class="docstring">
<div class="discussion">
<p>Formatting attributes that can be applied to an RTF document or a section
in a document.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash<String, Hash></tt>)</span>
—
<div class='inline'>
<p>a hash mapping each attribute to a hash that describes (1) the
attribute's default value, (2) how to parse the attribute from the
user, and (3) how to convert the attribute to an RTF sequence.</p>
</div>
</li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>1.0.0</p>
</div>
</li>
</ul>
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</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='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='symbol'>:portrait</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dictionary</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PORTRAIT</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='symbol'>:portrait</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>LANDSCAPE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='symbol'>:landscape</span>
<span class='rbrace'>}</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\landscape</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>==</span> <span class='symbol'>:landscape</span> <span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>size</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Page.html" title="RRTF::Page (module)">Page</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Page/Size.html" title="RRTF::Page::Size (class)">Size</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Page/Size.html#initialize-instance_method" title="RRTF::Page::Size#initialize (method)">new</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>from_user</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Page.html" title="RRTF::Page (module)">Page</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Page/Size.html" title="RRTF::Page::Size (class)">Size</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Page/Size.html#initialize-instance_method" title="RRTF::Page::Size#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</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='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\paperh</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</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='rbrace'>}</span>
<span class='rbrace'>}</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>margin</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Page.html" title="RRTF::Page (module)">Page</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Page/Margin.html" title="RRTF::Page::Margin (class)">Margin</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Page/Margin.html#initialize-instance_method" title="RRTF::Page::Margin#initialize (method)">new</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>from_user</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Page.html" title="RRTF::Page (module)">Page</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Page/Margin.html" title="RRTF::Page::Margin (class)">Margin</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Page/Margin.html#initialize-instance_method" title="RRTF::Page::Margin#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</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='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_left'>left</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\margr</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_right'>right</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\margt</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_top'>top</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\margb</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_bottom'>bottom</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span>
<span class='rbrace'>}</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='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</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'>from_user</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Utilities.html" title="RRTF::Utilities (class)">Utilities</a></span></span><span class='period'>.</span><span class='id identifier rubyid_value2twips'><span class='object_link'><a href="Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">value2twips</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_lambda'>lambda</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</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='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span>
<span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Generates attribute accessors for all page attributes when the module is
included in another module or class.</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="#body_height-instance_method" title="#body_height (instance method)">#<strong>body_height</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></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'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize_page_formatting-instance_method" title="#initialize_page_formatting (instance method)">#<strong>initialize_page_formatting</strong>(options = {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Initializes page formatting attributes.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#page_formatting_to_rtf-instance_method" title="#page_formatting_to_rtf (instance method)">#<strong>page_formatting_to_rtf</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Generates an RTF string representing all applied page formatting.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#set_page_formatting_from_hashmap-instance_method" title="#set_page_formatting_from_hashmap (instance method)">#<strong>set_page_formatting_from_hashmap</strong>(hash) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets document formatting attributes according to the supplied hashmap.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="included-class_method">
.<strong>included</strong>(base) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Generates attribute accessors for all page attributes when the module is
included in another module or class.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>1.0.0</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
912
913
914
915
916
917
918
919</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 912</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
<span class='comment'># define accessors in base for document attributes
</span> <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
<span class='const'><span class='object_link'><a href="#PAGE_ATTRIBUTES-constant" title="RRTF::PageFormatting::PAGE_ATTRIBUTES (constant)">PAGE_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span> <span class='comment'># each
</span> <span class='kw'>end</span> <span class='comment'># class_eval
</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">
</div>
</div>
<div class="tags">
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>1.0.0</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
981
982
983
984
985
986
987</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 981</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='symbol'>:portrait</span>
<span class='id identifier rubyid_size'>size</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='id identifier rubyid_margin'>margin</span><span class='period'>.</span><span class='id identifier rubyid_top'>top</span> <span class='op'>+</span> <span class='id identifier rubyid_margin'>margin</span><span class='period'>.</span><span class='id identifier rubyid_bottom'>bottom</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_size'>size</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='id identifier rubyid_margin'>margin</span><span class='period'>.</span><span class='id identifier rubyid_left'>left</span> <span class='op'>+</span> <span class='id identifier rubyid_margin'>margin</span><span class='period'>.</span><span class='id identifier rubyid_right'>right</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">
</div>
</div>
<div class="tags">
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>1.0.0</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
973
974
975
976
977
978
979</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 973</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='symbol'>:portrait</span>
<span class='id identifier rubyid_size'>size</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='id identifier rubyid_margin'>margin</span><span class='period'>.</span><span class='id identifier rubyid_left'>left</span> <span class='op'>+</span> <span class='id identifier rubyid_margin'>margin</span><span class='period'>.</span><span class='id identifier rubyid_right'>right</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_size'>size</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='id identifier rubyid_margin'>margin</span><span class='period'>.</span><span class='id identifier rubyid_top'>top</span> <span class='op'>+</span> <span class='id identifier rubyid_margin'>margin</span><span class='period'>.</span><span class='id identifier rubyid_bottom'>bottom</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="initialize_page_formatting-instance_method">
#<strong>initialize_page_formatting</strong>(options = {}) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'>
<p>The behavior of the “gutter” option changes with the document
“facing_pages” setting.</p>
</div>
</div>
<p>Initializes page formatting attributes.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>the document formatting options.</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
<ul class="option">
<li>
<span class="name">"orientation"</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
— default:
<tt>"PORTRAIT"</tt>
</span>
— <div class='inline'>
<p>the orientation of the paper (“PORTRAIT” or “LANDSCAPE”).</p>
</div>
</li>
<li>
<span class="name">"size"</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Page/Size.html" title="RRTF::Page::Size (class)">Page::Size</a></span></tt>)</span>
<span class="default">
— default:
<tt>Page::Size.new</tt>
</span>
— <div class='inline'>
<p>the size of the paper (object or string; see <span class='object_link'><a href="Page/Size.html#initialize-instance_method" title="RRTF::Page::Size#initialize (method)">RRTF::Page::Size#initialize</a></span>).</p>
</div>
</li>
<li>
<span class="name">"margin"</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Page/Margin.html" title="RRTF::Page::Margin (class)">Page::Margin</a></span></tt>)</span>
<span class="default">
— default:
<tt>Page::Margin.new</tt>
</span>
— <div class='inline'>
<p>the paper margin (object or string; see <span class='object_link'><a href="Page/Margin.html#initialize-instance_method" title="RRTF::Page::Margin#initialize (method)">RRTF::Page::Margin#initialize</a></span>).</p>
</div>
</li>
<li>
<span class="name">"gutter"</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>the page gutter width (specify a string, see <span class='object_link'><a href="Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">Utilities.value2twips</a></span>).</p>
</div>
</li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>1.0.0</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
930
931
932
933
934
935
936
937</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 930</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize_page_formatting'>initialize_page_formatting</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 attribute values
</span> <span class='const'><span class='object_link'><a href="#PAGE_ATTRIBUTES-constant" title="RRTF::PageFormatting::PAGE_ATTRIBUTES (constant)">PAGE_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
<span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span> <span class='comment'># each
</span> <span class='comment'># overwrite default attribute values with given values
</span> <span class='id identifier rubyid_set_page_formatting_from_hashmap'>set_page_formatting_from_hashmap</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="page_formatting_to_rtf-instance_method">
#<strong>page_formatting_to_rtf</strong> ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Generates an RTF string representing all applied page formatting.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>RTF string.</p>
</div>
</li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>1.0.0</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
959
960
961
962
963
964
965
966
967
968
969
970
971</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 959</span>
<span class='kw'>def</span> <span class='id identifier rubyid_page_formatting_to_rtf'>page_formatting_to_rtf</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='comment'># accumulate RTF representations of page attributes
</span> <span class='const'><span class='object_link'><a href="#PAGE_ATTRIBUTES-constant" title="RRTF::PageFormatting::PAGE_ATTRIBUTES (constant)">PAGE_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>to_rtf</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='id identifier rubyid_rtf'>rtf</span> <span class='kw'>unless</span> <span class='id identifier rubyid_rtf'>rtf</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>end</span> <span class='comment'># if
</span> <span class='kw'>end</span> <span class='comment'># each
</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 class="method_details ">
<h3 class="signature " id="set_page_formatting_from_hashmap-instance_method">
#<strong>set_page_formatting_from_hashmap</strong>(hash) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Sets document formatting attributes according to the supplied hashmap.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#initialize_page_formatting-instance_method" title="RRTF::PageFormatting#initialize_page_formatting (method)">#initialize_page_formatting</a></span></li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>1.0.0</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
941
942
943
944
945
946
947
948
949
950
951
952
953
954</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 941</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set_page_formatting_from_hashmap'>set_page_formatting_from_hashmap</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='comment'># skip unreconized attributes
</span> <span class='kw'>next</span> <span class='kw'>unless</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#PAGE_ATTRIBUTES-constant" title="RRTF::PageFormatting::PAGE_ATTRIBUTES (constant)">PAGE_ATTRIBUTES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='comment'># preprocess value if nessesary
</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="#PAGE_ATTRIBUTES-constant" title="RRTF::PageFormatting::PAGE_ATTRIBUTES (constant)">PAGE_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>from_user</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#PAGE_ATTRIBUTES-constant" title="RRTF::PageFormatting::PAGE_ATTRIBUTES (constant)">PAGE_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>from_user</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>elsif</span> <span class='const'><span class='object_link'><a href="#PAGE_ATTRIBUTES-constant" title="RRTF::PageFormatting::PAGE_ATTRIBUTES (constant)">PAGE_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dictionary</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#PAGE_ATTRIBUTES-constant" title="RRTF::PageFormatting::PAGE_ATTRIBUTES (constant)">PAGE_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dictionary</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_value'>value</span><span class='rbracket'>]</span>
<span class='kw'>end</span> <span class='comment'># if
</span> <span class='comment'># set attribute value
</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attribute'>attribute</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span> <span class='comment'># each
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jul 31 21:48:57 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>