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.
Files changed (137) hide show
  1. checksums.yaml +4 -4
  2. data/.byebug_history +6 -3
  3. data/CHANGELOG.md +24 -0
  4. data/README.md +194 -84
  5. data/documentation/RRTF.html +5 -5
  6. data/documentation/RRTF/AnonymousStyle.html +792 -0
  7. data/documentation/RRTF/BorderFormatting.html +821 -0
  8. data/documentation/RRTF/BorderStyle.html +493 -0
  9. data/documentation/RRTF/CharacterFormatting.html +293 -162
  10. data/documentation/RRTF/CharacterStyle.html +53 -109
  11. data/documentation/RRTF/Colour.html +61 -1
  12. data/documentation/RRTF/ColourTable.html +52 -52
  13. data/documentation/RRTF/CommandNode.html +367 -971
  14. data/documentation/RRTF/ContainerNode.html +44 -44
  15. data/documentation/RRTF/Converters.html +1 -1
  16. data/documentation/RRTF/Converters/HTML.html +1 -1
  17. data/documentation/RRTF/Converters/HTML/Helpers.html +1 -1
  18. data/documentation/RRTF/Converters/HTML/Node.html +1 -1
  19. data/documentation/RRTF/Converters/HTML/NodeSet.html +1 -1
  20. data/documentation/RRTF/Document.html +267 -255
  21. data/documentation/RRTF/DocumentFormatting.html +833 -0
  22. data/documentation/RRTF/DocumentProperties.html +444 -0
  23. data/documentation/RRTF/Font.html +1 -1
  24. data/documentation/RRTF/FontTable.html +1 -1
  25. data/documentation/RRTF/FooterNode.html +16 -16
  26. data/documentation/RRTF/GeometryNode.html +774 -0
  27. data/documentation/RRTF/GeometryProperties.html +1014 -0
  28. data/documentation/RRTF/HeaderNode.html +16 -16
  29. data/documentation/RRTF/ImageNode.html +705 -492
  30. data/documentation/RRTF/Information.html +1 -1
  31. data/documentation/RRTF/LinkNode.html +10 -10
  32. data/documentation/RRTF/ListLevel.html +1 -1
  33. data/documentation/RRTF/ListLevelNode.html +37 -37
  34. data/documentation/RRTF/ListMarker.html +1 -1
  35. data/documentation/RRTF/ListNode.html +19 -19
  36. data/documentation/RRTF/ListTable.html +1 -1
  37. data/documentation/RRTF/ListTemplate.html +1 -1
  38. data/documentation/RRTF/ListTextNode.html +14 -14
  39. data/documentation/RRTF/Node.html +26 -26
  40. data/documentation/RRTF/Page.html +129 -0
  41. data/documentation/RRTF/Page/Margin.html +1158 -0
  42. data/documentation/RRTF/Page/Size.html +946 -0
  43. data/documentation/RRTF/PageFormatting.html +954 -0
  44. data/documentation/RRTF/ParagraphFormatting.html +338 -56
  45. data/documentation/RRTF/ParagraphNode.html +10 -10
  46. data/documentation/RRTF/ParagraphStyle.html +72 -111
  47. data/documentation/RRTF/PositionFormatting.html +780 -0
  48. data/documentation/RRTF/PositionStyle.html +424 -0
  49. data/documentation/RRTF/Properties.html +243 -0
  50. data/documentation/RRTF/RTFError.html +21 -10
  51. data/documentation/RRTF/ShadingFormatting.html +712 -0
  52. data/documentation/RRTF/ShadingStyle.html +424 -0
  53. data/documentation/RRTF/Style.html +284 -697
  54. data/documentation/RRTF/Stylesheet.html +36 -3
  55. data/documentation/RRTF/TableCellNode.html +131 -131
  56. data/documentation/RRTF/TableNode.html +82 -82
  57. data/documentation/RRTF/TableRowNode.html +53 -53
  58. data/documentation/RRTF/TextNode.html +46 -46
  59. data/documentation/RRTF/Utilities.html +837 -17
  60. data/documentation/_index.html +139 -6
  61. data/documentation/class_list.html +1 -1
  62. data/documentation/file.README.html +218 -87
  63. data/documentation/index.html +218 -87
  64. data/documentation/method_list.html +631 -391
  65. data/documentation/top-level-namespace.html +1 -1
  66. data/examples/01.rtf +947 -20
  67. data/examples/01_everything.rb +176 -0
  68. data/examples/02.rtf +13 -0
  69. data/examples/02_basic_paragraph.rb +10 -0
  70. data/examples/03.rtf +20 -0
  71. data/examples/03_paragraph_inline_style.rb +14 -0
  72. data/examples/04.rtf +21 -0
  73. data/examples/04_paragraph_with_character_style.rb +18 -0
  74. data/examples/05.rtf +21 -0
  75. data/examples/05_hyperlinks.rb +21 -0
  76. data/examples/06.rtf +21 -0
  77. data/examples/06_basic_list.rb +21 -0
  78. data/examples/07.rtf +28 -0
  79. data/examples/07_nested_list.rb +27 -0
  80. data/examples/08.rtf +807 -0
  81. data/examples/08_images.rb +17 -0
  82. data/examples/09.rtf +84 -0
  83. data/examples/09_shapes.rb +56 -0
  84. data/examples/10.rtf +34 -0
  85. data/examples/10_stylesheet.rb +18 -0
  86. data/examples/resources/images/redshirt.png +0 -0
  87. data/examples/resources/images/redshirts.jpg +0 -0
  88. data/examples/resources/json/redshirt_styles.json +72 -8
  89. data/examples/~$01.rtf +0 -0
  90. data/lib/rrtf.rb +4 -16
  91. data/lib/rrtf/colour.rb +8 -0
  92. data/lib/rrtf/formatting.rb +988 -0
  93. data/lib/rrtf/node.rb +17 -1851
  94. data/lib/rrtf/node/command_node.rb +242 -0
  95. data/lib/rrtf/node/container_node.rb +75 -0
  96. data/lib/rrtf/node/document.rb +339 -0
  97. data/lib/rrtf/node/footer_node.rb +47 -0
  98. data/lib/rrtf/node/geometry_node.rb +65 -0
  99. data/lib/rrtf/node/header_node.rb +47 -0
  100. data/lib/rrtf/node/image_node.rb +175 -0
  101. data/lib/rrtf/node/link_node.rb +10 -0
  102. data/lib/rrtf/node/list_level_node.rb +44 -0
  103. data/lib/rrtf/node/list_node.rb +30 -0
  104. data/lib/rrtf/node/list_text_node.rb +22 -0
  105. data/lib/rrtf/node/node.rb +53 -0
  106. data/lib/rrtf/node/paragraph_node.rb +11 -0
  107. data/lib/rrtf/node/table_cell_node.rb +233 -0
  108. data/lib/rrtf/node/table_node.rb +136 -0
  109. data/lib/rrtf/node/table_row_node.rb +92 -0
  110. data/lib/rrtf/node/text_node.rb +76 -0
  111. data/lib/rrtf/page.rb +7 -0
  112. data/lib/rrtf/page/margin.rb +98 -0
  113. data/lib/rrtf/page/size.rb +98 -0
  114. data/lib/rrtf/properties.rb +3 -0
  115. data/lib/rrtf/properties/document_properties.rb +34 -0
  116. data/lib/rrtf/properties/geometry_properties.rb +380 -0
  117. data/lib/rrtf/properties/properties.rb +13 -0
  118. data/lib/rrtf/style.rb +4 -5
  119. data/lib/rrtf/style/anonymous_style.rb +73 -0
  120. data/lib/rrtf/style/border_style.rb +27 -0
  121. data/lib/rrtf/style/character_style.rb +1 -7
  122. data/lib/rrtf/style/paragraph_style.rb +0 -6
  123. data/lib/rrtf/style/position_style.rb +26 -0
  124. data/lib/rrtf/style/shading_style.rb +26 -0
  125. data/lib/rrtf/style/style.rb +60 -101
  126. data/lib/rrtf/utilities.rb +138 -0
  127. data/lib/rrtf/version.rb +1 -1
  128. data/rrtf.gemspec +1 -0
  129. metadata +85 -10
  130. data/examples/01_mac_libreoffice5_2_3_3.png +0 -0
  131. data/examples/01_mac_pages6_2.png +0 -0
  132. data/examples/01_mac_textedit1_12.png +0 -0
  133. data/examples/01_mac_word15_36.png +0 -0
  134. data/examples/01_styles_and_paragraphs.rb +0 -32
  135. data/lib/rrtf/paper.rb +0 -53
  136. data/lib/rrtf/style/document_style.rb +0 -116
  137. data/lib/rrtf/style/formatting.rb +0 -320
