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/ShadingStyle.html ADDED
@@ -0,0 +1,424 @@
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::ShadingStyle
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::ShadingStyle";
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>
41
+ &raquo;
42
+ <span class="title">ShadingStyle</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::ShadingStyle
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></li>
78
+
79
+ <li class="next">RRTF::ShadingStyle</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+ <dl>
93
+ <dt>Includes:</dt>
94
+ <dd><span class='object_link'><a href="ShadingFormatting.html" title="RRTF::ShadingFormatting (module)">ShadingFormatting</a></span></dd>
95
+ </dl>
96
+
97
+
98
+
99
+
100
+
101
+
102
+ <dl>
103
+ <dt>Defined in:</dt>
104
+ <dd>lib/rrtf/style/shading_style.rb</dd>
105
+ </dl>
106
+
107
+ </div>
108
+
109
+ <h2>Overview</h2><div class="docstring">
110
+ <div class="discussion">
111
+
112
+ <p>Represents a set of formatting that can be applied to shade paragraphs.</p>
113
+
114
+
115
+ </div>
116
+ </div>
117
+ <div class="tags">
118
+
119
+
120
+ </div>
121
+
122
+
123
+ <h2>Constant Summary</h2>
124
+
125
+ <h3 class="inherited">Constants included
126
+ from <span class='object_link'><a href="ShadingFormatting.html" title="RRTF::ShadingFormatting (module)">ShadingFormatting</a></span></h3>
127
+ <p class="inherited"><span class='object_link'><a href="ShadingFormatting.html#SHADING_ATTRIBUTES-constant" title="RRTF::ShadingFormatting::SHADING_ATTRIBUTES (constant)">RRTF::ShadingFormatting::SHADING_ATTRIBUTES</a></span></p>
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <h2>
135
+ Instance Method Summary
136
+ <small><a href="#" class="summary_toggle">collapse</a></small>
137
+ </h2>
138
+
139
+ <ul class="summary">
140
+
141
+ <li class="public ">
142
+ <span class="summary_signature">
143
+
144
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {}) &#x21d2; ShadingStyle </a>
145
+
146
+
147
+
148
+ </span>
149
+
150
+
151
+ <span class="note title constructor">constructor</span>
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <span class="summary_desc"><div class='inline'>
161
+ <p>This is the constructor for the ShadingStyle class.</p>
162
+ </div></span>
163
+
164
+ </li>
165
+
166
+
167
+ <li class="public ">
168
+ <span class="summary_signature">
169
+
170
+ <a href="#prefix-instance_method" title="#prefix (instance method)">#<strong>prefix</strong>(document) &#x21d2; Object </a>
171
+
172
+
173
+
174
+ </span>
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ <span class="summary_desc"><div class='inline'>
185
+ <p>This method generates a string containing the prefix associated with the
186
+ style object.</p>
187
+ </div></span>
188
+
189
+ </li>
190
+
191
+
192
+ <li class="public ">
193
+ <span class="summary_signature">
194
+
195
+ <a href="#rtf_formatting-instance_method" title="#rtf_formatting (instance method)">#<strong>rtf_formatting</strong>(document) &#x21d2; Object </a>
196
+
197
+
198
+
199
+ </span>
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+ <span class="summary_desc"><div class='inline'></div></span>
210
+
211
+ </li>
212
+
213
+
214
+ </ul>
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ShadingFormatting.html" title="RRTF::ShadingFormatting (module)">ShadingFormatting</a></span></h3>
227
+ <p class="inherited"><span class='object_link'><a href="ShadingFormatting.html#included-class_method" title="RRTF::ShadingFormatting.included (method)">included</a></span>, <span class='object_link'><a href="ShadingFormatting.html#initialize_shading_formatting-instance_method" title="RRTF::ShadingFormatting#initialize_shading_formatting (method)">#initialize_shading_formatting</a></span>, <span class='object_link'><a href="ShadingFormatting.html#set_shading_formatting_from_hashmap-instance_method" title="RRTF::ShadingFormatting#set_shading_formatting_from_hashmap (method)">#set_shading_formatting_from_hashmap</a></span>, <span class='object_link'><a href="ShadingFormatting.html#shading_formatting_to_rtf-instance_method" title="RRTF::ShadingFormatting#shading_formatting_to_rtf (method)">#shading_formatting_to_rtf</a></span></p>
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></h3>
238
+ <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>
239
+ <div id="constructor_details" class="method_details_list">
240
+ <h2>Constructor Details</h2>
241
+
242
+ <div class="method_details first">
243
+ <h3 class="signature first" id="initialize-instance_method">
244
+
245
+ #<strong>initialize</strong>(options = {}) &#x21d2; <tt><span class='object_link'><a href="" title="RRTF::ShadingStyle (class)">ShadingStyle</a></span></tt>
246
+
247
+
248
+
249
+
250
+
251
+ </h3><div class="docstring">
252
+ <div class="discussion">
253
+
254
+ <p>This is the constructor for the ShadingStyle class.</p>
255
+
256
+
257
+ </div>
258
+ </div>
259
+ <div class="tags">
260
+ <p class="tag_title">Parameters:</p>
261
+ <ul class="param">
262
+
263
+ <li>
264
+
265
+ <span class='name'>options</span>
266
+
267
+
268
+ <span class='type'>(<tt>Hash</tt>)</span>
269
+
270
+
271
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
272
+
273
+
274
+ &mdash;
275
+ <div class='inline'>
276
+ <p>the shading style options.</p>
277
+ </div>
278
+
279
+ </li>
280
+
281
+ </ul>
282
+
283
+
284
+
285
+
286
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
287
+ <ul class="option">
288
+
289
+ <li>
290
+ <span class="name">"sides"</span>
291
+ <span class="type">(<tt>String</tt>)</span>
292
+ <span class="default">
293
+
294
+ &mdash; default:
295
+ <tt>&#39;ALL&#39;</tt>
296
+
297
+ </span>
298
+
299
+ &mdash; <div class='inline'>
300
+ <p>the sides to which the border applied (“ALL”, “LEFT”, “RIGHT”, “TOP”, or
301
+ “BOTTOM”).</p>
302
+ </div>
303
+
304
+ </li>
305
+
306
+ </ul>
307
+
308
+
309
+
310
+ </div><table class="source_code">
311
+ <tr>
312
+ <td>
313
+ <pre class="lines">
314
+
315
+
316
+ 11
317
+ 12
318
+ 13
319
+ 14</pre>
320
+ </td>
321
+ <td>
322
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/shading_style.rb', line 11</span>
323
+
324
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
325
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
326
+ <span class='id identifier rubyid_initialize_shading_formatting'>initialize_shading_formatting</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
327
+ <span class='kw'>end</span></pre>
328
+ </td>
329
+ </tr>
330
+ </table>
331
+ </div>
332
+
333
+ </div>
334
+
335
+
336
+ <div id="instance_method_details" class="method_details_list">
337
+ <h2>Instance Method Details</h2>
338
+
339
+
340
+ <div class="method_details first">
341
+ <h3 class="signature first" id="prefix-instance_method">
342
+
343
+ #<strong>prefix</strong>(document) &#x21d2; <tt>Object</tt>
344
+
345
+
346
+
347
+
348
+
349
+ </h3><div class="docstring">
350
+ <div class="discussion">
351
+
352
+ <p>This method generates a string containing the prefix associated with the
353
+ style object. Equivalent to <span class='object_link'><a href="#rtf_formatting-instance_method" title="RRTF::ShadingStyle#rtf_formatting (method)">#rtf_formatting</a></span> for the ShadingStyle class.</p>
354
+
355
+
356
+ </div>
357
+ </div>
358
+ <div class="tags">
359
+
360
+
361
+ </div><table class="source_code">
362
+ <tr>
363
+ <td>
364
+ <pre class="lines">
365
+
366
+
367
+ 18
368
+ 19
369
+ 20</pre>
370
+ </td>
371
+ <td>
372
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/shading_style.rb', line 18</span>
373
+
374
+ <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>
375
+ <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>
376
+ <span class='kw'>end</span></pre>
377
+ </td>
378
+ </tr>
379
+ </table>
380
+ </div>
381
+
382
+ <div class="method_details ">
383
+ <h3 class="signature " id="rtf_formatting-instance_method">
384
+
385
+ #<strong>rtf_formatting</strong>(document) &#x21d2; <tt>Object</tt>
386
+
387
+
388
+
389
+
390
+
391
+ </h3><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 22
398
+ 23
399
+ 24</pre>
400
+ </td>
401
+ <td>
402
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/shading_style.rb', line 22</span>
403
+
404
+ <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>
405
+ <span class='id identifier rubyid_shading_formatting_to_rtf'>shading_formatting_to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
406
+ <span class='kw'>end</span></pre>
407
+ </td>
408
+ </tr>
409
+ </table>
410
+ </div>
411
+
412
+ </div>
413
+
414
+ </div>
415
+
416
+ <div id="footer">
417
+ Generated on Mon Jul 31 21:49:01 2017 by
418
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
419
+ 0.9.9 (ruby-2.3.3).
420
+ </div>
421
+
422
+ </div>
423
+ </body>
424
+ </html>
data/documentation/RRTF/Style.html CHANGED
@@ -60,7 +60,7 @@
60
60
  </div>
