rrtf 0.1.2 → 1.0.0

data/documentation/RRTF/CharacterStyle.html

@@ -74,6 +74,8 @@
         <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::CharacterStyle</li>
@@ -166,31 +168,6 @@
 <p>This is the constructor for the CharacterStyle class.</p>
 </div></span>
   
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#is_character_style%3F-instance_method" title="#is_character_style? (instance method)">#<strong>is_character_style?</strong>  &#x21d2; Boolean </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>This method overrides the is_character_style? method inherited from the
-Style class to always return true.</p>
-</div></span>
-  
 </li>
 
       
@@ -212,7 +189,7 @@ Style class to always return true.</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>This method generates a string containing the prefix associated with a
+<p>This method generates a string containing the prefix associated with the
 style object.</p>
 </div></span>
   
@@ -279,7 +256,7 @@ stylesheet).</p>
   
   
   <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#push_colours-instance_method" title="RRTF::CharacterFormatting#push_colours (method)">#push_colours</a></span>, <span class='object_link'><a href="CharacterFormatting.html#push_fonts-instance_method" title="RRTF::CharacterFormatting#push_fonts (method)">#push_fonts</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>
+  <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>
 
   
   
@@ -289,8 +266,14 @@ stylesheet).</p>
   
   
   
-  <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_document_style%3F-instance_method" title="RRTF::Style#is_document_style? (method)">#is_document_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#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></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>
   
@@ -727,8 +710,8 @@ string format.</p>
           </span>
           
             &mdash; <div class='inline'>
-<p>colour to apply to the background (highlight); see <span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">RRTF::Colour.from_string</a></span> for
-string format.</p>
+<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)">RRTF::Colour.from_string</a></span> for string
+format.</p>
 </div>
           
         </li>
@@ -750,6 +733,22 @@ format.</p>
           
         </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">
+            
+              &mdash; default:
+              <tt>nil</tt>
+            
+          </span>
+          
+            &mdash; <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>
@@ -817,62 +816,7 @@ format.</p>
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="is_character_style?-instance_method">
-  
-    #<strong>is_character_style?</strong>  &#x21d2; <tt>Boolean</tt> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-<p>This method overrides the is_character_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">
-
-
-20
-21
-22</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 20</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_is_character_style?'>is_character_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">
+  <h3 class="signature first" id="prefix-instance_method">
   
     #<strong>prefix</strong>(document)  &#x21d2; <tt>Object</tt> 
   
@@ -883,7 +827,7 @@ Style class to always return true.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>This method generates a string containing the prefix associated with a
+<p>This method generates a string containing the prefix associated with the
 style object.</p>
 
 
@@ -898,17 +842,17 @@ style object.</p>
       <pre class="lines">
 
 
+50
+51
+52
+53
+54
+55
 56
-57
-58
-59
-60
-61
-62
-63</pre>
+57</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 56</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 50</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>
@@ -938,12 +882,12 @@ style object.</p>
       <pre class="lines">
 
 
-65
-66
-67</pre>
+59
+60
+61</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 65</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 59</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_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>
@@ -980,6 +924,12 @@ stylesheet)</p>
       <pre class="lines">
 
 
+20
+21
+22
+23
+24
+25
 26
 27
 28
@@ -1000,16 +950,10 @@ stylesheet)</p>
 43
 44
 45
-46
-47
-48
-49
-50
-51
-52</pre>
+46</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 20</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
@@ -1048,7 +992,7 @@ stylesheet)</p>
 </div>
 
       <div id="footer">
-  Generated on Mon Jul 24 15:49:02 2017 by
+  Generated on Mon Jul 31 21:49:01 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.3).
 </div>

data/documentation/RRTF/Colour.html

@@ -297,6 +297,28 @@
 <p>This is the constructor for the Colour class.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#to_decimal-instance_method" title="#to_decimal (instance method)">#<strong>to_decimal</strong>(options = {})  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
 </li>
 
       
