rrtf 0.1.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -0,0 +1,1367 @@
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::DocumentStyle
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::DocumentStyle";
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 (D)</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">DocumentStyle</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::DocumentStyle
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::DocumentStyle</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/rrtf/style/document_style.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>This class represents styling attributes that are to be applied at the
108
+ document level.</p>
109
+
110
+
111
+ </div>
112
+ </div>
113
+ <div class="tags">
114
+
115
+
116
+ </div>
117
+ <h2>Constant Summary</h2>
118
+ <dl class="constants">
119
+
120
+ <dt id="PORTRAIT-constant" class="">PORTRAIT =
121
+ <div class="docstring">
122
+ <div class="discussion">
123
+
124
+ <p>Definition for a document orientation setting.</p>
125
+
126
+
127
+ </div>
128
+ </div>
129
+ <div class="tags">
130
+
131
+
132
+ </div>
133
+ </dt>
134
+ <dd><pre class="code"><span class='symbol'>:portrait</span></pre></dd>
135
+
136
+ <dt id="LANDSCAPE-constant" class="">LANDSCAPE =
137
+ <div class="docstring">
138
+ <div class="discussion">
139
+
140
+ <p>Definition for a document orientation setting.</p>
141
+
142
+
143
+ </div>
144
+ </div>
145
+ <div class="tags">
146
+
147
+
148
+ </div>
149
+ </dt>
150
+ <dd><pre class="code"><span class='symbol'>:landscape</span></pre></dd>
151
+
152
+ <dt id="DEFAULT_LEFT_MARGIN-constant" class="">DEFAULT_LEFT_MARGIN =
153
+ <div class="docstring">
154
+ <div class="discussion">
155
+
156
+ <p>Definition for a default margin setting.</p>
157
+
158
+
159
+ </div>
160
+ </div>
161
+ <div class="tags">
162
+
163
+
164
+ </div>
165
+ </dt>
166
+ <dd><pre class="code"><span class='int'>1800</span></pre></dd>
167
+
168
+ <dt id="DEFAULT_RIGHT_MARGIN-constant" class="">DEFAULT_RIGHT_MARGIN =
169
+ <div class="docstring">
170
+ <div class="discussion">
171
+
172
+ <p>Definition for a default margin setting.</p>
173
+
174
+
175
+ </div>
176
+ </div>
177
+ <div class="tags">
178
+
179
+
180
+ </div>
181
+ </dt>
182
+ <dd><pre class="code"><span class='int'>1800</span></pre></dd>
183
+
184
+ <dt id="DEFAULT_TOP_MARGIN-constant" class="">DEFAULT_TOP_MARGIN =
185
+ <div class="docstring">
186
+ <div class="discussion">
187
+
188
+ <p>Definition for a default margin setting.</p>
189
+
190
+
191
+ </div>
192
+ </div>
193
+ <div class="tags">
194
+
195
+
196
+ </div>
197
+ </dt>
198
+ <dd><pre class="code"><span class='int'>1440</span></pre></dd>
199
+
200
+ <dt id="DEFAULT_BOTTOM_MARGIN-constant" class="">DEFAULT_BOTTOM_MARGIN =
201
+ <div class="docstring">
202
+ <div class="discussion">
203
+
204
+ <p>Definition for a default margin setting.</p>
205
+
206
+
207
+ </div>
208
+ </div>
209
+ <div class="tags">
210
+
211
+
212
+ </div>
213
+ </dt>
214
+ <dd><pre class="code"><span class='int'>1440</span></pre></dd>
215
+
216
+ <dt id="STYLESHEET_SORT_NAME-constant" class="">STYLESHEET_SORT_NAME =
217
+ <div class="docstring">
218
+ <div class="discussion">
219
+
220
+ <p>stylesheet sorting codes</p>
221
+
222
+
223
+ </div>
224
+ </div>
225
+ <div class="tags">
226
+
227
+
228
+ </div>
229
+ </dt>
230
+ <dd><pre class="code"><span class='int'>0</span></pre></dd>
231
+
232
+ <dt id="STYLESHEET_SORT_DEFAULT-constant" class="">STYLESHEET_SORT_DEFAULT =
233
+ <div class="docstring">
234
+ <div class="discussion">
235
+
236
+ <p>stylesheet styles sorted by name</p>
237
+
238
+
239
+ </div>
240
+ </div>
241
+ <div class="tags">
242
+
243
+
244
+ </div>
245
+ </dt>
246
+ <dd><pre class="code"><span class='int'>1</span></pre></dd>
247
+
248
+ <dt id="STYLESHEET_SORT_FONT-constant" class="">STYLESHEET_SORT_FONT =
249
+ <div class="docstring">
250
+ <div class="discussion">
251
+
252
+ <p>stylesheet styles sorted by system default</p>
253
+
254
+
255
+ </div>
256
+ </div>
257
+ <div class="tags">
258
+
259
+
260
+ </div>
261
+ </dt>
262
+ <dd><pre class="code"><span class='int'>2</span></pre></dd>
263
+
264
+ <dt id="STYLESHEET_SORT_BASEDON-constant" class="">STYLESHEET_SORT_BASEDON =
265
+ <div class="docstring">
266
+ <div class="discussion">
267
+
268
+ <p>stylesheet styles sorted by font</p>
269
+
270
+
271
+ </div>
272
+ </div>
273
+ <div class="tags">
274
+
275
+
276
+ </div>
277
+ </dt>
278
+ <dd><pre class="code"><span class='int'>3</span></pre></dd>
279
+
280
+ <dt id="STYLESHEET_SORT_TYPE-constant" class="">STYLESHEET_SORT_TYPE =
281
+ <div class="docstring">
282
+ <div class="discussion">
283
+
284
+ <p>stylesheet styles sorted by based-on fonts</p>
285
+
286
+
287
+ </div>
288
+ </div>
289
+ <div class="tags">
290
+
291
+
292
+ </div>
293
+ </dt>
294
+ <dd><pre class="code"><span class='int'>4</span></pre></dd>
295
+
296
+ </dl>
297
+
298
+
299
+
300
+
301
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
302
+ <ul class="summary">
303
+
304
+ <li class="public ">
305
+ <span class="summary_signature">
306
+
307
+ <a href="#bottom_margin-instance_method" title="#bottom_margin (instance method)">#<strong>bottom_margin</strong> &#x21d2; Object </a>
308
+
309
+
310
+
311
+ </span>
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+ <span class="summary_desc"><div class='inline'>
325
+ <p>Attribute accessor.</p>
326
+ </div></span>
327
+
328
+ </li>
329
+
330
+
331
+ <li class="public ">
332
+ <span class="summary_signature">
333
+
334
+ <a href="#gutter-instance_method" title="#gutter (instance method)">#<strong>gutter</strong> &#x21d2; Object </a>
335
+
336
+
337
+
338
+ </span>
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+ <span class="summary_desc"><div class='inline'>
352
+ <p>Attribute accessor.</p>
353
+ </div></span>
354
+
355
+ </li>
356
+
357
+
358
+ <li class="public ">
359
+ <span class="summary_signature">
360
+
361
+ <a href="#left_margin-instance_method" title="#left_margin (instance method)">#<strong>left_margin</strong> &#x21d2; Object </a>
362
+
363
+
364
+
365
+ </span>
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+ <span class="summary_desc"><div class='inline'>
379
+ <p>Attribute accessor.</p>
380
+ </div></span>
381
+
382
+ </li>
383
+
384
+
385
+ <li class="public ">
386
+ <span class="summary_signature">
387
+
388
+ <a href="#orientation-instance_method" title="#orientation (instance method)">#<strong>orientation</strong> &#x21d2; Object </a>
389
+
390
+
391
+
392
+ </span>
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+ <span class="summary_desc"><div class='inline'>
406
+ <p>Attribute accessor.</p>
407
+ </div></span>
408
+
409
+ </li>
410
+
411
+
412
+ <li class="public ">
413
+ <span class="summary_signature">
414
+
415
+ <a href="#paper-instance_method" title="#paper (instance method)">#<strong>paper</strong> &#x21d2; Object </a>
416
+
417
+
418
+
419
+ </span>
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+ <span class="summary_desc"><div class='inline'>
433
+ <p>Attribute accessor.</p>
434
+ </div></span>
435
+
436
+ </li>
437
+
438
+
439
+ <li class="public ">
440
+ <span class="summary_signature">
441
+
442
+ <a href="#right_margin-instance_method" title="#right_margin (instance method)">#<strong>right_margin</strong> &#x21d2; Object </a>
443
+
444
+
445
+
446
+ </span>
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+ <span class="summary_desc"><div class='inline'>
460
+ <p>Attribute accessor.</p>
461
+ </div></span>
462
+
463
+ </li>
464
+
465
+
466
+ <li class="public ">
467
+ <span class="summary_signature">
468
+
469
+ <a href="#stylesheet_sort-instance_method" title="#stylesheet_sort (instance method)">#<strong>stylesheet_sort</strong> &#x21d2; Object </a>
470
+
471
+
472
+
473
+ </span>
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+ <span class="summary_desc"><div class='inline'>
487
+ <p>Attribute accessor.</p>
488
+ </div></span>
489
+
490
+ </li>
491
+
492
+
493
+ <li class="public ">
494
+ <span class="summary_signature">
495
+
496
+ <a href="#top_margin-instance_method" title="#top_margin (instance method)">#<strong>top_margin</strong> &#x21d2; Object </a>
497
+
498
+
499
+
500
+ </span>
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+ <span class="summary_desc"><div class='inline'>
514
+ <p>Attribute accessor.</p>
515
+ </div></span>
516
+
517
+ </li>
518
+
519
+
520
+ </ul>
521
+
522
+
523
+
524
+
525
+
526
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></h3>
527
+ <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>
528
+
529
+
530
+
531
+ <h2>
532
+ Instance Method Summary
533
+ <small><a href="#" class="summary_toggle">collapse</a></small>
534
+ </h2>
535
+
536
+ <ul class="summary">
537
+
538
+ <li class="public ">
539
+ <span class="summary_signature">
540
+
541
+ <a href="#body_height-instance_method" title="#body_height (instance method)">#<strong>body_height</strong> &#x21d2; Object </a>
542
+
543
+
544
+
545
+ </span>
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+ <span class="summary_desc"><div class='inline'>
556
+ <p>This method fetches the height of the available work area space for a
557
+ DocumentStyle object.</p>
558
+ </div></span>
559
+
560
+ </li>
561
+
562
+
563
+ <li class="public ">
564
+ <span class="summary_signature">
565
+
566
+ <a href="#body_width-instance_method" title="#body_width (instance method)">#<strong>body_width</strong> &#x21d2; Object </a>
567
+
568
+
569
+
570
+ </span>
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+
580
+ <span class="summary_desc"><div class='inline'>
581
+ <p>This method fetches the width of the available work area space for a
582
+ DocumentStyle object.</p>
583
+ </div></span>
584
+
585
+ </li>
586
+
587
+
588
+ <li class="public ">
589
+ <span class="summary_signature">
590
+
591
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {}) &#x21d2; DocumentStyle </a>
592
+
593
+
594
+
595
+ </span>
596
+
597
+
598
+ <span class="note title constructor">constructor</span>
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+ <span class="summary_desc"><div class='inline'>
608
+ <p>This is a constructor for the DocumentStyle class.</p>
609
+ </div></span>
610
+
611
+ </li>
612
+
613
+
614
+ <li class="public ">
615
+ <span class="summary_signature">
616
+
617
+ <a href="#is_document_style%3F-instance_method" title="#is_document_style? (instance method)">#<strong>is_document_style?</strong> &#x21d2; Boolean </a>
618
+
619
+
620
+
621
+ </span>
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+ <span class="summary_desc"><div class='inline'>
632
+ <p>This method overrides the is_document_style? method inherited from the
633
+ Style class to always return true.</p>
634
+ </div></span>
635
+
636
+ </li>
637
+
638
+
639
+ <li class="public ">
640
+ <span class="summary_signature">
641
+
642
+ <a href="#prefix-instance_method" title="#prefix (instance method)">#<strong>prefix</strong>(fonts = nil, colours = nil) &#x21d2; Object </a>
643
+
644
+
645
+
646
+ </span>
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+ <span class="summary_desc"><div class='inline'>
657
+ <p>This method generates a string containing the prefix associated with a
658
+ style object.</p>
659
+ </div></span>
660
+
661
+ </li>
662
+
663
+
664
+ </ul>
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Style.html" title="RRTF::Style (class)">Style</a></span></h3>
677
+ <p class="inherited"><span class='object_link'><a href="Style.html#is_character_style%3F-instance_method" title="RRTF::Style#is_character_style? (method)">#is_character_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#rtf_formatting-instance_method" title="RRTF::Style#rtf_formatting (method)">#rtf_formatting</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>, <span class='object_link'><a href="Style.html#to_rtf-instance_method" title="RRTF::Style#to_rtf (method)">#to_rtf</a></span></p>
678
+ <div id="constructor_details" class="method_details_list">
679
+ <h2>Constructor Details</h2>
680
+
681
+ <div class="method_details first">
682
+ <h3 class="signature first" id="initialize-instance_method">
683
+
684
+ #<strong>initialize</strong>(options = {}) &#x21d2; <tt><span class='object_link'><a href="" title="RRTF::DocumentStyle (class)">DocumentStyle</a></span></tt>
685
+
686
+
687
+
688
+
689
+
690
+ </h3><div class="docstring">
691
+ <div class="discussion">
692
+
693
+ <p>This is a constructor for the DocumentStyle class. This creates a document
694
+ style with a default paper setting of LETTER and portrait orientation (all
695
+ other attributes are nil).</p>
696
+
697
+
698
+ </div>
699
+ </div>
700
+ <div class="tags">
701
+
702
+
703
+ </div><table class="source_code">
704
+ <tr>
705
+ <td>
706
+ <pre class="lines">
707
+
708
+
709
+ 41
710
+ 42
711
+ 43
712
+ 44
713
+ 45
714
+ 46
715
+ 47
716
+ 48
717
+ 49
718
+ 50
719
+ 51
720
+ 52
721
+ 53
722
+ 54
723
+ 55
724
+ 56
725
+ 57
726
+ 58
727
+ 59
728
+ 60
729
+ 61
730
+ 62</pre>
731
+ </td>
732
+ <td>
733
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 41</span>
734
+
735
+ <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>
736
+ <span class='comment'># load default options
737
+ </span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
738
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>paper_size</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='const'><span class='object_link'><a href="Paper.html" title="RRTF::Paper (class)">Paper</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Paper.html#LETTER-constant" title="RRTF::Paper::LETTER (constant)">LETTER</a></span></span><span class='comma'>,</span>
739
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>left_margin</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='const'><span class='object_link'><a href="#DEFAULT_LEFT_MARGIN-constant" title="RRTF::DocumentStyle::DEFAULT_LEFT_MARGIN (constant)">DEFAULT_LEFT_MARGIN</a></span></span><span class='comma'>,</span>
740
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>right_margin</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='const'><span class='object_link'><a href="#DEFAULT_RIGHT_MARGIN-constant" title="RRTF::DocumentStyle::DEFAULT_RIGHT_MARGIN (constant)">DEFAULT_RIGHT_MARGIN</a></span></span><span class='comma'>,</span>
741
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>top_margin</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='const'><span class='object_link'><a href="#DEFAULT_TOP_MARGIN-constant" title="RRTF::DocumentStyle::DEFAULT_TOP_MARGIN (constant)">DEFAULT_TOP_MARGIN</a></span></span><span class='comma'>,</span>
742
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bottom_margin</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='const'><span class='object_link'><a href="#DEFAULT_BOTTOM_MARGIN-constant" title="RRTF::DocumentStyle::DEFAULT_BOTTOM_MARGIN (constant)">DEFAULT_BOTTOM_MARGIN</a></span></span><span class='comma'>,</span>
743
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>gutter</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span>
744
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>orientation</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='const'><span class='object_link'><a href="#PORTRAIT-constant" title="RRTF::DocumentStyle::PORTRAIT (constant)">PORTRAIT</a></span></span><span class='comma'>,</span>
745
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>stylesheet_sort</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='const'><span class='object_link'><a href="#STYLESHEET_SORT_DEFAULT-constant" title="RRTF::DocumentStyle::STYLESHEET_SORT_DEFAULT (constant)">STYLESHEET_SORT_DEFAULT</a></span></span>
746
+ <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>
747
+
748
+ <span class='ivar'>@paper</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'>paper_size</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
749
+ <span class='ivar'>@left_margin</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'>left_margin</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
750
+ <span class='ivar'>@right_margin</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'>right_margin</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
751
+ <span class='ivar'>@top_margin</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'>top_margin</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
752
+ <span class='ivar'>@bottom_margin</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'>bottom_margin</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
753
+ <span class='ivar'>@gutter</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'>gutter</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
754
+ <span class='ivar'>@orientation</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'>orientation</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
755
+ <span class='ivar'>@stylesheet_sort</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'>stylesheet_sort</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
756
+ <span class='kw'>end</span></pre>
757
+ </td>
758
+ </tr>
759
+ </table>
760
+ </div>
761
+
762
+ </div>
763
+
764
+ <div id="instance_attr_details" class="attr_details">
765
+ <h2>Instance Attribute Details</h2>
766
+
767
+
768
+ <span id="bottom_margin=-instance_method"></span>
769
+ <div class="method_details first">
770
+ <h3 class="signature first" id="bottom_margin-instance_method">
771
+
772
+ #<strong>bottom_margin</strong> &#x21d2; <tt>Object</tt>
773
+
774
+
775
+
776
+
777
+
778
+ </h3><div class="docstring">
779
+ <div class="discussion">
780
+
781
+ <p>Attribute accessor.</p>
782
+
783
+
784
+ </div>
785
+ </div>
786
+ <div class="tags">
787
+
788
+
789
+ </div><table class="source_code">
790
+ <tr>
791
+ <td>
792
+ <pre class="lines">
793
+
794
+
795
+ 31
796
+ 32
797
+ 33</pre>
798
+ </td>
799
+ <td>
800
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
801
+
802
+ <span class='kw'>def</span> <span class='id identifier rubyid_bottom_margin'>bottom_margin</span>
803
+ <span class='ivar'>@bottom_margin</span>
804
+ <span class='kw'>end</span></pre>
805
+ </td>
806
+ </tr>
807
+ </table>
808
+ </div>
809
+
810
+
811
+ <span id="gutter=-instance_method"></span>
812
+ <div class="method_details ">
813
+ <h3 class="signature " id="gutter-instance_method">
814
+
815
+ #<strong>gutter</strong> &#x21d2; <tt>Object</tt>
816
+
817
+
818
+
819
+
820
+
821
+ </h3><div class="docstring">
822
+ <div class="discussion">
823
+
824
+ <p>Attribute accessor.</p>
825
+
826
+
827
+ </div>
828
+ </div>
829
+ <div class="tags">
830
+
831
+
832
+ </div><table class="source_code">
833
+ <tr>
834
+ <td>
835
+ <pre class="lines">
836
+
837
+
838
+ 31
839
+ 32
840
+ 33</pre>
841
+ </td>
842
+ <td>
843
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
844
+
845
+ <span class='kw'>def</span> <span class='id identifier rubyid_gutter'>gutter</span>
846
+ <span class='ivar'>@gutter</span>
847
+ <span class='kw'>end</span></pre>
848
+ </td>
849
+ </tr>
850
+ </table>
851
+ </div>
852
+
853
+
854
+ <span id="left_margin=-instance_method"></span>
855
+ <div class="method_details ">
856
+ <h3 class="signature " id="left_margin-instance_method">
857
+
858
+ #<strong>left_margin</strong> &#x21d2; <tt>Object</tt>
859
+
860
+
861
+
862
+
863
+
864
+ </h3><div class="docstring">
865
+ <div class="discussion">
866
+
867
+ <p>Attribute accessor.</p>
868
+
869
+
870
+ </div>
871
+ </div>
872
+ <div class="tags">
873
+
874
+
875
+ </div><table class="source_code">
876
+ <tr>
877
+ <td>
878
+ <pre class="lines">
879
+
880
+
881
+ 31
882
+ 32
883
+ 33</pre>
884
+ </td>
885
+ <td>
886
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
887
+
888
+ <span class='kw'>def</span> <span class='id identifier rubyid_left_margin'>left_margin</span>
889
+ <span class='ivar'>@left_margin</span>
890
+ <span class='kw'>end</span></pre>
891
+ </td>
892
+ </tr>
893
+ </table>
894
+ </div>
895
+
896
+
897
+ <span id="orientation=-instance_method"></span>
898
+ <div class="method_details ">
899
+ <h3 class="signature " id="orientation-instance_method">
900
+
901
+ #<strong>orientation</strong> &#x21d2; <tt>Object</tt>
902
+
903
+
904
+
905
+
906
+
907
+ </h3><div class="docstring">
908
+ <div class="discussion">
909
+
910
+ <p>Attribute accessor.</p>
911
+
912
+
913
+ </div>
914
+ </div>
915
+ <div class="tags">
916
+
917
+
918
+ </div><table class="source_code">
919
+ <tr>
920
+ <td>
921
+ <pre class="lines">
922
+
923
+
924
+ 31
925
+ 32
926
+ 33</pre>
927
+ </td>
928
+ <td>
929
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
930
+
931
+ <span class='kw'>def</span> <span class='id identifier rubyid_orientation'>orientation</span>
932
+ <span class='ivar'>@orientation</span>
933
+ <span class='kw'>end</span></pre>
934
+ </td>
935
+ </tr>
936
+ </table>
937
+ </div>
938
+
939
+
940
+ <span id="paper=-instance_method"></span>
941
+ <div class="method_details ">
942
+ <h3 class="signature " id="paper-instance_method">
943
+
944
+ #<strong>paper</strong> &#x21d2; <tt>Object</tt>
945
+
946
+
947
+
948
+
949
+
950
+ </h3><div class="docstring">
951
+ <div class="discussion">
952
+
953
+ <p>Attribute accessor.</p>
954
+
955
+
956
+ </div>
957
+ </div>
958
+ <div class="tags">
959
+
960
+
961
+ </div><table class="source_code">
962
+ <tr>
963
+ <td>
964
+ <pre class="lines">
965
+
966
+
967
+ 31
968
+ 32
969
+ 33</pre>
970
+ </td>
971
+ <td>
972
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
973
+
974
+ <span class='kw'>def</span> <span class='id identifier rubyid_paper'>paper</span>
975
+ <span class='ivar'>@paper</span>
976
+ <span class='kw'>end</span></pre>
977
+ </td>
978
+ </tr>
979
+ </table>
980
+ </div>
981
+
982
+
983
+ <span id="right_margin=-instance_method"></span>
984
+ <div class="method_details ">
985
+ <h3 class="signature " id="right_margin-instance_method">
986
+
987
+ #<strong>right_margin</strong> &#x21d2; <tt>Object</tt>
988
+
989
+
990
+
991
+
992
+
993
+ </h3><div class="docstring">
994
+ <div class="discussion">
995
+
996
+ <p>Attribute accessor.</p>
997
+
998
+
999
+ </div>
1000
+ </div>
1001
+ <div class="tags">
1002
+
1003
+
1004
+ </div><table class="source_code">
1005
+ <tr>
1006
+ <td>
1007
+ <pre class="lines">
1008
+
1009
+
1010
+ 31
1011
+ 32
1012
+ 33</pre>
1013
+ </td>
1014
+ <td>
1015
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
1016
+
1017
+ <span class='kw'>def</span> <span class='id identifier rubyid_right_margin'>right_margin</span>
1018
+ <span class='ivar'>@right_margin</span>
1019
+ <span class='kw'>end</span></pre>
1020
+ </td>
1021
+ </tr>
1022
+ </table>
1023
+ </div>
1024
+
1025
+
1026
+ <span id="stylesheet_sort=-instance_method"></span>
1027
+ <div class="method_details ">
1028
+ <h3 class="signature " id="stylesheet_sort-instance_method">
1029
+
1030
+ #<strong>stylesheet_sort</strong> &#x21d2; <tt>Object</tt>
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+ </h3><div class="docstring">
1037
+ <div class="discussion">
1038
+
1039
+ <p>Attribute accessor.</p>
1040
+
1041
+
1042
+ </div>
1043
+ </div>
1044
+ <div class="tags">
1045
+
1046
+
1047
+ </div><table class="source_code">
1048
+ <tr>
1049
+ <td>
1050
+ <pre class="lines">
1051
+
1052
+
1053
+ 31
1054
+ 32
1055
+ 33</pre>
1056
+ </td>
1057
+ <td>
1058
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
1059
+
1060
+ <span class='kw'>def</span> <span class='id identifier rubyid_stylesheet_sort'>stylesheet_sort</span>
1061
+ <span class='ivar'>@stylesheet_sort</span>
1062
+ <span class='kw'>end</span></pre>
1063
+ </td>
1064
+ </tr>
1065
+ </table>
1066
+ </div>
1067
+
1068
+
1069
+ <span id="top_margin=-instance_method"></span>
1070
+ <div class="method_details ">
1071
+ <h3 class="signature " id="top_margin-instance_method">
1072
+
1073
+ #<strong>top_margin</strong> &#x21d2; <tt>Object</tt>
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+ </h3><div class="docstring">
1080
+ <div class="discussion">
1081
+
1082
+ <p>Attribute accessor.</p>
1083
+
1084
+
1085
+ </div>
1086
+ </div>
1087
+ <div class="tags">
1088
+
1089
+
1090
+ </div><table class="source_code">
1091
+ <tr>
1092
+ <td>
1093
+ <pre class="lines">
1094
+
1095
+
1096
+ 31
1097
+ 32
1098
+ 33</pre>
1099
+ </td>
1100
+ <td>
1101
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 31</span>
1102
+
1103
+ <span class='kw'>def</span> <span class='id identifier rubyid_top_margin'>top_margin</span>
1104
+ <span class='ivar'>@top_margin</span>
1105
+ <span class='kw'>end</span></pre>
1106
+ </td>
1107
+ </tr>
1108
+ </table>
1109
+ </div>
1110
+
1111
+ </div>
1112
+
1113
+
1114
+ <div id="instance_method_details" class="method_details_list">
1115
+ <h2>Instance Method Details</h2>
1116
+
1117
+
1118
+ <div class="method_details first">
1119
+ <h3 class="signature first" id="body_height-instance_method">
1120
+
1121
+ #<strong>body_height</strong> &#x21d2; <tt>Object</tt>
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+ </h3><div class="docstring">
1128
+ <div class="discussion">
1129
+
1130
+ <p>This method fetches the height of the available work area space for a
1131
+ DocumentStyle object.</p>
1132
+
1133
+
1134
+ </div>
1135
+ </div>
1136
+ <div class="tags">
1137
+
1138
+
1139
+ </div><table class="source_code">
1140
+ <tr>
1141
+ <td>
1142
+ <pre class="lines">
1143
+
1144
+
1145
+ 108
1146
+ 109
1147
+ 110
1148
+ 111
1149
+ 112
1150
+ 113
1151
+ 114</pre>
1152
+ </td>
1153
+ <td>
1154
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 108</span>
1155
+
1156
+ <span class='kw'>def</span> <span class='id identifier rubyid_body_height'>body_height</span>
1157
+ <span class='kw'>if</span> <span class='id identifier rubyid_orientation'>orientation</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#PORTRAIT-constant" title="RRTF::DocumentStyle::PORTRAIT (constant)">PORTRAIT</a></span></span>
1158
+ <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@top_margin</span> <span class='op'>+</span> <span class='ivar'>@bottom_margin</span><span class='rparen'>)</span>
1159
+ <span class='kw'>else</span>
1160
+ <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@top_margin</span> <span class='op'>+</span> <span class='ivar'>@bottom_margin</span><span class='rparen'>)</span>
1161
+ <span class='kw'>end</span>
1162
+ <span class='kw'>end</span></pre>
1163
+ </td>
1164
+ </tr>
1165
+ </table>
1166
+ </div>
1167
+
1168
+ <div class="method_details ">
1169
+ <h3 class="signature " id="body_width-instance_method">
1170
+
1171
+ #<strong>body_width</strong> &#x21d2; <tt>Object</tt>
1172
+
1173
+
1174
+
1175
+
1176
+
1177
+ </h3><div class="docstring">
1178
+ <div class="discussion">
1179
+
1180
+ <p>This method fetches the width of the available work area space for a
1181
+ DocumentStyle object.</p>
1182
+
1183
+
1184
+ </div>
1185
+ </div>
1186
+ <div class="tags">
1187
+
1188
+
1189
+ </div><table class="source_code">
1190
+ <tr>
1191
+ <td>
1192
+ <pre class="lines">
1193
+
1194
+
1195
+ 98
1196
+ 99
1197
+ 100
1198
+ 101
1199
+ 102
1200
+ 103
1201
+ 104</pre>
1202
+ </td>
1203
+ <td>
1204
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 98</span>
1205
+
1206
+ <span class='kw'>def</span> <span class='id identifier rubyid_body_width'>body_width</span>
1207
+ <span class='kw'>if</span> <span class='id identifier rubyid_orientation'>orientation</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#PORTRAIT-constant" title="RRTF::DocumentStyle::PORTRAIT (constant)">PORTRAIT</a></span></span>
1208
+ <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@left_margin</span> <span class='op'>+</span> <span class='ivar'>@right_margin</span><span class='rparen'>)</span>
1209
+ <span class='kw'>else</span>
1210
+ <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@left_margin</span> <span class='op'>+</span> <span class='ivar'>@right_margin</span><span class='rparen'>)</span>
1211
+ <span class='kw'>end</span>
1212
+ <span class='kw'>end</span></pre>
1213
+ </td>
1214
+ </tr>
1215
+ </table>
1216
+ </div>
1217
+
1218
+ <div class="method_details ">
1219
+ <h3 class="signature " id="is_document_style?-instance_method">
1220
+
1221
+ #<strong>is_document_style?</strong> &#x21d2; <tt>Boolean</tt>
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+ </h3><div class="docstring">
1228
+ <div class="discussion">
1229
+
1230
+ <p>This method overrides the is_document_style? method inherited from the
1231
+ Style class to always return true.</p>
1232
+
1233
+
1234
+ </div>
1235
+ </div>
1236
+ <div class="tags">
1237
+
1238
+ <p class="tag_title">Returns:</p>
1239
+ <ul class="return">
1240
+
1241
+ <li>
1242
+
1243
+
1244
+ <span class='type'>(<tt>Boolean</tt>)</span>
1245
+
1246
+
1247
+
1248
+ </li>
1249
+
1250
+ </ul>
1251
+
1252
+ </div><table class="source_code">
1253
+ <tr>
1254
+ <td>
1255
+ <pre class="lines">
1256
+
1257
+
1258
+ 66
1259
+ 67
1260
+ 68</pre>
1261
+ </td>
1262
+ <td>
1263
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 66</span>
1264
+
1265
+ <span class='kw'>def</span> <span class='id identifier rubyid_is_document_style?'>is_document_style?</span>
1266
+ <span class='kw'>true</span>
1267
+ <span class='kw'>end</span></pre>
1268
+ </td>
1269
+ </tr>
1270
+ </table>
1271
+ </div>
1272
+
1273
+ <div class="method_details ">
1274
+ <h3 class="signature " id="prefix-instance_method">
1275
+
1276
+ #<strong>prefix</strong>(fonts = nil, colours = nil) &#x21d2; <tt>Object</tt>
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+ </h3><div class="docstring">
1283
+ <div class="discussion">
1284
+
1285
+ <p>This method generates a string containing the prefix associated with a
1286
+ style object.</p>
1287
+
1288
+ <h4 id="label-Parameters">Parameters</h4>
1289
+ <dl class="rdoc-list note-list"><dt>document
1290
+ <dd>
1291
+ <p>A reference to the document using the style.</p>
1292
+ </dd></dl>
1293
+
1294
+
1295
+ </div>
1296
+ </div>
1297
+ <div class="tags">
1298
+
1299
+
1300
+ </div><table class="source_code">
1301
+ <tr>
1302
+ <td>
1303
+ <pre class="lines">
1304
+
1305
+
1306
+ 75
1307
+ 76
1308
+ 77
1309
+ 78
1310
+ 79
1311
+ 80
1312
+ 81
1313
+ 82
1314
+ 83
1315
+ 84
1316
+ 85
1317
+ 86
1318
+ 87
1319
+ 88
1320
+ 89
1321
+ 90
1322
+ 91
1323
+ 92
1324
+ 93
1325
+ 94</pre>
1326
+ </td>
1327
+ <td>
1328
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/document_style.rb', line 75</span>
1329
+
1330
+ <span class='kw'>def</span> <span class='id identifier rubyid_prefix'>prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_fonts'>fonts</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_colours'>colours</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
1331
+ <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>
1332
+
1333
+ <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'>\\stylesortmethod</span><span class='embexpr_beg'>#{</span><span class='ivar'>@stylesheet_sort</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@stylesheet_sort</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1334
+ <span class='kw'>if</span> <span class='id identifier rubyid_orientation'>orientation</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#LANDSCAPE-constant" title="RRTF::DocumentStyle::LANDSCAPE (constant)">LANDSCAPE</a></span></span>
1335
+ <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'>\\paperw</span><span class='embexpr_beg'>#{</span><span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1336
+ <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'>\\paperh</span><span class='embexpr_beg'>#{</span><span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1337
+ <span class='kw'>else</span>
1338
+ <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'>\\paperw</span><span class='embexpr_beg'>#{</span><span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1339
+ <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'>\\paperh</span><span class='embexpr_beg'>#{</span><span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@paper</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1340
+ <span class='kw'>end</span>
1341
+ <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'>\\margl</span><span class='embexpr_beg'>#{</span><span class='ivar'>@left_margin</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@left_margin</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1342
+ <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'>\\margr</span><span class='embexpr_beg'>#{</span><span class='ivar'>@right_margin</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@right_margin</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1343
+ <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'>\\margt</span><span class='embexpr_beg'>#{</span><span class='ivar'>@top_margin</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@top_margin</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1344
+ <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'>\\margb</span><span class='embexpr_beg'>#{</span><span class='ivar'>@bottom_margin</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@bottom_margin</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1345
+ <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'>\\gutter</span><span class='embexpr_beg'>#{</span><span class='ivar'>@gutter</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@gutter</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1346
+ <span class='id identifier rubyid_text'>text</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>\sectd\lndscpsxn</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='ivar'>@orientation</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#LANDSCAPE-constant" title="RRTF::DocumentStyle::LANDSCAPE (constant)">LANDSCAPE</a></span></span>
1347
+
1348
+ <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
1349
+ <span class='kw'>end</span></pre>
1350
+ </td>
1351
+ </tr>
1352
+ </table>
1353
+ </div>
1354
+
1355
+ </div>
1356
+
1357
+ </div>
1358
+
1359
+ <div id="footer">
1360
+ Generated on Mon Jul 24 15:49:02 2017 by
1361
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1362
+ 0.9.9 (ruby-2.3.3).
1363
+ </div>
1364
+
1365
+ </div>
1366
+ </body>
1367
+ </html>