61
61
 
62
62
  <div id="content"><h1>Class: RRTF::Style
63
-
63
+ <span class="abstract note title">Abstract</span>
64
64
 
65
65
 
66
66
  </h1>
@@ -69,11 +69,13 @@
69
69
  <dl>
70
70
  <dt>Inherits:</dt>
71
71
  <dd>
72
- <span class="inheritName">Object</span>
72
+ <span class="inheritName"><span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></span>
73
73
 
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">RRTF::Style</li>
78
80
 
79
81
  </ul>
@@ -101,18 +103,68 @@
101
103
 
102
104
  <h2>Overview</h2><div class="docstring">
103
105
  <div class="discussion">
104
-
105
- <p>This is a parent class that all style classes will derive from.</p>
106
+ <div class="note abstract">
107
+ <strong>This class is abstract.</strong>
108
+ <div class='inline'></div>
109
+ </div>
110
+
111
+ <p>Represents an abstract style that can be applied to elements within a
112
+ document AND appear in a document&#39;s stylesheet (i.e. paragraph,
113
+ character, table, &amp; section styles).</p>
106
114
 
107
115
 
108
116
  </div>
109
117
  </div>
110
118
  <div class="tags">
111
119
 
120
+ <p class="tag_title">Author:</p>
121
+ <ul class="author">
122
+
123
+ <li>
124
+
125
+
126
+
127
+
128
+
129
+ <div class='inline'>
130
+ <p>Wesley Hileman</p>
131
+ </div>
132
+
133
+ </li>
134
+
135
+ <li>
136
+
137
+
138
+
139
+
140
+
141
+ <div class='inline'>
142
+ <p>Peter Wood</p>
143
+ </div>
144
+
145
+ </li>
146
+
147
+ </ul>
148
+ <p class="tag_title">Since:</p>
149
+ <ul class="since">
150
+
151
+ <li>
152
+
153
+
154
+
155
+
156
+
157
+ <div class='inline'>
158
+ <p>legacy</p>
159
+ </div>
160
+
161
+ </li>
162
+
163
+ </ul>
112
164
 
113
165
  </div><div id="subclasses">
114
166
  <h2>Direct Known Subclasses</h2>
115
- <p class="children"><span class='object_link'><a href="CharacterStyle.html" title="RRTF::CharacterStyle (class)">CharacterStyle</a></span>, <span class='object_link'><a href="DocumentStyle.html" title="RRTF::DocumentStyle (class)">DocumentStyle</a></span>, <span class='object_link'><a href="ParagraphStyle.html" title="RRTF::ParagraphStyle (class)">ParagraphStyle</a></span></p>
167
+ <p class="children"><span class='object_link'><a href="CharacterStyle.html" title="RRTF::CharacterStyle (class)">CharacterStyle</a></span>, <span class='object_link'><a href="ParagraphStyle.html" title="RRTF::ParagraphStyle (class)">ParagraphStyle</a></span></p>
116
168
  </div>
117
169
 
118
170
 
@@ -141,9 +193,7 @@
141
193
 
142
194
 
143
195
 
144
- <span class="summary_desc"><div class='inline'>
145
- <p>Returns the value of attribute additive.</p>
146
- </div></span>
196
+ <span class="summary_desc"><div class='inline'></div></span>
147
197
 
148
198
  </li>
149
199
 
@@ -168,9 +218,7 @@
168
218
 
169
219
 
170
220
 
171
- <span class="summary_desc"><div class='inline'>
172
- <p>Returns the value of attribute auto_update.</p>
173
- </div></span>
221
+ <span class="summary_desc"><div class='inline'></div></span>
174
222
 
