classdoor_1_1Line.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Bugz Door Project: door::Line Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">Bugz Door Project
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.17 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. <div id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="namespacedoor.html">door</a></li><li class="navelem"><a class="el" href="classdoor_1_1Line.html">Line</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="summary">
  67. <a href="#pub-methods">Public Member Functions</a> &#124;
  68. <a href="#pri-attribs">Private Attributes</a> &#124;
  69. <a href="#friends">Friends</a> &#124;
  70. <a href="classdoor_1_1Line-members.html">List of all members</a> </div>
  71. <div class="headertitle">
  72. <div class="title">door::Line Class Reference</div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <p>Text and <a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a>.
  76. <a href="classdoor_1_1Line.html#details">More...</a></p>
  77. <p><code>#include &lt;<a class="el" href="door_8h_source.html">door.h</a>&gt;</code></p>
  78. <div class="dynheader">
  79. Collaboration diagram for door::Line:</div>
  80. <div class="dyncontent">
  81. <div class="center"><img src="classdoor_1_1Line__coll__graph.png" border="0" usemap="#door_1_1Line_coll__map" alt="Collaboration graph"/></div>
  82. <map name="door_1_1Line_coll__map" id="door_1_1Line_coll__map">
  83. <area shape="rect" title="Text and ANSIColor." alt="" coords="24,109,111,136"/>
  84. <area shape="rect" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes." alt="" coords="5,5,129,32"/>
  85. </map>
  86. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  87. <table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  89. Public Member Functions</h2></td></tr>
  90. <tr class="memitem:ad7f8494e6382aaacfa46d6da77309481"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#ad7f8494e6382aaacfa46d6da77309481">Line</a> (const std::string &amp;txt, int width=0)</td></tr>
  91. <tr class="separator:ad7f8494e6382aaacfa46d6da77309481"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ab4a8aca94290fdfe126d5dd290a6faf2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#ab4a8aca94290fdfe126d5dd290a6faf2">Line</a> (const char *txt, int width=0)</td></tr>
  93. <tr class="separator:ab4a8aca94290fdfe126d5dd290a6faf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a6c00fab76ac7007fc9ec8252e546454b"><td class="memItemLeft" align="right" valign="top"><a id="a6c00fab76ac7007fc9ec8252e546454b"></a>
  95. &#160;</td><td class="memItemRight" valign="bottom"><b>Line</b> (const std::string &amp;txt, int width, <a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a> c)</td></tr>
  96. <tr class="separator:a6c00fab76ac7007fc9ec8252e546454b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a9c3bfa3e34ac140bbbd8c273ef9f7eb1"><td class="memItemLeft" align="right" valign="top"><a id="a9c3bfa3e34ac140bbbd8c273ef9f7eb1"></a>
  98. &#160;</td><td class="memItemRight" valign="bottom"><b>Line</b> (const char *txt, int width, <a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a> c)</td></tr>
  99. <tr class="separator:a9c3bfa3e34ac140bbbd8c273ef9f7eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a40fb73abc6d1a4cca1d2836459f6cd5a"><td class="memItemLeft" align="right" valign="top"><a id="a40fb73abc6d1a4cca1d2836459f6cd5a"></a>
  101. &#160;</td><td class="memItemRight" valign="bottom"><b>Line</b> (const std::string &amp;txt, int width, <a class="el" href="namespacedoor.html#ad9c2405adaa0b5168bc53059b3a978c1">renderFunction</a> rf)</td></tr>
  102. <tr class="separator:a40fb73abc6d1a4cca1d2836459f6cd5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a8f9b6c3707f1a9566ab556d422bedade"><td class="memItemLeft" align="right" valign="top"><a id="a8f9b6c3707f1a9566ab556d422bedade"></a>
  104. &#160;</td><td class="memItemRight" valign="bottom"><b>Line</b> (const char *txt, int width, <a class="el" href="namespacedoor.html#ad9c2405adaa0b5168bc53059b3a978c1">renderFunction</a> rf)</td></tr>
  105. <tr class="separator:a8f9b6c3707f1a9566ab556d422bedade"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:acce7f7ed662df9d0b56b8817eb1e2baa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#acce7f7ed662df9d0b56b8817eb1e2baa">Line</a> (const <a class="el" href="classdoor_1_1Line.html">Line</a> &amp;rhs)</td></tr>
  107. <tr class="separator:acce7f7ed662df9d0b56b8817eb1e2baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:aed6e813113e3b5e9b2614e1a47859925"><td class="memItemLeft" align="right" valign="top"><a id="aed6e813113e3b5e9b2614e1a47859925"></a>
  109. &#160;</td><td class="memItemRight" valign="bottom"><b>Line</b> (<a class="el" href="classdoor_1_1Line.html">Line</a> &amp;&amp;rhs)</td></tr>
  110. <tr class="separator:aed6e813113e3b5e9b2614e1a47859925"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a548cd373dbd7ad89eab9acce79d324a2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a548cd373dbd7ad89eab9acce79d324a2">hasRender</a> (void)</td></tr>
  112. <tr class="separator:a548cd373dbd7ad89eab9acce79d324a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ae2f71d1340a75f4b9955e100a9022994"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#ae2f71d1340a75f4b9955e100a9022994">length</a> (void)</td></tr>
  114. <tr class="separator:ae2f71d1340a75f4b9955e100a9022994"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a557866135040c3b225353dc8629f8ea3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a557866135040c3b225353dc8629f8ea3">fit</a> (void)</td></tr>
  116. <tr class="separator:a557866135040c3b225353dc8629f8ea3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a9487858a23dc53c987e6504e501957e6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a9487858a23dc53c987e6504e501957e6">setPadding</a> (std::string &amp;padstring, <a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a> padColor)</td></tr>
  118. <tr class="separator:a9487858a23dc53c987e6504e501957e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a1a21ca77a2d7f261cf6946c85bd596cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a1a21ca77a2d7f261cf6946c85bd596cb">setPadding</a> (const char *padstring, <a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a> padcolor)</td></tr>
  120. <tr class="separator:a1a21ca77a2d7f261cf6946c85bd596cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a3e7ab2ba2c01dcb323dcfefbdad71784"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a3e7ab2ba2c01dcb323dcfefbdad71784">setText</a> (std::string &amp;txt)</td></tr>
  122. <tr class="separator:a3e7ab2ba2c01dcb323dcfefbdad71784"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a0d9e536c943d5ba0861195b2d3b491c1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a0d9e536c943d5ba0861195b2d3b491c1">setText</a> (const char *txt)</td></tr>
  124. <tr class="separator:a0d9e536c943d5ba0861195b2d3b491c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ae386f7bf1ad32bd8bf37209f80fb2262"><td class="memItemLeft" align="right" valign="top"><a id="ae386f7bf1ad32bd8bf37209f80fb2262"></a>
  126. const char *&#160;</td><td class="memItemRight" valign="bottom"><b>getText</b> (void)</td></tr>
  127. <tr class="separator:ae386f7bf1ad32bd8bf37209f80fb2262"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a8beaf1f9a1b84524d131a817ad8019ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a8beaf1f9a1b84524d131a817ad8019ae">setColor</a> (<a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a> c)</td></tr>
  129. <tr class="separator:a8beaf1f9a1b84524d131a817ad8019ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a03790e36725784901cd4e802917754ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a03790e36725784901cd4e802917754ce">setRender</a> (<a class="el" href="namespacedoor.html#ad9c2405adaa0b5168bc53059b3a978c1">renderFunction</a> rf)</td></tr>
  131. <tr class="separator:a03790e36725784901cd4e802917754ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a68f6b1bfdaab2ed72f2a13810b166049"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a68f6b1bfdaab2ed72f2a13810b166049">setUpdater</a> (<a class="el" href="namespacedoor.html#adb2697f83f8ce701366e05ed72c97d6e">updateFunction</a> uf)</td></tr>
  133. <tr class="separator:a68f6b1bfdaab2ed72f2a13810b166049"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a00ec1edb246d442c4dc7ac2dc5876624"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a00ec1edb246d442c4dc7ac2dc5876624">update</a> (void)</td></tr>
  135. <tr class="separator:a00ec1edb246d442c4dc7ac2dc5876624"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a0b94efd0f6ec6e9290fd5a73c7bbbca1"><td class="memItemLeft" align="right" valign="top"><a id="a0b94efd0f6ec6e9290fd5a73c7bbbca1"></a>
  137. std::string&#160;</td><td class="memItemRight" valign="bottom"><b>debug</b> (void)</td></tr>
  138. <tr class="separator:a0b94efd0f6ec6e9290fd5a73c7bbbca1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table><table class="memberdecls">
  140. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  141. Private Attributes</h2></td></tr>
  142. <tr class="memitem:a2008c67026c41f33bc2c8cb5f9787f3b"><td class="memItemLeft" align="right" valign="top"><a id="a2008c67026c41f33bc2c8cb5f9787f3b"></a>
  143. std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a2008c67026c41f33bc2c8cb5f9787f3b">text</a></td></tr>
  144. <tr class="memdesc:a2008c67026c41f33bc2c8cb5f9787f3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Text of the line. <br /></td></tr>
  145. <tr class="separator:a2008c67026c41f33bc2c8cb5f9787f3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ab9603154e50c33245f30dbc5c60bd5c8"><td class="memItemLeft" align="right" valign="top"><a id="ab9603154e50c33245f30dbc5c60bd5c8"></a>
  147. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#ab9603154e50c33245f30dbc5c60bd5c8">hasColor</a></td></tr>
  148. <tr class="memdesc:ab9603154e50c33245f30dbc5c60bd5c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Do we have color? <br /></td></tr>
  149. <tr class="separator:ab9603154e50c33245f30dbc5c60bd5c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a3896c3006cac3435613732c29afc60ed"><td class="memItemLeft" align="right" valign="top"><a id="a3896c3006cac3435613732c29afc60ed"></a>
  151. <a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a3896c3006cac3435613732c29afc60ed">color</a></td></tr>
  152. <tr class="memdesc:a3896c3006cac3435613732c29afc60ed"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a> color. <br /></td></tr>
  153. <tr class="separator:a3896c3006cac3435613732c29afc60ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a3fab9317af5f86949eb0d6faf1f04653"><td class="memItemLeft" align="right" valign="top"><a id="a3fab9317af5f86949eb0d6faf1f04653"></a>
  155. std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a3fab9317af5f86949eb0d6faf1f04653">padding</a></td></tr>
  156. <tr class="memdesc:a3fab9317af5f86949eb0d6faf1f04653"><td class="mdescLeft">&#160;</td><td class="mdescRight">Padding characters. <br /></td></tr>
  157. <tr class="separator:a3fab9317af5f86949eb0d6faf1f04653"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a5b5d31a50cce6b5aa9b9e15647bfeddc"><td class="memItemLeft" align="right" valign="top"><a id="a5b5d31a50cce6b5aa9b9e15647bfeddc"></a>
  159. <a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a5b5d31a50cce6b5aa9b9e15647bfeddc">paddingColor</a></td></tr>
  160. <tr class="memdesc:a5b5d31a50cce6b5aa9b9e15647bfeddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Padding color. <br /></td></tr>
  161. <tr class="separator:a5b5d31a50cce6b5aa9b9e15647bfeddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a6d12dbae8f1d7f70a32aa1b463bd9f6f"><td class="memItemLeft" align="right" valign="top"><a id="a6d12dbae8f1d7f70a32aa1b463bd9f6f"></a>
  163. <a class="el" href="namespacedoor.html#ad9c2405adaa0b5168bc53059b3a978c1">renderFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a6d12dbae8f1d7f70a32aa1b463bd9f6f">render</a></td></tr>
  164. <tr class="memdesc:a6d12dbae8f1d7f70a32aa1b463bd9f6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">renderFunction to use when rendering <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a>. <br /></td></tr>
  165. <tr class="separator:a6d12dbae8f1d7f70a32aa1b463bd9f6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:afe9688b3f58080fe437c0efaf7ab2949"><td class="memItemLeft" align="right" valign="top"><a id="afe9688b3f58080fe437c0efaf7ab2949"></a>
  167. <a class="el" href="namespacedoor.html#adb2697f83f8ce701366e05ed72c97d6e">updateFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#afe9688b3f58080fe437c0efaf7ab2949">updater</a></td></tr>
  168. <tr class="memdesc:afe9688b3f58080fe437c0efaf7ab2949"><td class="mdescLeft">&#160;</td><td class="mdescRight">updateFunction to use when updating. <br /></td></tr>
  169. <tr class="separator:afe9688b3f58080fe437c0efaf7ab2949"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a7a1dc1134b3afb646ad0bd241773c764"><td class="memItemLeft" align="right" valign="top"><a id="a7a1dc1134b3afb646ad0bd241773c764"></a>
  171. int&#160;</td><td class="memItemRight" valign="bottom"><b>width</b></td></tr>
  172. <tr class="separator:a7a1dc1134b3afb646ad0bd241773c764"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. </table><table class="memberdecls">
  174. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  175. Friends</h2></td></tr>
  176. <tr class="memitem:a702464834d9546f67f1952a62e4038f2"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Line.html#a702464834d9546f67f1952a62e4038f2">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classdoor_1_1Line.html">Line</a> &amp;l)</td></tr>
  177. <tr class="separator:a702464834d9546f67f1952a62e4038f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. </table>
  179. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  180. <div class="textblock"><p>Text and <a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a>. </p>
  181. <p>This holds text and <a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a> information, and knows how to send them out to the <a class="el" href="classdoor_1_1Door.html">Door</a>. </p>
  182. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  183. <a id="ad7f8494e6382aaacfa46d6da77309481"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#ad7f8494e6382aaacfa46d6da77309481">&#9670;&nbsp;</a></span>Line() <span class="overload">[1/3]</span></h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">door::Line::Line </td>
  190. <td>(</td>
  191. <td class="paramtype">const std::string &amp;&#160;</td>
  192. <td class="paramname"><em>txt</em>, </td>
  193. </tr>
  194. <tr>
  195. <td class="paramkey"></td>
  196. <td></td>
  197. <td class="paramtype">int&#160;</td>
  198. <td class="paramname"><em>w</em> = <code>0</code>&#160;</td>
  199. </tr>
  200. <tr>
  201. <td></td>
  202. <td>)</td>
  203. <td></td><td></td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <dl class="params"><dt>Parameters</dt><dd>
  208. <table class="params">
  209. <tr><td class="paramname">width</td><td>int</td></tr>
  210. </table>
  211. </dd>
  212. </dl>
  213. <p>Construct a new <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a>:: <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a> object with string and total width.</p>
  214. <dl class="params"><dt>Parameters</dt><dd>
  215. <table class="params">
  216. <tr><td class="paramname">txt</td><td>std::string </td></tr>
  217. <tr><td class="paramname">width</td><td>int </td></tr>
  218. </table>
  219. </dd>
  220. </dl>
  221. </div>
  222. </div>
  223. <a id="ab4a8aca94290fdfe126d5dd290a6faf2"></a>
  224. <h2 class="memtitle"><span class="permalink"><a href="#ab4a8aca94290fdfe126d5dd290a6faf2">&#9670;&nbsp;</a></span>Line() <span class="overload">[2/3]</span></h2>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">door::Line::Line </td>
  230. <td>(</td>
  231. <td class="paramtype">const char *&#160;</td>
  232. <td class="paramname"><em>txt</em>, </td>
  233. </tr>
  234. <tr>
  235. <td class="paramkey"></td>
  236. <td></td>
  237. <td class="paramtype">int&#160;</td>
  238. <td class="paramname"><em>w</em> = <code>0</code>&#160;</td>
  239. </tr>
  240. <tr>
  241. <td></td>
  242. <td>)</td>
  243. <td></td><td></td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Construct a new <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a>:: <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a> object with const char * and total width</p>
  248. <dl class="params"><dt>Parameters</dt><dd>
  249. <table class="params">
  250. <tr><td class="paramname">txt</td><td>const char * </td></tr>
  251. <tr><td class="paramname">width</td><td>int </td></tr>
  252. </table>
  253. </dd>
  254. </dl>
  255. </div>
  256. </div>
  257. <a id="acce7f7ed662df9d0b56b8817eb1e2baa"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#acce7f7ed662df9d0b56b8817eb1e2baa">&#9670;&nbsp;</a></span>Line() <span class="overload">[3/3]</span></h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">door::Line::Line </td>
  264. <td>(</td>
  265. <td class="paramtype">const <a class="el" href="classdoor_1_1Line.html">Line</a> &amp;&#160;</td>
  266. <td class="paramname"><em>rhs</em></td><td>)</td>
  267. <td></td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Construct a new <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a>:: <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a> object from an existing <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a></p>
  272. <dl class="params"><dt>Parameters</dt><dd>
  273. <table class="params">
  274. <tr><td class="paramname">rhs</td><td>const <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a>&amp; </td></tr>
  275. </table>
  276. </dd>
  277. </dl>
  278. </div>
  279. </div>
  280. <h2 class="groupheader">Member Function Documentation</h2>
  281. <a id="a557866135040c3b225353dc8629f8ea3"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#a557866135040c3b225353dc8629f8ea3">&#9670;&nbsp;</a></span>fit()</h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">void door::Line::fit </td>
  288. <td>(</td>
  289. <td class="paramtype">void&#160;</td>
  290. <td class="paramname"></td><td>)</td>
  291. <td></td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Make text the given width by padding string with spaces.</p>
  296. <dl class="params"><dt>Parameters</dt><dd>
  297. <table class="params">
  298. <tr><td class="paramname">width</td><td>int </td></tr>
  299. </table>
  300. </dd>
  301. </dl>
  302. </div>
  303. </div>
  304. <a id="a548cd373dbd7ad89eab9acce79d324a2"></a>
  305. <h2 class="memtitle"><span class="permalink"><a href="#a548cd373dbd7ad89eab9acce79d324a2">&#9670;&nbsp;</a></span>hasRender()</h2>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">bool door::Line::hasRender </td>
  311. <td>(</td>
  312. <td class="paramtype">void&#160;</td>
  313. <td class="paramname"></td><td>)</td>
  314. <td></td>
  315. </tr>
  316. </table>
  317. </div><div class="memdoc">
  318. <p>Has a render function been set?</p>
  319. <dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
  320. </div>
  321. </div>
  322. <a id="ae2f71d1340a75f4b9955e100a9022994"></a>
  323. <h2 class="memtitle"><span class="permalink"><a href="#ae2f71d1340a75f4b9955e100a9022994">&#9670;&nbsp;</a></span>length()</h2>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname">int door::Line::length </td>
  329. <td>(</td>
  330. <td class="paramtype">void&#160;</td>
  331. <td class="paramname"></td><td>)</td>
  332. <td></td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>Return total length of <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a></p>
  337. <p>text.length + 2 * padding length</p>
  338. <dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
  339. </div>
  340. </div>
  341. <a id="a8beaf1f9a1b84524d131a817ad8019ae"></a>
  342. <h2 class="memtitle"><span class="permalink"><a href="#a8beaf1f9a1b84524d131a817ad8019ae">&#9670;&nbsp;</a></span>setColor()</h2>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname">void door::Line::setColor </td>
  348. <td>(</td>
  349. <td class="paramtype"><a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a>&#160;</td>
  350. <td class="paramname"><em>c</em></td><td>)</td>
  351. <td></td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <p>set color</p>
  356. <dl class="params"><dt>Parameters</dt><dd>
  357. <table class="params">
  358. <tr><td class="paramname">c</td><td><a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a> </td></tr>
  359. </table>
  360. </dd>
  361. </dl>
  362. </div>
  363. </div>
  364. <a id="a1a21ca77a2d7f261cf6946c85bd596cb"></a>
  365. <h2 class="memtitle"><span class="permalink"><a href="#a1a21ca77a2d7f261cf6946c85bd596cb">&#9670;&nbsp;</a></span>setPadding() <span class="overload">[1/2]</span></h2>
  366. <div class="memitem">
  367. <div class="memproto">
  368. <table class="memname">
  369. <tr>
  370. <td class="memname">void door::Line::setPadding </td>
  371. <td>(</td>
  372. <td class="paramtype">const char *&#160;</td>
  373. <td class="paramname"><em>padstring</em>, </td>
  374. </tr>
  375. <tr>
  376. <td class="paramkey"></td>
  377. <td></td>
  378. <td class="paramtype"><a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a>&#160;</td>
  379. <td class="paramname"><em>padColor</em>&#160;</td>
  380. </tr>
  381. <tr>
  382. <td></td>
  383. <td>)</td>
  384. <td></td><td></td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <dl class="params"><dt>Parameters</dt><dd>
  389. <table class="params">
  390. <tr><td class="paramname">padstring</td><td>const char * </td></tr>
  391. <tr><td class="paramname">padColor</td><td><a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a></td></tr>
  392. </table>
  393. </dd>
  394. </dl>
  395. <p>set padding (color and text)</p>
  396. <dl class="params"><dt>Parameters</dt><dd>
  397. <table class="params">
  398. <tr><td class="paramname">padstring</td><td>const char * </td></tr>
  399. <tr><td class="paramname">padColor</td><td><a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a> </td></tr>
  400. </table>
  401. </dd>
  402. </dl>
  403. </div>
  404. </div>
  405. <a id="a9487858a23dc53c987e6504e501957e6"></a>
  406. <h2 class="memtitle"><span class="permalink"><a href="#a9487858a23dc53c987e6504e501957e6">&#9670;&nbsp;</a></span>setPadding() <span class="overload">[2/2]</span></h2>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname">void door::Line::setPadding </td>
  412. <td>(</td>
  413. <td class="paramtype">std::string &amp;&#160;</td>
  414. <td class="paramname"><em>padstring</em>, </td>
  415. </tr>
  416. <tr>
  417. <td class="paramkey"></td>
  418. <td></td>
  419. <td class="paramtype"><a class="el" href="classdoor_1_1ANSIColor.html">ANSIColor</a>&#160;</td>
  420. <td class="paramname"><em>padColor</em>&#160;</td>
  421. </tr>
  422. <tr>
  423. <td></td>
  424. <td>)</td>
  425. <td></td><td></td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <dl class="params"><dt>Parameters</dt><dd>
  430. <table class="params">
  431. <tr><td class="paramname">padstring</td><td>std::string &amp; </td></tr>
  432. <tr><td class="paramname">padColor</td><td><a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a></td></tr>
  433. </table>
  434. </dd>
  435. </dl>
  436. <p>set padding (color and text)</p>
  437. <dl class="params"><dt>Parameters</dt><dd>
  438. <table class="params">
  439. <tr><td class="paramname">padstring</td><td>std::string </td></tr>
  440. <tr><td class="paramname">padColor</td><td><a class="el" href="classdoor_1_1ANSIColor.html" title="Foreground, Background and Attributes.">ANSIColor</a> </td></tr>
  441. </table>
  442. </dd>
  443. </dl>
  444. </div>
  445. </div>
  446. <a id="a03790e36725784901cd4e802917754ce"></a>
  447. <h2 class="memtitle"><span class="permalink"><a href="#a03790e36725784901cd4e802917754ce">&#9670;&nbsp;</a></span>setRender()</h2>
  448. <div class="memitem">
  449. <div class="memproto">
  450. <table class="memname">
  451. <tr>
  452. <td class="memname">void door::Line::setRender </td>
  453. <td>(</td>
  454. <td class="paramtype"><a class="el" href="namespacedoor.html#ad9c2405adaa0b5168bc53059b3a978c1">renderFunction</a>&#160;</td>
  455. <td class="paramname"><em>rf</em></td><td>)</td>
  456. <td></td>
  457. </tr>
  458. </table>
  459. </div><div class="memdoc">
  460. <p>set render</p>
  461. <p>Set the renderFunction to use for this <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a>. This replaces the colorizer. </p><dl class="params"><dt>Parameters</dt><dd>
  462. <table class="params">
  463. <tr><td class="paramname">rf</td><td>renderFunction </td></tr>
  464. </table>
  465. </dd>
  466. </dl>
  467. </div>
  468. </div>
  469. <a id="a0d9e536c943d5ba0861195b2d3b491c1"></a>
  470. <h2 class="memtitle"><span class="permalink"><a href="#a0d9e536c943d5ba0861195b2d3b491c1">&#9670;&nbsp;</a></span>setText() <span class="overload">[1/2]</span></h2>
  471. <div class="memitem">
  472. <div class="memproto">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname">void door::Line::setText </td>
  476. <td>(</td>
  477. <td class="paramtype">const char *&#160;</td>
  478. <td class="paramname"><em>txt</em></td><td>)</td>
  479. <td></td>
  480. </tr>
  481. </table>
  482. </div><div class="memdoc">
  483. <p>Set <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a> text. </p><dl class="params"><dt>Parameters</dt><dd>
  484. <table class="params">
  485. <tr><td class="paramname">txt</td><td>const char * </td></tr>
  486. </table>
  487. </dd>
  488. </dl>
  489. </div>
  490. </div>
  491. <a id="a3e7ab2ba2c01dcb323dcfefbdad71784"></a>
  492. <h2 class="memtitle"><span class="permalink"><a href="#a3e7ab2ba2c01dcb323dcfefbdad71784">&#9670;&nbsp;</a></span>setText() <span class="overload">[2/2]</span></h2>
  493. <div class="memitem">
  494. <div class="memproto">
  495. <table class="memname">
  496. <tr>
  497. <td class="memname">void door::Line::setText </td>
  498. <td>(</td>
  499. <td class="paramtype">std::string &amp;&#160;</td>
  500. <td class="paramname"><em>txt</em></td><td>)</td>
  501. <td></td>
  502. </tr>
  503. </table>
  504. </div><div class="memdoc">
  505. <p>Set <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a> text. </p><dl class="params"><dt>Parameters</dt><dd>
  506. <table class="params">
  507. <tr><td class="paramname">txt</td><td>std::string </td></tr>
  508. </table>
  509. </dd>
  510. </dl>
  511. </div>
  512. </div>
  513. <a id="a68f6b1bfdaab2ed72f2a13810b166049"></a>
  514. <h2 class="memtitle"><span class="permalink"><a href="#a68f6b1bfdaab2ed72f2a13810b166049">&#9670;&nbsp;</a></span>setUpdater()</h2>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">void door::Line::setUpdater </td>
  520. <td>(</td>
  521. <td class="paramtype"><a class="el" href="namespacedoor.html#adb2697f83f8ce701366e05ed72c97d6e">updateFunction</a>&#160;</td>
  522. <td class="paramname"><em>newUpdater</em></td><td>)</td>
  523. <td></td>
  524. </tr>
  525. </table>
  526. </div><div class="memdoc">
  527. <p>set updater function</p>
  528. <p>This can update the line text when called. </p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd>Define an updateFunction. </dd></dl>
  529. <dl class="params"><dt>Parameters</dt><dd>
  530. <table class="params">
  531. <tr><td class="paramname">newUpdater</td><td>updateFunction </td></tr>
  532. </table>
  533. </dd>
  534. </dl>
  535. </div>
  536. </div>
  537. <a id="a00ec1edb246d442c4dc7ac2dc5876624"></a>
  538. <h2 class="memtitle"><span class="permalink"><a href="#a00ec1edb246d442c4dc7ac2dc5876624">&#9670;&nbsp;</a></span>update()</h2>
  539. <div class="memitem">
  540. <div class="memproto">
  541. <table class="memname">
  542. <tr>
  543. <td class="memname">bool door::Line::update </td>
  544. <td>(</td>
  545. <td class="paramtype">void&#160;</td>
  546. <td class="paramname"></td><td>)</td>
  547. <td></td>
  548. </tr>
  549. </table>
  550. </div><div class="memdoc">
  551. <p>Call updater, report if the text was actually changed.</p>
  552. <dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
  553. </div>
  554. </div>
  555. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  556. <a id="a702464834d9546f67f1952a62e4038f2"></a>
  557. <h2 class="memtitle"><span class="permalink"><a href="#a702464834d9546f67f1952a62e4038f2">&#9670;&nbsp;</a></span>operator&lt;&lt;</h2>
  558. <div class="memitem">
  559. <div class="memproto">
  560. <table class="mlabels">
  561. <tr>
  562. <td class="mlabels-left">
  563. <table class="memname">
  564. <tr>
  565. <td class="memname">std::ostream&amp; operator&lt;&lt; </td>
  566. <td>(</td>
  567. <td class="paramtype">std::ostream &amp;&#160;</td>
  568. <td class="paramname"><em>os</em>, </td>
  569. </tr>
  570. <tr>
  571. <td class="paramkey"></td>
  572. <td></td>
  573. <td class="paramtype">const <a class="el" href="classdoor_1_1Line.html">Line</a> &amp;&#160;</td>
  574. <td class="paramname"><em>l</em>&#160;</td>
  575. </tr>
  576. <tr>
  577. <td></td>
  578. <td>)</td>
  579. <td></td><td></td>
  580. </tr>
  581. </table>
  582. </td>
  583. <td class="mlabels-right">
  584. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  585. </tr>
  586. </table>
  587. </div><div class="memdoc">
  588. <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>This might be a problem, because const <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a> wouldn't allow me to track "updates". I.E. I send the line, I'd need to change the line's State to "nothing changed". Then, if something did change, the next update request would be able to know that yes, this does indeed need to be sent.</dd></dl>
  589. <dl class="bug"><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>This also might cause problems if I display a shared BasicLine (in multiple places), and then update it. It would only update in the first place (the others wouldn't show it needs an update). </dd></dl>
  590. <p>Output <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a></p>
  591. <p>This looks for padding and paddingColor. This uses the render function if set.</p>
  592. <dl class="params"><dt>Parameters</dt><dd>
  593. <table class="params">
  594. <tr><td class="paramname">os</td><td>std::ostream </td></tr>
  595. <tr><td class="paramname">l</td><td>const <a class="el" href="classdoor_1_1Line.html" title="Text and ANSIColor.">Line</a> &amp; </td></tr>
  596. </table>
  597. </dd>
  598. </dl>
  599. <dl class="section return"><dt>Returns</dt><dd>std::ostream&amp; </dd></dl>
  600. </div>
  601. </div>
  602. <hr/>The documentation for this class was generated from the following files:<ul>
  603. <li><a class="el" href="door_8h_source.html">door.h</a></li>
  604. <li><a class="el" href="lines_8cpp.html">lines.cpp</a></li>
  605. </ul>
  606. </div><!-- contents -->
  607. <!-- start footer part -->
  608. <hr class="footer"/><address class="footer"><small>
  609. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  610. <img class="footer" src="doxygen.png" alt="doxygen"/>
  611. </a> 1.8.17
  612. </small></address>
  613. </body>
  614. </html>