@@ -696,6 +718,44 @@ green or blue values.</p>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="to_decimal-instance_method">
+  
+    #<strong>to_decimal</strong>(options = {})  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+84
+85
+86
+87
+88
+89
+90</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 84</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_to_decimal'>to_decimal</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'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>reverse_bytes</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
+    <span class='lparen'>(</span><span class='ivar'>@blue</span> <span class='op'>*</span> <span class='int'>65536</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='lparen'>(</span><span class='ivar'>@green</span> <span class='op'>*</span> <span class='int'>256</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='ivar'>@red</span>
+  <span class='kw'>else</span>
+    <span class='lparen'>(</span><span class='ivar'>@red</span> <span class='op'>*</span> <span class='int'>65536</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='lparen'>(</span><span class='ivar'>@green</span> <span class='op'>*</span> <span class='int'>256</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='ivar'>@blue</span>
+  <span class='kw'>end</span> <span class='comment'># if
+</span><span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -803,7 +863,7 @@ to zero.</p>
 </div>
 
       <div id="footer">
-  Generated on Mon Jul 24 15:49:01 2017 by
+  Generated on Mon Jul 31 21:48:58 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>

data/documentation/RRTF/ColourTable.html

@@ -362,13 +362,13 @@ class.</p>
       <pre class="lines">
 
 
-95
-96
-97
-98</pre>
+103
+104
+105
+106</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 95</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 103</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_colours'>colours</span><span class='rparen'>)</span>
    <span class='ivar'>@colours</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -420,12 +420,12 @@ this method. An invalid index will return a nil value.</p>
       <pre class="lines">
 
 
-133
-134
-135</pre>
+141
+142
+143</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 133</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 141</span>
 
 <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
    <span class='ivar'>@colours</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
@@ -473,15 +473,15 @@ does nothing.</p>
       <pre class="lines">
 
 
-112
-113
-114
-115
-116
-117</pre>
+120
+121
+122
+123
+124
+125</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 112</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 120</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_colour'>colour</span><span class='rparen'>)</span>
    <span class='kw'>if</span> <span class='id identifier rubyid_colour'>colour</span><span class='period'>.</span><span class='id identifier rubyid_instance_of?'>instance_of?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></span><span class='rparen'>)</span>
@@ -521,14 +521,14 @@ iteration does not include the implicit default colour entry.</p>
       <pre class="lines">
 
 
-121
-122
-123
-124
-125</pre>
+129
+130
+131
+132
+133</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 121</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 129</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span>
    <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
@@ -575,13 +575,13 @@ of entry to account for the implicit default colour entry.</p>
       <pre class="lines">
 
 
-144
-145
-146
-147</pre>
+152
+153
+154
+155</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 144</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 152</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_colour'>colour</span><span class='rparen'>)</span>
    <span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='ivar'>@colours</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_colour'>colour</span><span class='rparen'>)</span>
@@ -618,12 +618,12 @@ of entry to account for the implicit default colour entry.</p>
       <pre class="lines">
 
 
-102
-103
-104</pre>
+110
+111
+112</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 102</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 110</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
    <span class='ivar'>@colours</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
@@ -666,19 +666,19 @@ Defaults to zero.</p>
       <pre class="lines">
 
 
-169
-170
-171
-172
-173
-174
-175
-176
 177
-178</pre>
+178
+179
+180
+181
+182
+183
+184
+185
+186</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 169</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 177</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_indent'>indent</span><span class='op'>=</span><span class='int'>0</span><span class='rparen'>)</span>
    <span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>&gt;</span> <span class='int'>0</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> </span><span class='tstring_end'>&#39;</span></span> <span class='op'>*</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
@@ -728,18 +728,18 @@ Defaults to zero.</p>
       <pre class="lines">
 
 
-154
-155
-156
-157
-158
-159
-160
-161
-162</pre>
+162
+163
+164
+165
+166
+167
+168
+169
+170</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 154</span>
+      <pre class="code"><span class="info file"># File 'lib/rrtf/colour.rb', line 162</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='id identifier rubyid_indent'>indent</span><span class='op'>=</span><span class='int'>0</span><span class='rparen'>)</span>
    <span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>&gt;</span> <span class='int'>0</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> </span><span class='tstring_end'>&#39;</span></span> <span class='op'>*</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
@@ -760,7 +760,7 @@ Defaults to zero.</p>
 </div>
 
       <div id="footer">
-  Generated on Mon Jul 24 15:49:01 2017 by
+  Generated on Mon Jul 31 21:48:58 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>