175
223
  </li>
176
224
 
@@ -195,9 +243,7 @@
195
243
 
196
244
 
197
245
 
198
- <span class="summary_desc"><div class='inline'>
199
- <p>Returns the value of attribute based_on_style_handle.</p>
200
- </div></span>
246
+ <span class="summary_desc"><div class='inline'></div></span>
201
247
 
202
248
  </li>
203
249
 
@@ -222,9 +268,7 @@
222
268
 
223
269
 
224
270
 
225
- <span class="summary_desc"><div class='inline'>
226
- <p>Returns the value of attribute handle.</p>
227
- </div></span>
271
+ <span class="summary_desc"><div class='inline'></div></span>
228
272
 
229
273
  </li>
230
274
 
@@ -249,9 +293,7 @@
249
293
 
250
294
 
251
295
 
252
- <span class="summary_desc"><div class='inline'>
253
- <p>Returns the value of attribute hidden.</p>
254
- </div></span>
296
+ <span class="summary_desc"><div class='inline'></div></span>
255
297
 
256
298
  </li>
257
299
 
@@ -276,9 +318,7 @@
276
318
 
277
319
 
278
320
 
279
- <span class="summary_desc"><div class='inline'>
280
- <p>Returns the value of attribute name.</p>
281
- </div></span>
321
+ <span class="summary_desc"><div class='inline'></div></span>
282
322
 
283
323
  </li>
284
324
 
@@ -303,9 +343,7 @@
303
343
 
304
344
 
305
345
 
306
- <span class="summary_desc"><div class='inline'>
307
- <p>Returns the value of attribute next_style_handle.</p>
308
- </div></span>
346
+ <span class="summary_desc"><div class='inline'></div></span>
309
347
 
310
348
  </li>
311
349
 
@@ -330,9 +368,7 @@
330
368
 
331
369
 
332
370
 
333
- <span class="summary_desc"><div class='inline'>
334
- <p>Returns the value of attribute primary.</p>
335
- </div></span>
371
+ <span class="summary_desc"><div class='inline'></div></span>
336
372
 
337
373
  </li>
338
374
 
@@ -357,9 +393,7 @@
357
393
 
358
394
 
359
395
 
360
- <span class="summary_desc"><div class='inline'>
361
- <p>Returns the value of attribute priority.</p>
362
- </div></span>
396
+ <span class="summary_desc"><div class='inline'></div></span>
363
397
 
364
398
  </li>
365
399
 
@@ -406,150 +440,7 @@
406
440
  <li class="public ">
407
441
  <span class="summary_signature">
408
442
 
409
- <a href="#is_character_style%3F-instance_method" title="#is_character_style? (instance method)">#<strong>is_character_style?</strong> &#x21d2; Boolean </a>
410
-
411
-
412
-
413
- </span>
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
- <span class="summary_desc"><div class='inline'>
424
- <p>Used to determine if the style applies to characters.</p>
425
- </div></span>
426
-
427
- </li>
428
-
429
-
430
- <li class="public ">
431
- <span class="summary_signature">
432
-
433
- <a href="#is_document_style%3F-instance_method" title="#is_document_style? (instance method)">#<strong>is_document_style?</strong> &#x21d2; Boolean </a>
434
-
435
-
436
-
437
- </span>
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
446
-
447
- <span class="summary_desc"><div class='inline'>
448
- <p>Used to determine if the style applies to documents.</p>
449
- </div></span>
450
-
451
- </li>
452
-
453
-
454
- <li class="public ">
455
- <span class="summary_signature">
456
-
457
- <a href="#is_paragraph_style%3F-instance_method" title="#is_paragraph_style? (instance method)">#<strong>is_paragraph_style?</strong> &#x21d2; Boolean </a>
458
-
459
-
460
-
461
- </span>
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
- <span class="summary_desc"><div class='inline'>
472
- <p>Used to determine if the style applies to paragraphs.</p>
473
- </div></span>
474
-
475
- </li>
476
-
477
-
478
- <li class="public ">
479
- <span class="summary_signature">
480
-
481
- <a href="#is_table_style%3F-instance_method" title="#is_table_style? (instance method)">#<strong>is_table_style?</strong> &#x21d2; Boolean </a>
482
-
483
-
484
-
485
- </span>
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
- <span class="summary_desc"><div class='inline'>
496
- <p>Used to determine if the style applies to tables.</p>
497
- </div></span>
498
-
499
- </li>
500
-
501
-
502
- <li class="public ">
503
- <span class="summary_signature">
504
-
505
- <a href="#prefix-instance_method" title="#prefix (instance method)">#<strong>prefix</strong>(document) &#x21d2; Object </a>
506
-
507
-
508
-
509
- </span>
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
- <span class="summary_desc"><div class='inline'>
520
- <p>This method retrieves the command prefix text associated with a Style
521
- object.</p>
522
- </div></span>
523
-
524
- </li>
525
-
526
-
527
- <li class="public ">
528
- <span class="summary_signature">
529
-
530
- <a href="#rtf_formatting-instance_method" title="#rtf_formatting (instance method)">#<strong>rtf_formatting</strong> &#x21d2; Object </a>
531
-
532
-
533
-
534
- </span>
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
- <span class="summary_desc"><div class='inline'></div></span>
545
-
546
- </li>
547
-
548
-
549
- <li class="public ">
550
- <span class="summary_signature">
551
-
552
- <a href="#styledef-instance_method" title="#styledef (instance method)">#<strong>styledef</strong> &#x21d2; Object </a>
443
+ <a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong>(document) &#x21d2; Object </a>
553
444
 
554
445
 
555
446
 
@@ -558,92 +449,32 @@ object.</p>
558
449
 
559
450
 
560
451
 
561
-
452
+ <span class="abstract note title">abstract</span>
562
453
 
563
454
 
564
455
 
565
456
 
566
457
  <span class="summary_desc"><div class='inline'>
567
- <p>Constructs an RTF identifier for the style.</p>
458
+ <p>Constructs the RTF formatting representing the style in a Stylesheet.</p>
568
459
  </div></span>
569
460
 
570
461
  </li>
571
462
 
572
463
 
