RedGreen
/
bzdoor


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bugz Door Project: door::Render Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Bugz Door Project
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacedoor.html">door</a></li><li class="navelem"><a class="el" href="classdoor_1_1Render.html">Render</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classdoor_1_1Render-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">door::Render Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Rendering a string with <a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a>.  
 <a href="classdoor_1_1Render.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="door_8h_source.html">door.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6540ecf2f2f4a3e9eaeb47cc9c7daa00"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Render.html#a6540ecf2f2f4a3e9eaeb47cc9c7daa00">Render</a> (const std::string txt)</td></tr>
<tr class="separator:a6540ecf2f2f4a3e9eaeb47cc9c7daa00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c32f938c06d5d6b87d238ba6072324e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Render.html#a9c32f938c06d5d6b87d238ba6072324e">append</a> (<a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a> color, int len=1)</td></tr>
<tr class="separator:a9c32f938c06d5d6b87d238ba6072324e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae83a23641dde4dff29b5214ea1921f3b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Render.html#ae83a23641dde4dff29b5214ea1921f3b">output</a> (std::ostream &amp;os)</td></tr>
<tr class="separator:ae83a23641dde4dff29b5214ea1921f3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ada0caea3ba255104474a2f0bfa94d6d2"><td class="memItemLeft" align="right" valign="top"><a id="ada0caea3ba255104474a2f0bfa94d6d2"></a>
const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Render.html#ada0caea3ba255104474a2f0bfa94d6d2">text</a></td></tr>
<tr class="memdesc:ada0caea3ba255104474a2f0bfa94d6d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Complete text to be rendered. <br /></td></tr>
<tr class="separator:ada0caea3ba255104474a2f0bfa94d6d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a887fd73649a7e63257cc695e2756bc66"><td class="memItemLeft" align="right" valign="top"><a id="a887fd73649a7e63257cc695e2756bc66"></a>
std::vector&lt; <a class="el" href="classdoor_1_1ColorOutput.html">ColorOutput</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Render.html#a887fd73649a7e63257cc695e2756bc66">outputs</a></td></tr>
<tr class="memdesc:a887fd73649a7e63257cc695e2756bc66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector of <a class="el" href="classdoor_1_1ColorOutput.html" title="This holds an ANSIColor and text position + length.">ColorOutput</a> object. <br /></td></tr>
<tr class="separator:a887fd73649a7e63257cc695e2756bc66"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Rendering a string with <a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a>. </p>
<p>This holds the string, and a vector that contains <a class="el" href="classdoor_1_1ColorOutput.html" title="This holds an ANSIColor and text position + length.">ColorOutput</a> parts.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdoor_1_1Render.html#ae83a23641dde4dff29b5214ea1921f3b">Render::output()</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6540ecf2f2f4a3e9eaeb47cc9c7daa00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6540ecf2f2f4a3e9eaeb47cc9c7daa00">&#9670;&nbsp;</a></span>Render()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">door::Render::Render </td>
          <td>(</td>
          <td class="paramtype">const std::string&#160;</td>
          <td class="paramname"><em>txt</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Construct a new <a class="el" href="classdoor_1_1Render.html" title="Rendering a string with ANSIColor.">Render</a>:: <a class="el" href="classdoor_1_1Render.html" title="Rendering a string with ANSIColor.">Render</a> object</p>
<p><a class="el" href="classdoor_1_1Render.html" title="Rendering a string with ANSIColor.">Render</a> consists of constant text, and vector of <a class="el" href="classdoor_1_1ColorOutput.html" title="This holds an ANSIColor and text position + length.">ColorOutput</a></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">txt</td><td>Text </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9c32f938c06d5d6b87d238ba6072324e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c32f938c06d5d6b87d238ba6072324e">&#9670;&nbsp;</a></span>append()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void door::Render::append </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a>&#160;</td>
          <td class="paramname"><em>color</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>len</em> = <code>1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create render output.</p>
<p>Call this for each section you want to colorize.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">color</td><td></td></tr>
    <tr><td class="paramname">len</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ae83a23641dde4dff29b5214ea1921f3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae83a23641dde4dff29b5214ea1921f3b">&#9670;&nbsp;</a></span>output()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void door::Render::output </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Output the <a class="el" href="classdoor_1_1Render.html" title="Rendering a string with ANSIColor.">Render</a>.</p>
<p>This consists of going through the vector, getting the fragment (from pos and len), and outputting the color and fragment.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="door_8h_source.html">door.h</a></li>
<li><a class="el" href="door_8cpp.html">door.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>