<!DOCTYPE html> <html>

<head>
  <meta charset="utf-8">

<meta name=“viewport” content=“width=device-width, initial-scale=1.0”> <title>

Class: RubyText::Effects

  &mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="../css/style.css" type="text/css" />

<link rel="stylesheet" href="../css/common.css" type="text/css" />

<script type=“text/javascript”>

pathId = "RubyText::Effects";
relpath = '../';

</script>

<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>

</head>
<body>
  <div class="nav_wrap">
    <iframe id="nav" src="../class_list.html?1"></iframe>
    <div id="resizer"></div>
  </div>

  <div id="main" tabindex="-1">
    <div id="header">
      <div id="menu">

  <a href="../_index.html">Index (E)</a> &raquo;
  <span class='title'><span class='object_link'><a href="../RubyText.html" title="RubyText (module)">RubyText</a></span></span>
   &raquo; 
  <span class="title">Effects</span>

</div>

    <div id="search">

<a class="full_list_link" id="class_list_link"
    href="../class_list.html">

    <svg width="24" height="24">
      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
    </svg>
</a>

</div>

  <div class="clear"></div>
</div>

<div id="content"><h1>Class: RubyText::Effects

</h1> <div class=“box_info”>

<dl>
  <dt>Inherits:</dt>
  <dd>
    <span class="inheritName">Object</span>

      <ul class="fullTree">
        <li>Object</li>

          <li class="next">RubyText::Effects</li>

      </ul>
      <a href="#" class="inheritanceTree">show all</a>

  </dd>
</dl>

<dl>
  <dt>Defined in:</dt>
  <dd>effects.rb</dd>
</dl>

</div>

<h2>Overview</h2><div class=“docstring”>

<div class="discussion">

<p>Hande text effects (bold, normal, reverse, underline)</p>

</div>

</div> <div class=“tags”>

</div>

  <h2>
    Constant Summary
    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
  </h2>

  <dl class="constants">

      <dt id="Modes-constant" class="">Modes =
        <div class="docstring">
<div class="discussion">

<p>Text modes</p>

</div>

</div> <div class=“tags”>

</div>

</dt>
<dd><pre class="code"><span class='lbrace'>{</span><span class='label'>bold:</span>    <span class='const'>Curses</span><span class='op'>::</span><span class='const'>A_BOLD</span><span class='comma'>,</span>

<span class='label'>normal:</span> <span class='const'>Curses</span><span class='op'>::</span><span class='const'>A_NORMAL</span><span class='comma'>,</span> <span class='label'>reverse:</span> <span class='const'>Curses</span><span class='op'>::</span><span class='const'>A_REVERSE</span><span class='comma'>,</span> <span class='label'>under:</span> <span class='const'>Curses</span><span class='op'>::</span><span class='const'>A_UNDERLINE</span><span class='rbrace'>}</span></pre></dd>

      <dt id="Others-constant" class="">Others =
        <div class="docstring">
<div class="discussion">

<p>Other text modes “of our own”</p>

</div>

</div> <div class=“tags”>

</div>

      </dt>
      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>%[</span><span class='tstring_content'>:show, :hide</span><span class='tstring_end'>]</span></span></pre></dd>

  </dl>

<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">

    <li class="public ">
<span class="summary_signature">

    <a href="#bg-instance_method" title="#bg (instance method)">#<strong>bg</strong>  &#x21d2; Object </a>

</span>

    <span class="note title readonly">readonly</span>

  <span class="summary_desc"><div class='inline'>

<p>show/hide cursor; more later??.</p> </div></span>

</li>

    <li class="public ">
<span class="summary_signature">

    <a href="#fg-instance_method" title="#fg (instance method)">#<strong>fg</strong>  &#x21d2; Object </a>

</span>

    <span class="note title readonly">readonly</span>

  <span class="summary_desc"><div class='inline'>

<p>show/hide cursor; more later??.</p> </div></span>

</li>

    <li class="public ">
<span class="summary_signature">

    <a href="#value-instance_method" title="#value (instance method)">#<strong>value</strong>  &#x21d2; Object </a>

</span>

    <span class="note title readonly">readonly</span>

  <span class="summary_desc"><div class='inline'>

