doc/TermUtils/Tab/Holder.html in term_utils-0.3.0 vs doc/TermUtils/Tab/Holder.html in term_utils-0.3.1

- old
+ new

@@ -118,10 +118,64 @@ <ul class="summary"> <li class="public "> <span class="summary_signature"> + <a href="#column_defaults-instance_method" title="#column_defaults (instance method)">#<strong>column_defaults</strong> &#x21d2; Hash </a> + + + + </span> + + + + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>`:width`, `:align`, `:fixed`, `:ellipsis`, `:format`.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#table_defaults-instance_method" title="#table_defaults (instance method)">#<strong>table_defaults</strong> &#x21d2; Hash </a> + + + + </span> + + + + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>`:offset`, `:column_separator_width`.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#tables-instance_method" title="#tables (instance method)">#<strong>tables</strong> &#x21d2; Hash&lt;Symbol, Tab::Table&gt; </a> </span> @@ -156,10 +210,34 @@ <ul class="summary"> <li class="public "> <span class="summary_signature"> + <a href="#create_table-instance_method" title="#create_table (instance method)">#<strong>create_table</strong>(opts = {}, &amp;block) &#x21d2; Tab::Table </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Creates a new table, using default properties, without registering it.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#define_table-instance_method" title="#define_table (instance method)">#<strong>define_table</strong>(id, opts = {}, &amp;block) &#x21d2; Tab::Table </a> </span> @@ -171,11 +249,11 @@ <span class="summary_desc"><div class='inline'> -<p>Defines a table.</p> +<p>Defines a table, using default properties.</p> </div></span> </li> @@ -251,10 +329,58 @@ </div></span> </li> + <li class="public "> + <span class="summary_signature"> + + <a href="#set_column_defaults-instance_method" title="#set_column_defaults (instance method)">#<strong>set_column_defaults</strong>(opts = {}) &#x21d2; Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Sets column default properties.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#set_table_defaults-instance_method" title="#set_table_defaults (instance method)">#<strong>set_table_defaults</strong>(opts = {}) &#x21d2; Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Sets table default properties.</p> +</div></span> + +</li> + + </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> @@ -283,18 +409,22 @@ <tr> <td> <pre class="lines"> -290 -291 -292</pre> +421 +422 +423 +424 +425</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 290</span> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 421</span> <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> + <span class='ivar'>@table_defaults</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Tab.html" title="TermUtils::Tab (module)">Tab</a></span></span><span class='period'>.</span><span class='id identifier rubyid_init_table_props'><span class='object_link'><a href="../Tab.html#init_table_props-class_method" title="TermUtils::Tab.init_table_props (method)">init_table_props</a></span></span> + <span class='ivar'>@column_defaults</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Tab.html" title="TermUtils::Tab (module)">Tab</a></span></span><span class='period'>.</span><span class='id identifier rubyid_init_column_props'><span class='object_link'><a href="../Tab.html#init_column_props-class_method" title="TermUtils::Tab.init_column_props (method)">init_column_props</a></span></span> <span class='ivar'>@tables</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>end</span></pre> </td> </tr> </table> @@ -304,14 +434,136 @@ <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> - <span id="tables=-instance_method"></span> + <span id="column_defaults=-instance_method"></span> <div class="method_details first"> - <h3 class="signature first" id="tables-instance_method"> + <h3 class="signature first" id="column_defaults-instance_method"> + #<strong>column_defaults</strong> &#x21d2; <tt>Hash</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns `:width`, `:align`, `:fixed`, `:ellipsis`, `:format`.</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + &mdash; + <div class='inline'> +<p>`:width`, `:align`, `:fixed`, `:ellipsis`, `:format`.</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +418 +419 +420</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 418</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_column_defaults'>column_defaults</span> + <span class='ivar'>@column_defaults</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + + <span id="table_defaults=-instance_method"></span> + <div class="method_details "> + <h3 class="signature " id="table_defaults-instance_method"> + + #<strong>table_defaults</strong> &#x21d2; <tt>Hash</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns `:offset`, `:column_separator_width`.</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + &mdash; + <div class='inline'> +<p>`:offset`, `:column_separator_width`.</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +416 +417 +418</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 416</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_table_defaults'>table_defaults</span> + <span class='ivar'>@table_defaults</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + + <span id="tables=-instance_method"></span> + <div class="method_details "> + <h3 class="signature " id="tables-instance_method"> + #<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> @@ -342,16 +594,16 @@ <tr> <td> <pre class="lines"> -289 -290 -291</pre> +420 +421 +422</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 289</span> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 420</span> <span class='kw'>def</span> <span class='id identifier rubyid_tables'>tables</span> <span class='ivar'>@tables</span> <span class='kw'>end</span></pre> </td> @@ -365,22 +617,103 @@ <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> - <h3 class="signature first" id="define_table-instance_method"> + <h3 class="signature first" id="create_table-instance_method"> + #<strong>create_table</strong>(opts = {}, &amp;block) &#x21d2; <tt><span class='object_link'><a href="Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Creates a new table, using default properties, without registering it.</p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>opts</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + <em class="default">(defaults to: <tt>{}</tt>)</em> + + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Table.html" title="TermUtils::Tab::Table (class)">Tab::Table</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +446 +447 +448 +449 +450 +451 +452 +453</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 446</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_create_table'>create_table</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='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> + <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:offset</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@table_defaults</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:offset</span><span class='rparen'>)</span> + <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:column_separator_width</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@table_defaults</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:column_separator_width</span><span class='rparen'>)</span> + <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:column_defaults</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@column_defaults</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span> + <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> + <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> + <span class='id identifier rubyid_new_tab'>new_tab</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="define_table-instance_method"> + #<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> </h3><div class="docstring"> <div class="discussion"> -<p>Defines a table.</p> +<p>Defines a table, using default properties.</p> </div> </div> <div class="tags"> @@ -431,30 +764,36 @@ <tr> <td> <pre class="lines"> -297 -298 -299 -300 -301 -302 -303 -304 -305 -306 -307</pre> +458 +459 +460 +461 +462 +463 +464 +465 +466 +467 +468 +469 +470 +471</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 297</span> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 458</span> <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> <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> <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> <span class='kw'>else</span> <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> + <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:offset</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@table_defaults</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:offset</span><span class='rparen'>)</span> + <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:column_separator_width</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@table_defaults</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:column_separator_width</span><span class='rparen'>)</span> + <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:column_defaults</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@column_defaults</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span> <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> <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> <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> <span class='kw'>end</span> <span class='ivar'>@tables</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> @@ -516,16 +855,16 @@ <tr> <td> <pre class="lines"> -311 -312 -313</pre> +475 +476 +477</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 311</span> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 475</span> <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> <span class='ivar'>@tables</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> @@ -642,30 +981,227 @@ <tr> <td> <pre class="lines"> -321 -322 -323</pre> +485 +486 +487</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 321</span> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 485</span> <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> <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> <span class='kw'>end</span></pre> </td> </tr> </table> </div> + <div class="method_details "> + <h3 class="signature " id="set_column_defaults-instance_method"> + + #<strong>set_column_defaults</strong>(opts = {}) &#x21d2; <tt>Object</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Sets column default properties.</p> + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>opts</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + <em class="default">(defaults to: <tt>{}</tt>)</em> + + + </li> + +</ul> + + + + <p class="tag_title">Options Hash (<tt>opts</tt>):</p> + <ul class="option"> + + <li> + <span class="name">:width</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">:align</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">:fixed</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">:ellipsis</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">:format</span> + <span class="type">(<tt>Proc</tt>, <tt>String</tt>, <tt>nil</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +440 +441 +442</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 440</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_set_column_defaults'>set_column_defaults</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> + <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Tab.html" title="TermUtils::Tab (module)">Tab</a></span></span><span class='period'>.</span><span class='id identifier rubyid_assign_column_props'><span class='object_link'><a href="../Tab.html#assign_column_props-class_method" title="TermUtils::Tab.assign_column_props (method)">assign_column_props</a></span></span><span class='lparen'>(</span><span class='ivar'>@column_defaults</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> + + <div class="method_details "> + <h3 class="signature " id="set_table_defaults-instance_method"> + + #<strong>set_table_defaults</strong>(opts = {}) &#x21d2; <tt>Object</tt> + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Sets table default properties.</p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>opts</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + <em class="default">(defaults to: <tt>{}</tt>)</em> + + + </li> + +</ul> + + + + + <p class="tag_title">Options Hash (<tt>opts</tt>):</p> + <ul class="option"> + + <li> + <span class="name">:offset</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">:column_separator_width</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +430 +431 +432</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 430</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_set_table_defaults'>set_table_defaults</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> + <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Tab.html" title="TermUtils::Tab (module)">Tab</a></span></span><span class='period'>.</span><span class='id identifier rubyid_assign_table_props'><span class='object_link'><a href="../Tab.html#assign_table_props-class_method" title="TermUtils::Tab.assign_table_props (method)">assign_table_props</a></span></span><span class='lparen'>(</span><span class='ivar'>@table_defaults</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + <div id="footer"> - Generated on Sun Nov 10 18:36:19 2019 by + Generated on Sat Nov 16 17:06:16 2019 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.20 (ruby-2.6.5). </div> </div> \ No newline at end of file