data/documentation/RRTF/Page/Size.html ADDED
@@ -0,0 +1,946 @@
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
+ Class: RRTF::Page::Size
8
+
9
+ &mdash; 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::Page::Size";
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 (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../RRTF.html" title="RRTF (module)">RRTF</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Page.html" title="RRTF::Page (module)">Page</a></span></span>
41
+ &raquo;
42
+ <span class="title">Size</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>Class: RRTF::Page::Size
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">RRTF::Page::Size</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/rrtf/page/size.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Represents the size of a page (width and height).</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+ <p class="tag_title">Author:</p>
113
+ <ul class="author">
114
+
115
+ <li>
116
+
117
+
118
+
119
+
120
+
121
+ <div class='inline'>
122
+ <p>Wesley Hileman</p>
123
+ </div>
124
+
125
+ </li>
126
+
127
+ </ul>
128
+ <p class="tag_title">Since:</p>
129
+ <ul class="since">
130
+
131
+ <li>
132
+
133
+
134
+
135
+
136
+
137
+ <div class='inline'>
138
+ <p>1.0.0</p>
139
+ </div>
140
+
141
+ </li>
142
+
143
+ </ul>
144
+
145
+ </div>
146
+ <h2>Constant Summary</h2>
147
+ <dl class="constants">
148
+
149
+ <dt id="DICTIONARY-constant" class="">DICTIONARY =
150
+ <div class="docstring">
151
+ <div class="discussion">
152
+
153
+ <p>Dictionary of standard paper sizes in twips.</p>
154
+
155
+
156
+ </div>
157
+ </div>
158
+ <div class="tags">
159
+
160
+ <p class="tag_title">Since:</p>
161
+ <ul class="since">
162
+
163
+ <li>
164
+
165
+
166
+
167
+
168
+
169
+ <div class='inline'>
170
+ <p>1.0.0</p>
171
+ </div>
172
+
173
+ </li>
174
+
175
+ </ul>
176
+
177
+ </div>
178
+ </dt>
179
+ <dd><pre class="code"><span class='lbrace'>{</span>
180
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A0</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>47685</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>67416</span><span class='rbrace'>}</span><span class='comma'>,</span>
181
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A1</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>33680</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>47685</span><span class='rbrace'>}</span><span class='comma'>,</span>
182
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A2</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>23814</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>33680</span><span class='rbrace'>}</span><span class='comma'>,</span>
183
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A3</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>16840</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>23814</span><span class='rbrace'>}</span><span class='comma'>,</span>
184
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A4</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>11907</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>16840</span><span class='rbrace'>}</span><span class='comma'>,</span>
185
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A5</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>8392</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>11907</span><span class='rbrace'>}</span><span class='comma'>,</span>
186
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>LETTER</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>12247</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>15819</span><span class='rbrace'>}</span><span class='comma'>,</span>
187
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>LEGAL</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>12247</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>20185</span><span class='rbrace'>}</span><span class='comma'>,</span>
188
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>EXECUTIVE</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>10773</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>14402</span><span class='rbrace'>}</span><span class='comma'>,</span>
189
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>LEDGER_TABLOID</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>15819</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>24494</span><span class='rbrace'>}</span>
190
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
191
+
192
+ </dl>
193
+
194
+
195
+
196
+
197
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
198
+ <ul class="summary">
199
+
200
+ <li class="public ">
201
+ <span class="summary_signature">
202
+
203
+ <a href="#height-instance_method" title="#height (instance method)">#<strong>height</strong> &#x21d2; Object </a>
204
+
205
+
206
+
207
+ </span>
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+ <span class="summary_desc"><div class='inline'></div></span>
221
+
222
+ </li>
223
+
224
+
225
+ <li class="public ">
226
+ <span class="summary_signature">
227
+
228
+ <a href="#width-instance_method" title="#width (instance method)">#<strong>width</strong> &#x21d2; Object </a>
229
+
230
+
231
+
232
+ </span>
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+ <span class="summary_desc"><div class='inline'></div></span>
246
+
247
+ </li>
248
+
249
+
250
+ </ul>
251
+
252
+
253
+
254
+
255
+
256
+ <h2>
257
+ Class Method Summary
258
+ <small><a href="#" class="summary_toggle">collapse</a></small>
259
+ </h2>
260
+
261
+ <ul class="summary">
262
+
263
+ <li class="public ">
264
+ <span class="summary_signature">
265
+
266
+ <a href="#from_string-class_method" title="from_string (class method)">.<strong>from_string</strong>(string) &#x21d2; Size </a>
267
+
268
+
269
+
270
+ </span>
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+ <span class="summary_desc"><div class='inline'>
281
+ <p>Converts a string representing a paper size into a paper object.</p>
282
+ </div></span>
283
+
284
+ </li>
285
+
286
+
287
+ <li class="public ">
288
+ <span class="summary_signature">
289
+
290
+ <a href="#parse_string-class_method" title="parse_string (class method)">.<strong>parse_string</strong>(string) &#x21d2; Hash&lt;String, Integer&gt; </a>
291
+
292
+
293
+
294
+ </span>
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <span class="summary_desc"><div class='inline'>
305
+ <p>Converts a string representing a paper size into an ordered pair (a
306
+ two-item array) representing the width and height of the paper.</p>
307
+ </div></span>
308
+
309
+ </li>
310
+
311
+
312
+ </ul>
313
+
314
+ <h2>
315
+ Instance Method Summary
316
+ <small><a href="#" class="summary_toggle">collapse</a></small>
317
+ </h2>
318
+
319
+ <ul class="summary">
320
+
321
+ <li class="public ">
322
+ <span class="summary_signature">
323
+
324
+ <a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(obj) &#x21d2; Object </a>
325
+
326
+
327
+
328
+ (also: #eql?)
329
+
330
+ </span>
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+ <span class="summary_desc"><div class='inline'></div></span>
341
+
342
+ </li>
343
+
344
+
345
+ <li class="public ">
346
+ <span class="summary_signature">
347
+
348
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(value = nil) &#x21d2; Size </a>
349
+
350
+
351
+
352
+ </span>
353
+
354
+
355
+ <span class="note title constructor">constructor</span>
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+ <span class="summary_desc"><div class='inline'>
365
+ <p>This is the constructor for the Paper class.</p>
366
+ </div></span>
367
+
368
+ </li>
369
+
370
+
371
+ </ul>
372
+
373
+
374
+ <div id="constructor_details" class="method_details_list">
375
+ <h2>Constructor Details</h2>
376
+
377
+ <div class="method_details first">
378
+ <h3 class="signature first" id="initialize-instance_method">
379
+
380
+ #<strong>initialize</strong>(value = nil) &#x21d2; <tt><span class='object_link'><a href="" title="RRTF::Page::Size (class)">Size</a></span></tt>
381
+
382
+
383
+
384
+
385
+
386
+ </h3><div class="docstring">
387
+ <div class="discussion">
388
+
389
+ <div class="note notetag">
390
+ <strong>Note:</strong>
391
+ <div class='inline'>
392
+ <p>Paper size is stored internally in twentieth points (twips).</p>
393
+ </div>
394
+ </div>
395
+
396
+
397
+ <p>This is the constructor for the Paper class. All dimension parameters to
398
+ this method are in twips.</p>
399
+
400
+
401
+ </div>
402
+ </div>
403
+ <div class="tags">
404
+ <p class="tag_title">Parameters:</p>
405
+ <ul class="param">
406
+
407
+ <li>
408
+
409
+ <span class='name'>value</span>
410
+
411
+
412
+ <span class='type'>(<tt>String</tt>, <tt>Hash</tt>)</span>
413
+
414
+
415
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
416
+
417
+
418
+ &mdash;
419
+ <div class='inline'>
420
+ <p>from which to parse the size.</p>
421
+ </div>
422
+
423
+ </li>
424
+
425
+ </ul>
426
+
427
+
428
+
429
+
430
+ <p class="tag_title">Options Hash (<tt>value</tt>):</p>
431
+ <ul class="option">
432
+
433
+ <li>
434
+ <span class="name">"width"</span>
435
+ <span class="type">(<tt>Integer</tt>)</span>
436
+ <span class="default">
437
+
438
+ </span>
439
+
440
+ &mdash; <div class='inline'>
441
+ <p>the width of the paper in portrait mode (twips).</p>
442
+ </div>
443
+
444
+ </li>
445
+
446
+ </ul>
447
+
448
+
449
+
450
+ <p class="tag_title">See Also:</p>
451
+ <ul class="see">
452
+
453
+ <li><span class='object_link'><a href="#from_string-class_method" title="RRTF::Page::Size.from_string (method)">from_string</a></span></li>
454
+
455
+ <li><span class='object_link'><a href="#parse_string-class_method" title="RRTF::Page::Size.parse_string (method)">parse_string</a></span></li>
456
+
457
+ <li><span class='object_link'><a href="../Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">Utilities.value2twips</a></span></li>
458
+
459
+ </ul>
460
+ <p class="tag_title">Since:</p>
461
+ <ul class="since">
462
+
463
+ <li>
464
+
465
+
466
+
467
+
468
+
469
+ <div class='inline'>
470
+ <p>1.0.0</p>
471
+ </div>
472
+
473
+ </li>
474
+
475
+ </ul>
476
+
477
+ </div><table class="source_code">
478
+ <tr>
479
+ <td>
480
+ <pre class="lines">
481
+
482
+
483
+ 66
484
+ 67
485
+ 68
486
+ 69
487
+ 70
488
+ 71
489
+ 72
490
+ 73
491
+ 74
492
+ 75
493
+ 76
494
+ 77
495
+ 78
496
+ 79
497
+ 80
498
+ 81
499
+ 82
500
+ 83
501
+ 84
502
+ 85</pre>
503
+ </td>
504
+ <td>
505
+ <pre class="code"><span class="info file"># File 'lib/rrtf/page/size.rb', line 66</span>
506
+
507
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
508
+ <span class='comment'># default options
509
+ </span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
510
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>12247</span><span class='comma'>,</span>
511
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>15819</span>
512
+ <span class='rbrace'>}</span>
513
+
514
+ <span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
515
+ <span class='kw'>when</span> <span class='const'>String</span>
516
+ <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_parse_string'>parse_string</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='rparen'>)</span>
517
+ <span class='kw'>when</span> <span class='const'>Hash</span>
518
+ <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
519
+ <span class='kw'>when</span> <span class='kw'>nil</span>
520
+ <span class='kw'>else</span>
521
+ <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="../RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="../RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid page size format </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
522
+ <span class='kw'>end</span> <span class='comment'># case
523
+ </span>
524
+ <span class='ivar'>@width</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
525
+ <span class='ivar'>@height</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
526
+ <span class='kw'>end</span></pre>
527
+ </td>
528
+ </tr>
529
+ </table>
530
+ </div>
531
+
532
+ </div>
533
+
534
+ <div id="instance_attr_details" class="attr_details">
535
+ <h2>Instance Attribute Details</h2>
536
+
537
+
538
+ <span id="height=-instance_method"></span>
539
+ <div class="method_details first">
540
+ <h3 class="signature first" id="height-instance_method">
541
+
542
+ #<strong>height</strong> &#x21d2; <tt>Object</tt>
543
+
544
+
545
+
546
+
547
+
548
+ </h3><div class="docstring">
549
+ <div class="discussion">
550
+
551
+
552
+ </div>
553
+ </div>
554
+ <div class="tags">
555
+
556
+ <p class="tag_title">Since:</p>
557
+ <ul class="since">
558
+
559
+ <li>
560
+
561
+
562
+
563
+
564
+
565
+ <div class='inline'>
566
+ <p>1.0.0</p>
567
+ </div>
568
+
569
+ </li>
570
+
571
+ </ul>
572
+
573
+ </div><table class="source_code">
574
+ <tr>
575
+ <td>
576
+ <pre class="lines">
577
+
578
+
579
+ 6
580
+ 7
581
+ 8</pre>
582
+ </td>
583
+ <td>
584
+ <pre class="code"><span class="info file"># File 'lib/rrtf/page/size.rb', line 6</span>
585
+
586
+ <span class='kw'>def</span> <span class='id identifier rubyid_height'>height</span>
587
+ <span class='ivar'>@height</span>
588
+ <span class='kw'>end</span></pre>
589
+ </td>
590
+ </tr>
591
+ </table>
592
+ </div>
593
+
594
+
595
+ <span id="width=-instance_method"></span>
596
+ <div class="method_details ">
597
+ <h3 class="signature " id="width-instance_method">
598
+
599
+ #<strong>width</strong> &#x21d2; <tt>Object</tt>
600
+
601
+
602
+
603
+
604
+
605
+ </h3><div class="docstring">
606
+ <div class="discussion">
607
+
608
+
609
+ </div>
610
+ </div>
611
+ <div class="tags">
612
+
613
+ <p class="tag_title">Since:</p>
614
+ <ul class="since">
615
+
616
+ <li>
617
+
618
+
619
+
620
+
621
+
622
+ <div class='inline'>
623
+ <p>1.0.0</p>
624
+ </div>
625
+
626
+ </li>
627
+
628
+ </ul>
629
+
630
+ </div><table class="source_code">
631
+ <tr>
632
+ <td>
633
+ <pre class="lines">
634
+
635
+
636
+ 6
637
+ 7
638
+ 8</pre>
639
+ </td>
640
+ <td>
641
+ <pre class="code"><span class="info file"># File 'lib/rrtf/page/size.rb', line 6</span>
642
+
643
+ <span class='kw'>def</span> <span class='id identifier rubyid_width'>width</span>
644
+ <span class='ivar'>@width</span>
645
+ <span class='kw'>end</span></pre>
646
+ </td>
647
+ </tr>
648
+ </table>
649
+ </div>
650
+
651
+ </div>
652
+
653
+
654
+ <div id="class_method_details" class="method_details_list">
655
+ <h2>Class Method Details</h2>
656
+
657
+
658
+ <div class="method_details first">
659
+ <h3 class="signature first" id="from_string-class_method">
660
+
661
+ .<strong>from_string</strong>(string) &#x21d2; <tt><span class='object_link'><a href="" title="RRTF::Page::Size (class)">Size</a></span></tt>
662
+
663
+
664
+
665
+
666
+
667
+ </h3><div class="docstring">
668
+ <div class="discussion">
669
+
670
+ <p>Converts a string representing a paper size into a paper object.</p>
671
+
672
+
673
+ </div>
674
+ </div>
675
+ <div class="tags">
676
+
677
+ <p class="tag_title">Returns:</p>
678
+ <ul class="return">
679
+
680
+ <li>
681
+
682
+
683
+ <span class='type'>(<tt><span class='object_link'><a href="" title="RRTF::Page::Size (class)">Size</a></span></tt>)</span>
684
+
685
+
686
+
687
+ &mdash;
688
+ <div class='inline'>
689
+ <p>the paper object representing the width &amp; height of the paper.</p>
690
+ </div>
691
+
692
+ </li>
693
+
694
+ </ul>
695
+
696
+ <p class="tag_title">See Also:</p>
697
+ <ul class="see">
698
+
699
+ <li><span class='object_link'><a href="#parse_string-class_method" title="RRTF::Page::Size.parse_string (method)">parse_string</a></span></li>
700
+
701
+ </ul>
702
+ <p class="tag_title">Since:</p>
703
+ <ul class="since">
704
+
705
+ <li>
706
+
707
+
708
+
709
+
710
+
711
+ <div class='inline'>
712
+ <p>1.0.0</p>
713
+ </div>
714
+
715
+ </li>
716
+
717
+ </ul>
718
+
719
+ </div><table class="source_code">
720
+ <tr>
721
+ <td>
722
+ <pre class="lines">
723
+
724
+
725
+ 27
726
+ 28
727
+ 29</pre>
728
+ </td>
729
+ <td>
730
+ <pre class="code"><span class="info file"># File 'lib/rrtf/page/size.rb', line 27</span>
731
+
732
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_string'>from_string</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
733
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_string'>parse_string</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span><span class='rparen'>)</span>
734
+ <span class='kw'>end</span></pre>
735
+ </td>
736
+ </tr>
737
+ </table>
738
+ </div>
739
+
740
+ <div class="method_details ">
741
+ <h3 class="signature " id="parse_string-class_method">
742
+
743
+ .<strong>parse_string</strong>(string) &#x21d2; <tt>Hash&lt;String, Integer&gt;</tt>
744
+
745
+
746
+
747
+
748
+
749
+ </h3><div class="docstring">
750
+ <div class="discussion">
751
+
752
+ <p>Converts a string representing a paper size into an ordered pair (a
753
+ two-item array) representing the width and height of the paper.</p>
754
+
755
+
756
+ </div>
757
+ </div>
758
+ <div class="tags">
759
+ <p class="tag_title">Parameters:</p>
760
+ <ul class="param">
761
+
762
+ <li>
763
+
764
+ <span class='name'>string</span>
765
+
766
+
767
+ <span class='type'>(<tt>String</tt>)</span>
768
+
769
+
770
+
771
+ &mdash;
772
+ <div class='inline'>
773
+ <p>the string to be parsed that can take on one of two formats: (1)
774
+ “&lt;SIZE&gt;” where SIZE is an entry in <span class='object_link'><a href="#DICTIONARY-constant" title="RRTF::Page::Size::DICTIONARY (constant)">DICTIONARY</a></span> or (2) “WIDTH,
775
+ HEIGHT” where WIDTH and HEIGHT are width and height strings with optional
776
+ units suffix (see <span class='object_link'><a href="../Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">Utilities.value2twips</a></span>, default is twips)</p>
777
+ </div>
778
+
779
+ </li>
780
+
781
+ </ul>
782
+
783
+ <p class="tag_title">Returns:</p>
784
+ <ul class="return">
785
+
786
+ <li>
787
+
788
+
789
+ <span class='type'>(<tt>Hash&lt;String, Integer&gt;</tt>)</span>
790
+
791
+
792
+
793
+ &mdash;
794
+ <div class='inline'>
795
+ <p>the ordered pair (hash with keys “width” and “height”) representing the
796
+ width and height of the paper.</p>
797
+ </div>
798
+
799
+ </li>
800
+
801
+ </ul>
802
+
803
+ <p class="tag_title">See Also:</p>
804
+ <ul class="see">
805
+
806
+ <li><span class='object_link'><a href="../Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">Utilities.value2twips</a></span></li>
807
+
808
+ </ul>
809
+ <p class="tag_title">Since:</p>
810
+ <ul class="since">
811
+
812
+ <li>
813
+
814
+
815
+
816
+
817
+
818
+ <div class='inline'>
819
+ <p>1.0.0</p>
820
+ </div>
821
+
822
+ </li>
823
+
824
+ </ul>
825
+
826
+ </div><table class="source_code">
827
+ <tr>
828
+ <td>
829
+ <pre class="lines">
830
+
831
+
832
+ 42
833
+ 43
834
+ 44
835
+ 45
836
+ 46
837
+ 47
838
+ 48
839
+ 49
840
+ 50
841
+ 51
842
+ 52
843
+ 53
844
+ 54
845
+ 55</pre>
846
+ </td>
847
+ <td>
848
+ <pre class="code"><span class="info file"># File 'lib/rrtf/page/size.rb', line 42</span>
849
+
850
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_string'>parse_string</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
851
+ <span class='comment'># first, try to lookup in size dictionary
852
+ </span> <span class='id identifier rubyid_size'>size</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#DICTIONARY-constant" title="RRTF::Page::Size::DICTIONARY (constant)">DICTIONARY</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_string'>string</span><span class='rbracket'>]</span>
853
+ <span class='kw'>return</span> <span class='id identifier rubyid_size'>size</span> <span class='kw'>unless</span> <span class='id identifier rubyid_size'>size</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
854
+
855
+ <span class='comment'># if not found, try to extract width and height from string
856
+ </span> <span class='id identifier rubyid_parts'>parts</span> <span class='op'>=</span> <span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>,</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:strip</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_str'>str</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../../RRTF.html" title="RRTF (module)">RRTF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Utilities.html" title="RRTF::Utilities (class)">Utilities</a></span></span><span class='period'>.</span><span class='id identifier rubyid_value2twips'><span class='object_link'><a href="../Utilities.html#value2twips-class_method" title="RRTF::Utilities.value2twips (method)">value2twips</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
857
+ <span class='kw'>if</span> <span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>2</span>
858
+ <span class='kw'>return</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>width</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_parts'>parts</span> <span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>height</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_parts'>parts</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbrace'>}</span>
859
+ <span class='kw'>end</span> <span class='comment'># if
860
+ </span>
861
+ <span class='comment'># unable to parse string
862
+ </span> <span class='const'><span class='object_link'><a href="../RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="../RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unable to parse size from string &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_string'>string</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39;.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
863
+ <span class='kw'>end</span></pre>
864
+ </td>
865
+ </tr>
866
+ </table>
867
+ </div>
868
+
869
+ </div>
870
+
871
+ <div id="instance_method_details" class="method_details_list">
872
+ <h2>Instance Method Details</h2>
873
+
874
+
875
+ <div class="method_details first">
876
+ <h3 class="signature first" id="==-instance_method">
877
+
878
+ #<strong>==</strong>(obj) &#x21d2; <tt>Object</tt>
879
+
880
+
881
+
882
+ <span class="aliases">Also known as:
883
+ <span class="names"><span id='eql?-instance_method'>eql?</span></span>
884
+ </span>
885
+
886
+
887
+
888
+ </h3><div class="docstring">
889
+ <div class="discussion">
890
+
891
+
892
+ </div>
893
+ </div>
894
+ <div class="tags">
895
+
896
+ <p class="tag_title">Since:</p>
897
+ <ul class="since">
898
+
899
+ <li>
900
+
901
+
902
+
903
+
904
+
905
+ <div class='inline'>
906
+ <p>1.0.0</p>
907
+ </div>
908
+
909
+ </li>
910
+
911
+ </ul>
912
+
913
+ </div><table class="source_code">
914
+ <tr>
915
+ <td>
916
+ <pre class="lines">
917
+
918
+
919
+ 87
920
+ 88
921
+ 89</pre>
922
+ </td>
923
+ <td>
924
+ <pre class="code"><span class="info file"># File 'lib/rrtf/page/size.rb', line 87</span>
925
+
926
+ <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
927
+ <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>==</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_state'>state</span> <span class='op'>==</span> <span class='id identifier rubyid_state'>state</span>
928
+ <span class='kw'>end</span></pre>
929
+ </td>
930
+ </tr>
931
+ </table>
932
+ </div>
933
+
934
+ </div>
935
+
936
+ </div>
937
+
938
+ <div id="footer">
939
+ Generated on Mon Jul 31 21:48:58 2017 by
940
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
941
+ 0.9.9 (ruby-2.3.3).
942
+ </div>
943
+
944
+ </div>
945
+ </body>
946
+ </html>