573
- <li class="public ">
574
- <span class="summary_signature">
575
-
576
- <a href="#stylename-instance_method" title="#stylename (instance method)">#<strong>stylename</strong> &#x21d2; Object </a>
577
-
578
-
579
-
580
- </span>
581
-
582
-
583
-
584
-
585
-
586
-
587
-
588
-
589
-
590
- <span class="summary_desc"><div class='inline'></div></span>
591
-
592
- </li>
593
-
594
-
595
- <li class="public ">
596
- <span class="summary_signature">
597
-
598
- <a href="#suffix-instance_method" title="#suffix (instance method)">#<strong>suffix</strong>(document) &#x21d2; Object </a>
599
-
600
-
601
-
602
- </span>
603
-
604
-
605
-
606
-
607
-
608
-
609
-
610
-
611
-
612
- <span class="summary_desc"><div class='inline'>
613
- <p>This method retrieves the command suffix text associated with a Style
614
- object.</p>
615
- </div></span>
464
+ </ul>
616
465
 
617
- </li>
618
466
 
619
-
620
- <li class="public ">
621
- <span class="summary_signature">
622
-
623
- <a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong>(document) &#x21d2; Object </a>
624
-
625
467
 
626
-
627
- </span>
628
-
629
468
 
630
469
 
631
470
 
632
471
 
633
472
 
634
473
 
635
-
636
-
637
- <span class="summary_desc"><div class='inline'>
638
- <p>Constructs the RTF formatting representing the style.</p>
639
- </div></span>
640
474
 
641
- </li>
642
-
643
-
644
- </ul>
645
475
 
646
-
476
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></h3>
477
+ <p class="inherited"><span class='object_link'><a href="AnonymousStyle.html#prefix-instance_method" title="RRTF::AnonymousStyle#prefix (method)">#prefix</a></span>, <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#rtf_formatting-instance_method" title="RRTF::AnonymousStyle#rtf_formatting (method)">#rtf_formatting</a></span>, <span class='object_link'><a href="AnonymousStyle.html#suffix-instance_method" title="RRTF::AnonymousStyle#suffix (method)">#suffix</a></span></p>
647
478
  <div id="constructor_details" class="method_details_list">
648
479
  <h2>Constructor Details</h2>
649
480
 
@@ -839,20 +670,29 @@ style is applied is updated.</p>
839
670
  </ul>
840
671
 
841
672
 
842
-
673
+ <p class="tag_title">Since:</p>
674
+ <ul class="since">
675
+
676
+ <li>
677
+
678
+
679
+
680
+
681
+
682
+ <div class='inline'>
683
+ <p>legacy</p>
684
+ </div>
685
+
686
+ </li>
687
+
688
+ </ul>
689
+
843
690
  </div><table class="source_code">
844
691
  <tr>
845
692
  <td>
846
693
  <pre class="lines">
847
694
 
848
695
 
849
- 19
850
- 20
851
- 21
852
- 22
853
- 23
854
- 24
855
- 25
856
696
  26
857
697
  27
858
698
  28
@@ -869,10 +709,18 @@ style is applied is updated.</p>
869
709
  39
870
710
  40
871
711
  41
872
- 42</pre>
712
+ 42
713
+ 43
714
+ 44
715
+ 45
716
+ 46
717
+ 47
718
+ 48
719
+ 49
720
+ 50</pre>
873
721
  </td>
874
722
  <td>
875
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 19</span>
723
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 26</span>
876
724
 
877
725
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
878
726
  <span class='comment'># load default options
@@ -887,6 +735,7 @@ style is applied is updated.</p>
887
735
  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>based_on_style_handle</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span>
888
736
  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>hidden</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='kw'>false</span>
889
737
  <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
738
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
890
739
 
891
740
  <span class='ivar'>@handle</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'>handle</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
892
741
  <span class='ivar'>@name</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'>name</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
@@ -922,13 +771,27 @@ style is applied is updated.</p>
922
771
  </h3><div class="docstring">
923
772
  <div class="discussion">
924
773
 
925
- <p>Returns the value of attribute additive</p>
926
-
927
774
 
928
775
  </div>
929
776
  </div>
930
777
  <div class="tags">
931
778
 
779
+ <p class="tag_title">Since:</p>
780
+ <ul class="since">
781
+
782
+ <li>
783
+
784
+
785
+
786
+
787
+
788
+ <div class='inline'>
789
+ <p>legacy</p>
790
+ </div>
791
+
792
+ </li>
793
+
794
+ </ul>
932
795
 
933
796
  </div><table class="source_code">
934
797
  <tr>
@@ -936,12 +799,12 @@ style is applied is updated.</p>
936
799
  <pre class="lines">
937
800
 
938
801
 
939
- 3
940
- 4
941
- 5</pre>
802
+ 10
803
+ 11
804
+ 12</pre>
942
805
  </td>
943
806
  <td>
944
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
807
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
945
808
 
946
809
  <span class='kw'>def</span> <span class='id identifier rubyid_additive'>additive</span>
947
810
  <span class='ivar'>@additive</span>
@@ -965,13 +828,27 @@ style is applied is updated.</p>
965
828
  </h3><div class="docstring">
966
829
  <div class="discussion">
967
830
 
968
- <p>Returns the value of attribute auto_update</p>
969
-
970
831
 
971
832
  </div>
972
833
  </div>
973
834
  <div class="tags">
974
835
 
836
+ <p class="tag_title">Since:</p>
837
+ <ul class="since">
838
+
839
+ <li>
840
+
841
+
842
+
843
+
844
+
845
+ <div class='inline'>
846
+ <p>legacy</p>
847
+ </div>
848
+
849
+ </li>
850
+
851
+ </ul>
975
852
 
976
853
  </div><table class="source_code">
977
854
  <tr>
@@ -979,12 +856,12 @@ style is applied is updated.</p>
979
856
  <pre class="lines">
980
857
 
981
858
 
982
- 3
983
- 4
984
- 5</pre>
859
+ 10
860
+ 11
861
+ 12</pre>
985
862
  </td>
986
863
  <td>
987
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
864
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
988
865
 
989
866
  <span class='kw'>def</span> <span class='id identifier rubyid_auto_update'>auto_update</span>
990
867
  <span class='ivar'>@auto_update</span>
@@ -1008,13 +885,27 @@ style is applied is updated.</p>
1008
885
  </h3><div class="docstring">
1009
886
  <div class="discussion">
1010
887
 
1011
- <p>Returns the value of attribute based_on_style_handle</p>
1012
-
1013
888
 
1014
889
  </div>
1015
890
  </div>
1016
891
  <div class="tags">
1017
892
 
