rrtf 0.1.1 → 0.1.2

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 (70) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -7
  3. data/documentation/RRTF/CharacterFormatting.html +1002 -0
  4. data/documentation/RRTF/CharacterStyle.html +1058 -0
  5. data/documentation/RRTF/Colour.html +813 -0
  6. data/documentation/RRTF/ColourTable.html +770 -0
  7. data/documentation/RRTF/CommandNode.html +2372 -0
  8. data/documentation/RRTF/ContainerNode.html +826 -0
  9. data/documentation/RRTF/Converters/HTML/Helpers.html +272 -0
  10. data/documentation/RRTF/Converters/HTML/Node.html +364 -0
  11. data/documentation/RRTF/Converters/HTML/NodeSet.html +265 -0
  12. data/documentation/RRTF/Converters/HTML.html +337 -0
  13. data/documentation/RRTF/Converters.html +117 -0
  14. data/documentation/RRTF/Document.html +2405 -0
  15. data/documentation/RRTF/DocumentStyle.html +1367 -0
  16. data/documentation/RRTF/Font.html +790 -0
  17. data/documentation/RRTF/FontTable.html +763 -0
  18. data/documentation/RRTF/FooterNode.html +515 -0
  19. data/documentation/RRTF/HeaderNode.html +515 -0
  20. data/documentation/RRTF/ImageNode.html +1374 -0
  21. data/documentation/RRTF/Information.html +809 -0
  22. data/documentation/RRTF/LinkNode.html +264 -0
  23. data/documentation/RRTF/ListLevel.html +799 -0
  24. data/documentation/RRTF/ListLevelNode.html +612 -0
  25. data/documentation/RRTF/ListMarker.html +595 -0
  26. data/documentation/RRTF/ListNode.html +368 -0
  27. data/documentation/RRTF/ListTable.html +343 -0
  28. data/documentation/RRTF/ListTemplate.html +433 -0
  29. data/documentation/RRTF/ListTextNode.html +285 -0
  30. data/documentation/RRTF/Node.html +616 -0
  31. data/documentation/RRTF/Paper.html +624 -0
  32. data/documentation/RRTF/ParagraphFormatting.html +749 -0
  33. data/documentation/RRTF/ParagraphNode.html +275 -0
  34. data/documentation/RRTF/ParagraphStyle.html +1319 -0
  35. data/documentation/RRTF/RTFError.html +295 -0
  36. data/documentation/RRTF/Style.html +1767 -0
  37. data/documentation/RRTF/Stylesheet.html +1768 -0
  38. data/documentation/RRTF/TableCellNode.html +1704 -0
  39. data/documentation/RRTF/TableNode.html +1025 -0
  40. data/documentation/RRTF/TableRowNode.html +675 -0
  41. data/documentation/RRTF/TextNode.html +600 -0
  42. data/documentation/RRTF/Utilities.html +201 -0
  43. data/documentation/RRTF.html +129 -0
  44. data/documentation/_index.html +478 -0
  45. data/documentation/class_list.html +51 -0
  46. data/documentation/css/common.css +1 -0
  47. data/documentation/css/full_list.css +58 -0
  48. data/documentation/css/style.css +492 -0
  49. data/documentation/file.README.html +223 -0
  50. data/documentation/file_list.html +56 -0
  51. data/documentation/frames.html +17 -0
  52. data/documentation/index.html +223 -0
  53. data/documentation/js/app.js +248 -0
  54. data/documentation/js/full_list.js +216 -0
  55. data/documentation/js/jquery.js +4 -0
  56. data/documentation/method_list.html +2203 -0
  57. data/documentation/top-level-namespace.html +110 -0
  58. data/examples/01.rtf +14 -17
  59. data/examples/01_mac_word15_36.png +0 -0
  60. data/examples/01_styles_and_paragraphs.rb +3 -4
  61. data/examples/resources/json/redshirt_styles.json +4 -2
  62. data/lib/rrtf/node.rb +86 -167
  63. data/lib/rrtf/style/character_style.rb +4 -3
  64. data/lib/rrtf/style/formatting.rb +55 -11
  65. data/lib/rrtf/style/paragraph_style.rb +19 -4
  66. data/lib/rrtf/style/style.rb +15 -15
  67. data/lib/rrtf/stylesheet.rb +57 -16
  68. data/lib/rrtf/version.rb +1 -1
  69. data/rrtf.gemspec +1 -0
  70. metadata +70 -1
