<!DOCTYPE html> <html>

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

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

Class: RubyText::Color

  &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::Color";
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 (C)</a> &raquo;
  <span class='title'><span class='object_link'><a href="../RubyText.html" title="RubyText (module)">RubyText</a></span></span>
   &raquo; 
  <span class="title">Color</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::Color

</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::Color</li>

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

  </dd>
</dl>

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

</div>

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

<div class="discussion">

<p>Handles color constants and fg/bg pairs</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="Colors-constant" class="">Colors =

      </dt>
      <dd><pre class="code"><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></pre></dd>

  </dl>

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

  <ul class="summary">

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

    <a href="#index-class_method" title="index (class method)">.<strong>index</strong>(color)  &#x21d2; Object </a>

</span>

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

<p>Find “our” color number.</p> </div></span>

</li>

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

    <a href="#pair-class_method" title="pair (class method)">.<strong>pair</strong>(fg, bg)  &#x21d2; Object </a>

</span>

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

<p>Define a fg/bg color pair.</p> </div></span>

</li>

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

    <a href="#sym2const-class_method" title="sym2const (class method)">.<strong>sym2const</strong>(color)  &#x21d2; Object </a>

</span>

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

<p>Convert Ruby symbol to curses color constant name.</p> </div></span>

</li>

  </ul>

<div id="class_method_details" class="method_details_list">
  <h2>Class Method Details</h2>

    <div class="method_details first">
<h3 class="signature first" id="index-class_method">

  .<strong>index</strong>(color)  &#x21d2; <tt>Object</tt>

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

<div class="discussion">

<p>Find “our” color number</p>

</div>

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

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

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

25 26 27</pre>

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

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_color'>color</span><span class='rparen'>)</span>

<span class='const'><span class='object_link'><a href="#Colors-constant" title="RubyText::Color::Colors (constant)">Colors</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find_index'>find_index</span><span class='lparen'>(</span><span class='id identifier rubyid_color'>color</span><span class='rparen'>)</span>  <span class='comment'># &quot;our&quot; number

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

  </td>
</tr>

</table> </div>

    <div class="method_details ">
<h3 class="signature " id="pair-class_method">

  .<strong>pair</strong>(fg, bg)  &#x21d2; <tt>Object</tt>

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

<div class="discussion">

<p>Define a fg/bg color pair</p>

</div>

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

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

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

31 32 33 34 35 36</pre>

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

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pair'>pair</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='id identifier rubyid_nf'>nf</span><span class='comma'>,</span> <span class='id identifier rubyid_nb'>nb</span> <span class='op'>=</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_fg'>fg</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_bg'>bg</span><span class='rparen'>)</span>
<span class='id identifier rubyid_num'>num</span> <span class='op'>=</span> <span class='int'>8</span><span class='op'>*</span><span class='id identifier rubyid_nf'>nf</span> <span class='op'>+</span> <span class='id identifier rubyid_nb'>nb</span>
<span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_init_pair'>init_pair</span><span class='lparen'>(</span><span class='id identifier rubyid_num'>num</span><span class='comma'>,</span> <span class='id identifier rubyid_sym2const'>sym2const</span><span class='lparen'>(</span><span class='id identifier rubyid_fg'>fg</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_sym2const'>sym2const</span><span class='lparen'>(</span><span class='id identifier rubyid_bg'>bg</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_num'>num</span>

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

  </td>
</tr>

</table> </div>

    <div class="method_details ">
<h3 class="signature " id="sym2const-class_method">

  .<strong>sym2const</strong>(color)  &#x21d2; <tt>Object</tt>

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

<div class="discussion">

<p>Convert Ruby symbol to curses color constant name</p>

</div>

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

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

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

19 20 21</pre>

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

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_sym2const'>sym2const</span><span class='lparen'>(</span><span class='id identifier rubyid_color'>color</span><span class='rparen'>)</span> <span class='comment'># to curses constant </span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>COLOR_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_color'>color</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></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:23:59 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>