893
+ <p class="tag_title">Since:</p>
894
+ <ul class="since">
895
+
896
+ <li>
897
+
898
+
899
+
900
+
901
+
902
+ <div class='inline'>
903
+ <p>legacy</p>
904
+ </div>
905
+
906
+ </li>
907
+
908
+ </ul>
1018
909
 
1019
910
  </div><table class="source_code">
1020
911
  <tr>
@@ -1022,12 +913,12 @@ style is applied is updated.</p>
1022
913
  <pre class="lines">
1023
914
 
1024
915
 
1025
- 3
1026
- 4
1027
- 5</pre>
916
+ 10
917
+ 11
918
+ 12</pre>
1028
919
  </td>
1029
920
  <td>
1030
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
921
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
1031
922
 
1032
923
  <span class='kw'>def</span> <span class='id identifier rubyid_based_on_style_handle'>based_on_style_handle</span>
1033
924
  <span class='ivar'>@based_on_style_handle</span>
@@ -1051,13 +942,27 @@ style is applied is updated.</p>
1051
942
  </h3><div class="docstring">
1052
943
  <div class="discussion">
1053
944
 
1054
- <p>Returns the value of attribute handle</p>
1055
-
1056
945
 
1057
946
  </div>
1058
947
  </div>
1059
948
  <div class="tags">
1060
949
 
950
+ <p class="tag_title">Since:</p>
951
+ <ul class="since">
952
+
953
+ <li>
954
+
955
+
956
+
957
+
958
+
959
+ <div class='inline'>
960
+ <p>legacy</p>
961
+ </div>
962
+
963
+ </li>
964
+
965
+ </ul>
1061
966
 
1062
967
  </div><table class="source_code">
1063
968
  <tr>
@@ -1065,12 +970,12 @@ style is applied is updated.</p>
1065
970
  <pre class="lines">
1066
971
 
1067
972
 
1068
- 3
1069
- 4
1070
- 5</pre>
973
+ 10
974
+ 11
975
+ 12</pre>
1071
976
  </td>
1072
977
  <td>
1073
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
978
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
1074
979
 
1075
980
  <span class='kw'>def</span> <span class='id identifier rubyid_handle'>handle</span>
1076
981
  <span class='ivar'>@handle</span>
@@ -1094,142 +999,27 @@ style is applied is updated.</p>
1094
999
  </h3><div class="docstring">
1095
1000
  <div class="discussion">
1096
1001
 
1097
- <p>Returns the value of attribute hidden</p>
1098
-
1099
1002
 
1100
1003
  </div>
1101
1004
  </div>
1102
1005
  <div class="tags">
1103
1006
 
1104
-
1105
- </div><table class="source_code">
1106
- <tr>
1107
- <td>
1108
- <pre class="lines">
1109
-
1110
-
1111
- 3
1112
- 4
1113
- 5</pre>
1114
- </td>
1115
- <td>
1116
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
1117
-
1118
- <span class='kw'>def</span> <span class='id identifier rubyid_hidden'>hidden</span>
1119
- <span class='ivar'>@hidden</span>
1120
- <span class='kw'>end</span></pre>
1121
- </td>
1122
- </tr>
1123
- </table>
1124
- </div>
1125
-
1126
-
1127
- <span id="name=-instance_method"></span>
1128
- <div class="method_details ">
1129
- <h3 class="signature " id="name-instance_method">
1130
-
1131
- #<strong>name</strong> &#x21d2; <tt>Object</tt>
1132
-
1133
-
1007
+ <p class="tag_title">Since:</p>
1008
+ <ul class="since">
1134
1009
 
1135
-
1136
-
1137
- </h3><div class="docstring">
1138
- <div class="discussion">
1139
-
1140
- <p>Returns the value of attribute name</p>
1141
-
1142
-
1143
- </div>
1144
- </div>
1145
- <div class="tags">
1146
-
1147
-
1148
- </div><table class="source_code">
1149
- <tr>
1150
- <td>
1151
- <pre class="lines">
1152
-
1153
-
1154
- 3
1155
- 4
1156
- 5</pre>
1157
- </td>
1158
- <td>
1159
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
1160
-
1161
- <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
1162
- <span class='ivar'>@name</span>
1163
- <span class='kw'>end</span></pre>
1164
- </td>
1165
- </tr>
1166
- </table>
1167
- </div>
1168
-
1010
+ <li>
1169
1011
 
1170
- <span id="next_style_handle=-instance_method"></span>
1171
- <div class="method_details ">
1172
- <h3 class="signature " id="next_style_handle-instance_method">
1173
-
1174
- #<strong>next_style_handle</strong> &#x21d2; <tt>Object</tt>
1175
-
1176
-
1177
-
1178
-
1179
-
1180
- </h3><div class="docstring">
1181
- <div class="discussion">
1182
-
1183
- <p>Returns the value of attribute next_style_handle</p>
1184
-
1185
-
1186
- </div>
1187
- </div>
1188
- <div class="tags">
1189
-
1190
-
1191
- </div><table class="source_code">
1192
- <tr>
1193
- <td>
1194
- <pre class="lines">
1195
-
1196
-
1197
- 3
1198
- 4
1199
- 5</pre>
1200
- </td>
1201
- <td>
1202
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
1203
-
1204
- <span class='kw'>def</span> <span class='id identifier rubyid_next_style_handle'>next_style_handle</span>
1205
- <span class='ivar'>@next_style_handle</span>
1206
- <span class='kw'>end</span></pre>
1207
- </td>
1208
- </tr>
1209
- </table>
1210
- </div>
1211
-
1212
1012
 
1213
- <span id="primary=-instance_method"></span>
1214
- <div class="method_details ">
1215
- <h3 class="signature " id="primary-instance_method">
1216
-
1217
- #<strong>primary</strong> &#x21d2; <tt>Object</tt>
1218
-
1219
-
1220
-
1221
-
1222
-
1223
- </h3><div class="docstring">
1224
- <div class="discussion">
1225
-
1226
- <p>Returns the value of attribute primary</p>
1227
-
1228
-
1229
- </div>
1013
+
1014
+
1015
+
1016
+ <div class='inline'>
1017
+ <p>legacy</p>
1230
1018
  </div>
1231
- <div class="tags">
1019
+
1020
+ </li>
1232
1021
 
1022
+ </ul>
1233
1023
 
1234
1024
  </div><table class="source_code">
1235
1025
  <tr>
