rrtf 0.1.2 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.byebug_history +6 -3
- data/CHANGELOG.md +24 -0
- data/README.md +194 -84
- data/documentation/RRTF.html +5 -5
- data/documentation/RRTF/AnonymousStyle.html +792 -0
- data/documentation/RRTF/BorderFormatting.html +821 -0
- data/documentation/RRTF/BorderStyle.html +493 -0
- data/documentation/RRTF/CharacterFormatting.html +293 -162
- data/documentation/RRTF/CharacterStyle.html +53 -109
- data/documentation/RRTF/Colour.html +61 -1
- data/documentation/RRTF/ColourTable.html +52 -52
- data/documentation/RRTF/CommandNode.html +367 -971
- data/documentation/RRTF/ContainerNode.html +44 -44
- data/documentation/RRTF/Converters.html +1 -1
- data/documentation/RRTF/Converters/HTML.html +1 -1
- data/documentation/RRTF/Converters/HTML/Helpers.html +1 -1
- data/documentation/RRTF/Converters/HTML/Node.html +1 -1
- data/documentation/RRTF/Converters/HTML/NodeSet.html +1 -1
- data/documentation/RRTF/Document.html +267 -255
- data/documentation/RRTF/DocumentFormatting.html +833 -0
- data/documentation/RRTF/DocumentProperties.html +444 -0
- data/documentation/RRTF/Font.html +1 -1
- data/documentation/RRTF/FontTable.html +1 -1
- data/documentation/RRTF/FooterNode.html +16 -16
- data/documentation/RRTF/GeometryNode.html +774 -0
- data/documentation/RRTF/GeometryProperties.html +1014 -0
- data/documentation/RRTF/HeaderNode.html +16 -16
- data/documentation/RRTF/ImageNode.html +705 -492
- data/documentation/RRTF/Information.html +1 -1
- data/documentation/RRTF/LinkNode.html +10 -10
- data/documentation/RRTF/ListLevel.html +1 -1
- data/documentation/RRTF/ListLevelNode.html +37 -37
- data/documentation/RRTF/ListMarker.html +1 -1
- data/documentation/RRTF/ListNode.html +19 -19
- data/documentation/RRTF/ListTable.html +1 -1
- data/documentation/RRTF/ListTemplate.html +1 -1
- data/documentation/RRTF/ListTextNode.html +14 -14
- data/documentation/RRTF/Node.html +26 -26
- data/documentation/RRTF/Page.html +129 -0
- data/documentation/RRTF/Page/Margin.html +1158 -0
- data/documentation/RRTF/Page/Size.html +946 -0
- data/documentation/RRTF/PageFormatting.html +954 -0
- data/documentation/RRTF/ParagraphFormatting.html +338 -56
- data/documentation/RRTF/ParagraphNode.html +10 -10
- data/documentation/RRTF/ParagraphStyle.html +72 -111
- data/documentation/RRTF/PositionFormatting.html +780 -0
- data/documentation/RRTF/PositionStyle.html +424 -0
- data/documentation/RRTF/Properties.html +243 -0
- data/documentation/RRTF/RTFError.html +21 -10
- data/documentation/RRTF/ShadingFormatting.html +712 -0
- data/documentation/RRTF/ShadingStyle.html +424 -0
- data/documentation/RRTF/Style.html +284 -697
- data/documentation/RRTF/Stylesheet.html +36 -3
- data/documentation/RRTF/TableCellNode.html +131 -131
- data/documentation/RRTF/TableNode.html +82 -82
- data/documentation/RRTF/TableRowNode.html +53 -53
- data/documentation/RRTF/TextNode.html +46 -46
- data/documentation/RRTF/Utilities.html +837 -17
- data/documentation/_index.html +139 -6
- data/documentation/class_list.html +1 -1
- data/documentation/file.README.html +218 -87
- data/documentation/index.html +218 -87
- data/documentation/method_list.html +631 -391
- data/documentation/top-level-namespace.html +1 -1
- data/examples/01.rtf +947 -20
- data/examples/01_everything.rb +176 -0
- data/examples/02.rtf +13 -0
- data/examples/02_basic_paragraph.rb +10 -0
- data/examples/03.rtf +20 -0
- data/examples/03_paragraph_inline_style.rb +14 -0
- data/examples/04.rtf +21 -0
- data/examples/04_paragraph_with_character_style.rb +18 -0
- data/examples/05.rtf +21 -0
- data/examples/05_hyperlinks.rb +21 -0
- data/examples/06.rtf +21 -0
- data/examples/06_basic_list.rb +21 -0
- data/examples/07.rtf +28 -0
- data/examples/07_nested_list.rb +27 -0
- data/examples/08.rtf +807 -0
- data/examples/08_images.rb +17 -0
- data/examples/09.rtf +84 -0
- data/examples/09_shapes.rb +56 -0
- data/examples/10.rtf +34 -0
- data/examples/10_stylesheet.rb +18 -0
- data/examples/resources/images/redshirt.png +0 -0
- data/examples/resources/images/redshirts.jpg +0 -0
- data/examples/resources/json/redshirt_styles.json +72 -8
- data/examples/~$01.rtf +0 -0
- data/lib/rrtf.rb +4 -16
- data/lib/rrtf/colour.rb +8 -0
- data/lib/rrtf/formatting.rb +988 -0
- data/lib/rrtf/node.rb +17 -1851
- data/lib/rrtf/node/command_node.rb +242 -0
- data/lib/rrtf/node/container_node.rb +75 -0
- data/lib/rrtf/node/document.rb +339 -0
- data/lib/rrtf/node/footer_node.rb +47 -0
- data/lib/rrtf/node/geometry_node.rb +65 -0
- data/lib/rrtf/node/header_node.rb +47 -0
- data/lib/rrtf/node/image_node.rb +175 -0
- data/lib/rrtf/node/link_node.rb +10 -0
- data/lib/rrtf/node/list_level_node.rb +44 -0
- data/lib/rrtf/node/list_node.rb +30 -0
- data/lib/rrtf/node/list_text_node.rb +22 -0
- data/lib/rrtf/node/node.rb +53 -0
- data/lib/rrtf/node/paragraph_node.rb +11 -0
- data/lib/rrtf/node/table_cell_node.rb +233 -0
- data/lib/rrtf/node/table_node.rb +136 -0
- data/lib/rrtf/node/table_row_node.rb +92 -0
- data/lib/rrtf/node/text_node.rb +76 -0
- data/lib/rrtf/page.rb +7 -0
- data/lib/rrtf/page/margin.rb +98 -0
- data/lib/rrtf/page/size.rb +98 -0
- data/lib/rrtf/properties.rb +3 -0
- data/lib/rrtf/properties/document_properties.rb +34 -0
- data/lib/rrtf/properties/geometry_properties.rb +380 -0
- data/lib/rrtf/properties/properties.rb +13 -0
- data/lib/rrtf/style.rb +4 -5
- data/lib/rrtf/style/anonymous_style.rb +73 -0
- data/lib/rrtf/style/border_style.rb +27 -0
- data/lib/rrtf/style/character_style.rb +1 -7
- data/lib/rrtf/style/paragraph_style.rb +0 -6
- data/lib/rrtf/style/position_style.rb +26 -0
- data/lib/rrtf/style/shading_style.rb +26 -0
- data/lib/rrtf/style/style.rb +60 -101
- data/lib/rrtf/utilities.rb +138 -0
- data/lib/rrtf/version.rb +1 -1
- data/rrtf.gemspec +1 -0
- metadata +85 -10
- data/examples/01_mac_libreoffice5_2_3_3.png +0 -0
- data/examples/01_mac_pages6_2.png +0 -0
- data/examples/01_mac_textedit1_12.png +0 -0
- data/examples/01_mac_word15_36.png +0 -0
- data/examples/01_styles_and_paragraphs.rb +0 -32
- data/lib/rrtf/paper.rb +0 -53
- data/lib/rrtf/style/document_style.rb +0 -116
- data/lib/rrtf/style/formatting.rb +0 -320
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
|
|
101
101
|
<dl>
|
|
102
102
|
<dt>Defined in:</dt>
|
|
103
|
-
<dd>lib/rrtf/node.rb</dd>
|
|
103
|
+
<dd>lib/rrtf/node/paragraph_node.rb</dd>
|
|
104
104
|
</dl>
|
|
105
105
|
|
|
106
106
|
</div>
|
|
@@ -185,7 +185,7 @@
|
|
|
185
185
|
|
|
186
186
|
|
|
187
187
|
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="CommandNode.html" title="RRTF::CommandNode (class)">CommandNode</a></span></h3>
|
|
188
|
-
<p class="inherited"><span class='object_link'><a href="CommandNode.html#<<-instance_method" title="RRTF::CommandNode#<< (method)">#<<</a></span>, <span class='object_link'><a href="CommandNode.html#apply-instance_method" title="RRTF::CommandNode#apply (method)">#apply</a></span>, <span class='object_link'><a href="CommandNode.html#
|
|
188
|
+
<p class="inherited"><span class='object_link'><a href="CommandNode.html#<<-instance_method" title="RRTF::CommandNode#<< (method)">#<<</a></span>, <span class='object_link'><a href="CommandNode.html#apply-instance_method" title="RRTF::CommandNode#apply (method)">#apply</a></span>, <span class='object_link'><a href="CommandNode.html#footnote-instance_method" title="RRTF::CommandNode#footnote (method)">#footnote</a></span>, <span class='object_link'><a href="CommandNode.html#geometry-instance_method" title="RRTF::CommandNode#geometry (method)">#geometry</a></span>, <span class='object_link'><a href="CommandNode.html#image-instance_method" title="RRTF::CommandNode#image (method)">#image</a></span>, <span class='object_link'><a href="CommandNode.html#line_break-instance_method" title="RRTF::CommandNode#line_break (method)">#line_break</a></span>, <span class='object_link'><a href="CommandNode.html#link-instance_method" title="RRTF::CommandNode#link (method)">#link</a></span>, <span class='object_link'><a href="CommandNode.html#list-instance_method" title="RRTF::CommandNode#list (method)">#list</a></span>, <span class='object_link'><a href="CommandNode.html#paragraph-instance_method" title="RRTF::CommandNode#paragraph (method)">#paragraph</a></span>, <span class='object_link'><a href="CommandNode.html#table-instance_method" title="RRTF::CommandNode#table (method)">#table</a></span>, <span class='object_link'><a href="CommandNode.html#to_rtf-instance_method" title="RRTF::CommandNode#to_rtf (method)">#to_rtf</a></span></p>
|
|
189
189
|
|
|
190
190
|
|
|
191
191
|
|
|
@@ -238,15 +238,15 @@
|
|
|
238
238
|
<pre class="lines">
|
|
239
239
|
|
|
240
240
|
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
241
|
+
4
|
|
242
|
+
5
|
|
243
|
+
6
|
|
244
|
+
7
|
|
245
|
+
8
|
|
246
|
+
9</pre>
|
|
247
247
|
</td>
|
|
248
248
|
<td>
|
|
249
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line
|
|
249
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node/paragraph_node.rb', line 4</span>
|
|
250
250
|
|
|
251
251
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_style'>style</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
252
252
|
<span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>\pard</span><span class='tstring_end'>'</span></span>
|
|
@@ -265,7 +265,7 @@
|
|
|
265
265
|
</div>
|
|
266
266
|
|
|
267
267
|
<div id="footer">
|
|
268
|
-
Generated on Mon Jul
|
|
268
|
+
Generated on Mon Jul 31 21:49:00 2017 by
|
|
269
269
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
270
270
|
0.9.9 (ruby-2.3.3).
|
|
271
271
|
</div>
|
|
@@ -74,6 +74,8 @@
|
|
|
74
74
|
<ul class="fullTree">
|
|
75
75
|
<li>Object</li>
|
|
76
76
|
|
|
77
|
+
<li class="next"><span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></li>
|
|
78
|
+
|
|
77
79
|
<li class="next"><span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></li>
|
|
78
80
|
|
|
79
81
|
<li class="next">RRTF::ParagraphStyle</li>
|
|
@@ -182,31 +184,6 @@ formatting modules.</p>
|
|
|
182
184
|
<p>This is the constructor for the CharacterStyle class.</p>
|
|
183
185
|
</div></span>
|
|
184
186
|
|
|
185
|
-
</li>
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
<li class="public ">
|
|
189
|
-
<span class="summary_signature">
|
|
190
|
-
|
|
191
|
-
<a href="#is_paragraph_style%3F-instance_method" title="#is_paragraph_style? (instance method)">#<strong>is_paragraph_style?</strong> ⇒ Boolean </a>
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
</span>
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
<span class="summary_desc"><div class='inline'>
|
|
206
|
-
<p>This method overrides the is_paragraph_style? method inherited from the
|
|
207
|
-
Style class to always return true.</p>
|
|
208
|
-
</div></span>
|
|
209
|
-
|
|
210
187
|
</li>
|
|
211
188
|
|
|
212
189
|
|
|
@@ -294,7 +271,7 @@ style object.</p>
|
|
|
294
271
|
|
|
295
272
|
|
|
296
273
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="CharacterFormatting.html" title="RRTF::CharacterFormatting (module)">CharacterFormatting</a></span></h3>
|
|
297
|
-
<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#
|
|
274
|
+
<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>
|
|
298
275
|
|
|
299
276
|
|
|
300
277
|
|
|
@@ -315,8 +292,14 @@ style object.</p>
|
|
|
315
292
|
|
|
316
293
|
|
|
317
294
|
|
|
318
|
-
|
|
319
|
-
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></h3>
|
|
302
|
+
<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>
|
|
320
303
|
<div id="constructor_details" class="method_details_list">
|
|
321
304
|
<h2>Constructor Details</h2>
|
|
322
305
|
|
|
@@ -753,8 +736,8 @@ string format.</p>
|
|
|
753
736
|
</span>
|
|
754
737
|
|
|
755
738
|
— <div class='inline'>
|
|
756
|
-
<p>colour to apply to the background
|
|
757
|
-
|
|
739
|
+
<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
|
|
740
|
+
format.</p>
|
|
758
741
|
</div>
|
|
759
742
|
|
|
760
743
|
</li>
|
|
@@ -776,6 +759,22 @@ format.</p>
|
|
|
776
759
|
|
|
777
760
|
</li>
|
|
778
761
|
|
|
762
|
+
<li>
|
|
763
|
+
<span class="name">"highlight_color"</span>
|
|
764
|
+
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></tt>)</span>
|
|
765
|
+
<span class="default">
|
|
766
|
+
|
|
767
|
+
— default:
|
|
768
|
+
<tt>nil</tt>
|
|
769
|
+
|
|
770
|
+
</span>
|
|
771
|
+
|
|
772
|
+
— <div class='inline'>
|
|
773
|
+
<p>colour with which to highlight text.</p>
|
|
774
|
+
</div>
|
|
775
|
+
|
|
776
|
+
</li>
|
|
777
|
+
|
|
779
778
|
<li>
|
|
780
779
|
<span class="name">"font"</span>
|
|
781
780
|
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Font.html" title="RRTF::Font (class)">Font</a></span></tt>)</span>
|
|
@@ -1000,6 +999,23 @@ page (i.e. without breaking).</p>
|
|
|
1000
999
|
— <div class='inline'>
|
|
1001
1000
|
<p>the text flow direction in the paragraph ('LEFT_TO_RIGHT' or
|
|
1002
1001
|
'RIGHT_TO_LEFT').</p>
|
|
1002
|
+
</div>
|
|
1003
|
+
|
|
1004
|
+
</li>
|
|
1005
|
+
|
|
1006
|
+
<li>
|
|
1007
|
+
<span class="name">"border"</span>
|
|
1008
|
+
<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>
|
|
1009
|
+
<span class="default">
|
|
1010
|
+
|
|
1011
|
+
— default:
|
|
1012
|
+
<tt>nil</tt>
|
|
1013
|
+
|
|
1014
|
+
</span>
|
|
1015
|
+
|
|
1016
|
+
— <div class='inline'>
|
|
1017
|
+
<p>the border style(s) to be applied to the paragraph (see
|
|
1018
|
+
<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>
|
|
1003
1019
|
</div>
|
|
1004
1020
|
|
|
1005
1021
|
</li>
|
|
@@ -1041,62 +1057,7 @@ page (i.e. without breaking).</p>
|
|
|
1041
1057
|
|
|
1042
1058
|
|
|
1043
1059
|
<div class="method_details first">
|
|
1044
|
-
<h3 class="signature first" id="
|
|
1045
|
-
|
|
1046
|
-
#<strong>is_paragraph_style?</strong> ⇒ <tt>Boolean</tt>
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
</h3><div class="docstring">
|
|
1053
|
-
<div class="discussion">
|
|
1054
|
-
|
|
1055
|
-
<p>This method overrides the is_paragraph_style? method inherited from the
|
|
1056
|
-
Style class to always return true.</p>
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
</div>
|
|
1060
|
-
</div>
|
|
1061
|
-
<div class="tags">
|
|
1062
|
-
|
|
1063
|
-
<p class="tag_title">Returns:</p>
|
|
1064
|
-
<ul class="return">
|
|
1065
|
-
|
|
1066
|
-
<li>
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
</li>
|
|
1074
|
-
|
|
1075
|
-
</ul>
|
|
1076
|
-
|
|
1077
|
-
</div><table class="source_code">
|
|
1078
|
-
<tr>
|
|
1079
|
-
<td>
|
|
1080
|
-
<pre class="lines">
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
26
|
|
1084
|
-
27
|
|
1085
|
-
28</pre>
|
|
1086
|
-
</td>
|
|
1087
|
-
<td>
|
|
1088
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line 26</span>
|
|
1089
|
-
|
|
1090
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_is_paragraph_style?'>is_paragraph_style?</span>
|
|
1091
|
-
<span class='kw'>true</span>
|
|
1092
|
-
<span class='kw'>end</span></pre>
|
|
1093
|
-
</td>
|
|
1094
|
-
</tr>
|
|
1095
|
-
</table>
|
|
1096
|
-
</div>
|
|
1097
|
-
|
|
1098
|
-
<div class="method_details ">
|
|
1099
|
-
<h3 class="signature " id="prefix-instance_method">
|
|
1060
|
+
<h3 class="signature first" id="prefix-instance_method">
|
|
1100
1061
|
|
|
1101
1062
|
#<strong>prefix</strong>(document) ⇒ <tt>Object</tt>
|
|
1102
1063
|
|
|
@@ -1133,17 +1094,17 @@ be nil if no colours used).</p>
|
|
|
1133
1094
|
<pre class="lines">
|
|
1134
1095
|
|
|
1135
1096
|
|
|
1097
|
+
67
|
|
1098
|
+
68
|
|
1099
|
+
69
|
|
1100
|
+
70
|
|
1101
|
+
71
|
|
1102
|
+
72
|
|
1136
1103
|
73
|
|
1137
|
-
74
|
|
1138
|
-
75
|
|
1139
|
-
76
|
|
1140
|
-
77
|
|
1141
|
-
78
|
|
1142
|
-
79
|
|
1143
|
-
80</pre>
|
|
1104
|
+
74</pre>
|
|
1144
1105
|
</td>
|
|
1145
1106
|
<td>
|
|
1146
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line
|
|
1107
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line 67</span>
|
|
1147
1108
|
|
|
1148
1109
|
<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>
|
|
1149
1110
|
<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>
|
|
@@ -1173,20 +1134,20 @@ be nil if no colours used).</p>
|
|
|
1173
1134
|
<pre class="lines">
|
|
1174
1135
|
|
|
1175
1136
|
|
|
1137
|
+
76
|
|
1138
|
+
77
|
|
1139
|
+
78
|
|
1140
|
+
79
|
|
1141
|
+
80
|
|
1142
|
+
81
|
|
1176
1143
|
82
|
|
1177
1144
|
83
|
|
1178
1145
|
84
|
|
1179
1146
|
85
|
|
1180
|
-
86
|
|
1181
|
-
87
|
|
1182
|
-
88
|
|
1183
|
-
89
|
|
1184
|
-
90
|
|
1185
|
-
91
|
|
1186
|
-
92</pre>
|
|
1147
|
+
86</pre>
|
|
1187
1148
|
</td>
|
|
1188
1149
|
<td>
|
|
1189
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line
|
|
1150
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line 76</span>
|
|
1190
1151
|
|
|
1191
1152
|
<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>
|
|
1192
1153
|
<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>
|
|
@@ -1241,6 +1202,12 @@ be nil if no colours used).</p>
|
|
|
1241
1202
|
<pre class="lines">
|
|
1242
1203
|
|
|
1243
1204
|
|
|
1205
|
+
31
|
|
1206
|
+
32
|
|
1207
|
+
33
|
|
1208
|
+
34
|
|
1209
|
+
35
|
|
1210
|
+
36
|
|
1244
1211
|
37
|
|
1245
1212
|
38
|
|
1246
1213
|
39
|
|
@@ -1261,16 +1228,10 @@ be nil if no colours used).</p>
|
|
|
1261
1228
|
54
|
|
1262
1229
|
55
|
|
1263
1230
|
56
|
|
1264
|
-
57
|
|
1265
|
-
58
|
|
1266
|
-
59
|
|
1267
|
-
60
|
|
1268
|
-
61
|
|
1269
|
-
62
|
|
1270
|
-
63</pre>
|
|
1231
|
+
57</pre>
|
|
1271
1232
|
</td>
|
|
1272
1233
|
<td>
|
|
1273
|
-
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line
|
|
1234
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/style/paragraph_style.rb', line 31</span>
|
|
1274
1235
|
|
|
1275
1236
|
<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>
|
|
1276
1237
|
<span class='comment'># load default options
|
|
@@ -1309,7 +1270,7 @@ be nil if no colours used).</p>
|
|
|
1309
1270
|
</div>
|
|
1310
1271
|
|
|
1311
1272
|
<div id="footer">
|
|
1312
|
-
Generated on Mon Jul
|
|
1273
|
+
Generated on Mon Jul 31 21:49:01 2017 by
|
|
1313
1274
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1314
1275
|
0.9.9 (ruby-2.3.3).
|
|
1315
1276
|
</div>
|
|
@@ -0,0 +1,780 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: RRTF::PositionFormatting
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "RRTF::PositionFormatting";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (P)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">PositionFormatting</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: RRTF::PositionFormatting
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
<dl>
|
|
78
|
+
<dt>Included in:</dt>
|
|
79
|
+
<dd><span class='object_link'><a href="PositionStyle.html" title="RRTF::PositionStyle (class)">PositionStyle</a></span></dd>
|
|
80
|
+
</dl>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/rrtf/formatting.rb</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
|
92
|
+
<div class="discussion">
|
|
93
|
+
|
|
94
|
+
<p>Paragraph absolute positioning formatting attributes and methods.</p>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
</div>
|
|
98
|
+
</div>
|
|
99
|
+
<div class="tags">
|
|
100
|
+
|
|
101
|
+
<p class="tag_title">Author:</p>
|
|
102
|
+
<ul class="author">
|
|
103
|
+
|
|
104
|
+
<li>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<div class='inline'>
|
|
111
|
+
<p>Wesley Hileman</p>
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
</li>
|
|
115
|
+
|
|
116
|
+
</ul>
|
|
117
|
+
<p class="tag_title">Since:</p>
|
|
118
|
+
<ul class="since">
|
|
119
|
+
|
|
120
|
+
<li>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<div class='inline'>
|
|
127
|
+
<p>1.0.0</p>
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
</li>
|
|
131
|
+
|
|
132
|
+
</ul>
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
<h2>Constant Summary</h2>
|
|
136
|
+
<dl class="constants">
|
|
137
|
+
|
|
138
|
+
<dt id="POSITION_ATTRIBUTES-constant" class="">POSITION_ATTRIBUTES =
|
|
139
|
+
<div class="docstring">
|
|
140
|
+
<div class="discussion">
|
|
141
|
+
|
|
142
|
+
<p>Formatting attributes that can be applied to position paragraphs as frames.</p>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="tags">
|
|
148
|
+
|
|
149
|
+
<p class="tag_title">Since:</p>
|
|
150
|
+
<ul class="since">
|
|
151
|
+
|
|
152
|
+
<li>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<div class='inline'>
|
|
159
|
+
<p>1.0.0</p>
|
|
160
|
+
</div>
|
|
161
|
+
|
|
162
|
+
</li>
|
|
163
|
+
|
|
164
|
+
</ul>
|
|
165
|
+
|
|
166
|
+
</div>
|
|
167
|
+
</dt>
|
|
168
|
+
<dd><pre class="code"><span class='lbrace'>{</span>
|
|
169
|
+
<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>
|
|
170
|
+
<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>
|
|
171
|
+
<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>
|
|
172
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\absw</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'>\\absh</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='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>
|
|
173
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
174
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>horizontal_reference</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
175
|
+
<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>
|
|
176
|
+
<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>
|
|
177
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PAGE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>phpg</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
178
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>phmrg</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
179
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>COLUMN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>phcol</span><span class='tstring_end'>"</span></span>
|
|
180
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
181
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\</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>
|
|
182
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
183
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>vertical_reference</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
184
|
+
<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>
|
|
185
|
+
<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>
|
|
186
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PAGE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>pvpg</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
187
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>pvmrg</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
188
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PARAGRAPH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>pvpara</span><span class='tstring_end'>"</span></span>
|
|
189
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
190
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\</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>
|
|
191
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
192
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>horizontal_position</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
193
|
+
<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>
|
|
194
|
+
<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>
|
|
195
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>CENTER</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>posxc</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
196
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>LEFT</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>posxl</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
197
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>RIGHT</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>posxr</span><span class='tstring_end'>"</span></span>
|
|
198
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
199
|
+
<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='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
|
200
|
+
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
201
|
+
<span class='kw'>if</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='op'>&&</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^([A-Z]+)$</span><span class='regexp_end'>/</span></span>
|
|
202
|
+
<span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>horizontal_position</span><span class='tstring_end'>"</span></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>
|
|
203
|
+
<span class='kw'>else</span>
|
|
204
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>posx</span><span class='embexpr_beg'>#{</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='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
205
|
+
<span class='kw'>end</span>
|
|
206
|
+
<span class='kw'>end</span><span class='comma'>,</span>
|
|
207
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\</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>
|
|
208
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
209
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>vertical_position</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
210
|
+
<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>
|
|
211
|
+
<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>
|
|
212
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>CENTER</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>posyc</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
213
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>TOP</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>posyt</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
214
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>BOTTOM</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>posyb</span><span class='tstring_end'>"</span></span>
|
|
215
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
216
|
+
<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='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
|
217
|
+
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
218
|
+
<span class='kw'>if</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='op'>&&</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^([A-Z]+)$</span><span class='regexp_end'>/</span></span>
|
|
219
|
+
<span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_ATTRIBUTES</a></span></span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>vertical_position</span><span class='tstring_end'>"</span></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>
|
|
220
|
+
<span class='kw'>else</span>
|
|
221
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>posy</span><span class='embexpr_beg'>#{</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='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
222
|
+
<span class='kw'>end</span>
|
|
223
|
+
<span class='kw'>end</span><span class='comma'>,</span>
|
|
224
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\</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>
|
|
225
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
226
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text_wrap</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
227
|
+
<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>
|
|
228
|
+
<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>
|
|
229
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>NONE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>nowrap</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
230
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>wrapdefault</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
231
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>AROUND</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>wraparound</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
232
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>TIGHT</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>wraptight</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
233
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>THROUGH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>wrapthrough</span><span class='tstring_end'>"</span></span>
|
|
234
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
235
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\</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>
|
|
236
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
237
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>drop_cap_lines</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
238
|
+
<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>
|
|
239
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\dropcapli</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>
|
|
240
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
241
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>drop_cap_type</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
242
|
+
<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>
|
|
243
|
+
<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>
|
|
244
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>IN_TEXT</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1</span><span class='comma'>,</span>
|
|
245
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>IN_MARGIN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2</span>
|
|
246
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
247
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\dropcapt</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>
|
|
248
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
249
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lock_anchor</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
|
250
|
+
<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>
|
|
251
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='op'>|</span> <span class='lparen'>(</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'>\\abslock0</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\abslock1</span><span class='tstring_end'>"</span></span><span class='rparen'>)</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>
|
|
252
|
+
<span class='rbrace'>}</span>
|
|
253
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
254
|
+
|
|
255
|
+
</dl>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<h2>
|
|
265
|
+
Class Method Summary
|
|
266
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
267
|
+
</h2>
|
|
268
|
+
|
|
269
|
+
<ul class="summary">
|
|
270
|
+
|
|
271
|
+
<li class="public ">
|
|
272
|
+
<span class="summary_signature">
|
|
273
|
+
|
|
274
|
+
<a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base) ⇒ Object </a>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
</span>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<span class="summary_desc"><div class='inline'>
|
|
289
|
+
<p>Generates attribute accessors for all position attributes when the module
|
|
290
|
+
is included in another module or class.</p>
|
|
291
|
+
</div></span>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
</ul>
|
|
297
|
+
|
|
298
|
+
<h2>
|
|
299
|
+
Instance Method Summary
|
|
300
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
301
|
+
</h2>
|
|
302
|
+
|
|
303
|
+
<ul class="summary">
|
|
304
|
+
|
|
305
|
+
<li class="public ">
|
|
306
|
+
<span class="summary_signature">
|
|
307
|
+
|
|
308
|
+
<a href="#initialize_position_formatting-instance_method" title="#initialize_position_formatting (instance method)">#<strong>initialize_position_formatting</strong>(options = {}) ⇒ Object </a>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
</span>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<span class="summary_desc"><div class='inline'>
|
|
323
|
+
<p>Initializes position formatting attributes.</p>
|
|
324
|
+
</div></span>
|
|
325
|
+
|
|
326
|
+
</li>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
<li class="public ">
|
|
330
|
+
<span class="summary_signature">
|
|
331
|
+
|
|
332
|
+
<a href="#position_formatting_to_rtf-instance_method" title="#position_formatting_to_rtf (instance method)">#<strong>position_formatting_to_rtf</strong>(document) ⇒ Object </a>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
</span>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<span class="summary_desc"><div class='inline'>
|
|
347
|
+
<p>Generates an RTF string representing all applied position formatting.</p>
|
|
348
|
+
</div></span>
|
|
349
|
+
|
|
350
|
+
</li>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<li class="public ">
|
|
354
|
+
<span class="summary_signature">
|
|
355
|
+
|
|
356
|
+
<a href="#set_position_formatting_from_hashmap-instance_method" title="#set_position_formatting_from_hashmap (instance method)">#<strong>set_position_formatting_from_hashmap</strong>(hash) ⇒ Object </a>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
</span>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
<span class="summary_desc"><div class='inline'>
|
|
371
|
+
<p>Sets formatting attributes according to the supplied hashmap.</p>
|
|
372
|
+
</div></span>
|
|
373
|
+
|
|
374
|
+
</li>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
</ul>
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<div id="class_method_details" class="method_details_list">
|
|
383
|
+
<h2>Class Method Details</h2>
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
<div class="method_details first">
|
|
387
|
+
<h3 class="signature first" id="included-class_method">
|
|
388
|
+
|
|
389
|
+
.<strong>included</strong>(base) ⇒ <tt>Object</tt>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
</h3><div class="docstring">
|
|
396
|
+
<div class="discussion">
|
|
397
|
+
|
|
398
|
+
<p>Generates attribute accessors for all position attributes when the module
|
|
399
|
+
is included in another module or class.</p>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
</div>
|
|
403
|
+
</div>
|
|
404
|
+
<div class="tags">
|
|
405
|
+
|
|
406
|
+
<p class="tag_title">Since:</p>
|
|
407
|
+
<ul class="since">
|
|
408
|
+
|
|
409
|
+
<li>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
<div class='inline'>
|
|
416
|
+
<p>1.0.0</p>
|
|
417
|
+
</div>
|
|
418
|
+
|
|
419
|
+
</li>
|
|
420
|
+
|
|
421
|
+
</ul>
|
|
422
|
+
|
|
423
|
+
</div><table class="source_code">
|
|
424
|
+
<tr>
|
|
425
|
+
<td>
|
|
426
|
+
<pre class="lines">
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
623
|
|
430
|
+
624
|
|
431
|
+
625
|
|
432
|
+
626
|
|
433
|
+
627
|
|
434
|
+
628
|
|
435
|
+
629
|
|
436
|
+
630</pre>
|
|
437
|
+
</td>
|
|
438
|
+
<td>
|
|
439
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 623</span>
|
|
440
|
+
|
|
441
|
+
<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>
|
|
442
|
+
<span class='comment'># define accessors in base for position attributes
|
|
443
|
+
</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>
|
|
444
|
+
<span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_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>
|
|
445
|
+
<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>
|
|
446
|
+
<span class='kw'>end</span> <span class='comment'># each
|
|
447
|
+
</span> <span class='kw'>end</span> <span class='comment'># class_eval
|
|
448
|
+
</span><span class='kw'>end</span></pre>
|
|
449
|
+
</td>
|
|
450
|
+
</tr>
|
|
451
|
+
</table>
|
|
452
|
+
</div>
|
|
453
|
+
|
|
454
|
+
</div>
|
|
455
|
+
|
|
456
|
+
<div id="instance_method_details" class="method_details_list">
|
|
457
|
+
<h2>Instance Method Details</h2>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<div class="method_details first">
|
|
461
|
+
<h3 class="signature first" id="initialize_position_formatting-instance_method">
|
|
462
|
+
|
|
463
|
+
#<strong>initialize_position_formatting</strong>(options = {}) ⇒ <tt>Object</tt>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
</h3><div class="docstring">
|
|
470
|
+
<div class="discussion">
|
|
471
|
+
|
|
472
|
+
<p>Initializes position formatting attributes.</p>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
</div>
|
|
476
|
+
</div>
|
|
477
|
+
<div class="tags">
|
|
478
|
+
<p class="tag_title">Parameters:</p>
|
|
479
|
+
<ul class="param">
|
|
480
|
+
|
|
481
|
+
<li>
|
|
482
|
+
|
|
483
|
+
<span class='name'>options</span>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
—
|
|
493
|
+
<div class='inline'>
|
|
494
|
+
<p>the border formatting options.</p>
|
|
495
|
+
</div>
|
|
496
|
+
|
|
497
|
+
</li>
|
|
498
|
+
|
|
499
|
+
</ul>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
505
|
+
<ul class="option">
|
|
506
|
+
|
|
507
|
+
<li>
|
|
508
|
+
<span class="name">"sides"</span>
|
|
509
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
510
|
+
<span class="default">
|
|
511
|
+
|
|
512
|
+
— default:
|
|
513
|
+
<tt>'ALL'</tt>
|
|
514
|
+
|
|
515
|
+
</span>
|
|
516
|
+
|
|
517
|
+
— <div class='inline'>
|
|
518
|
+
<p>the sides to which the border applied (“ALL”, “LEFT”, “RIGHT”, “TOP”, or
|
|
519
|
+
“BOTTOM”).</p>
|
|
520
|
+
</div>
|
|
521
|
+
|
|
522
|
+
</li>
|
|
523
|
+
|
|
524
|
+
</ul>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
<p class="tag_title">Since:</p>
|
|
528
|
+
<ul class="since">
|
|
529
|
+
|
|
530
|
+
<li>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
<div class='inline'>
|
|
537
|
+
<p>1.0.0</p>
|
|
538
|
+
</div>
|
|
539
|
+
|
|
540
|
+
</li>
|
|
541
|
+
|
|
542
|
+
</ul>
|
|
543
|
+
|
|
544
|
+
</div><table class="source_code">
|
|
545
|
+
<tr>
|
|
546
|
+
<td>
|
|
547
|
+
<pre class="lines">
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
636
|
|
551
|
+
637
|
|
552
|
+
638
|
|
553
|
+
639
|
|
554
|
+
640
|
|
555
|
+
641
|
|
556
|
+
642
|
|
557
|
+
643</pre>
|
|
558
|
+
</td>
|
|
559
|
+
<td>
|
|
560
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 636</span>
|
|
561
|
+
|
|
562
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize_position_formatting'>initialize_position_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>
|
|
563
|
+
<span class='comment'># load default attribute values
|
|
564
|
+
</span> <span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_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>
|
|
565
|
+
<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>
|
|
566
|
+
<span class='kw'>end</span> <span class='comment'># each
|
|
567
|
+
</span> <span class='comment'># overwrite default attribute values with given values
|
|
568
|
+
</span> <span class='id identifier rubyid_set_position_formatting_from_hashmap'>set_position_formatting_from_hashmap</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
569
|
+
<span class='kw'>end</span></pre>
|
|
570
|
+
</td>
|
|
571
|
+
</tr>
|
|
572
|
+
</table>
|
|
573
|
+
</div>
|
|
574
|
+
|
|
575
|
+
<div class="method_details ">
|
|
576
|
+
<h3 class="signature " id="position_formatting_to_rtf-instance_method">
|
|
577
|
+
|
|
578
|
+
#<strong>position_formatting_to_rtf</strong>(document) ⇒ <tt>Object</tt>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
</h3><div class="docstring">
|
|
585
|
+
<div class="discussion">
|
|
586
|
+
|
|
587
|
+
<div class="note notetag">
|
|
588
|
+
<strong>Note:</strong>
|
|
589
|
+
<div class='inline'>
|
|
590
|
+
<p>To generate correct RTF control words for colours and fonts, a document
|
|
591
|
+
object must be provided to this method so that colour and font indicies may
|
|
592
|
+
be found in the document's colour and font tables, respectively.</p>
|
|
593
|
+
</div>
|
|
594
|
+
</div>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
<p>Generates an RTF string representing all applied position formatting.</p>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</div>
|
|
601
|
+
</div>
|
|
602
|
+
<div class="tags">
|
|
603
|
+
<p class="tag_title">Parameters:</p>
|
|
604
|
+
<ul class="param">
|
|
605
|
+
|
|
606
|
+
<li>
|
|
607
|
+
|
|
608
|
+
<span class='name'>document</span>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
<span class='type'>(<tt><span class='object_link'><a href="Document.html" title="RRTF::Document (class)">Document</a></span></tt>)</span>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
—
|
|
616
|
+
<div class='inline'>
|
|
617
|
+
<p>the document for which the RTF is to be generated.</p>
|
|
618
|
+
</div>
|
|
619
|
+
|
|
620
|
+
</li>
|
|
621
|
+
|
|
622
|
+
</ul>
|
|
623
|
+
|
|
624
|
+
<p class="tag_title">Since:</p>
|
|
625
|
+
<ul class="since">
|
|
626
|
+
|
|
627
|
+
<li>
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
<div class='inline'>
|
|
634
|
+
<p>1.0.0</p>
|
|
635
|
+
</div>
|
|
636
|
+
|
|
637
|
+
</li>
|
|
638
|
+
|
|
639
|
+
</ul>
|
|
640
|
+
|
|
641
|
+
</div><table class="source_code">
|
|
642
|
+
<tr>
|
|
643
|
+
<td>
|
|
644
|
+
<pre class="lines">
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
668
|
|
648
|
+
669
|
|
649
|
+
670
|
|
650
|
+
671
|
|
651
|
+
672
|
|
652
|
+
673
|
|
653
|
+
674
|
|
654
|
+
675
|
|
655
|
+
676
|
|
656
|
+
677
|
|
657
|
+
678
|
|
658
|
+
679
|
|
659
|
+
680</pre>
|
|
660
|
+
</td>
|
|
661
|
+
<td>
|
|
662
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 668</span>
|
|
663
|
+
|
|
664
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_position_formatting_to_rtf'>position_formatting_to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
|
|
665
|
+
<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>
|
|
666
|
+
|
|
667
|
+
<span class='comment'># accumulate RTF representations of paragraph attributes
|
|
668
|
+
</span> <span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_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>
|
|
669
|
+
<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>
|
|
670
|
+
<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='comma'>,</span> <span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
|
|
671
|
+
<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>
|
|
672
|
+
<span class='kw'>end</span> <span class='comment'># if
|
|
673
|
+
</span> <span class='kw'>end</span> <span class='comment'># each
|
|
674
|
+
</span>
|
|
675
|
+
<span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
|
|
676
|
+
<span class='kw'>end</span></pre>
|
|
677
|
+
</td>
|
|
678
|
+
</tr>
|
|
679
|
+
</table>
|
|
680
|
+
</div>
|
|
681
|
+
|
|
682
|
+
<div class="method_details ">
|
|
683
|
+
<h3 class="signature " id="set_position_formatting_from_hashmap-instance_method">
|
|
684
|
+
|
|
685
|
+
#<strong>set_position_formatting_from_hashmap</strong>(hash) ⇒ <tt>Object</tt>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
</h3><div class="docstring">
|
|
692
|
+
<div class="discussion">
|
|
693
|
+
|
|
694
|
+
<p>Sets formatting attributes according to the supplied hashmap.</p>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
</div>
|
|
698
|
+
</div>
|
|
699
|
+
<div class="tags">
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
<p class="tag_title">See Also:</p>
|
|
703
|
+
<ul class="see">
|
|
704
|
+
|
|
705
|
+
<li><span class='object_link'><a href="#initialize_position_formatting-instance_method" title="RRTF::PositionFormatting#initialize_position_formatting (method)">#initialize_position_formatting</a></span></li>
|
|
706
|
+
|
|
707
|
+
</ul>
|
|
708
|
+
<p class="tag_title">Since:</p>
|
|
709
|
+
<ul class="since">
|
|
710
|
+
|
|
711
|
+
<li>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<div class='inline'>
|
|
718
|
+
<p>1.0.0</p>
|
|
719
|
+
</div>
|
|
720
|
+
|
|
721
|
+
</li>
|
|
722
|
+
|
|
723
|
+
</ul>
|
|
724
|
+
|
|
725
|
+
</div><table class="source_code">
|
|
726
|
+
<tr>
|
|
727
|
+
<td>
|
|
728
|
+
<pre class="lines">
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
647
|
|
732
|
+
648
|
|
733
|
+
649
|
|
734
|
+
650
|
|
735
|
+
651
|
|
736
|
+
652
|
|
737
|
+
653
|
|
738
|
+
654
|
|
739
|
+
655
|
|
740
|
+
656
|
|
741
|
+
657
|
|
742
|
+
658
|
|
743
|
+
659
|
|
744
|
+
660</pre>
|
|
745
|
+
</td>
|
|
746
|
+
<td>
|
|
747
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/formatting.rb', line 647</span>
|
|
748
|
+
|
|
749
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_set_position_formatting_from_hashmap'>set_position_formatting_from_hashmap</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
|
|
750
|
+
<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>
|
|
751
|
+
<span class='comment'># skip unreconized attributes
|
|
752
|
+
</span> <span class='kw'>next</span> <span class='kw'>unless</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_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>
|
|
753
|
+
<span class='comment'># preprocess value if nessesary
|
|
754
|
+
</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_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>
|
|
755
|
+
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_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>
|
|
756
|
+
<span class='kw'>elsif</span> <span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_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>
|
|
757
|
+
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#POSITION_ATTRIBUTES-constant" title="RRTF::PositionFormatting::POSITION_ATTRIBUTES (constant)">POSITION_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>
|
|
758
|
+
<span class='kw'>end</span> <span class='comment'># if
|
|
759
|
+
</span> <span class='comment'># set attribute value
|
|
760
|
+
</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>
|
|
761
|
+
<span class='kw'>end</span> <span class='comment'># each
|
|
762
|
+
</span><span class='kw'>end</span></pre>
|
|
763
|
+
</td>
|
|
764
|
+
</tr>
|
|
765
|
+
</table>
|
|
766
|
+
</div>
|
|
767
|
+
|
|
768
|
+
</div>
|
|
769
|
+
|
|
770
|
+
</div>
|
|
771
|
+
|
|
772
|
+
<div id="footer">
|
|
773
|
+
Generated on Mon Jul 31 21:48:57 2017 by
|
|
774
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
775
|
+
0.9.9 (ruby-2.3.3).
|
|
776
|
+
</div>
|
|
777
|
+
|
|
778
|
+
</div>
|
|
779
|
+
</body>
|
|
780
|
+
</html>
|