Textbox documentation

ac0745 · Feb 4, 2020 · 843b6785f1572ae076e63000e3134695adf0d354 · 843b678
1 parent 2a4f067
commit 843b6785f1572ae076e63000e3134695adf0d354
Show file tree

Hide file tree

Showing 45 changed files with 242 additions and 72 deletions.
diff --git a/docs/html/annotated.html b/docs/html/annotated.html
@@ -72,9 +72,8 @@ $(function() {
 <tr id="row_4_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPosition.html" target="_self">Position</a></td><td class="desc"></td></tr>
 <tr id="row_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classTextBox.html" target="_self">TextBox</a></td><td class="desc"></td></tr>
 <tr id="row_6_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classTile.html" target="_self">Tile</a></td><td class="desc"></td></tr>
-<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classTileColor.html" target="_self">TileColor</a></td><td class="desc"></td></tr>
-<tr id="row_8_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classView.html" target="_self">View</a></td><td class="desc"></td></tr>
-<tr id="row_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classWorld.html" target="_self">World</a></td><td class="desc"></td></tr>
+<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classView.html" target="_self">View</a></td><td class="desc"></td></tr>
+<tr id="row_8_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classWorld.html" target="_self">World</a></td><td class="desc"></td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

diff --git a/docs/html/classTextBox-members.html b/docs/html/classTextBox-members.html
@@ -66,7 +66,7 @@ $(function() {
 <p>This is the complete list of members for <a class="el" href="classTextBox.html">TextBox</a>, including all inherited members.</p>
 <table class="directory">
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>background</b> (defined in <a class="el" href="classDrawable.html">Drawable</a>)</td><td class="entry"><a class="el" href="classDrawable.html">Drawable</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>clear</b>() (defined in <a class="el" href="classTextBox.html">TextBox</a>)</td><td class="entry"><a class="el" href="classTextBox.html">TextBox</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classTextBox.html#a4c1596312c23884283a8ed1ddc157498">clear</a>()</td><td class="entry"><a class="el" href="classTextBox.html">TextBox</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classPosition.html#a1e8d504b0da4c180636701bfe601062a">down</a>()</td><td class="entry"><a class="el" href="classPosition.html">Position</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classTextBox.html#a0c0cc6ad72ef6106986d99c2a9f09566">draw</a>() const</td><td class="entry"><a class="el" href="classTextBox.html">TextBox</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Drawable</b>(int _x=0, int _y=0, Terminal::Color _foreground=Terminal::Color::FG_DEFAULT, Terminal::Color _background=Terminal::Color::BG_DEFAULT) (defined in <a class="el" href="classDrawable.html">Drawable</a>)</td><td class="entry"><a class="el" href="classDrawable.html">Drawable</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
@@ -75,7 +75,7 @@ $(function() {
   <tr bgcolor="#f0f0f0"><td class="entry"><b>operator&lt;&lt;</b> (defined in <a class="el" href="classTextBox.html">TextBox</a>)</td><td class="entry"><a class="el" href="classTextBox.html">TextBox</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classPosition.html#a9d56fe16af27a28c3a08b57274aff4eb">Position</a>(int _x=0, int _y=0)</td><td class="entry"><a class="el" href="classPosition.html">Position</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr><td class="entry"><a class="el" href="classPosition.html#a93145b914ae40b74e5e45b6920fb366c">right</a>()</td><td class="entry"><a class="el" href="classPosition.html">Position</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>TextBox</b>(int _x, int _y, int _width) (defined in <a class="el" href="classTextBox.html">TextBox</a>)</td><td class="entry"><a class="el" href="classTextBox.html">TextBox</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classTextBox.html#acadf456d9a9f360ab21ecaaec350d7e8">TextBox</a>(int _x, int _y, int _width)</td><td class="entry"><a class="el" href="classTextBox.html">TextBox</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr><td class="entry"><a class="el" href="classPosition.html#a9cf4908f7d31576c281f9877dba43493">up</a>()</td><td class="entry"><a class="el" href="classPosition.html">Position</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classTextBox.html#ae7fefd07064ff652a0cf600b038d08a4">width</a></td><td class="entry"><a class="el" href="classTextBox.html">TextBox</a></td><td class="entry"></td></tr>
   <tr bgcolor="#f0f0f0"><td class="entry"><b>x</b> (defined in <a class="el" href="classPosition.html">Position</a>)</td><td class="entry"><a class="el" href="classPosition.html">Position</a></td><td class="entry"></td></tr>

diff --git a/docs/html/classTextBox.html b/docs/html/classTextBox.html
@@ -88,13 +88,11 @@ Collaboration diagram for TextBox:</div>
 <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:acadf456d9a9f360ab21ecaaec350d7e8"><td class="memItemLeft" align="right" valign="top"><a id="acadf456d9a9f360ab21ecaaec350d7e8"></a>
-&#160;</td><td class="memItemRight" valign="bottom"><b>TextBox</b> (int _x, int _y, int _width)</td></tr>
+<tr class="memitem:acadf456d9a9f360ab21ecaaec350d7e8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextBox.html#acadf456d9a9f360ab21ecaaec350d7e8">TextBox</a> (int _x, int _y, int _width)</td></tr>
 <tr class="separator:acadf456d9a9f360ab21ecaaec350d7e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0c0cc6ad72ef6106986d99c2a9f09566"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextBox.html#a0c0cc6ad72ef6106986d99c2a9f09566">draw</a> () const</td></tr>
 <tr class="separator:a0c0cc6ad72ef6106986d99c2a9f09566"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a4c1596312c23884283a8ed1ddc157498"><td class="memItemLeft" align="right" valign="top"><a id="a4c1596312c23884283a8ed1ddc157498"></a>
-void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
+<tr class="memitem:a4c1596312c23884283a8ed1ddc157498"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTextBox.html#a4c1596312c23884283a8ed1ddc157498">clear</a> ()</td></tr>
 <tr class="separator:a4c1596312c23884283a8ed1ddc157498"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header pub_methods_classDrawable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classDrawable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classDrawable.html">Drawable</a></td></tr>
 <tr class="memitem:a280fc6e4495c105f1dbe7cd33f3d937a inherit pub_methods_classDrawable"><td class="memItemLeft" align="right" valign="top"><a id="a280fc6e4495c105f1dbe7cd33f3d937a"></a>
@@ -140,7 +138,77 @@ template&lt;typename T &gt; </td></tr>
 <tr class="memitem:a54a9674dabd382b8861aa61cfd0d328d"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classTextBox.html">TextBox</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator&lt;&lt;</b> (<a class="el" href="classTextBox.html">TextBox</a> &amp;, T)</td></tr>
 <tr class="separator:a54a9674dabd382b8861aa61cfd0d328d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
+<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="acadf456d9a9f360ab21ecaaec350d7e8"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acadf456d9a9f360ab21ecaaec350d7e8">&#9670;&nbsp;</a></span>TextBox()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">TextBox::TextBox </td>
+          <td>(</td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>_x</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>_y</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>_width</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Create a textbox to position at given coordinates</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">_x</td><td>X coordinate </td></tr>
+    <tr><td class="paramname">_y</td><td>Y coordinate </td></tr>
+    <tr><td class="paramname">_width</td><td>Width of text box </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
 <h2 class="groupheader">Member Function Documentation</h2>
+<a id="a4c1596312c23884283a8ed1ddc157498"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4c1596312c23884283a8ed1ddc157498">&#9670;&nbsp;</a></span>clear()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void TextBox::clear </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Clear the contents </p>
+
+</div>
+</div>
 <a id="a0c0cc6ad72ef6106986d99c2a9f09566"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a0c0cc6ad72ef6106986d99c2a9f09566">&#9670;&nbsp;</a></span>draw()</h2>
 

diff --git a/docs/html/classes.html b/docs/html/classes.html
@@ -66,18 +66,17 @@ $(function() {
 <table class="classindex">
 <tr><td rowspan="2" valign="bottom"><a name="letter_d"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;d&#160;&#160;</div></td></tr></table>
 </td><td rowspan="2" valign="bottom"><a name="letter_k"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;k&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="classTerminal_1_1Position.html">Position</a> (Terminal)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classTileColor.html">TileColor</a>&#160;&#160;&#160;</td><td></td></tr>
+</td><td valign="top"><a class="el" href="classTerminal_1_1Position.html">Position</a> (Terminal)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_v"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;v&#160;&#160;</div></td></tr></table>
+</td><td></td></tr>
 <tr><td rowspan="2" valign="bottom"><a name="letter_t"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;t&#160;&#160;</div></td></tr></table>
-</td><td rowspan="2" valign="bottom"><a name="letter_v"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;v&#160;&#160;</div></td></tr></table>
 </td><td></td></tr>
-<tr><td valign="top"><a class="el" href="classDrawable.html">Drawable</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classKeyboard.html">Keyboard</a>&#160;&#160;&#160;</td><td></td></tr>
+<tr><td valign="top"><a class="el" href="classDrawable.html">Drawable</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classKeyboard.html">Keyboard</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classView.html">View</a>&#160;&#160;&#160;</td><td></td></tr>
 <tr><td rowspan="2" valign="bottom"><a name="letter_e"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;e&#160;&#160;</div></td></tr></table>
 </td><td rowspan="2" valign="bottom"><a name="letter_p"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;p&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="classTextBox.html">TextBox</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classView.html">View</a>&#160;&#160;&#160;</td><td></td></tr>
-<tr><td valign="top"><a class="el" href="classTile.html">Tile</a>&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_w"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;w&#160;&#160;</div></td></tr></table>
+</td><td valign="top"><a class="el" href="classTextBox.html">TextBox</a>&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_w"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;w&#160;&#160;</div></td></tr></table>
 </td><td></td></tr>
-<tr><td valign="top"><a class="el" href="classEntity.html">Entity</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classPosition.html">Position</a>&#160;&#160;&#160;</td><td></td><td></td></tr>
-<tr><td></td><td></td><td></td><td valign="top"><a class="el" href="classWorld.html">World</a>&#160;&#160;&#160;</td><td></td></tr>
+<tr><td valign="top"><a class="el" href="classTile.html">Tile</a>&#160;&#160;&#160;</td><td></td></tr>
+<tr><td valign="top"><a class="el" href="classEntity.html">Entity</a>&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classPosition.html">Position</a>&#160;&#160;&#160;</td><td></td><td valign="top"><a class="el" href="classWorld.html">World</a>&#160;&#160;&#160;</td><td></td></tr>
 <tr><td></td><td></td><td></td><td></td><td></td></tr>
 </table>
 <div class="qindex"><a class="qindex" href="#letter_d">d</a>&#160;|&#160;<a class="qindex" href="#letter_e">e</a>&#160;|&#160;<a class="qindex" href="#letter_k">k</a>&#160;|&#160;<a class="qindex" href="#letter_p">p</a>&#160;|&#160;<a class="qindex" href="#letter_t">t</a>&#160;|&#160;<a class="qindex" href="#letter_v">v</a>&#160;|&#160;<a class="qindex" href="#letter_w">w</a></div>

diff --git a/docs/html/files.html b/docs/html/files.html
@@ -72,9 +72,8 @@ $(function() {
 <tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="terminal_8h_source.html"><span class="icondoc"></span></a><b>terminal.h</b></td><td class="desc"></td></tr>
 <tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="textbox_8h_source.html"><span class="icondoc"></span></a><b>textbox.h</b></td><td class="desc"></td></tr>
 <tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="tile_8h_source.html"><span class="icondoc"></span></a><b>tile.h</b></td><td class="desc"></td></tr>
-<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="tilecolor_8h_source.html"><span class="icondoc"></span></a><b>tilecolor.h</b></td><td class="desc"></td></tr>
-<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="view_8h_source.html"><span class="icondoc"></span></a><b>view.h</b></td><td class="desc"></td></tr>
-<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="world_8h_source.html"><span class="icondoc"></span></a><b>world.h</b></td><td class="desc"></td></tr>
+<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="view_8h_source.html"><span class="icondoc"></span></a><b>view.h</b></td><td class="desc"></td></tr>
+<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="world_8h_source.html"><span class="icondoc"></span></a><b>world.h</b></td><td class="desc"></td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

diff --git a/docs/html/functions.html b/docs/html/functions.html
@@ -62,6 +62,9 @@ $(function() {
 <li>background
 : <a class="el" href="classTile.html#a027db3765997461d15b88e5938927910">Tile</a>
 </li>
+<li>clear()
+: <a class="el" href="classTextBox.html#a4c1596312c23884283a8ed1ddc157498">TextBox</a>
+</li>
 <li>defaultContents
 : <a class="el" href="classTile.html#a5229e4f00658f47e654852fd437d7a57">Tile</a>
 </li>
@@ -94,6 +97,9 @@ $(function() {
 <li>right()
 : <a class="el" href="classPosition.html#a93145b914ae40b74e5e45b6920fb366c">Position</a>
 </li>
+<li>TextBox()
+: <a class="el" href="classTextBox.html#acadf456d9a9f360ab21ecaaec350d7e8">TextBox</a>
+</li>
 <li>up()
 : <a class="el" href="classPosition.html#a9cf4908f7d31576c281f9877dba43493">Position</a>
 </li>

diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
@@ -59,6 +59,9 @@ $(function() {
 
 <div class="contents">
 &#160;<ul>
+<li>clear()
+: <a class="el" href="classTextBox.html#a4c1596312c23884283a8ed1ddc157498">TextBox</a>
+</li>
 <li>down()
 : <a class="el" href="classPosition.html#a1e8d504b0da4c180636701bfe601062a">Position</a>
 </li>
@@ -82,6 +85,9 @@ $(function() {
 <li>right()
 : <a class="el" href="classPosition.html#a93145b914ae40b74e5e45b6920fb366c">Position</a>
 </li>
+<li>TextBox()
+: <a class="el" href="classTextBox.html#acadf456d9a9f360ab21ecaaec350d7e8">TextBox</a>
+</li>
 <li>up()
 : <a class="el" href="classPosition.html#a9cf4908f7d31576c281f9877dba43493">Position</a>
 </li>

diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
@@ -74,8 +74,7 @@ This inheritance list is sorted roughly, but not completely, alphabetically:</di
 <tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classView.html" target="_self">View</a></td><td class="desc"></td></tr>
 <tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classTerminal_1_1Position.html" target="_self">Terminal::Position</a></td><td class="desc"></td></tr>
 <tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classTile.html" target="_self">Tile</a></td><td class="desc"></td></tr>
-<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classTileColor.html" target="_self">TileColor</a></td><td class="desc"></td></tr>
-<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classWorld.html" target="_self">World</a></td><td class="desc"></td></tr>
+<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classWorld.html" target="_self">World</a></td><td class="desc"></td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->