@@ -1237,15 +1027,15 @@ style is applied is updated.</p>
1237
1027
  <pre class="lines">
1238
1028
 
1239
1029
 
1240
- 3
1241
- 4
1242
- 5</pre>
1030
+ 10
1031
+ 11
1032
+ 12</pre>
1243
1033
  </td>
1244
1034
  <td>
1245
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
1035
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
1246
1036
 
1247
- <span class='kw'>def</span> <span class='id identifier rubyid_primary'>primary</span>
1248
- <span class='ivar'>@primary</span>
1037
+ <span class='kw'>def</span> <span class='id identifier rubyid_hidden'>hidden</span>
1038
+ <span class='ivar'>@hidden</span>
1249
1039
  <span class='kw'>end</span></pre>
1250
1040
  </td>
1251
1041
  </tr>
@@ -1253,59 +1043,11 @@ style is applied is updated.</p>
1253
1043
  </div>
1254
1044
 
1255
1045
 
1256
- <span id="priority=-instance_method"></span>
1046
+ <span id="name=-instance_method"></span>
1257
1047
  <div class="method_details ">
1258
- <h3 class="signature " id="priority-instance_method">
1259
-
1260
- #<strong>priority</strong> &#x21d2; <tt>Object</tt>
1261
-
1262
-
1263
-
1264
-
1265
-
1266
- </h3><div class="docstring">
1267
- <div class="discussion">
1268
-
1269
- <p>Returns the value of attribute priority</p>
1270
-
1271
-
1272
- </div>
1273
- </div>
1274
- <div class="tags">
1275
-
1276
-
1277
- </div><table class="source_code">
1278
- <tr>
1279
- <td>
1280
- <pre class="lines">
1281
-
1282
-
1283
- 3
1284
- 4
1285
- 5</pre>
1286
- </td>
1287
- <td>
1288
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
1289
-
1290
- <span class='kw'>def</span> <span class='id identifier rubyid_priority'>priority</span>
1291
- <span class='ivar'>@priority</span>
1292
- <span class='kw'>end</span></pre>
1293
- </td>
1294
- </tr>
1295
- </table>
1296
- </div>
1297
-
1298
- </div>
1299
-
1300
-
1301
- <div id="instance_method_details" class="method_details_list">
1302
- <h2>Instance Method Details</h2>
1303
-
1304
-
1305
- <div class="method_details first">
1306
- <h3 class="signature first" id="is_character_style?-instance_method">
1048
+ <h3 class="signature " id="name-instance_method">
1307
1049
 
1308
- #<strong>is_character_style?</strong> &#x21d2; <tt>Boolean</tt>
1050
+ #<strong>name</strong> &#x21d2; <tt>Object</tt>
1309
1051
 
1310
1052
 
1311
1053
 
@@ -1314,23 +1056,23 @@ style is applied is updated.</p>
1314
1056
  </h3><div class="docstring">
1315
1057
  <div class="discussion">
1316
1058
 
1317
- <p>Used to determine if the style applies to characters. This method always
1318
- returns false and should be overridden by derived classes as needed.</p>
1319
-
1320
1059
 
1321
1060
  </div>
1322
1061
  </div>
1323
1062
  <div class="tags">
1324
1063
 
1325
- <p class="tag_title">Returns:</p>
1326
- <ul class="return">
1064
+ <p class="tag_title">Since:</p>
1065
+ <ul class="since">
1327
1066
 
1328
1067
  <li>
1329
1068
 
1330
1069
 
1331
- <span class='type'>(<tt>Boolean</tt>)</span>
1332
1070
 
1333
1071
 
1072
+
1073
+ <div class='inline'>
1074
+ <p>legacy</p>
1075
+ </div>
1334
1076
 
1335
1077
  </li>
1336
1078
 
@@ -1342,25 +1084,27 @@ returns false and should be overridden by derived classes as needed.</p>
1342
1084
  <pre class="lines">
1343
1085
 
1344
1086
 
1345
- 80
1346
- 81
1347
- 82</pre>
1087
+ 10
1088
+ 11
1089
+ 12</pre>
1348
1090
  </td>
1349
1091
  <td>
1350
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 80</span>
1092
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
1351
1093
 
1352
- <span class='kw'>def</span> <span class='id identifier rubyid_is_character_style?'>is_character_style?</span>
1353
- <span class='kw'>false</span>
1094
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
1095
+ <span class='ivar'>@name</span>
1354
1096
  <span class='kw'>end</span></pre>
1355
1097
  </td>
1356
1098
  </tr>
1357
1099
  </table>
1358
1100
  </div>
1359
1101
 
1102
+
1103
+ <span id="next_style_handle=-instance_method"></span>
1360
1104
  <div class="method_details ">
1361
- <h3 class="signature " id="is_document_style?-instance_method">
1105
+ <h3 class="signature " id="next_style_handle-instance_method">
1362
1106
 
1363
- #<strong>is_document_style?</strong> &#x21d2; <tt>Boolean</tt>
1107
+ #<strong>next_style_handle</strong> &#x21d2; <tt>Object</tt>
1364
1108
 
1365
1109
 
1366
1110
 
@@ -1369,23 +1113,23 @@ returns false and should be overridden by derived classes as needed.</p>
1369
1113
  </h3><div class="docstring">
1370
1114
  <div class="discussion">
1371
1115
 
1372
- <p>Used to determine if the style applies to documents. This method always
1373
- returns false and should be overridden by derived classes as needed.</p>
1374
-
1375
1116
 
1376
1117
  </div>
1377
1118
  </div>
1378
1119
  <div class="tags">
1379
1120
 
1380
- <p class="tag_title">Returns:</p>
1381
- <ul class="return">
1121
+ <p class="tag_title">Since:</p>
1122
+ <ul class="since">
1382
1123
 
1383
1124
  <li>
1384
1125
 
1385
1126
 
1386
- <span class='type'>(<tt>Boolean</tt>)</span>
1387
1127
 
1388
1128
 
1129
+
1130
+ <div class='inline'>
1131
+ <p>legacy</p>
1132
+ </div>
1389
1133
 
1390
1134
  </li>
1391
1135
 
@@ -1397,25 +1141,27 @@ returns false and should be overridden by derived classes as needed.</p>
1397
1141
  <pre class="lines">
1398
1142
 
1399
1143
 
1400
- 92
1401
- 93
1402
- 94</pre>
1144
+ 10
1145
+ 11
1146
+ 12</pre>
1403
1147
  </td>
