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,826 @@
|
|
|
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::ContainerNode
|
|
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::ContainerNode";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">ContainerNode</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::ContainerNode
|
|
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="Node.html" title="RRTF::Node (class)">Node</a></span></span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next"><span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></li>
|
|
78
|
+
|
|
79
|
+
<li class="next">RRTF::ContainerNode</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
<dl>
|
|
93
|
+
<dt>Includes:</dt>
|
|
94
|
+
<dd>Enumerable</dd>
|
|
95
|
+
</dl>
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<dl>
|
|
103
|
+
<dt>Defined in:</dt>
|
|
104
|
+
<dd>lib/rrtf/node.rb</dd>
|
|
105
|
+
</dl>
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
<h2>Overview</h2><div class="docstring">
|
|
110
|
+
<div class="discussion">
|
|
111
|
+
|
|
112
|
+
<p>This class represents a Node that can contain other Node objects. Its a
|
|
113
|
+
base class for more specific Node types.</p>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
</div>
|
|
117
|
+
</div>
|
|
118
|
+
<div class="tags">
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
</div><div id="subclasses">
|
|
122
|
+
<h2>Direct Known Subclasses</h2>
|
|
123
|
+
<p class="children"><span class='object_link'><a href="CommandNode.html" title="RRTF::CommandNode (class)">CommandNode</a></span>, <span class='object_link'><a href="TableNode.html" title="RRTF::TableNode (class)">TableNode</a></span>, <span class='object_link'><a href="TableRowNode.html" title="RRTF::TableRowNode (class)">TableRowNode</a></span></p>
|
|
124
|
+
</div>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
130
|
+
<ul class="summary">
|
|
131
|
+
|
|
132
|
+
<li class="public ">
|
|
133
|
+
<span class="summary_signature">
|
|
134
|
+
|
|
135
|
+
<a href="#children-instance_method" title="#children (instance method)">#<strong>children</strong> ⇒ Object </a>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
</span>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<span class="summary_desc"><div class='inline'>
|
|
153
|
+
<p>Children elements of the node.</p>
|
|
154
|
+
</div></span>
|
|
155
|
+
|
|
156
|
+
</li>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</ul>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></h3>
|
|
166
|
+
<p class="inherited"><span class='object_link'><a href="Node.html#parent-instance_method" title="RRTF::Node#parent (method)">#parent</a></span></p>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<h2>
|
|
171
|
+
Instance Method Summary
|
|
172
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
173
|
+
</h2>
|
|
174
|
+
|
|
175
|
+
<ul class="summary">
|
|
176
|
+
|
|
177
|
+
<li class="public ">
|
|
178
|
+
<span class="summary_signature">
|
|
179
|
+
|
|
180
|
+
<a href="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(index) ⇒ Object </a>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</span>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<span class="summary_desc"><div class='inline'>
|
|
195
|
+
<p>This method overloads the array dereference operator to allow for access to
|
|
196
|
+
the child elements of a ContainerNode object.</p>
|
|
197
|
+
</div></span>
|
|
198
|
+
|
|
199
|
+
</li>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<li class="public ">
|
|
203
|
+
<span class="summary_signature">
|
|
204
|
+
|
|
205
|
+
<a href="#each-instance_method" title="#each (instance method)">#<strong>each</strong> ⇒ Object </a>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</span>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<span class="summary_desc"><div class='inline'>
|
|
220
|
+
<p>This method provides for iteration over the contents of a ContainerNode
|
|
221
|
+
object.</p>
|
|
222
|
+
</div></span>
|
|
223
|
+
|
|
224
|
+
</li>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<li class="public ">
|
|
228
|
+
<span class="summary_signature">
|
|
229
|
+
|
|
230
|
+
<a href="#first-instance_method" title="#first (instance method)">#<strong>first</strong> ⇒ Object </a>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
</span>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<span class="summary_desc"><div class='inline'>
|
|
245
|
+
<p>This method fetches the first node child for a ContainerNode object.</p>
|
|
246
|
+
</div></span>
|
|
247
|
+
|
|
248
|
+
</li>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<li class="public ">
|
|
252
|
+
<span class="summary_signature">
|
|
253
|
+
|
|
254
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(parent) ⇒ ContainerNode </a>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
</span>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<span class="note title constructor">constructor</span>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<span class="summary_desc"><div class='inline'>
|
|
271
|
+
<p>This is the constructor for the ContainerNode class.</p>
|
|
272
|
+
</div></span>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<li class="public ">
|
|
278
|
+
<span class="summary_signature">
|
|
279
|
+
|
|
280
|
+
<a href="#last-instance_method" title="#last (instance method)">#<strong>last</strong> ⇒ Object </a>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class="summary_desc"><div class='inline'>
|
|
295
|
+
<p>This method fetches the last node child for a ContainerNode object.</p>
|
|
296
|
+
</div></span>
|
|
297
|
+
|
|
298
|
+
</li>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<li class="public ">
|
|
302
|
+
<span class="summary_signature">
|
|
303
|
+
|
|
304
|
+
<a href="#size-instance_method" title="#size (instance method)">#<strong>size</strong> ⇒ Object </a>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
</span>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
<span class="summary_desc"><div class='inline'>
|
|
319
|
+
<p>This method returns a count of the number of children a ContainerNode
|
|
320
|
+
object contains.</p>
|
|
321
|
+
</div></span>
|
|
322
|
+
|
|
323
|
+
</li>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<li class="public ">
|
|
327
|
+
<span class="summary_signature">
|
|
328
|
+
|
|
329
|
+
<a href="#store-instance_method" title="#store (instance method)">#<strong>store</strong>(node) ⇒ Object </a>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
</span>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
<span class="summary_desc"><div class='inline'>
|
|
344
|
+
<p>This method adds a new node element to the end of the list of nodes
|
|
345
|
+
maintained by a ContainerNode object.</p>
|
|
346
|
+
</div></span>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<li class="public ">
|
|
352
|
+
<span class="summary_signature">
|
|
353
|
+
|
|
354
|
+
<a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong> ⇒ Object </a>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</span>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
|
369
|
+
<p>This method generates the RTF text for a ContainerNode object.</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
</ul>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></h3>
|
|
389
|
+
<p class="inherited"><span class='object_link'><a href="Node.html#is_root%3F-instance_method" title="RRTF::Node#is_root? (method)">#is_root?</a></span>, <span class='object_link'><a href="Node.html#next_node-instance_method" title="RRTF::Node#next_node (method)">#next_node</a></span>, <span class='object_link'><a href="Node.html#previous_node-instance_method" title="RRTF::Node#previous_node (method)">#previous_node</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="RRTF::Node#root (method)">#root</a></span></p>
|
|
390
|
+
<div id="constructor_details" class="method_details_list">
|
|
391
|
+
<h2>Constructor Details</h2>
|
|
392
|
+
|
|
393
|
+
<div class="method_details first">
|
|
394
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
395
|
+
|
|
396
|
+
#<strong>initialize</strong>(parent) ⇒ <tt><span class='object_link'><a href="" title="RRTF::ContainerNode (class)">ContainerNode</a></span></tt>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
</h3><div class="docstring">
|
|
403
|
+
<div class="discussion">
|
|
404
|
+
|
|
405
|
+
<p>This is the constructor for the ContainerNode class.</p>
|
|
406
|
+
|
|
407
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
408
|
+
<dl class="rdoc-list note-list"><dt>parent
|
|
409
|
+
<dd>
|
|
410
|
+
<p>A reference to the parent node that owners the new ContainerNode object.</p>
|
|
411
|
+
</dd></dl>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
</div>
|
|
415
|
+
</div>
|
|
416
|
+
<div class="tags">
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
</div><table class="source_code">
|
|
420
|
+
<tr>
|
|
421
|
+
<td>
|
|
422
|
+
<pre class="lines">
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
144
|
|
426
|
+
145
|
|
427
|
+
146
|
|
428
|
+
147
|
|
429
|
+
148</pre>
|
|
430
|
+
</td>
|
|
431
|
+
<td>
|
|
432
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 144</span>
|
|
433
|
+
|
|
434
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
|
|
435
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
|
|
436
|
+
<span class='ivar'>@children</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
437
|
+
<span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='kw'>yield</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
|
438
|
+
<span class='kw'>end</span></pre>
|
|
439
|
+
</td>
|
|
440
|
+
</tr>
|
|
441
|
+
</table>
|
|
442
|
+
</div>
|
|
443
|
+
|
|
444
|
+
</div>
|
|
445
|
+
|
|
446
|
+
<div id="instance_attr_details" class="attr_details">
|
|
447
|
+
<h2>Instance Attribute Details</h2>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<span id="children=-instance_method"></span>
|
|
451
|
+
<div class="method_details first">
|
|
452
|
+
<h3 class="signature first" id="children-instance_method">
|
|
453
|
+
|
|
454
|
+
#<strong>children</strong> ⇒ <tt>Object</tt>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
</h3><div class="docstring">
|
|
461
|
+
<div class="discussion">
|
|
462
|
+
|
|
463
|
+
<p>Children elements of the node</p>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
</div>
|
|
467
|
+
</div>
|
|
468
|
+
<div class="tags">
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
</div><table class="source_code">
|
|
472
|
+
<tr>
|
|
473
|
+
<td>
|
|
474
|
+
<pre class="lines">
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
137
|
|
478
|
+
138
|
|
479
|
+
139</pre>
|
|
480
|
+
</td>
|
|
481
|
+
<td>
|
|
482
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 137</span>
|
|
483
|
+
|
|
484
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_children'>children</span>
|
|
485
|
+
<span class='ivar'>@children</span>
|
|
486
|
+
<span class='kw'>end</span></pre>
|
|
487
|
+
</td>
|
|
488
|
+
</tr>
|
|
489
|
+
</table>
|
|
490
|
+
</div>
|
|
491
|
+
|
|
492
|
+
</div>
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
<div id="instance_method_details" class="method_details_list">
|
|
496
|
+
<h2>Instance Method Details</h2>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
<div class="method_details first">
|
|
500
|
+
<h3 class="signature first" id="[]-instance_method">
|
|
501
|
+
|
|
502
|
+
#<strong>[]</strong>(index) ⇒ <tt>Object</tt>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
</h3><div class="docstring">
|
|
509
|
+
<div class="discussion">
|
|
510
|
+
|
|
511
|
+
<p>This method overloads the array dereference operator to allow for access to
|
|
512
|
+
the child elements of a ContainerNode object.</p>
|
|
513
|
+
|
|
514
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
515
|
+
<dl class="rdoc-list note-list"><dt>index
|
|
516
|
+
<dd>
|
|
517
|
+
<p>The offset from the first child of the child object to be returned.
|
|
518
|
+
Negative index values work from the back of the list of children. An
|
|
519
|
+
invalid index will cause a nil value to be returned.</p>
|
|
520
|
+
</dd></dl>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
</div>
|
|
524
|
+
</div>
|
|
525
|
+
<div class="tags">
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
</div><table class="source_code">
|
|
529
|
+
<tr>
|
|
530
|
+
<td>
|
|
531
|
+
<pre class="lines">
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
195
|
|
535
|
+
196
|
|
536
|
+
197</pre>
|
|
537
|
+
</td>
|
|
538
|
+
<td>
|
|
539
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 195</span>
|
|
540
|
+
|
|
541
|
+
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
|
|
542
|
+
<span class='ivar'>@children</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
|
|
543
|
+
<span class='kw'>end</span></pre>
|
|
544
|
+
</td>
|
|
545
|
+
</tr>
|
|
546
|
+
</table>
|
|
547
|
+
</div>
|
|
548
|
+
|
|
549
|
+
<div class="method_details ">
|
|
550
|
+
<h3 class="signature " id="each-instance_method">
|
|
551
|
+
|
|
552
|
+
#<strong>each</strong> ⇒ <tt>Object</tt>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
</h3><div class="docstring">
|
|
559
|
+
<div class="discussion">
|
|
560
|
+
|
|
561
|
+
<p>This method provides for iteration over the contents of a ContainerNode
|
|
562
|
+
object.</p>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
</div>
|
|
566
|
+
</div>
|
|
567
|
+
<div class="tags">
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
</div><table class="source_code">
|
|
571
|
+
<tr>
|
|
572
|
+
<td>
|
|
573
|
+
<pre class="lines">
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
177
|
|
577
|
+
178
|
|
578
|
+
179</pre>
|
|
579
|
+
</td>
|
|
580
|
+
<td>
|
|
581
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 177</span>
|
|
582
|
+
|
|
583
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span>
|
|
584
|
+
<span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_child'>child</span><span class='op'>|</span> <span class='kw'>yield</span> <span class='id identifier rubyid_child'>child</span><span class='rbrace'>}</span>
|
|
585
|
+
<span class='kw'>end</span></pre>
|
|
586
|
+
</td>
|
|
587
|
+
</tr>
|
|
588
|
+
</table>
|
|
589
|
+
</div>
|
|
590
|
+
|
|
591
|
+
<div class="method_details ">
|
|
592
|
+
<h3 class="signature " id="first-instance_method">
|
|
593
|
+
|
|
594
|
+
#<strong>first</strong> ⇒ <tt>Object</tt>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</h3><div class="docstring">
|
|
601
|
+
<div class="discussion">
|
|
602
|
+
|
|
603
|
+
<p>This method fetches the first node child for a ContainerNode object. If a
|
|
604
|
+
container contains no children this method returns nil.</p>
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
</div>
|
|
608
|
+
</div>
|
|
609
|
+
<div class="tags">
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
</div><table class="source_code">
|
|
613
|
+
<tr>
|
|
614
|
+
<td>
|
|
615
|
+
<pre class="lines">
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
165
|
|
619
|
+
166
|
|
620
|
+
167</pre>
|
|
621
|
+
</td>
|
|
622
|
+
<td>
|
|
623
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 165</span>
|
|
624
|
+
|
|
625
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_first'>first</span>
|
|
626
|
+
<span class='ivar'>@children</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
627
|
+
<span class='kw'>end</span></pre>
|
|
628
|
+
</td>
|
|
629
|
+
</tr>
|
|
630
|
+
</table>
|
|
631
|
+
</div>
|
|
632
|
+
|
|
633
|
+
<div class="method_details ">
|
|
634
|
+
<h3 class="signature " id="last-instance_method">
|
|
635
|
+
|
|
636
|
+
#<strong>last</strong> ⇒ <tt>Object</tt>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
</h3><div class="docstring">
|
|
643
|
+
<div class="discussion">
|
|
644
|
+
|
|
645
|
+
<p>This method fetches the last node child for a ContainerNode object. If a
|
|
646
|
+
container contains no children this method returns nil.</p>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
</div>
|
|
650
|
+
</div>
|
|
651
|
+
<div class="tags">
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
</div><table class="source_code">
|
|
655
|
+
<tr>
|
|
656
|
+
<td>
|
|
657
|
+
<pre class="lines">
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
171
|
|
661
|
+
172
|
|
662
|
+
173</pre>
|
|
663
|
+
</td>
|
|
664
|
+
<td>
|
|
665
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 171</span>
|
|
666
|
+
|
|
667
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_last'>last</span>
|
|
668
|
+
<span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
|
|
669
|
+
<span class='kw'>end</span></pre>
|
|
670
|
+
</td>
|
|
671
|
+
</tr>
|
|
672
|
+
</table>
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
<div class="method_details ">
|
|
676
|
+
<h3 class="signature " id="size-instance_method">
|
|
677
|
+
|
|
678
|
+
#<strong>size</strong> ⇒ <tt>Object</tt>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
</h3><div class="docstring">
|
|
685
|
+
<div class="discussion">
|
|
686
|
+
|
|
687
|
+
<p>This method returns a count of the number of children a ContainerNode
|
|
688
|
+
object contains.</p>
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
</div>
|
|
692
|
+
</div>
|
|
693
|
+
<div class="tags">
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
</div><table class="source_code">
|
|
697
|
+
<tr>
|
|
698
|
+
<td>
|
|
699
|
+
<pre class="lines">
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
183
|
|
703
|
+
184
|
|
704
|
+
185</pre>
|
|
705
|
+
</td>
|
|
706
|
+
<td>
|
|
707
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 183</span>
|
|
708
|
+
|
|
709
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
|
|
710
|
+
<span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
|
|
711
|
+
<span class='kw'>end</span></pre>
|
|
712
|
+
</td>
|
|
713
|
+
</tr>
|
|
714
|
+
</table>
|
|
715
|
+
</div>
|
|
716
|
+
|
|
717
|
+
<div class="method_details ">
|
|
718
|
+
<h3 class="signature " id="store-instance_method">
|
|
719
|
+
|
|
720
|
+
#<strong>store</strong>(node) ⇒ <tt>Object</tt>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
</h3><div class="docstring">
|
|
727
|
+
<div class="discussion">
|
|
728
|
+
|
|
729
|
+
<p>This method adds a new node element to the end of the list of nodes
|
|
730
|
+
maintained by a ContainerNode object. Nil objects are ignored.</p>
|
|
731
|
+
|
|
732
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
733
|
+
<dl class="rdoc-list note-list"><dt>node
|
|
734
|
+
<dd>
|
|
735
|
+
<p>A reference to the Node object to be added.</p>
|
|
736
|
+
</dd></dl>
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
</div>
|
|
740
|
+
</div>
|
|
741
|
+
<div class="tags">
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
</div><table class="source_code">
|
|
745
|
+
<tr>
|
|
746
|
+
<td>
|
|
747
|
+
<pre class="lines">
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
155
|
|
751
|
+
156
|
|
752
|
+
157
|
|
753
|
+
158
|
|
754
|
+
159
|
|
755
|
+
160
|
|
756
|
+
161</pre>
|
|
757
|
+
</td>
|
|
758
|
+
<td>
|
|
759
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 155</span>
|
|
760
|
+
|
|
761
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
|
|
762
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
763
|
+
<span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></span><span class='rparen'>)</span>
|
|
764
|
+
<span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span> <span class='op'>=</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span> <span class='op'>!=</span> <span class='kw'>self</span>
|
|
765
|
+
<span class='kw'>end</span>
|
|
766
|
+
<span class='id identifier rubyid_node'>node</span>
|
|
767
|
+
<span class='kw'>end</span></pre>
|
|
768
|
+
</td>
|
|
769
|
+
</tr>
|
|
770
|
+
</table>
|
|
771
|
+
</div>
|
|
772
|
+
|
|
773
|
+
<div class="method_details ">
|
|
774
|
+
<h3 class="signature " id="to_rtf-instance_method">
|
|
775
|
+
|
|
776
|
+
#<strong>to_rtf</strong> ⇒ <tt>Object</tt>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
</h3><div class="docstring">
|
|
783
|
+
<div class="discussion">
|
|
784
|
+
|
|
785
|
+
<p>This method generates the RTF text for a ContainerNode object.</p>
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
</div>
|
|
789
|
+
</div>
|
|
790
|
+
<div class="tags">
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
</div><table class="source_code">
|
|
794
|
+
<tr>
|
|
795
|
+
<td>
|
|
796
|
+
<pre class="lines">
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
200
|
|
800
|
+
201
|
|
801
|
+
202</pre>
|
|
802
|
+
</td>
|
|
803
|
+
<td>
|
|
804
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/node.rb', line 200</span>
|
|
805
|
+
|
|
806
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_rtf'>to_rtf</span>
|
|
807
|
+
<span class='const'><span class='object_link'><a href="RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>.to_rtf method not yet implemented.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
808
|
+
<span class='kw'>end</span></pre>
|
|
809
|
+
</td>
|
|
810
|
+
</tr>
|
|
811
|
+
</table>
|
|
812
|
+
</div>
|
|
813
|
+
|
|
814
|
+
</div>
|
|
815
|
+
|
|
816
|
+
</div>
|
|
817
|
+
|
|
818
|
+
<div id="footer">
|
|
819
|
+
Generated on Mon Jul 24 15:48:59 2017 by
|
|
820
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
821
|
+
0.9.9 (ruby-2.3.3).
|
|
822
|
+
</div>
|
|
823
|
+
|
|
824
|
+
</div>
|
|
825
|
+
</body>
|
|
826
|
+
</html>
|