term_utils 0.1.1 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,674 @@
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: TermUtils::Tab::Holder
8
+
9
+ &mdash; Documentation by YARD 0.9.20
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 = "TermUtils::Tab::Holder";
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 (H)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Tab.html" title="TermUtils::Tab (module)">Tab</a></span></span>
41
+ &raquo;
42
+ <span class="title">Holder</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: TermUtils::Tab::Holder
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">TermUtils::Tab::Holder</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/term_utils/tab.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Represents a holder of tables.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#tables-instance_method" title="#tables (instance method)">#<strong>tables</strong> &#x21d2; Hash&lt;Symbol, Tab::Table&gt; </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+ <span class="summary_desc"><div class='inline'></div></span>
141
+
142
+ </li>
143
+
144
+
145
+ </ul>
146
+
147
+
148
+
149
+
150
+
151
+ <h2>
152
+ Instance Method Summary
153
+ <small><a href="#" class="summary_toggle">collapse</a></small>
154
+ </h2>
155
+
156
+ <ul class="summary">
157
+
158
+ <li class="public ">
159
+ <span class="summary_signature">
160
+
161
+ <a href="#define_table-instance_method" title="#define_table (instance method)">#<strong>define_table</strong>(id, opts = {}, &amp;block) &#x21d2; Tab::Table </a>
162
+
163
+
164
+
165
+ </span>
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <span class="summary_desc"><div class='inline'>
176
+ <p>Defines a table.</p>
177
+ </div></span>
178
+
179
+ </li>
180
+
181
+
182
+ <li class="public ">
183
+ <span class="summary_signature">
184
+
185
+ <a href="#find_table-instance_method" title="#find_table (instance method)">#<strong>find_table</strong>(id) &#x21d2; Tab::Table<sup>?</sup> </a>
186
+
187
+
188
+
189
+ </span>
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+ <span class="summary_desc"><div class='inline'>
200
+ <p>Finds a table.</p>
201
+ </div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}) &#x21d2; Holder </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+ <span class="note title constructor">constructor</span>
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+ <span class="summary_desc"><div class='inline'>
226
+ <p>A new instance of Holder.</p>
227
+ </div></span>
228
+
229
+ </li>
230
+
231
+
232
+ <li class="public ">
233
+ <span class="summary_signature">
234
+
235
+ <a href="#printer-instance_method" title="#printer (instance method)">#<strong>printer</strong>(id, io, opts = {}, &amp;block) &#x21d2; Tab::Printer </a>
236
+
237
+
238
+
239
+ </span>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ <span class="summary_desc"><div class='inline'>
250
+ <p>Creates a new table printer.</p>
251
+ </div></span>
252
+
253
+ </li>
254
+
255
+
256
+ </ul>
257
+
258
+
259
+ <div id="constructor_details" class="method_details_list">
260
+ <h2>Constructor Details</h2>
261
+
262
+ <div class="method_details first">
263
+ <h3 class="signature first" id="initialize-instance_method">
264
+
265
+ #<strong>initialize</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::Tab::Holder (class)">Holder</a></span></tt>
266
+
267
+
268
+
269
+
270
+
271
+ </h3><div class="docstring">
272
+ <div class="discussion">
273
+
274
+ <p>Returns a new instance of Holder</p>
275
+
276
+
277
+ </div>
278
+ </div>
279
+ <div class="tags">
280
+
281
+
282
+ </div><table class="source_code">
283
+ <tr>
284
+ <td>
285
+ <pre class="lines">
286
+
287
+
288
+ 290
289
+ 291
290
+ 292</pre>
291
+ </td>
292
+ <td>
293
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 290</span>
294
+
295
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
296
+ <span class='ivar'>@tables</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
297
+ <span class='kw'>end</span></pre>
298
+ </td>
299
+ </tr>
300
+ </table>
301
+ </div>
302
+
303
+ </div>
304
+
305
+ <div id="instance_attr_details" class="attr_details">
306
+ <h2>Instance Attribute Details</h2>
307
+
308
+
309
+ <span id="tables=-instance_method"></span>
310
+ <div class="method_details first">
311
+ <h3 class="signature first" id="tables-instance_method">
312
+
313
+ #<strong>tables</strong> &#x21d2; <tt>Hash&lt;Symbol, <span class='object_link'><a href="Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span>&gt;</tt>
314
+
315
+
316
+
317
+
318
+
319
+ </h3><div class="docstring">
320
+ <div class="discussion">
321
+
322
+
323
+ </div>
324
+ </div>
325
+ <div class="tags">
326
+
327
+ <p class="tag_title">Returns:</p>
328
+ <ul class="return">
329
+
330
+ <li>
331
+
332
+
333
+ <span class='type'>(<tt>Hash&lt;Symbol, <span class='object_link'><a href="Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span>&gt;</tt>)</span>
334
+
335
+
336
+
337
+ </li>
338
+
339
+ </ul>
340
+
341
+ </div><table class="source_code">
342
+ <tr>
343
+ <td>
344
+ <pre class="lines">
345
+
346
+
347
+ 289
348
+ 290
349
+ 291</pre>
350
+ </td>
351
+ <td>
352
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 289</span>
353
+
354
+ <span class='kw'>def</span> <span class='id identifier rubyid_tables'>tables</span>
355
+ <span class='ivar'>@tables</span>
356
+ <span class='kw'>end</span></pre>
357
+ </td>
358
+ </tr>
359
+ </table>
360
+ </div>
361
+
362
+ </div>
363
+
364
+
365
+ <div id="instance_method_details" class="method_details_list">
366
+ <h2>Instance Method Details</h2>
367
+
368
+
369
+ <div class="method_details first">
370
+ <h3 class="signature first" id="define_table-instance_method">
371
+
372
+ #<strong>define_table</strong>(id, opts = {}, &amp;block) &#x21d2; <tt><span class='object_link'><a href="Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt>
373
+
374
+
375
+
376
+
377
+
378
+ </h3><div class="docstring">
379
+ <div class="discussion">
380
+
381
+ <p>Defines a table.</p>
382
+
383
+
384
+ </div>
385
+ </div>
386
+ <div class="tags">
387
+ <p class="tag_title">Parameters:</p>
388
+ <ul class="param">
389
+
390
+ <li>
391
+
392
+ <span class='name'>id</span>
393
+
394
+
395
+ <span class='type'>(<tt>Symbol</tt>)</span>
396
+
397
+
398
+
399
+ </li>
400
+
401
+ <li>
402
+
403
+ <span class='name'>opts</span>
404
+
405
+
406
+ <span class='type'>(<tt>Hash</tt>)</span>
407
+
408
+
409
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
410
+
411
+
412
+ </li>
413
+
414
+ </ul>
415
+
416
+ <p class="tag_title">Returns:</p>
417
+ <ul class="return">
418
+
419
+ <li>
420
+
421
+
422
+ <span class='type'>(<tt><span class='object_link'><a href="Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt>)</span>
423
+
424
+
425
+
426
+ </li>
427
+
428
+ </ul>
429
+
430
+ </div><table class="source_code">
431
+ <tr>
432
+ <td>
433
+ <pre class="lines">
434
+
435
+
436
+ 297
437
+ 298
438
+ 299
439
+ 300
440
+ 301
441
+ 302
442
+ 303
443
+ 304
444
+ 305
445
+ 306
446
+ 307</pre>
447
+ </td>
448
+ <td>
449
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 297</span>
450
+
451
+ <span class='kw'>def</span> <span class='id identifier rubyid_define_table'>define_table</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
452
+ <span class='kw'>if</span> <span class='ivar'>@tables</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span> <span class='id identifier rubyid_id'>id</span>
453
+ <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='ivar'>@tables</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span>
454
+ <span class='kw'>else</span>
455
+ <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
456
+ <span class='id identifier rubyid_new_tab'>new_tab</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Table.html" title="TermUtils::Tab::Table (class)">Table</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Table.html#initialize-instance_method" title="TermUtils::Tab::Table#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
457
+ <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_new_tab'>new_tab</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span>
458
+ <span class='ivar'>@tables</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_new_tab'>new_tab</span>
459
+ <span class='kw'>end</span>
460
+ <span class='ivar'>@tables</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span>
461
+ <span class='kw'>end</span></pre>
462
+ </td>
463
+ </tr>
464
+ </table>
465
+ </div>
466
+
467
+ <div class="method_details ">
468
+ <h3 class="signature " id="find_table-instance_method">
469
+
470
+ #<strong>find_table</strong>(id) &#x21d2; <tt><span class='object_link'><a href="Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt><sup>?</sup>
471
+
472
+
473
+
474
+
475
+
476
+ </h3><div class="docstring">
477
+ <div class="discussion">
478
+
479
+ <p>Finds a table.</p>
480
+
481
+
482
+ </div>
483
+ </div>
484
+ <div class="tags">
485
+ <p class="tag_title">Parameters:</p>
486
+ <ul class="param">
487
+
488
+ <li>
489
+
490
+ <span class='name'>id</span>
491
+
492
+
493
+ <span class='type'>(<tt>Symbol</tt>)</span>
494
+
495
+
496
+
497
+ </li>
498
+
499
+ </ul>
500
+
501
+ <p class="tag_title">Returns:</p>
502
+ <ul class="return">
503
+
504
+ <li>
505
+
506
+
507
+ <span class='type'>(<tt><span class='object_link'><a href="Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt>, <tt>nil</tt>)</span>
508
+
509
+
510
+
511
+ </li>
512
+
513
+ </ul>
514
+
515
+ </div><table class="source_code">
516
+ <tr>
517
+ <td>
518
+ <pre class="lines">
519
+
520
+
521
+ 311
522
+ 312
523
+ 313</pre>
524
+ </td>
525
+ <td>
526
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 311</span>
527
+
528
+ <span class='kw'>def</span> <span class='id identifier rubyid_find_table'>find_table</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
529
+ <span class='ivar'>@tables</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span>
530
+ <span class='kw'>end</span></pre>
531
+ </td>
532
+ </tr>
533
+ </table>
534
+ </div>
535
+
536
+ <div class="method_details ">
537
+ <h3 class="signature " id="printer-instance_method">
538
+
539
+ #<strong>printer</strong>(id, io, opts = {}, &amp;block) &#x21d2; <tt><span class='object_link'><a href="Printer.html" title="TermUtils::Tab::Printer (class)">Tab::Printer</a></span></tt>
540
+
541
+
542
+
543
+
544
+
545
+ </h3><div class="docstring">
546
+ <div class="discussion">
547
+
548
+ <p>Creates a new table printer.</p>
549
+
550
+
551
+ </div>
552
+ </div>
553
+ <div class="tags">
554
+ <p class="tag_title">Parameters:</p>
555
+ <ul class="param">
556
+
557
+ <li>
558
+
559
+ <span class='name'>id</span>
560
+
561
+
562
+ <span class='type'>(<tt>Symbol</tt>)</span>
563
+
564
+
565
+
566
+ </li>
567
+
568
+ <li>
569
+
570
+ <span class='name'>io</span>
571
+
572
+
573
+ <span class='type'>(<tt>IO</tt>)</span>
574
+
575
+
576
+
577
+ </li>
578
+
579
+ <li>
580
+
581
+ <span class='name'>opts</span>
582
+
583
+
584
+ <span class='type'>(<tt>Hash</tt>)</span>
585
+
586
+
587
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
588
+
589
+
590
+ </li>
591
+
592
+ </ul>
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+ <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
602
+ <ul class="option">
603
+
604
+ <li>
605
+ <span class="name">:offset</span>
606
+ <span class="type">(<tt>Integer</tt>)</span>
607
+ <span class="default">
608
+
609
+ </span>
610
+
611
+ </li>
612
+
613
+ <li>
614
+ <span class="name">:column_separator_width</span>
615
+ <span class="type">(<tt>Integer</tt>)</span>
616
+ <span class="default">
617
+
618
+ </span>
619
+
620
+ </li>
621
+
622
+ </ul>
623
+
624
+
625
+
626
+
627
+ <p class="tag_title">Returns:</p>
628
+ <ul class="return">
629
+
630
+ <li>
631
+
632
+
633
+ <span class='type'>(<tt><span class='object_link'><a href="Printer.html" title="TermUtils::Tab::Printer (class)">Tab::Printer</a></span></tt>)</span>
634
+
635
+
636
+
637
+ </li>
638
+
639
+ </ul>
640
+
641
+ </div><table class="source_code">
642
+ <tr>
643
+ <td>
644
+ <pre class="lines">
645
+
646
+
647
+ 321
648
+ 322
649
+ 323</pre>
650
+ </td>
651
+ <td>
652
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 321</span>
653
+
654
+ <span class='kw'>def</span> <span class='id identifier rubyid_printer'>printer</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_io'>io</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
655
+ <span class='id identifier rubyid_find_table'>find_table</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_printer'>printer</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
656
+ <span class='kw'>end</span></pre>
657
+ </td>
658
+ </tr>
659
+ </table>
660
+ </div>
661
+
662
+ </div>
663
+
664
+ </div>
665
+
666
+ <div id="footer">
667
+ Generated on Thu Oct 17 22:50:58 2019 by
668
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
669
+ 0.9.20 (ruby-2.6.5).
670
+ </div>
671
+
672
+ </div>
673
+ </body>
674
+ </html>