1404
1148
  <td>
1405
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 92</span>
1149
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
1406
1150
 
1407
- <span class='kw'>def</span> <span class='id identifier rubyid_is_document_style?'>is_document_style?</span>
1408
- <span class='kw'>false</span>
1151
+ <span class='kw'>def</span> <span class='id identifier rubyid_next_style_handle'>next_style_handle</span>
1152
+ <span class='ivar'>@next_style_handle</span>
1409
1153
  <span class='kw'>end</span></pre>
1410
1154
  </td>
1411
1155
  </tr>
1412
1156
  </table>
1413
1157
  </div>
1414
1158
 
1159
+
1160
+ <span id="primary=-instance_method"></span>
1415
1161
  <div class="method_details ">
1416
- <h3 class="signature " id="is_paragraph_style?-instance_method">
1162
+ <h3 class="signature " id="primary-instance_method">
1417
1163
 
1418
- #<strong>is_paragraph_style?</strong> &#x21d2; <tt>Boolean</tt>
1164
+ #<strong>primary</strong> &#x21d2; <tt>Object</tt>
1419
1165
 
1420
1166
 
1421
1167
 
@@ -1424,23 +1170,23 @@ returns false and should be overridden by derived classes as needed.</p>
1424
1170
  </h3><div class="docstring">
1425
1171
  <div class="discussion">
1426
1172
 
1427
- <p>Used to determine if the style applies to paragraphs. This method always
1428
- returns false and should be overridden by derived classes as needed.</p>
1429
-
1430
1173
 
1431
1174
  </div>
1432
1175
  </div>
1433
1176
  <div class="tags">
1434
1177
 
1435
- <p class="tag_title">Returns:</p>
1436
- <ul class="return">
1178
+ <p class="tag_title">Since:</p>
1179
+ <ul class="since">
1437
1180
 
1438
1181
  <li>
1439
1182
 
1440
1183
 
1441
- <span class='type'>(<tt>Boolean</tt>)</span>
1442
1184
 
1443
1185
 
1186
+
1187
+ <div class='inline'>
1188
+ <p>legacy</p>
1189
+ </div>
1444
1190
 
1445
1191
  </li>
1446
1192
 
@@ -1452,25 +1198,27 @@ returns false and should be overridden by derived classes as needed.</p>
1452
1198
  <pre class="lines">
1453
1199
 
1454
1200
 
1455
- 86
1456
- 87
1457
- 88</pre>
1201
+ 10
1202
+ 11
1203
+ 12</pre>
1458
1204
  </td>
1459
1205
  <td>
1460
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 86</span>
1206
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
1461
1207
 
1462
- <span class='kw'>def</span> <span class='id identifier rubyid_is_paragraph_style?'>is_paragraph_style?</span>
1463
- <span class='kw'>false</span>
1208
+ <span class='kw'>def</span> <span class='id identifier rubyid_primary'>primary</span>
1209
+ <span class='ivar'>@primary</span>
1464
1210
  <span class='kw'>end</span></pre>
1465
1211
  </td>
1466
1212
  </tr>
1467
1213
  </table>
1468
1214
  </div>
1469
1215
 
1216
+
1217
+ <span id="priority=-instance_method"></span>
1470
1218
  <div class="method_details ">
1471
- <h3 class="signature " id="is_table_style?-instance_method">
1219
+ <h3 class="signature " id="priority-instance_method">
1472
1220
 
1473
- #<strong>is_table_style?</strong> &#x21d2; <tt>Boolean</tt>
1221
+ #<strong>priority</strong> &#x21d2; <tt>Object</tt>
1474
1222
 
1475
1223
 
1476
1224
 
@@ -1479,23 +1227,23 @@ returns false and should be overridden by derived classes as needed.</p>
1479
1227
  </h3><div class="docstring">
1480
1228
  <div class="discussion">
1481
1229
 
1482
- <p>Used to determine if the style applies to tables. This method always
1483
- returns false and should be overridden by derived classes as needed.</p>
1484
-
1485
1230
 
1486
1231
  </div>
1487
1232
  </div>
1488
1233
  <div class="tags">
1489
1234
 
1490
- <p class="tag_title">Returns:</p>
1491
- <ul class="return">
1235
+ <p class="tag_title">Since:</p>
1236
+ <ul class="since">
1492
1237
 
1493
1238
  <li>
1494
1239
 
1495
1240
 
1496
- <span class='type'>(<tt>Boolean</tt>)</span>
1497
1241
 
1498
1242
 
1243
+
1244
+ <div class='inline'>
1245
+ <p>legacy</p>
1246
+ </div>
1499
1247
 
1500
1248
  </li>
1501
1249
 
@@ -1507,98 +1255,32 @@ returns false and should be overridden by derived classes as needed.</p>
1507
1255
  <pre class="lines">
1508
1256
 
1509
1257
 
1510
- 98
1511
- 99
1512
- 100</pre>
1258
+ 10
1259
+ 11
1260
+ 12</pre>
1513
1261
  </td>
1514
1262
  <td>
1515
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 98</span>
1263
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
1516
1264
 
1517
- <span class='kw'>def</span> <span class='id identifier rubyid_is_table_style?'>is_table_style?</span>
1518
- <span class='kw'>false</span>
1265
+ <span class='kw'>def</span> <span class='id identifier rubyid_priority'>priority</span>
1266
+ <span class='ivar'>@priority</span>
1519
1267
  <span class='kw'>end</span></pre>
1520
1268
  </td>
1521
1269
  </tr>
1522
1270
  </table>
1523
1271
  </div>
1524
1272
 
1525
- <div class="method_details ">
1526
- <h3 class="signature " id="prefix-instance_method">
1527
-
1528
- #<strong>prefix</strong>(document) &#x21d2; <tt>Object</tt>
1529
-
1530
-
1531
-
1532
-
1533
-
1534
- </h3><div class="docstring">
1535
- <div class="discussion">
1536
-
1537
- <p>This method retrieves the command prefix text associated with a Style
1538
- object. This method always returns nil and should be overridden by derived
1539
- classes as needed.</p>
1540
-
1541
-
1542
1273
  </div>
1543
- </div>
1544
- <div class="tags">
1545
-
1546
-
1547
- </div><table class="source_code">
1548
- <tr>
1549
- <td>
1550
- <pre class="lines">
1551
-
1552
1274
 
1553
- 63
1554
- 64
1555
- 65</pre>
1556
- </td>
1557
- <td>
1558
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 63</span>
1559
1275
 