<p>show/hide cursor; more later??.</p> </div></span>

</li>

</ul>

  <h2>
    Instance Method Summary
    <small><a href="#" class="summary_toggle">collapse</a></small>
  </h2>

  <ul class="summary">

      <li class="public ">
<span class="summary_signature">

    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(*args, bg: nil)  &#x21d2; Effects </a>

</span>

  <span class="note title constructor">constructor</span>

  <span class="summary_desc"><div class='inline'>

<p>Initialize an Effects object.</p> </div></span>

</li>

      <li class="public ">
<span class="summary_signature">

    <a href="#reset-instance_method" title="#reset (instance method)">#<strong>reset</strong>(win)  &#x21d2; Object </a>

</span>

  <span class="summary_desc"><div class='inline'>

<p>“Turn off” effect in specified window.</p> </div></span>

</li>

      <li class="public ">
<span class="summary_signature">

    <a href="#set-instance_method" title="#set (instance method)">#<strong>set</strong>(win)  &#x21d2; Object </a>

</span>

  <span class="summary_desc"><div class='inline'>

<p>“Turn on” effect to specified window.</p> </div></span>

</li>

</ul>

<div id=“constructor_details” class=“method_details_list”>

<h2>Constructor Details</h2>

  <div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">

  #<strong>initialize</strong>(*args, bg: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="RubyText::Effects (class)">Effects</a></span></tt>

</h3><div class=“docstring”>

<div class="discussion">

<p>Initialize an Effects object</p>

</div>

</div> <div class=“tags”>

</div><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

30 31 32 33 34 35 36 37 38 39 40 41 42 43</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'effects.rb', line 30</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='label'>bg:</span> <span class='kw'>nil</span><span class='rparen'>)</span>

<span class='id identifier rubyid_bits'>bits</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='ivar'>@list</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_arg'>arg</span><span class='op'>|</span>
  <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="#Modes-constant" title="RubyText::Effects::Modes (constant)">Modes</a></span></span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span>
    <span class='id identifier rubyid_val'>val</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#Modes-constant" title="RubyText::Effects::Modes (constant)">Modes</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_arg'>arg</span><span class='rbracket'>]</span>
    <span class='id identifier rubyid_bits'>bits</span> <span class='op'>|=</span> <span class='id identifier rubyid_val'>val</span>
  <span class='kw'>elsif</span> <span class='op'>::</span><span class='const'><span class='object_link'><a href="../top-level-namespace.html#Colors-constant" title="Colors (constant)">Colors</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span>
    <span class='ivar'>@fg</span> <span class='op'>=</span> <span class='id identifier rubyid_arg'>arg</span>   <span class='comment'># symbol

</span> <span class='kw'>end</span>

<span class='kw'>end</span>
<span class='ivar'>@bg</span> <span class='op'>=</span> <span class='id identifier rubyid_bg'>bg</span> <span class='op'>||</span> <span class='ivar'>@bg</span>
<span class='ivar'>@value</span> <span class='op'>=</span> <span class='id identifier rubyid_bits'>bits</span>

<span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

</div>

<div id="instance_attr_details" class="attr_details">
  <h2>Instance Attribute Details</h2>

    <span id=""></span>
    <div class="method_details first">
<h3 class="signature first" id="bg-instance_method">

  #<strong>bg</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>

</h3><div class=“docstring”>

<div class="discussion">

<p>show/hide cursor; more later??</p>

</div>

</div> <div class=“tags”>

</div><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

24 25 26</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'effects.rb', line 24</span>

<span class='kw'>def</span> <span class='id identifier rubyid_bg'>bg</span>

<span class='ivar'>@bg</span>

<span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

    <span id=""></span>
    <div class="method_details ">
<h3 class="signature " id="fg-instance_method">

  #<strong>fg</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>

</h3><div class=“docstring”>

<div class="discussion">

<p>show/hide cursor; more later??</p>

</div>

</div> <div class=“tags”>

</div><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

24 25 26</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'effects.rb', line 24</span>

<span class='kw'>def</span> <span class='id identifier rubyid_fg'>fg</span>