data/documentation/RRTF/CharacterStyle.html ADDED
@@ -0,0 +1,1058 @@
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::CharacterStyle
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::CharacterStyle";
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 (C)</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">CharacterStyle</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::CharacterStyle
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="Style.html" title="RRTF::Style (class)">Style</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></li>
78
+
79
+ <li class="next">RRTF::CharacterStyle</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="CharacterFormatting.html" title="RRTF::CharacterFormatting (module)">CharacterFormatting</a></span></dd>
95
+ </dl>
96
+
97
+
98
+
99
+
100
+
101
+
102
+ <dl>
103
+ <dt>Defined in:</dt>
104
+ <dd>lib/rrtf/style/character_style.rb</dd>
105
+ </dl>
106
+
107
+ </div>
108
+
109
+ <h2>Overview</h2><div class="docstring">
110
+ <div class="discussion">
111
+
112
+ <p>This class represents a character style for an RTF document.</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="CharacterFormatting.html" title="RRTF::CharacterFormatting (module)">CharacterFormatting</a></span></h3>
127
+ <p class="inherited"><span class='object_link'><a href="CharacterFormatting.html#CHARACTER_ATTRIBUTES-constant" title="RRTF::CharacterFormatting::CHARACTER_ATTRIBUTES (constant)">RRTF::CharacterFormatting::CHARACTER_ATTRIBUTES</a></span></p>
128
+
129
+
130
+
131
+
132
+ <h2>Instance Attribute Summary</h2>
133
+
134
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></h3>
135
+ <p class="inherited"><span class='object_link'><a href="Style.html#additive-instance_method" title="RRTF::Style#additive (method)">#additive</a></span>, <span class='object_link'><a href="Style.html#auto_update-instance_method" title="RRTF::Style#auto_update (method)">#auto_update</a></span>, <span class='object_link'><a href="Style.html#based_on_style_handle-instance_method" title="RRTF::Style#based_on_style_handle (method)">#based_on_style_handle</a></span>, <span class='object_link'><a href="Style.html#handle-instance_method" title="RRTF::Style#handle (method)">#handle</a></span>, <span class='object_link'><a href="Style.html#hidden-instance_method" title="RRTF::Style#hidden (method)">#hidden</a></span>, <span class='object_link'><a href="Style.html#name-instance_method" title="RRTF::Style#name (method)">#name</a></span>, <span class='object_link'><a href="Style.html#next_style_handle-instance_method" title="RRTF::Style#next_style_handle (method)">#next_style_handle</a></span>, <span class='object_link'><a href="Style.html#primary-instance_method" title="RRTF::Style#primary (method)">#primary</a></span>, <span class='object_link'><a href="Style.html#priority-instance_method" title="RRTF::Style#priority (method)">#priority</a></span></p>
136
+
137
+
138
+
139
+ <h2>
140
+ Instance Method Summary
141
+ <small><a href="#" class="summary_toggle">collapse</a></small>
142
+ </h2>
143
+
144
+ <ul class="summary">
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {}) &#x21d2; CharacterStyle </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+ <span class="note title constructor">constructor</span>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+ <span class="summary_desc"><div class='inline'>
166
+ <p>This is the constructor for the CharacterStyle class.</p>
167
+ </div></span>
168
+
169
+ </li>
170
+
171
+
172
+ <li class="public ">
173
+ <span class="summary_signature">
174
+
175
+ <a href="#is_character_style%3F-instance_method" title="#is_character_style? (instance method)">#<strong>is_character_style?</strong> &#x21d2; Boolean </a>
176
+
177
+
178
+
179
+ </span>
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <span class="summary_desc"><div class='inline'>
190
+ <p>This method overrides the is_character_style? method inherited from the
191
+ Style class to always return true.</p>
192
+ </div></span>
193
+
194
+ </li>
195
+
196
+
197
+ <li class="public ">
198
+ <span class="summary_signature">
199
+
200
+ <a href="#prefix-instance_method" title="#prefix (instance method)">#<strong>prefix</strong>(document) &#x21d2; Object </a>
201
+
202
+
203
+
204
+ </span>
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+ <span class="summary_desc"><div class='inline'>
215
+ <p>This method generates a string containing the prefix associated with a
216
+ style object.</p>
217
+ </div></span>
218
+
219
+ </li>
220
+
221
+
222
+ <li class="public ">
223
+ <span class="summary_signature">
224
+
225
+ <a href="#rtf_formatting-instance_method" title="#rtf_formatting (instance method)">#<strong>rtf_formatting</strong>(document) &#x21d2; Object </a>
226
+
227
+
228
+
229
+ </span>
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <span class="summary_desc"><div class='inline'></div></span>
240
+
241
+ </li>
242
+
243
+
244
+ <li class="public ">
245
+ <span class="summary_signature">
246
+
247
+ <a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong>(document, options = {}) &#x21d2; Object </a>
248
+
249
+
250
+
251
+ </span>
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+ <span class="summary_desc"><div class='inline'>
262
+ <p>Converts the stylesheet character style into its RTF representation (for
263
+ stylesheet).</p>
264
+ </div></span>
265
+
266
+ </li>
267
+
268
+
269
+ </ul>
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="CharacterFormatting.html" title="RRTF::CharacterFormatting (module)">CharacterFormatting</a></span></h3>
282
+ <p class="inherited"><span class='object_link'><a href="CharacterFormatting.html#character_formatting_to_rtf-instance_method" title="RRTF::CharacterFormatting#character_formatting_to_rtf (method)">#character_formatting_to_rtf</a></span>, <span class='object_link'><a href="CharacterFormatting.html#included-class_method" title="RRTF::CharacterFormatting.included (method)">included</a></span>, <span class='object_link'><a href="CharacterFormatting.html#initialize_character_formatting-instance_method" title="RRTF::CharacterFormatting#initialize_character_formatting (method)">#initialize_character_formatting</a></span>, <span class='object_link'><a href="CharacterFormatting.html#push_colours-instance_method" title="RRTF::CharacterFormatting#push_colours (method)">#push_colours</a></span>, <span class='object_link'><a href="CharacterFormatting.html#push_fonts-instance_method" title="RRTF::CharacterFormatting#push_fonts (method)">#push_fonts</a></span>, <span class='object_link'><a href="CharacterFormatting.html#set_character_formatting_from_hashmap-instance_method" title="RRTF::CharacterFormatting#set_character_formatting_from_hashmap (method)">#set_character_formatting_from_hashmap</a></span></p>
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></h3>
293
+ <p class="inherited"><span class='object_link'><a href="Style.html#is_document_style%3F-instance_method" title="RRTF::Style#is_document_style? (method)">#is_document_style?</a></span>, <span class='object_link'><a href="Style.html#is_paragraph_style%3F-instance_method" title="RRTF::Style#is_paragraph_style? (method)">#is_paragraph_style?</a></span>, <span class='object_link'><a href="Style.html#is_table_style%3F-instance_method" title="RRTF::Style#is_table_style? (method)">#is_table_style?</a></span>, <span class='object_link'><a href="Style.html#styledef-instance_method" title="RRTF::Style#styledef (method)">#styledef</a></span>, <span class='object_link'><a href="Style.html#stylename-instance_method" title="RRTF::Style#stylename (method)">#stylename</a></span>, <span class='object_link'><a href="Style.html#suffix-instance_method" title="RRTF::Style#suffix (method)">#suffix</a></span></p>
294
+ <div id="constructor_details" class="method_details_list">
295
+ <h2>Constructor Details</h2>
296
+
297
+ <div class="method_details first">
298
+ <h3 class="signature first" id="initialize-instance_method">
299
+
300
+ #<strong>initialize</strong>(options = {}) &#x21d2; <tt><span class='object_link'><a href="" title="RRTF::CharacterStyle (class)">CharacterStyle</a></span></tt>
301
+
302
+
303
+
304
+
305
+
306
+ </h3><div class="docstring">
307
+ <div class="discussion">
308
+
309
+ <p>This is the constructor for the CharacterStyle class.</p>
310
+
311
+
312
+ </div>
313
+ </div>
314
+ <div class="tags">
315
+ <p class="tag_title">Parameters:</p>
316
+ <ul class="param">
317
+
318
+ <li>
319
+
320
+ <span class='name'>options</span>
321
+
322
+
323
+ <span class='type'>(<tt>Hash</tt>)</span>
324
+
325
+
326
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
327
+
328
+
329
+ &mdash;
330
+ <div class='inline'>
331
+ <p>the character style options.</p>
332
+ </div>
333
+
334
+ </li>
335
+
336
+ </ul>
337
+
338
+
339
+
340
+
341
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
342
+ <ul class="option">
343
+
344
+ <li>
345
+ <span class="name">"name"</span>
346
+ <span class="type">(<tt>String</tt>)</span>
347
+ <span class="default">
348
+
349
+ &mdash; default:
350
+ <tt>nil</tt>
351
+
352
+ </span>
353
+
354
+ &mdash; <div class='inline'>
355
+ <p>human-readable name for the style.</p>
356
+ </div>
357
+
358
+ </li>
359
+
360
+ <li>
361
+ <span class="name">"handle"</span>
362
+ <span class="type">(<tt>Integer</tt>)</span>
363
+ <span class="default">
364
+
365
+ &mdash; default:
366
+ <tt>nil</tt>
367
+
368
+ </span>
369
+
370
+ &mdash; <div class='inline'>
371
+ <p>16-bit integer that identifies the style in a document.</p>
372
+ </div>
373
+
374
+ </li>
375
+
376
+ <li>
377
+ <span class="name">"next_style_handle"</span>
378
+ <span class="type">(<tt>Integer</tt>)</span>
379
+ <span class="default">
380
+
381
+ &mdash; default:
382
+ <tt>nil</tt>
383
+
384
+ </span>
385
+
386
+ &mdash; <div class='inline'>
387
+ <p>16-bit integer that identifies the next style for this style.</p>
388
+ </div>
389
+
390
+ </li>
391
+
392
+ <li>
393
+ <span class="name">"based_on_style_handle"</span>
394
+ <span class="type">(<tt>Integer</tt>)</span>
395
+ <span class="default">
396
+
397
+ &mdash; default:
398
+ <tt>nil</tt>
399
+
400
+ </span>
401
+
402
+ &mdash; <div class='inline'>
403
+ <p>16-bit integer that identifies the base style for this style.</p>
404
+ </div>
405
+
406
+ </li>
407
+
408
+ <li>
409
+ <span class="name">"priority"</span>
410
+ <span class="type">(<tt>Integer</tt>)</span>
411
+ <span class="default">
412
+
413
+ &mdash; default:
414
+ <tt>nil</tt>
415
+
416
+ </span>
417
+
418
+ &mdash; <div class='inline'>
419
+ <p>16-bit integer that indicates the ordering of the style among other styles
420
+ in a document.</p>
421
+ </div>
422
+
423
+ </li>
424
+
425
+ <li>
426
+ <span class="name">"primary"</span>
427
+ <span class="type">(<tt>Boolean</tt>)</span>
428
+ <span class="default">
429
+
430
+ &mdash; default:
431
+ <tt>false</tt>
432
+
433
+ </span>
434
+
435
+ &mdash; <div class='inline'>
436
+ <p>whether or not this style is a primary or “quick” style.</p>
437
+ </div>
438
+
439
+ </li>
440
+
441
+ <li>
442
+ <span class="name">"additive"</span>
443
+ <span class="type">(<tt>Boolean</tt>)</span>
444
+ <span class="default">
445
+
446
+ &mdash; default:
447
+ <tt>false</tt>
448
+
449
+ </span>
450
+
451
+ &mdash; <div class='inline'>
452
+ <p>whether or not this character style is additive to the current paragraph
453
+ style.</p>
454
+ </div>
455
+
456
+ </li>
457
+
458
+ <li>
459
+ <span class="name">"auto_update"</span>
460
+ <span class="type">(<tt>Boolean</tt>)</span>
461
+ <span class="default">
462
+
463
+ &mdash; default:
464
+ <tt>false</tt>
465
+
466
+ </span>
467
+
468
+ &mdash; <div class='inline'>
469
+ <p>whether or not this style should be updated when any node to which the
470
+ style is applied is updated.</p>
471
+ </div>
472
+
473
+ </li>
474
+
475
+ <li>
476
+ <span class="name">"hidden"</span>
477
+ <span class="type">(<tt>Boolean</tt>)</span>
478
+ <span class="default">
479
+
480
+ &mdash; default:
481
+ <tt>false</tt>
482
+
483
+ </span>
484
+
485
+ &mdash; <div class='inline'>
486
+ <p>whether or not the style should be hidden.</p>
487
+ </div>
488
+
489
+ </li>
490
+
491
+ <li>
492
+ <span class="name">"bold"</span>
493
+ <span class="type">(<tt>Boolean</tt>)</span>
494
+ <span class="default">
495
+
496
+ &mdash; default:
497
+ <tt>nil</tt>
498
+
499
+ </span>
500
+
501
+ &mdash; <div class='inline'>
502
+ <p>enable or disable bold (nil to remain same).</p>
503
+ </div>
504
+
505
+ </li>
506
+
507
+ <li>
508
+ <span class="name">"italic"</span>
509
+ <span class="type">(<tt>Boolean</tt>)</span>
510
+ <span class="default">
511
+
512
+ &mdash; default:
513
+ <tt>nil</tt>
514
+
515
+ </span>
516
+
517
+ &mdash; <div class='inline'>
518
+ <p>enable or disable italic (nil to remain same).</p>
519
+ </div>
520
+
521
+ </li>
522
+
523
+ <li>
524
+ <span class="name">"underline"</span>
525
+ <span class="type">(<tt>Boolean</tt>, <tt>String</tt>)</span>
526
+ <span class="default">
527
+
528
+ &mdash; default:
529
+ <tt>nil</tt>
530
+
531
+ </span>
532
+
533
+ &mdash; <div class='inline'>
534
+ <p>enable or disable underline (nil to remain same); can also be a string (see
535
+ <span class='object_link'><a href="CharacterFormatting.html#CHARACTER_ATTRIBUTES-constant" title="RRTF::CharacterFormatting::CHARACTER_ATTRIBUTES (constant)">RRTF::CharacterFormatting::CHARACTER_ATTRIBUTES</a></span>).</p>
536
+ </div>
537
+
538
+ </li>
539
+
540
+ <li>
541
+ <span class="name">"uppercase"</span>
542
+ <span class="type">(<tt>Boolean</tt>)</span>
543
+ <span class="default">
544
+
545
+ &mdash; default:
546
+ <tt>nil</tt>
547
+
548
+ </span>
549
+
550
+ &mdash; <div class='inline'>
551
+ <p>enable or disable all caps (nil to remain same).</p>
552
+ </div>
553
+
554
+ </li>
555
+
556
+ <li>
557
+ <span class="name">"superscript"</span>
558
+ <span class="type">(<tt>Boolean</tt>)</span>
559
+ <span class="default">
560
+
561
+ &mdash; default:
562
+ <tt>nil</tt>
563
+
564
+ </span>
565
+
566
+ &mdash; <div class='inline'>
567
+ <p>enable or disable superscript (nil to remain same).</p>
568
+ </div>
569
+
570
+ </li>
571
+
572
+ <li>
573
+ <span class="name">"subscript"</span>
574
+ <span class="type">(<tt>Boolean</tt>)</span>
575
+ <span class="default">
576
+
577
+ &mdash; default:
578
+ <tt>nil</tt>
579
+
580
+ </span>
581
+
582
+ &mdash; <div class='inline'>
583
+ <p>enable or disable subscript (nil to remain same).</p>
584
+ </div>
585
+
586
+ </li>
587
+
588
+ <li>
589
+ <span class="name">"strike"</span>
590
+ <span class="type">(<tt>Boolean</tt>)</span>
591
+ <span class="default">
592
+
593
+ &mdash; default:
594
+ <tt>nil</tt>
595
+
596
+ </span>
597
+
598
+ &mdash; <div class='inline'>
599
+ <p>enable or disable single line-through (nil to remain same).</p>
600
+ </div>
601
+
602
+ </li>
603
+
604
+ <li>
605
+ <span class="name">"emboss"</span>
606
+ <span class="type">(<tt>Boolean</tt>)</span>
607
+ <span class="default">
608
+
609
+ &mdash; default:
610
+ <tt>nil</tt>
611
+
612
+ </span>
613
+
614
+ &mdash; <div class='inline'>
615
+ <p>enable or disable emboss (nil to remain same).</p>
616
+ </div>
617
+
618
+ </li>
619
+
620
+ <li>
621
+ <span class="name">"imprint"</span>
622
+ <span class="type">(<tt>Boolean</tt>)</span>
623
+ <span class="default">
624
+
625
+ &mdash; default:
626
+ <tt>nil</tt>
627
+
628
+ </span>
629
+
630
+ &mdash; <div class='inline'>
631
+ <p>enable or disable imprint (nil to remain same).</p>
632
+ </div>
633
+
634
+ </li>
635
+
636
+ <li>
637
+ <span class="name">"outline"</span>
638
+ <span class="type">(<tt>Boolean</tt>)</span>
639
+ <span class="default">
640
+
641
+ &mdash; default:
642
+ <tt>nil</tt>
643
+
644
+ </span>
645
+
646
+ &mdash; <div class='inline'>
647
+ <p>enable or disable outline (nil to remain same).</p>
648
+ </div>
649
+
650
+ </li>
651
+
652
+ <li>
653
+ <span class="name">"text_hidden"</span>
654
+ <span class="type">(<tt>Boolean</tt>)</span>
655
+ <span class="default">
656
+
657
+ &mdash; default:
658
+ <tt>nil</tt>
659
+
660
+ </span>
661
+
662
+ &mdash; <div class='inline'>
663
+ <p>enable or disable hidden (nil to remain same).</p>
664
+ </div>
665
+
666
+ </li>
667
+
668
+ <li>
669
+ <span class="name">"kerning"</span>
670
+ <span class="type">(<tt>Boolean</tt>, <tt>Integer</tt>)</span>
671
+ <span class="default">
672
+
673
+ &mdash; default:
674
+ <tt>nil</tt>
675
+
676
+ </span>
677
+
678
+ &mdash; <div class='inline'>
679
+ <p>enable or disable kerning (nil to remain same); to enable specify the font
680
+ size in half-points above which kerining will be applied.</p>
681
+ </div>
682
+
683
+ </li>
684
+
685
+ <li>
686
+ <span class="name">"character_spacing_offset"</span>
687
+ <span class="type">(<tt>Integer</tt>)</span>
688
+ <span class="default">
689
+
690
+ &mdash; default:
691
+ <tt>nil</tt>
692
+
693
+ </span>
694
+
695
+ &mdash; <div class='inline'>
696
+ <p>quarter points by which to expand or compress character spacing (negative
697
+ for compress).</p>
698
+ </div>
699
+
700
+ </li>
701
+
702
+ <li>
703
+ <span class="name">"foreground_color"</span>
704
+ <span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></tt>)</span>
705
+ <span class="default">
706
+
707
+ &mdash; default:
708
+ <tt>nil</tt>
709
+
710
+ </span>
711
+
712
+ &mdash; <div class='inline'>
713
+ <p>colour to apply to the foreground (text); see <span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">RRTF::Colour.from_string</a></span> for
714
+ string format.</p>
715
+ </div>
716
+
717
+ </li>
718
+
719
+ <li>
720
+ <span class="name">"background_color"</span>
721
+ <span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></tt>)</span>
722
+ <span class="default">
723
+
724
+ &mdash; default:
725
+ <tt>nil</tt>
726
+
727
+ </span>
728
+
729
+ &mdash; <div class='inline'>
730
+ <p>colour to apply to the background (highlight); see <span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">RRTF::Colour.from_string</a></span> for
731
+ string format.</p>
732
+ </div>
733
+
734
+ </li>
735
+
736
+ <li>
737
+ <span class="name">"underline_color"</span>
738
+ <span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Colour.html" title="RRTF::Colour (class)">Colour</a></span></tt>)</span>
739
+ <span class="default">
740
+
741
+ &mdash; default:
742
+ <tt>nil</tt>
743
+
744
+ </span>
745
+
746
+ &mdash; <div class='inline'>
747
+ <p>colour to apply to the underline; see <span class='object_link'><a href="Colour.html#from_string-class_method" title="RRTF::Colour.from_string (method)">RRTF::Colour.from_string</a></span> for string
748
+ format.</p>
749
+ </div>
750
+
751
+ </li>
752
+
753
+ <li>
754
+ <span class="name">"font"</span>
755
+ <span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Font.html" title="RRTF::Font (class)">Font</a></span></tt>)</span>
756
+ <span class="default">
757
+
758
+ &mdash; default:
759
+ <tt>nil</tt>
760
+
761
+ </span>
762
+
763
+ &mdash; <div class='inline'>
764
+ <p>font to apply to text; see <span class='object_link'><a href="Font.html#from_string-class_method" title="RRTF::Font.from_string (method)">Font.from_string</a></span> for string format.</p>
765
+ </div>
766
+
767
+ </li>
768
+
769
+ <li>
770
+ <span class="name">"font_size"</span>
771
+ <span class="type">(<tt>Integer</tt>)</span>
772
+ <span class="default">
773
+
774
+ &mdash; default:
775
+ <tt>nil</tt>
776
+
777
+ </span>
778
+
779
+ &mdash; <div class='inline'>
780
+ <p>font size in half-points.</p>
781
+ </div>
782
+
783
+ </li>
784
+
785
+ </ul>
786
+
787
+
788
+
789
+ </div><table class="source_code">
790
+ <tr>
791
+ <td>
792
+ <pre class="lines">
793
+
794
+
795
+ 13
796
+ 14
797
+ 15
798
+ 16</pre>
799
+ </td>
800
+ <td>
801
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 13</span>
802
+
803
+ <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>
804
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
805
+ <span class='id identifier rubyid_initialize_character_formatting'>initialize_character_formatting</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
806
+ <span class='kw'>end</span></pre>
807
+ </td>
808
+ </tr>
809
+ </table>
810
+ </div>
811
+
812
+ </div>
813
+
814
+
815
+ <div id="instance_method_details" class="method_details_list">
816
+ <h2>Instance Method Details</h2>
817
+
818
+
819
+ <div class="method_details first">
820
+ <h3 class="signature first" id="is_character_style?-instance_method">
821
+
822
+ #<strong>is_character_style?</strong> &#x21d2; <tt>Boolean</tt>
823
+
824
+
825
+
826
+
827
+
828
+ </h3><div class="docstring">
829
+ <div class="discussion">
830
+
831
+ <p>This method overrides the is_character_style? method inherited from the
832
+ Style class to always return true.</p>
833
+
834
+
835
+ </div>
836
+ </div>
837
+ <div class="tags">
838
+
839
+ <p class="tag_title">Returns:</p>
840
+ <ul class="return">
841
+
842
+ <li>
843
+
844
+
845
+ <span class='type'>(<tt>Boolean</tt>)</span>
846
+
847
+
848
+
849
+ </li>
850
+
851
+ </ul>
852
+
853
+ </div><table class="source_code">
854
+ <tr>
855
+ <td>
856
+ <pre class="lines">
857
+
858
+
859
+ 20
860
+ 21
861
+ 22</pre>
862
+ </td>
863
+ <td>
864
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 20</span>
865
+
866
+ <span class='kw'>def</span> <span class='id identifier rubyid_is_character_style?'>is_character_style?</span>
867
+ <span class='kw'>true</span>
868
+ <span class='kw'>end</span></pre>
869
+ </td>
870
+ </tr>
871
+ </table>
872
+ </div>
873
+
874
+ <div class="method_details ">
875
+ <h3 class="signature " id="prefix-instance_method">
876
+
877
+ #<strong>prefix</strong>(document) &#x21d2; <tt>Object</tt>
878
+
879
+
880
+
881
+
882
+
883
+ </h3><div class="docstring">
884
+ <div class="discussion">
885
+
886
+ <p>This method generates a string containing the prefix associated with a
887
+ style object.</p>
888
+
889
+
890
+ </div>
891
+ </div>
892
+ <div class="tags">
893
+
894
+
895
+ </div><table class="source_code">
896
+ <tr>
897
+ <td>
898
+ <pre class="lines">
899
+
900
+
901
+ 56
902
+ 57
903
+ 58
904
+ 59
905
+ 60
906
+ 61
907
+ 62
908
+ 63</pre>
909
+ </td>
910
+ <td>
911
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 56</span>
912
+
913
+ <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>
914
+ <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
915
+
916
+ <span class='id identifier rubyid_text'>text</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\cs</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_handle'>handle</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
917
+ <span class='id identifier rubyid_text'>text</span> <span class='op'>&lt;&lt;</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>
918
+
919
+ <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
920
+ <span class='kw'>end</span></pre>
921
+ </td>
922
+ </tr>
923
+ </table>
924
+ </div>
925
+
926
+ <div class="method_details ">
927
+ <h3 class="signature " id="rtf_formatting-instance_method">
928
+
929
+ #<strong>rtf_formatting</strong>(document) &#x21d2; <tt>Object</tt>
930
+
931
+
932
+
933
+
934
+
935
+ </h3><table class="source_code">
936
+ <tr>
937
+ <td>
938
+ <pre class="lines">
939
+
940
+
941
+ 65
942
+ 66
943
+ 67</pre>
944
+ </td>
945
+ <td>
946
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 65</span>
947
+
948
+ <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>
949
+ <span class='id identifier rubyid_character_formatting_to_rtf'>character_formatting_to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
950
+ <span class='kw'>end</span></pre>
951
+ </td>
952
+ </tr>
953
+ </table>
954
+ </div>
955
+
956
+ <div class="method_details ">
957
+ <h3 class="signature " id="to_rtf-instance_method">
958
+
959
+ #<strong>to_rtf</strong>(document, options = {}) &#x21d2; <tt>Object</tt>
960
+
961
+
962
+
963
+
964
+
965
+ </h3><div class="docstring">
966
+ <div class="discussion">
967
+
968
+ <p>Converts the stylesheet character style into its RTF representation (for
969
+ stylesheet)</p>
970
+
971
+
972
+ </div>
973
+ </div>
974
+ <div class="tags">
975
+
976
+
977
+ </div><table class="source_code">
978
+ <tr>
979
+ <td>
980
+ <pre class="lines">
981
+
982
+
983
+ 26
984
+ 27
985
+ 28
986
+ 29
987
+ 30
988
+ 31
989
+ 32
990
+ 33
991
+ 34
992
+ 35
993
+ 36
994
+ 37
995
+ 38
996
+ 39
997
+ 40
998
+ 41
999
+ 42
1000
+ 43
1001
+ 44
1002
+ 45
1003
+ 46
1004
+ 47
1005
+ 48
1006
+ 49
1007
+ 50
1008
+ 51
1009
+ 52</pre>
1010
+ </td>
1011
+ <td>
1012
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/character_style.rb', line 26</span>
1013
+
1014
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1015
+ <span class='comment'># load default options
1016
+ </span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1017
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>uglify</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span>
1018
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>base_indent</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>0</span>
1019
+ <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>
1020
+ <span class='comment'># build formatting helpers
1021
+ </span> <span class='id identifier rubyid_base_prefix'>base_prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>uglify</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> </span><span class='tstring_end'>&#39;</span></span><span class='op'>*</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>base_indent</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
1022
+ <span class='id identifier rubyid_name_prefix'>name_prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>uglify</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> </span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
1023
+ <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>uglify</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> </span><span class='tstring_end'>&#39;</span></span>
1024
+
1025
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
1026
+
1027
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_base_prefix'>base_prefix</span>
1028
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>{\\*\\cs</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_handle'>handle</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1029
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_rtf_formatting'>rtf_formatting</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1030
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\additive</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@additive</span>
1031
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\sbasedon</span><span class='embexpr_beg'>#{</span><span class='ivar'>@based_on_style_handle</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@based_on_style_handle</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1032
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\sautoupd</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@auto_update</span>
1033
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\snext</span><span class='embexpr_beg'>#{</span><span class='ivar'>@next_style_handle</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@next_style_handle</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1034
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\sqformat</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@primary</span>
1035
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\spriority</span><span class='embexpr_beg'>#{</span><span class='ivar'>@priority</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@priority</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1036
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\shidden</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_suffix'>suffix</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@hidden</span>
1037
+ <span class='id identifier rubyid_rtf'>rtf</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name_prefix'>name_prefix</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>;}</span><span class='tstring_end'>&quot;</span></span>
1038
+
1039
+ <span class='id identifier rubyid_rtf'>rtf</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
1040
+ <span class='kw'>end</span></pre>
1041
+ </td>
1042
+ </tr>
1043
+ </table>
1044
+ </div>
1045
+
1046
+ </div>
1047
+
1048
+ </div>
1049
+
1050
+ <div id="footer">
1051
+ Generated on Mon Jul 24 15:49:02 2017 by
1052
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1053
+ 0.9.9 (ruby-2.3.3).
1054
+ </div>
1055
+
1056
+ </div>
1057
+ </body>
1058
+ </html>