1560
- <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>
1561
- <span class='kw'>nil</span>
1562
- <span class='kw'>end</span></pre>
1563
- </td>
1564
- </tr>
1565
- </table>
1566
- </div>
1567
-
1568
- <div class="method_details ">
1569
- <h3 class="signature " id="rtf_formatting-instance_method">
1570
-
1571
- #<strong>rtf_formatting</strong> &#x21d2; <tt>Object</tt>
1572
-
1573
-
1574
-
1575
-
1576
-
1577
- </h3><table class="source_code">
1578
- <tr>
1579
- <td>
1580
- <pre class="lines">
1581
-
1582
-
1583
- 67
1584
- 68
1585
- 69</pre>
1586
- </td>
1587
- <td>
1588
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 67</span>
1276
+ <div id="instance_method_details" class="method_details_list">
1277
+ <h2>Instance Method Details</h2>
1589
1278
 
1590
- <span class='kw'>def</span> <span class='id identifier rubyid_rtf_formatting'>rtf_formatting</span>
1591
- <span class='kw'>nil</span>
1592
- <span class='kw'>end</span></pre>
1593
- </td>
1594
- </tr>
1595
- </table>
1596
- </div>
1597
1279
 
1598
- <div class="method_details ">
1599
- <h3 class="signature " id="styledef-instance_method">
1280
+ <div class="method_details first">
1281
+ <h3 class="signature first" id="to_rtf-instance_method">
1600
1282
 
1601
- #<strong>styledef</strong> &#x21d2; <tt>Object</tt>
1283
+ #<strong>to_rtf</strong>(document) &#x21d2; <tt>Object</tt>
1602
1284
 
1603
1285
 
1604
1286
 
@@ -1606,130 +1288,35 @@ classes as needed.</p>
1606
1288
 
1607
1289
  </h3><div class="docstring">
1608
1290
  <div class="discussion">
1609
-
1610
- <p>Constructs an RTF identifier for the style. (override in derived classes as
1611
- needed)</p>
1612
-
1613
-
1614
- </div>
1291
+ <div class="note abstract">
1292
+ <strong>This method is abstract.</strong>
1293
+ <div class='inline'></div>
1615
1294
  </div>
1616
- <div class="tags">
1617
-
1618
1295
 
1619
- </div><table class="source_code">
1620
- <tr>
1621
- <td>
1622
- <pre class="lines">
1623
-
1624
-
1625
- 46
1626
- 47
1627
- 48</pre>
1628
- </td>
1629
- <td>
1630
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 46</span>
1631
-
1632
- <span class='kw'>def</span> <span class='id identifier rubyid_styledef'>styledef</span>
1633
- <span class='kw'>nil</span>
1634
- <span class='kw'>end</span></pre>
1635
- </td>
1636
- </tr>
1637
- </table>
1638
- </div>
1639
-
1640
- <div class="method_details ">
1641
- <h3 class="signature " id="stylename-instance_method">
1642
-
1643
- #<strong>stylename</strong> &#x21d2; <tt>Object</tt>
1644
-
1645
-
1646
-
1647
-
1648
-
1649
- </h3><table class="source_code">
1650
- <tr>
1651
- <td>
1652
- <pre class="lines">
1653
-
1654
-
1655
- 50
1656
- 51
1657
- 52</pre>
1658
- </td>
1659
- <td>
1660
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 50</span>
1661
-
1662
- <span class='kw'>def</span> <span class='id identifier rubyid_stylename'>stylename</span>
1663
- <span class='id identifier rubyid_name'>name</span>
1664
- <span class='kw'>end</span></pre>
1665
- </td>
1666
- </tr>
1667
- </table>
1668
- </div>
1669
-
1670
- <div class="method_details ">
1671
- <h3 class="signature " id="suffix-instance_method">
1672
-
1673
- #<strong>suffix</strong>(document) &#x21d2; <tt>Object</tt>
1674
-
1675
-
1676
-
1677
-
1678
-
1679
- </h3><div class="docstring">
1680
- <div class="discussion">
1681
-
1682
- <p>This method retrieves the command suffix text associated with a Style
1683
- object. This method always returns nil and should be overridden by derived
1684
- classes as needed.</p>
1296
+ <p>Constructs the RTF formatting representing the style in a Stylesheet.
1297
+ (override in derived classes as needed).</p>
1685
1298
 
1686
1299
 
1687
1300
  </div>
1688
1301
  </div>
1689
1302
  <div class="tags">
1690
1303
 
1691
-
1692
- </div><table class="source_code">
1693
- <tr>
1694
- <td>
1695
- <pre class="lines">
1696
-
1697
-
1698
- 74
1699
- 75
1700
- 76</pre>
1701
- </td>
1702
- <td>
1703
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 74</span>
1704
-
1705
- <span class='kw'>def</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
1706
- <span class='kw'>nil</span>
1707
- <span class='kw'>end</span></pre>
1708
- </td>
1709
- </tr>
1710
- </table>
1711
- </div>
1712
-
1713
- <div class="method_details ">
1714
- <h3 class="signature " id="to_rtf-instance_method">
1715
-
1716
- #<strong>to_rtf</strong>(document) &#x21d2; <tt>Object</tt>
1304
+ <p class="tag_title">Since:</p>
1305
+ <ul class="since">
1717
1306
 
1718
-
1719
-
1720
-
1721
-
1722
- </h3><div class="docstring">
1723
- <div class="discussion">
1724
-
1725
- <p>Constructs the RTF formatting representing the style. (override in derived
1726
- classes as needed)</p>
1727
-
1728
-
1729
- </div>
1307
+ <li>
1308
+
1309
+
1310
+
1311
+
1312
+
1313
+ <div class='inline'>
1314
+ <p>0.0.1</p>
1730
1315
  </div>
1731
- <div class="tags">
1316
+
1317
+ </li>
1732
1318
 
1319
+ </ul>
1733
1320
 
1734
1321
  </div><table class="source_code">
1735
1322
  <tr>
@@ -1757,7 +1344,7 @@ classes as needed)</p>
1757
1344
  </div>
1758
1345
 
1759
1346
  <div id="footer">
1760
- Generated on Mon Jul 24 15:49:02 2017 by
1347
+ Generated on Mon Jul 31 21:48:59 2017 by
1761
1348
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1762
1349
  0.9.9 (ruby-2.3.3).
1763
1350
  </div>