classdoor_1_1Goto.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
  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::Goto 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_1Goto.html">Goto</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_1Goto-members.html">List of all members</a> </div>
  71. <div class="headertitle">
  72. <div class="title">door::Goto Class Reference</div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <p>ANSI <a class="el" href="classdoor_1_1Goto.html" title="ANSI Goto X, Y position.">Goto</a> X, Y position.
  76. <a href="classdoor_1_1Goto.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. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80. Public Member Functions</h2></td></tr>
  81. <tr class="memitem:a099828631625d5b66bb8789510d849d7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Goto.html#a099828631625d5b66bb8789510d849d7">Goto</a> (int xpos, int ypos)</td></tr>
  82. <tr class="separator:a099828631625d5b66bb8789510d849d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a0181dcfef7179657b7401b12ee85ac5a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Goto.html#a0181dcfef7179657b7401b12ee85ac5a">Goto</a> (const <a class="el" href="classdoor_1_1Goto.html">Goto</a> &amp;)=default</td></tr>
  84. <tr class="separator:a0181dcfef7179657b7401b12ee85ac5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ab35b0dd6bfe0594cb99fb65fec4dbf24"><td class="memItemLeft" align="right" valign="top"><a id="ab35b0dd6bfe0594cb99fb65fec4dbf24"></a>
  86. void&#160;</td><td class="memItemRight" valign="bottom"><b>set</b> (int xpos, int ypos)</td></tr>
  87. <tr class="separator:ab35b0dd6bfe0594cb99fb65fec4dbf24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. </table><table class="memberdecls">
  89. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  90. Private Attributes</h2></td></tr>
  91. <tr class="memitem:ad7ec5ef329c85fd0be0110f628a9106a"><td class="memItemLeft" align="right" valign="top"><a id="ad7ec5ef329c85fd0be0110f628a9106a"></a>
  92. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Goto.html#ad7ec5ef329c85fd0be0110f628a9106a">x</a></td></tr>
  93. <tr class="memdesc:ad7ec5ef329c85fd0be0110f628a9106a"><td class="mdescLeft">&#160;</td><td class="mdescRight">X-Position. <br /></td></tr>
  94. <tr class="separator:ad7ec5ef329c85fd0be0110f628a9106a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a2ef887a839d1542dc2b7bbcbc4cd0477"><td class="memItemLeft" align="right" valign="top"><a id="a2ef887a839d1542dc2b7bbcbc4cd0477"></a>
  96. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Goto.html#a2ef887a839d1542dc2b7bbcbc4cd0477">y</a></td></tr>
  97. <tr class="memdesc:a2ef887a839d1542dc2b7bbcbc4cd0477"><td class="mdescLeft">&#160;</td><td class="mdescRight">Y-Position. <br /></td></tr>
  98. <tr class="separator:a2ef887a839d1542dc2b7bbcbc4cd0477"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  101. Friends</h2></td></tr>
  102. <tr class="memitem:a21a0915b21cc762dc148f7ba6797229b"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1Goto.html#a21a0915b21cc762dc148f7ba6797229b">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classdoor_1_1Goto.html">Goto</a> &amp;g)</td></tr>
  103. <tr class="separator:a21a0915b21cc762dc148f7ba6797229b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table>
  105. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  106. <div class="textblock"><p>ANSI <a class="el" href="classdoor_1_1Goto.html" title="ANSI Goto X, Y position.">Goto</a> X, Y position. </p>
  107. <p>This handles outputting ANSI codes to position the cursor on the screen. </p>
  108. <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="menu-example_8cpp-example.html#_a15">menu-example.cpp</a>.</dd>
  109. </dl>
  110. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  111. <a id="a099828631625d5b66bb8789510d849d7"></a>
  112. <h2 class="memtitle"><span class="permalink"><a href="#a099828631625d5b66bb8789510d849d7">&#9670;&nbsp;</a></span>Goto() <span class="overload">[1/2]</span></h2>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">door::Goto::Goto </td>
  118. <td>(</td>
  119. <td class="paramtype">int&#160;</td>
  120. <td class="paramname"><em>xpos</em>, </td>
  121. </tr>
  122. <tr>
  123. <td class="paramkey"></td>
  124. <td></td>
  125. <td class="paramtype">int&#160;</td>
  126. <td class="paramname"><em>ypos</em>&#160;</td>
  127. </tr>
  128. <tr>
  129. <td></td>
  130. <td>)</td>
  131. <td></td><td></td>
  132. </tr>
  133. </table>
  134. </div><div class="memdoc">
  135. <p>Construct a new <a class="el" href="classdoor_1_1Goto.html" title="ANSI Goto X, Y position.">Goto</a>:: <a class="el" href="classdoor_1_1Goto.html" title="ANSI Goto X, Y position.">Goto</a> object</p>
  136. <dl class="params"><dt>Parameters</dt><dd>
  137. <table class="params">
  138. <tr><td class="paramname">xpos</td><td></td></tr>
  139. <tr><td class="paramname">ypos</td><td></td></tr>
  140. </table>
  141. </dd>
  142. </dl>
  143. </div>
  144. </div>
  145. <a id="a0181dcfef7179657b7401b12ee85ac5a"></a>
  146. <h2 class="memtitle"><span class="permalink"><a href="#a0181dcfef7179657b7401b12ee85ac5a">&#9670;&nbsp;</a></span>Goto() <span class="overload">[2/2]</span></h2>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="mlabels">
  150. <tr>
  151. <td class="mlabels-left">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">door::Goto::Goto </td>
  155. <td>(</td>
  156. <td class="paramtype">const <a class="el" href="classdoor_1_1Goto.html">Goto</a> &amp;&#160;</td>
  157. <td class="paramname"></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </td>
  162. <td class="mlabels-right">
  163. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Default <a class="el" href="classdoor_1_1Goto.html" title="ANSI Goto X, Y position.">Goto</a> constructor copier </p>
  168. </div>
  169. </div>
  170. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  171. <a id="a21a0915b21cc762dc148f7ba6797229b"></a>
  172. <h2 class="memtitle"><span class="permalink"><a href="#a21a0915b21cc762dc148f7ba6797229b">&#9670;&nbsp;</a></span>operator&lt;&lt;</h2>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="mlabels">
  176. <tr>
  177. <td class="mlabels-left">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">std::ostream&amp; operator&lt;&lt; </td>
  181. <td>(</td>
  182. <td class="paramtype">std::ostream &amp;&#160;</td>
  183. <td class="paramname"><em>os</em>, </td>
  184. </tr>
  185. <tr>
  186. <td class="paramkey"></td>
  187. <td></td>
  188. <td class="paramtype">const <a class="el" href="classdoor_1_1Goto.html">Goto</a> &amp;&#160;</td>
  189. <td class="paramname"><em>g</em>&#160;</td>
  190. </tr>
  191. <tr>
  192. <td></td>
  193. <td>)</td>
  194. <td></td><td></td>
  195. </tr>
  196. </table>
  197. </td>
  198. <td class="mlabels-right">
  199. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>Output the ANSI codes to position the cursor to the given y,x position.</p>
  204. <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd><p class="startdd">Optimize the ANSI goto string output. </p>
  205. <p class="enddd">Update the <a class="el" href="classdoor_1_1Door.html">Door</a> object so it know where the cursor is positioned.</p>
  206. </dd></dl>
  207. <dl class="params"><dt>Parameters</dt><dd>
  208. <table class="params">
  209. <tr><td class="paramname">os</td><td>std::ostream </td></tr>
  210. <tr><td class="paramname">g</td><td>const <a class="el" href="classdoor_1_1Goto.html" title="ANSI Goto X, Y position.">Goto</a> </td></tr>
  211. </table>
  212. </dd>
  213. </dl>
  214. <dl class="section return"><dt>Returns</dt><dd>std::ostream&amp; </dd></dl>
  215. </div>
  216. </div>
  217. <hr/>The documentation for this class was generated from the following files:<ul>
  218. <li><a class="el" href="door_8h_source.html">door.h</a></li>
  219. <li><a class="el" href="door_8cpp.html">door.cpp</a></li>
  220. </ul>
  221. </div><!-- contents -->
  222. <!-- start footer part -->
  223. <hr class="footer"/><address class="footer"><small>
  224. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  225. <img class="footer" src="doxygen.png" alt="doxygen"/>
  226. </a> 1.8.17
  227. </small></address>
  228. </body>
  229. </html>