<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RRTF::ParagraphStyle
— 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::ParagraphStyle";
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">ParagraphStyle</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::ParagraphStyle
</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="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></li>
<li class="next"><span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></li>
<li class="next">RRTF::ParagraphStyle</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="CharacterFormatting.html" title="RRTF::CharacterFormatting (module)">CharacterFormatting</a></span>, <span class='object_link'><a href="ParagraphFormatting.html" title="RRTF::ParagraphFormatting (module)">ParagraphFormatting</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rrtf/style/paragraph_style.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'>
<p>paragraphs can be styled with character commands in addition to paragraph
commands, thus this class includes both paragraph & character
formatting modules.</p>
</div>
</div>
<p>This class represents a styling for a paragraph within an RTF document.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="CharacterFormatting.html" title="RRTF::CharacterFormatting (module)">CharacterFormatting</a></span></h3>
<p class="inherited"><span class='object_link'><a href="CharacterFormatting.html#CHARACTER_ATTRIBUTES-constant" title="RRTF::CharacterFormatting::CHARACTER_ATTRIBUTES (constant)">CharacterFormatting::CHARACTER_ATTRIBUTES</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="ParagraphFormatting.html" title="RRTF::ParagraphFormatting (module)">ParagraphFormatting</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ParagraphFormatting.html#PARAGRAPH_ATTRIBUTES-constant" title="RRTF::ParagraphFormatting::PARAGRAPH_ATTRIBUTES (constant)">RRTF::ParagraphFormatting::PARAGRAPH_ATTRIBUTES</a></span></p>
<h2>Instance Attribute Summary</h2>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {}) ⇒ ParagraphStyle </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>This is the constructor for the CharacterStyle class.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prefix-instance_method" title="#prefix (instance method)">#<strong>prefix</strong>(document) ⇒ 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>
<li class="public ">
<span class="summary_signature">
<a href="#rtf_formatting-instance_method" title="#rtf_formatting (instance method)">#<strong>rtf_formatting</strong>(document) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong>(document, options = {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Converts the stylesheet paragraph style into its RTF representation.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="CharacterFormatting.html" title="RRTF::CharacterFormatting (module)">CharacterFormatting</a></span></h3>
<p class="inherited"><span class='object_link'><a href="CharacterFormatting.html#character_formatting_to_rtf-instance_method" title="RRTF::CharacterFormatting#character_formatting_to_rtf (method)">#character_formatting_to_rtf</a></span>, <span class='object_link'><a href="CharacterFormatting.html#included-class_method" title="RRTF::CharacterFormatting.included (method)">included</a></span>, <span class='object_link'><a href="CharacterFormatting.html#initialize_character_formatting-instance_method" title="RRTF::CharacterFormatting#initialize_character_formatting (method)">#initialize_character_formatting</a></span>, <span class='object_link'><a href="CharacterFormatting.html#set_character_formatting_from_hashmap-instance_method" title="RRTF::CharacterFormatting#set_character_formatting_from_hashmap (method)">#set_character_formatting_from_hashmap</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ParagraphFormatting.html" title="RRTF::ParagraphFormatting (module)">ParagraphFormatting</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ParagraphFormatting.html#included-class_method" title="RRTF::ParagraphFormatting.included (method)">included</a></span>, <span class='object_link'><a href="ParagraphFormatting.html#initialize_paragraph_formatting-instance_method" title="RRTF::ParagraphFormatting#initialize_paragraph_formatting (method)">#initialize_paragraph_formatting</a></span>, <span class='object_link'><a href="ParagraphFormatting.html#paragraph_formatting_to_rtf-instance_method" title="RRTF::ParagraphFormatting#paragraph_formatting_to_rtf (method)">#paragraph_formatting_to_rtf</a></span>, <span class='object_link'><a href="ParagraphFormatting.html#set_paragraph_formatting_from_hashmap-instance_method" title="RRTF::ParagraphFormatting#set_paragraph_formatting_from_hashmap (method)">#set_paragraph_formatting_from_hashmap</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></h3>
<p class="inherited"><span class='object_link'><a href="AnonymousStyle.html#push_colours-instance_method" title="RRTF::AnonymousStyle#push_colours (method)">#push_colours</a></span>, <span class='object_link'><a href="AnonymousStyle.html#push_fonts-instance_method" title="RRTF::AnonymousStyle#push_fonts (method)">#push_fonts</a></span>, <span class='object_link'><a href="AnonymousStyle.html#suffix-instance_method" title="RRTF::AnonymousStyle#suffix (method)">#suffix</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::ParagraphStyle (class)">ParagraphStyle</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>This is the constructor for the CharacterStyle class.</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 character style options.</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
<ul class="option">
<li>
<span class="name">"name"</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>human-readable name for the style.</p>
</div>
</li>
<li>
<span class="name">"handle"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>16-bit integer that identifies the style in a document.</p>
</div>
</li>
<li>
<span class="name">"next_style_handle"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>16-bit integer that identifies the next style for this style.</p>
</div>
</li>
<li>
<span class="name">"based_on_style_handle"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>16-bit integer that identifies the base style for this style.</p>
</div>
</li>
<li>
<span class="name">"priority"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>16-bit integer that indicates the ordering of the style among other styles
in a document.</p>
</div>
</li>
<li>
<span class="name">"primary"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>false</tt>
</span>
— <div class='inline'>
<p>whether or not this style is a primary or “quick” style.</p>
</div>
</li>
<li>
<span class="name">"additive"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>false</tt>
</span>
— <div class='inline'>
<p>whether or not this character style is additive to the current paragraph
style.</p>
</div>
</li>
<li>
<span class="name">"auto_update"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>false</tt>
</span>
— <div class='inline'>
<p>whether or not this style should be updated when any node to which the
style is applied is updated.</p>
</div>
</li>
<li>
<span class="name">"hidden"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>false</tt>
</span>
— <div class='inline'>
<p>whether or not the style should be hidden.</p>
</div>
</li>
<li>
<span class="name">"bold"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable bold (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"italic"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable italic (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"underline"</span>
<span class="type">(<tt>Boolean</tt>, <tt>String</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable underline (nil to remain same); can also be a string (see
<span class='object_link'><a href="CharacterFormatting.html#CHARACTER_ATTRIBUTES-constant" title="RRTF::CharacterFormatting::CHARACTER_ATTRIBUTES (constant)">CharacterFormatting::CHARACTER_ATTRIBUTES</a></span>).</p>
</div>
</li>
<li>
<span class="name">"uppercase"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable all caps (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"superscript"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable superscript (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"subscript"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable subscript (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"strike"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable single line-through (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"emboss"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable emboss (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"imprint"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable imprint (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"outline"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable outline (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"text_hidden"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable hidden (nil to remain same).</p>
</div>
</li>
<li>
<span class="name">"kerning"</span>
<span class="type">(<tt>Boolean</tt>, <tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable kerning (nil to remain same); to enable specify the font
size in half-points above which kerining will be applied.</p>
</div>
</li>
<li>
<span class="name">"character_spacing_offset"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>quarter points by which to expand or compress character spacing (negative
for compress).</p>
</div>
</li>
<li>
<span class="name">"foreground_color"</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>colour to apply to the foreground (text); see <span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">Colour.from_string</a></span> for
string format.</p>
</div>
</li>
<li>
<span class="name">"background_color"</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>colour to apply to the background; see <span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">Colour.from_string</a></span> for string
format.</p>
</div>
</li>
<li>
<span class="name">"underline_color"</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>colour to apply to the underline; see <span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">Colour.from_string</a></span> for string
format.</p>
</div>
</li>
<li>
<span class="name">"highlight_color"</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>colour with which to highlight text.</p>
</div>
</li>
<li>
<span class="name">"font"</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Font.html" title="RRTF::Font (class)">Font</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>font to apply to text; see <span class='object_link'><a href="Font.html#from_string-class_method" title="RRTF::Font.from_string (method)">Font.from_string</a></span> for string format.</p>
</div>
</li>
<li>
<span class="name">"font_size"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>font size in half-points.</p>
</div>
</li>
<li>
<span class="name">"justification"</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
— default:
<tt>'LEFT'</tt>
</span>
— <div class='inline'>
<p>the paragraph justification ('LEFT',
'CENTER'/'CENTRE', 'RIGHT', or 'FULL').</p>
</div>
</li>
<li>
<span class="name">"left_indent"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>the left indent of the paragraph (twentieth points).</p>
</div>
</li>
<li>
<span class="name">"right_indent"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>the right indent of the paragraph (twentieth points).</p>
</div>
</li>
<li>
<span class="name">"first_line_indent"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>the first line indent of the paragraph (twentieth points).</p>
</div>
</li>
<li>
<span class="name">"space_before"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>the space before the paragraph (twentieth points).</p>
</div>
</li>
<li>
<span class="name">"space_after"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>the space after the paragraph (twentieth points).</p>
</div>
</li>
<li>
<span class="name">"line_spacing"</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>the line spacing in the paragraph (twentieth points).</p>
</div>
</li>
<li>
<span class="name">"widow_orphan_ctl"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable widow-and-orphan control.</p>
</div>
</li>
<li>
<span class="name">"no_break"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>when true, tries to keep the paragraph on the same page (i.e. without
breaking).</p>
</div>
</li>
<li>
<span class="name">"no_break_with_next"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>when true, tries to keep the paragraph with the next paragraph on the same
page (i.e. without breaking).</p>
</div>
</li>
<li>
<span class="name">"hyphenate"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>enable or disable hyphenation for the paragraph.</p>
</div>
</li>
<li>
<span class="name">"paragraph_flow"</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
— default:
<tt>'LEFT_TO_RIGHT'</tt>
</span>
— <div class='inline'>
<p>the text flow direction in the paragraph ('LEFT_TO_RIGHT' or
'RIGHT_TO_LEFT').</p>
</div>
</li>
<li>
<span class="name">"border"</span>
<span class="type">(<tt>Array<Hash, <span class='object_link'><a href="BorderStyle.html" title="RRTF::BorderStyle (class)">BorderStyle</a></span>></tt>, <tt>Hash</tt>, <tt><span class='object_link'><a href="BorderStyle.html" title="RRTF::BorderStyle (class)">BorderStyle</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>the border style(s) to be applied to the paragraph (see
<span class='object_link'><a href="BorderFormatting.html#initialize_border_formatting-instance_method" title="RRTF::BorderFormatting#initialize_border_formatting (method)">BorderFormatting#initialize_border_formatting</a></span>).</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line 18</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='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_initialize_paragraph_formatting'>initialize_paragraph_formatting</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_initialize_character_formatting'>initialize_character_formatting</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>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="prefix-instance_method">
#<strong>prefix</strong>(document) ⇒ <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>fonts
<dd>
<p>A reference to a FontTable containing any fonts used by the style (may be
nil if no fonts used).</p>
</dd><dt>colours
<dd>
<p>A reference to a ColourTable containing any colours used by the style (may
be nil if no colours used).</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69
70
71
72
73
74</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_prefix'>prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</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'>\\s</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_handle'>handle</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_handle'>handle</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='id identifier rubyid_rtf_formatting'>rtf_formatting</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</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="rtf_formatting-instance_method">
#<strong>rtf_formatting</strong>(document) ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
76
77
78
79
80
81
82
83
84
85
86</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line 76</span>
<span class='kw'>def</span> <span class='id identifier rubyid_rtf_formatting'>rtf_formatting</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
<span class='id identifier rubyid_rtf'>rtf</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_pf'>pf</span> <span class='op'>=</span> <span class='id identifier rubyid_paragraph_formatting_to_rtf'>paragraph_formatting_to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
<span class='id identifier rubyid_cf'>cf</span> <span class='op'>=</span> <span class='id identifier rubyid_character_formatting_to_rtf'>character_formatting_to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='id identifier rubyid_pf'>pf</span> <span class='kw'>unless</span> <span class='id identifier rubyid_pf'>pf</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='id identifier rubyid_cf'>cf</span> <span class='kw'>unless</span> <span class='id identifier rubyid_cf'>cf</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_rtf'>rtf</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="to_rtf-instance_method">
#<strong>to_rtf</strong>(document, options = {}) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Converts the stylesheet paragraph style into its RTF representation</p>
<h4 id="label-Parameters">Parameters</h4>
<dl class="rdoc-list note-list"><dt>fonts
<dd>
<p>A reference to a FontTable containing any fonts used by the style (may be
nil if no fonts used).</p>
</dd><dt>colours
<dd>
<p>A reference to a ColourTable containing any colours used by the style (may
be nil if no colours used).</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='comma'>,</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'>uglify</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>base_indent</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>0</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='comment'># build formatting helpers
</span> <span class='id identifier rubyid_base_prefix'>base_prefix</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'>uglify</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></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'>base_indent</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_name_prefix'>name_prefix</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'>uglify</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_suffix'>suffix</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'>uglify</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_rtf'>rtf</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_rtf'>rtf</span> <span class='op'><<</span> <span class='id identifier rubyid_base_prefix'>base_prefix</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>{\\s</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_handle'>handle</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_rtf_formatting'>rtf_formatting</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\additive</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@additive</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\sbasedon</span><span class='embexpr_beg'>#{</span><span class='ivar'>@based_on_style_handle</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@based_on_style_handle</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\sautoupd</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@auto_update</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\snext</span><span class='embexpr_beg'>#{</span><span class='ivar'>@next_style_handle</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@next_style_handle</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\sqformat</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@primary</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\spriority</span><span class='embexpr_beg'>#{</span><span class='ivar'>@priority</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@priority</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\shidden</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@hidden</span>
<span class='id identifier rubyid_rtf'>rtf</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name_prefix'>name_prefix</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>;}</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_rtf'>rtf</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 Wed Aug 2 23:05:19 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>