<span class='ivar'>@fg</span>

<span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

    <span id=""></span>
    <div class="method_details ">
<h3 class="signature " id="value-instance_method">

  #<strong>value</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>

</h3><div class=“docstring”>

<div class="discussion">

<p>show/hide cursor; more later??</p>

</div>

</div> <div class=“tags”>

</div><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

24 25 26</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'effects.rb', line 24</span>

<span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>

<span class='ivar'>@value</span>

<span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

</div>

<div id="instance_method_details" class="method_details_list">
  <h2>Instance Method Details</h2>

    <div class="method_details first">
<h3 class="signature first" id="reset-instance_method">

  #<strong>reset</strong>(win)  &#x21d2; <tt>Object</tt>

</h3><div class=“docstring”>

<div class="discussion">

<p>“Turn off” effect in specified window</p>

</div>

</div> <div class=“tags”>

</div><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

58 59 60 61 62</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'effects.rb', line 58</span>

<span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span><span class='lparen'>(</span><span class='id identifier rubyid_win'>win</span><span class='rparen'>)</span>

<span class='id identifier rubyid_attr'>attr</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
<span class='id identifier rubyid_win'>win</span><span class='period'>.</span><span class='id identifier rubyid_cwin'>cwin</span><span class='period'>.</span><span class='id identifier rubyid_attroff'>attroff</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_win'>win</span><span class='period'>.</span><span class='id identifier rubyid_set_colors'>set_colors</span><span class='lparen'>(</span><span class='ivar'>@old_fg</span><span class='comma'>,</span> <span class='ivar'>@old_bg</span><span class='rparen'>)</span>  <span class='comment'># Does restore logic work?

</span><span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

    <div class="method_details ">
<h3 class="signature " id="set-instance_method">

  #<strong>set</strong>(win)  &#x21d2; <tt>Object</tt>

</h3><div class=“docstring”>

<div class="discussion">

<p>“Turn on” effect to specified window</p>

</div>

</div> <div class=“tags”>

</div><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

47 48 49 50 51 52 53 54</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'effects.rb', line 47</span>

<span class='kw'>def</span> <span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='id identifier rubyid_win'>win</span><span class='rparen'>)</span>

<span class='ivar'>@old_fg</span><span class='comma'>,</span> <span class='ivar'>@old_bg</span>  <span class='op'>=</span> <span class='id identifier rubyid_win'>win</span><span class='period'>.</span><span class='id identifier rubyid_fg'>fg</span><span class='comma'>,</span> <span class='id identifier rubyid_win'>win</span><span class='period'>.</span><span class='id identifier rubyid_bg'>bg</span>  <span class='comment'># Save off current state?

</span> <span class='id identifier rubyid_attr'>attr</span><span class='comma'>,</span> <span class='id identifier rubyid_fg'>fg</span><span class='comma'>,</span> <span class='id identifier rubyid_bg'>bg</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_fg'>fg</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_bg'>bg</span>

<span class='id identifier rubyid_win'>win</span><span class='period'>.</span><span class='id identifier rubyid_cwin'>cwin</span><span class='period'>.</span><span class='id identifier rubyid_attron'>attron</span><span class='lparen'>(</span><span class='id identifier rubyid_attr'>attr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_fg'>fg</span> <span class='op'>||=</span> <span class='id identifier rubyid_win'>win</span><span class='period'>.</span><span class='id identifier rubyid_fg'>fg</span>
<span class='id identifier rubyid_bg'>bg</span> <span class='op'>||=</span> <span class='id identifier rubyid_win'>win</span><span class='period'>.</span><span class='id identifier rubyid_bg'>bg</span>
<span class='id identifier rubyid_win'>win</span><span class='period'>.</span><span class='id identifier rubyid_set_colors'>set_colors</span><span class='lparen'>(</span><span class='id identifier rubyid_fg'>fg</span><span class='comma'>,</span> <span class='id identifier rubyid_bg'>bg</span><span class='rparen'>)</span>

<span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

</div>

</div>

    <div id="footer">
Generated on Sat Feb  8 04:24:00 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.24 (ruby-2.4.2).

</div>

  </div>
</body>

</html>