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