classGuiCanvas.html 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689
  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" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: GuiCanvas 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="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#pub-methods">Public Member Functions</a> &#124;
  45. <a href="classGuiCanvas-members.html">List of all members</a> </div>
  46. <div class="headertitle"><div class="title">GuiCanvas Class Reference</div></div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p><code>#include &lt;guiCanvas_ScriptBinding.h&gt;</code></p>
  50. <p>Inherits <a class="el" href="classGuiControl.html">GuiControl</a>.</p>
  51. <table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  53. Public Member Functions</h2></td></tr>
  54. <tr class="memitem:a64b07a262cc429c9d45cf39f239c6c35" id="r_a64b07a262cc429c9d45cf39f239c6c35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a64b07a262cc429c9d45cf39f239c6c35">cursorOff</a> ()</td></tr>
  55. <tr class="separator:a64b07a262cc429c9d45cf39f239c6c35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:aa757b5f3c22eff72288ba049eab34ed1" id="r_aa757b5f3c22eff72288ba049eab34ed1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#aa757b5f3c22eff72288ba049eab34ed1">cursorOn</a> ()</td></tr>
  57. <tr class="separator:aa757b5f3c22eff72288ba049eab34ed1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:a94f091f2112f16749e972330299f2554" id="r_a94f091f2112f16749e972330299f2554"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a94f091f2112f16749e972330299f2554">getBackgroundColor</a> (...)</td></tr>
  59. <tr class="separator:a94f091f2112f16749e972330299f2554"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:af502596f1859f2abce33770ad9101512" id="r_af502596f1859f2abce33770ad9101512"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#af502596f1859f2abce33770ad9101512">getContent</a> ()</td></tr>
  61. <tr class="separator:af502596f1859f2abce33770ad9101512"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a411c7297210a54ab69c75278db8a11bf" id="r_a411c7297210a54ab69c75278db8a11bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a411c7297210a54ab69c75278db8a11bf">getCursorPos</a> ()</td></tr>
  63. <tr class="separator:a411c7297210a54ab69c75278db8a11bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a83cab1eba647a8757f3636f91a8faa0d" id="r_a83cab1eba647a8757f3636f91a8faa0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a83cab1eba647a8757f3636f91a8faa0d">getMouseControl</a> ()</td></tr>
  65. <tr class="separator:a83cab1eba647a8757f3636f91a8faa0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a9ac5f4177566cb90111ba5056bd8603f" id="r_a9ac5f4177566cb90111ba5056bd8603f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a9ac5f4177566cb90111ba5056bd8603f">getUseBackgroundColor</a> (...)</td></tr>
  67. <tr class="separator:a9ac5f4177566cb90111ba5056bd8603f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:ab3108839b75614c3c5e93409e187732e" id="r_ab3108839b75614c3c5e93409e187732e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ab3108839b75614c3c5e93409e187732e">hideCursor</a> ()</td></tr>
  69. <tr class="separator:ab3108839b75614c3c5e93409e187732e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a803215fa18ca4506a55aac400bb9488d" id="r_a803215fa18ca4506a55aac400bb9488d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a803215fa18ca4506a55aac400bb9488d">isCursorOn</a> ()</td></tr>
  71. <tr class="separator:a803215fa18ca4506a55aac400bb9488d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a95022c396df6b951276ec7e164900466" id="r_a95022c396df6b951276ec7e164900466"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a95022c396df6b951276ec7e164900466">popDialog</a> (handle)</td></tr>
  73. <tr class="separator:a95022c396df6b951276ec7e164900466"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a8a917bb8ea6e5970a887b1291efcbfb5" id="r_a8a917bb8ea6e5970a887b1291efcbfb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a8a917bb8ea6e5970a887b1291efcbfb5">popLayer</a> (layer)</td></tr>
  75. <tr class="separator:a8a917bb8ea6e5970a887b1291efcbfb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ae3f4285cd6aa7a65a0adaff55d138ceb" id="r_ae3f4285cd6aa7a65a0adaff55d138ceb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ae3f4285cd6aa7a65a0adaff55d138ceb">pushDialog</a> (handle[, layer])</td></tr>
  77. <tr class="separator:ae3f4285cd6aa7a65a0adaff55d138ceb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a566282c49958139882ff8068c1d3ea50" id="r_a566282c49958139882ff8068c1d3ea50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a566282c49958139882ff8068c1d3ea50">renderFront</a> (bool enable)</td></tr>
  79. <tr class="separator:a566282c49958139882ff8068c1d3ea50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ac827b978aa122f136a14c198687ad80f" id="r_ac827b978aa122f136a14c198687ad80f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ac827b978aa122f136a14c198687ad80f">repaint</a> ()</td></tr>
  81. <tr class="separator:ac827b978aa122f136a14c198687ad80f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ad20897c5c8bd47f5d4005989bead0e55" id="r_ad20897c5c8bd47f5d4005989bead0e55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
  83. <tr class="separator:ad20897c5c8bd47f5d4005989bead0e55"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a47117fdbef6b3a112c25f0856190e970" id="r_a47117fdbef6b3a112c25f0856190e970"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a47117fdbef6b3a112c25f0856190e970">resetCursor</a> ()</td></tr>
  85. <tr class="separator:a47117fdbef6b3a112c25f0856190e970"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a384c3ead0aa0c633ec5aeecd96bb766d" id="r_a384c3ead0aa0c633ec5aeecd96bb766d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a384c3ead0aa0c633ec5aeecd96bb766d">setBackgroundColor</a> (float red, float green, float blue, [float alpha=1.0])</td></tr>
  87. <tr class="separator:a384c3ead0aa0c633ec5aeecd96bb766d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ad44ea8ffb2b28e5e15b62fa109f045cb" id="r_ad44ea8ffb2b28e5e15b62fa109f045cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ad44ea8ffb2b28e5e15b62fa109f045cb">setContent</a> (handle)</td></tr>
  89. <tr class="separator:ad44ea8ffb2b28e5e15b62fa109f045cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a7e7ac249b0968d3a584cdb6e977019c5" id="r_a7e7ac249b0968d3a584cdb6e977019c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a7e7ac249b0968d3a584cdb6e977019c5">setCursor</a> (cursorHandle)</td></tr>
  91. <tr class="separator:a7e7ac249b0968d3a584cdb6e977019c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a0a1c00269a5da1001689a609dd105fa5" id="r_a0a1c00269a5da1001689a609dd105fa5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a0a1c00269a5da1001689a609dd105fa5">setCursorPos</a> ()</td></tr>
  93. <tr class="separator:a0a1c00269a5da1001689a609dd105fa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a9c45cb3718256770fb91160f6190c123" id="r_a9c45cb3718256770fb91160f6190c123"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a9c45cb3718256770fb91160f6190c123">setDoubleClickDelay</a> ()</td></tr>
  95. <tr class="separator:a9c45cb3718256770fb91160f6190c123"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a844ae18610873efc52cfcdc1ef5d43a7" id="r_a844ae18610873efc52cfcdc1ef5d43a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a844ae18610873efc52cfcdc1ef5d43a7">setDoubleClickMoveBuffer</a> ()</td></tr>
  97. <tr class="separator:a844ae18610873efc52cfcdc1ef5d43a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:add8f202c1c9216c297ca9303647c832d" id="r_add8f202c1c9216c297ca9303647c832d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#add8f202c1c9216c297ca9303647c832d">setUseBackgroundColor</a> (...)</td></tr>
  99. <tr class="separator:add8f202c1c9216c297ca9303647c832d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ad84ea3ef3bfa8f70f3c8d28a56423a22" id="r_ad84ea3ef3bfa8f70f3c8d28a56423a22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ad84ea3ef3bfa8f70f3c8d28a56423a22">showCursor</a> ()</td></tr>
  101. <tr class="separator:ad84ea3ef3bfa8f70f3c8d28a56423a22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="inherit_header pub_methods_classGuiControl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classGuiControl')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classGuiControl.html">GuiControl</a></td></tr>
  103. <tr class="memitem:af286d6a5582d8a0457f5e1c3436ef76d inherit pub_methods_classGuiControl" id="r_af286d6a5582d8a0457f5e1c3436ef76d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#af286d6a5582d8a0457f5e1c3436ef76d">addGuiControl</a> (int controlId)</td></tr>
  104. <tr class="separator:af286d6a5582d8a0457f5e1c3436ef76d inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:acc8d4330cd289e30b039d62f2e83dd94 inherit pub_methods_classGuiControl" id="r_acc8d4330cd289e30b039d62f2e83dd94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#acc8d4330cd289e30b039d62f2e83dd94">findHitControl</a> (int x, int y)</td></tr>
  106. <tr class="separator:acc8d4330cd289e30b039d62f2e83dd94 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a154e102ba3f65bebd68161dbba397089 inherit pub_methods_classGuiControl" id="r_a154e102ba3f65bebd68161dbba397089"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a154e102ba3f65bebd68161dbba397089">getCenter</a> ()</td></tr>
  108. <tr class="separator:a154e102ba3f65bebd68161dbba397089 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ae82815e20c56ea6d156f96d4da8674c1 inherit pub_methods_classGuiControl" id="r_ae82815e20c56ea6d156f96d4da8674c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ae82815e20c56ea6d156f96d4da8674c1">getExtent</a> (...)</td></tr>
  110. <tr class="separator:ae82815e20c56ea6d156f96d4da8674c1 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:afe6fe960cf56f2572d869cb35a94af15 inherit pub_methods_classGuiControl" id="r_afe6fe960cf56f2572d869cb35a94af15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#afe6fe960cf56f2572d869cb35a94af15">getGlobalCenter</a> ()</td></tr>
  112. <tr class="separator:afe6fe960cf56f2572d869cb35a94af15 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:abf4c88928ff0639d87005959f1cd075e inherit pub_methods_classGuiControl" id="r_abf4c88928ff0639d87005959f1cd075e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#abf4c88928ff0639d87005959f1cd075e">getGlobalPosition</a> ()</td></tr>
  114. <tr class="separator:abf4c88928ff0639d87005959f1cd075e inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a7200f6d1e76e582fdb7d2163e52b0d7a inherit pub_methods_classGuiControl" id="r_a7200f6d1e76e582fdb7d2163e52b0d7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a7200f6d1e76e582fdb7d2163e52b0d7a">getMinExtent</a> ()</td></tr>
  116. <tr class="separator:a7200f6d1e76e582fdb7d2163e52b0d7a inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a93311cced3fcabc401afdc846bc1b3b6 inherit pub_methods_classGuiControl" id="r_a93311cced3fcabc401afdc846bc1b3b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a93311cced3fcabc401afdc846bc1b3b6">getParent</a> ()</td></tr>
  118. <tr class="separator:a93311cced3fcabc401afdc846bc1b3b6 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a0cc8e3fc4543d86236287679ed5be652 inherit pub_methods_classGuiControl" id="r_a0cc8e3fc4543d86236287679ed5be652"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a0cc8e3fc4543d86236287679ed5be652">getPosition</a> ()</td></tr>
  120. <tr class="separator:a0cc8e3fc4543d86236287679ed5be652 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:afab766445043570e6a82c14851366933 inherit pub_methods_classGuiControl" id="r_afab766445043570e6a82c14851366933"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#afab766445043570e6a82c14851366933">getText</a> ()</td></tr>
  122. <tr class="separator:afab766445043570e6a82c14851366933 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:aaa26252d86c2ce51bf0396ca64d70aed inherit pub_methods_classGuiControl" id="r_aaa26252d86c2ce51bf0396ca64d70aed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#aaa26252d86c2ce51bf0396ca64d70aed">getTextExtend</a> ()</td></tr>
  124. <tr class="separator:aaa26252d86c2ce51bf0396ca64d70aed inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:af3cb252caff861f28e5201d3523b7b34 inherit pub_methods_classGuiControl" id="r_af3cb252caff861f28e5201d3523b7b34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#af3cb252caff861f28e5201d3523b7b34">getTextWrap</a> ()</td></tr>
  126. <tr class="separator:af3cb252caff861f28e5201d3523b7b34 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a574b29843fb09dff2bf8edd82341f051 inherit pub_methods_classGuiControl" id="r_a574b29843fb09dff2bf8edd82341f051"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a574b29843fb09dff2bf8edd82341f051">getValue</a> ()</td></tr>
  128. <tr class="separator:a574b29843fb09dff2bf8edd82341f051 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:aea5d649c3c9c8380b9cc22486dc05fae inherit pub_methods_classGuiControl" id="r_aea5d649c3c9c8380b9cc22486dc05fae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#aea5d649c3c9c8380b9cc22486dc05fae">isActive</a> ()</td></tr>
  130. <tr class="separator:aea5d649c3c9c8380b9cc22486dc05fae inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:aefffd8942bc2da8487e4d5e47516bbd8 inherit pub_methods_classGuiControl" id="r_aefffd8942bc2da8487e4d5e47516bbd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#aefffd8942bc2da8487e4d5e47516bbd8">isAwake</a> ()</td></tr>
  132. <tr class="separator:aefffd8942bc2da8487e4d5e47516bbd8 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:ab57d4e846b3cbeedf99356a0d4e4fd87 inherit pub_methods_classGuiControl" id="r_ab57d4e846b3cbeedf99356a0d4e4fd87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ab57d4e846b3cbeedf99356a0d4e4fd87">isVisible</a> ()</td></tr>
  134. <tr class="separator:ab57d4e846b3cbeedf99356a0d4e4fd87 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a7da97bf20870fab15fc5847e71439399 inherit pub_methods_classGuiControl" id="r_a7da97bf20870fab15fc5847e71439399"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a7da97bf20870fab15fc5847e71439399">makeFirstResponder</a> (isFirst)</td></tr>
  136. <tr class="separator:a7da97bf20870fab15fc5847e71439399 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a505a51805f8630c17b1951b15b50a382 inherit pub_methods_classGuiControl" id="r_a505a51805f8630c17b1951b15b50a382"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a505a51805f8630c17b1951b15b50a382">performClick</a> ()</td></tr>
  138. <tr class="separator:a505a51805f8630c17b1951b15b50a382 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a0b7ff8d450172b5f169a2efb6cfac684 inherit pub_methods_classGuiControl" id="r_a0b7ff8d450172b5f169a2efb6cfac684"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a0b7ff8d450172b5f169a2efb6cfac684">pointInControl</a> (int x, int y)</td></tr>
  140. <tr class="separator:a0b7ff8d450172b5f169a2efb6cfac684 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a895cc03d6f060d82263c56b1a3cac8ce inherit pub_methods_classGuiControl" id="r_a895cc03d6f060d82263c56b1a3cac8ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a895cc03d6f060d82263c56b1a3cac8ce">reorderChild</a> (child1, child2)</td></tr>
  142. <tr class="separator:a895cc03d6f060d82263c56b1a3cac8ce inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a1c8691ea146391976a079c2dbe32d98f inherit pub_methods_classGuiControl" id="r_a1c8691ea146391976a079c2dbe32d98f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a1c8691ea146391976a079c2dbe32d98f">resize</a> (int x, int y, int w, int h)</td></tr>
  144. <tr class="separator:a1c8691ea146391976a079c2dbe32d98f inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a8f28561f4fe9f2f8ba30ecb8ad586c6d inherit pub_methods_classGuiControl" id="r_a8f28561f4fe9f2f8ba30ecb8ad586c6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a8f28561f4fe9f2f8ba30ecb8ad586c6d">setActive</a> (<a class="el" href="classGuiControl.html#aea5d649c3c9c8380b9cc22486dc05fae">isActive</a>)</td></tr>
  146. <tr class="separator:a8f28561f4fe9f2f8ba30ecb8ad586c6d inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:ae96a357d63d095bace0284f579edb993 inherit pub_methods_classGuiControl" id="r_ae96a357d63d095bace0284f579edb993"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ae96a357d63d095bace0284f579edb993">setCanSave</a> (bool canSave)</td></tr>
  148. <tr class="separator:ae96a357d63d095bace0284f579edb993 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:aa964464577a29d704e5fb091ebec0807 inherit pub_methods_classGuiControl" id="r_aa964464577a29d704e5fb091ebec0807"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#aa964464577a29d704e5fb091ebec0807">setCenter</a> (int x, int y)</td></tr>
  150. <tr class="separator:aa964464577a29d704e5fb091ebec0807 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:ae02549eb9fb23ba73889e6f7c545e2c0 inherit pub_methods_classGuiControl" id="r_ae02549eb9fb23ba73889e6f7c545e2c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ae02549eb9fb23ba73889e6f7c545e2c0">setExtent</a> (int width, int height)</td></tr>
  152. <tr class="separator:ae02549eb9fb23ba73889e6f7c545e2c0 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a027d7313dfaca48ac22f8d0fef1d3c73 inherit pub_methods_classGuiControl" id="r_a027d7313dfaca48ac22f8d0fef1d3c73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a027d7313dfaca48ac22f8d0fef1d3c73">setFirstResponder</a> ()</td></tr>
  154. <tr class="separator:a027d7313dfaca48ac22f8d0fef1d3c73 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ad6c107fadf835c74a229f8cac0cc98ab inherit pub_methods_classGuiControl" id="r_ad6c107fadf835c74a229f8cac0cc98ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ad6c107fadf835c74a229f8cac0cc98ab">setPosition</a> (int x, int y)</td></tr>
  156. <tr class="separator:ad6c107fadf835c74a229f8cac0cc98ab inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a98098c5cbd63eeb7885723b1266822e2 inherit pub_methods_classGuiControl" id="r_a98098c5cbd63eeb7885723b1266822e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a98098c5cbd63eeb7885723b1266822e2">setPositionGlobal</a> (int x, int y)</td></tr>
  158. <tr class="separator:a98098c5cbd63eeb7885723b1266822e2 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:ae285a02aa287b0fc1c6dd25af891ca93 inherit pub_methods_classGuiControl" id="r_ae285a02aa287b0fc1c6dd25af891ca93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ae285a02aa287b0fc1c6dd25af891ca93">setProfile</a> (GuiControlProfile p)</td></tr>
  160. <tr class="separator:ae285a02aa287b0fc1c6dd25af891ca93 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:a322803a0b6092a7f432517e3bbd6e614 inherit pub_methods_classGuiControl" id="r_a322803a0b6092a7f432517e3bbd6e614"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a322803a0b6092a7f432517e3bbd6e614">setText</a> (text)</td></tr>
  162. <tr class="separator:a322803a0b6092a7f432517e3bbd6e614 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:af1cca41bf7d04decc73b99c1befbbac2 inherit pub_methods_classGuiControl" id="r_af1cca41bf7d04decc73b99c1befbbac2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#af1cca41bf7d04decc73b99c1befbbac2">setTextExtend</a> (setting)</td></tr>
  164. <tr class="separator:af1cca41bf7d04decc73b99c1befbbac2 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:abf0c06f0453bde4f0f9ed7682dedbb93 inherit pub_methods_classGuiControl" id="r_abf0c06f0453bde4f0f9ed7682dedbb93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#abf0c06f0453bde4f0f9ed7682dedbb93">setTextID</a> (id)</td></tr>
  166. <tr class="separator:abf0c06f0453bde4f0f9ed7682dedbb93 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:aef0aa14a4c602deede303ce92f7d7610 inherit pub_methods_classGuiControl" id="r_aef0aa14a4c602deede303ce92f7d7610"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#aef0aa14a4c602deede303ce92f7d7610">setTextWrap</a> (setting)</td></tr>
  168. <tr class="separator:aef0aa14a4c602deede303ce92f7d7610 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a85de7207005ddac355bc228383053fc7 inherit pub_methods_classGuiControl" id="r_a85de7207005ddac355bc228383053fc7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a85de7207005ddac355bc228383053fc7">setValue</a> (value)</td></tr>
  170. <tr class="separator:a85de7207005ddac355bc228383053fc7 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:af205cf4b7908a58b75b2bbf0ea41b100 inherit pub_methods_classGuiControl" id="r_af205cf4b7908a58b75b2bbf0ea41b100"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#af205cf4b7908a58b75b2bbf0ea41b100">setVisible</a> (<a class="el" href="classGuiControl.html#ab57d4e846b3cbeedf99356a0d4e4fd87">isVisible</a>)</td></tr>
  172. <tr class="separator:af205cf4b7908a58b75b2bbf0ea41b100 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. </table>
  174. <h2 class="groupheader">Member Function Documentation</h2>
  175. <a id="a64b07a262cc429c9d45cf39f239c6c35" name="a64b07a262cc429c9d45cf39f239c6c35"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#a64b07a262cc429c9d45cf39f239c6c35">&#9670;&#160;</a></span>cursorOff()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> cursorOff </td>
  182. <td>(</td>
  183. <td class="paramname"></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Use the cursorOff method to disable the cursor. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  189. </div>
  190. </div>
  191. <a id="aa757b5f3c22eff72288ba049eab34ed1" name="aa757b5f3c22eff72288ba049eab34ed1"></a>
  192. <h2 class="memtitle"><span class="permalink"><a href="#aa757b5f3c22eff72288ba049eab34ed1">&#9670;&#160;</a></span>cursorOn()</h2>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> cursorOn </td>
  198. <td>(</td>
  199. <td class="paramname"></td><td>)</td>
  200. <td></td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <p>Use the cursorOn method to enable the cursor. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  205. </div>
  206. </div>
  207. <a id="a94f091f2112f16749e972330299f2554" name="a94f091f2112f16749e972330299f2554"></a>
  208. <h2 class="memtitle"><span class="permalink"><a href="#a94f091f2112f16749e972330299f2554">&#9670;&#160;</a></span>getBackgroundColor()</h2>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getBackgroundColor </td>
  214. <td>(</td>
  215. <td class="paramtype">&#160;</td>
  216. <td class="paramname"><em>...</em></td><td>)</td>
  217. <td></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Gets the background color for the canvas. </p><dl class="section return"><dt>Returns</dt><dd>(float red / float green / float blue / float alpha) The background color for the canvas. </dd></dl>
  222. </div>
  223. </div>
  224. <a id="af502596f1859f2abce33770ad9101512" name="af502596f1859f2abce33770ad9101512"></a>
  225. <h2 class="memtitle"><span class="permalink"><a href="#af502596f1859f2abce33770ad9101512">&#9670;&#160;</a></span>getContent()</h2>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getContent </td>
  231. <td>(</td>
  232. <td class="paramname"></td><td>)</td>
  233. <td></td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <p>Use the getContent method to get the ID of the control which is being used as the current canvas content. </p><dl class="section return"><dt>Returns</dt><dd>Returns the ID of the current canvas content (a control), or 0 meaning the canvas is empty </dd></dl>
  238. </div>
  239. </div>
  240. <a id="a411c7297210a54ab69c75278db8a11bf" name="a411c7297210a54ab69c75278db8a11bf"></a>
  241. <h2 class="memtitle"><span class="permalink"><a href="#a411c7297210a54ab69c75278db8a11bf">&#9670;&#160;</a></span>getCursorPos()</h2>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getCursorPos </td>
  247. <td>(</td>
  248. <td class="paramname"></td><td>)</td>
  249. <td></td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <p>Use the getCursorPos method to retrieve the current position of the mouse pointer. </p><dl class="section return"><dt>Returns</dt><dd>Returns a vector containing the ???x y??? coordinates of the cursor in the canvas </dd></dl>
  254. </div>
  255. </div>
  256. <a id="a83cab1eba647a8757f3636f91a8faa0d" name="a83cab1eba647a8757f3636f91a8faa0d"></a>
  257. <h2 class="memtitle"><span class="permalink"><a href="#a83cab1eba647a8757f3636f91a8faa0d">&#9670;&#160;</a></span>getMouseControl()</h2>
  258. <div class="memitem">
  259. <div class="memproto">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getMouseControl </td>
  263. <td>(</td>
  264. <td class="paramname"></td><td>)</td>
  265. <td></td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <p>Gets the gui control under the mouse. </p>
  270. </div>
  271. </div>
  272. <a id="a9ac5f4177566cb90111ba5056bd8603f" name="a9ac5f4177566cb90111ba5056bd8603f"></a>
  273. <h2 class="memtitle"><span class="permalink"><a href="#a9ac5f4177566cb90111ba5056bd8603f">&#9670;&#160;</a></span>getUseBackgroundColor()</h2>
  274. <div class="memitem">
  275. <div class="memproto">
  276. <table class="memname">
  277. <tr>
  278. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getUseBackgroundColor </td>
  279. <td>(</td>
  280. <td class="paramtype">&#160;</td>
  281. <td class="paramname"><em>...</em></td><td>)</td>
  282. <td></td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Gets whether the canvas background color is in use or not. </p><dl class="section return"><dt>Returns</dt><dd>Whether the canvas background color is in use or not. </dd></dl>
  287. </div>
  288. </div>
  289. <a id="ab3108839b75614c3c5e93409e187732e" name="ab3108839b75614c3c5e93409e187732e"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#ab3108839b75614c3c5e93409e187732e">&#9670;&#160;</a></span>hideCursor()</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> hideCursor </td>
  296. <td>(</td>
  297. <td class="paramname"></td><td>)</td>
  298. <td></td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. </div>
  303. </div>
  304. <a id="a803215fa18ca4506a55aac400bb9488d" name="a803215fa18ca4506a55aac400bb9488d"></a>
  305. <h2 class="memtitle"><span class="permalink"><a href="#a803215fa18ca4506a55aac400bb9488d">&#9670;&#160;</a></span>isCursorOn()</h2>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isCursorOn </td>
  311. <td>(</td>
  312. <td class="paramname"></td><td>)</td>
  313. <td></td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. </div>
  318. </div>
  319. <a id="a95022c396df6b951276ec7e164900466" name="a95022c396df6b951276ec7e164900466"></a>
  320. <h2 class="memtitle"><span class="permalink"><a href="#a95022c396df6b951276ec7e164900466">&#9670;&#160;</a></span>popDialog()</h2>
  321. <div class="memitem">
  322. <div class="memproto">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> popDialog </td>
  326. <td>(</td>
  327. <td class="paramtype">handle&#160;</td>
  328. <td class="paramname"></td><td>)</td>
  329. <td></td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Use the popDialog method to remove a currently showing dialog. If no handle is provided, the top most dialog is popped. </p><dl class="params"><dt>Parameters</dt><dd>
  334. <table class="params">
  335. <tr><td class="paramname">handle</td><td>The ID or a previously pushed dialog. </td></tr>
  336. </table>
  337. </dd>
  338. </dl>
  339. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  340. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classGuiCanvas.html#ae3f4285cd6aa7a65a0adaff55d138ceb">pushDialog</a>, <a class="el" href="classGuiCanvas.html#a8a917bb8ea6e5970a887b1291efcbfb5">popLayer</a> </dd></dl>
  341. </div>
  342. </div>
  343. <a id="a8a917bb8ea6e5970a887b1291efcbfb5" name="a8a917bb8ea6e5970a887b1291efcbfb5"></a>
  344. <h2 class="memtitle"><span class="permalink"><a href="#a8a917bb8ea6e5970a887b1291efcbfb5">&#9670;&#160;</a></span>popLayer()</h2>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> popLayer </td>
  350. <td>(</td>
  351. <td class="paramtype">layer&#160;</td>
  352. <td class="paramname"></td><td>)</td>
  353. <td></td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <p>Use the popLayer method to remove (close) all dialogs in the specified canvas ???layer???. </p><dl class="params"><dt>Parameters</dt><dd>
  358. <table class="params">
  359. <tr><td class="paramname">layer</td><td>A integer value in the range [ 0 , inf ) specifying the canvas layer to clear. </td></tr>
  360. </table>
  361. </dd>
  362. </dl>
  363. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  364. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classGuiCanvas.html#ae3f4285cd6aa7a65a0adaff55d138ceb">pushDialog</a>, <a class="el" href="classGuiCanvas.html#a95022c396df6b951276ec7e164900466">popDialog</a> </dd></dl>
  365. </div>
  366. </div>
  367. <a id="ae3f4285cd6aa7a65a0adaff55d138ceb" name="ae3f4285cd6aa7a65a0adaff55d138ceb"></a>
  368. <h2 class="memtitle"><span class="permalink"><a href="#ae3f4285cd6aa7a65a0adaff55d138ceb">&#9670;&#160;</a></span>pushDialog()</h2>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> pushDialog </td>
  374. <td>(</td>
  375. <td class="paramtype">handle&#160;</td>
  376. <td class="paramname">[, layer]</td><td>)</td>
  377. <td></td>
  378. </tr>
  379. </table>
  380. </div><div class="memdoc">
  381. <p>Use the pushDialog method to open a dialog on a specific canvas layer, or in the same layer the last openned dialog. Newly placed dialogs placed in a layer with another dialog(s) will overlap the prior dialog(s). </p><dl class="params"><dt>Parameters</dt><dd>
  382. <table class="params">
  383. <tr><td class="paramname">handle</td><td>The numeric ID or name of the dialog to be opened. </td></tr>
  384. <tr><td class="paramname">layer</td><td>A integer value in the range [ 0 , inf ) specifying the canvas layer to place the dialog in. </td></tr>
  385. </table>
  386. </dd>
  387. </dl>
  388. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  389. </div>
  390. </div>
  391. <a id="a566282c49958139882ff8068c1d3ea50" name="a566282c49958139882ff8068c1d3ea50"></a>
  392. <h2 class="memtitle"><span class="permalink"><a href="#a566282c49958139882ff8068c1d3ea50">&#9670;&#160;</a></span>renderFront()</h2>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="memname">
  396. <tr>
  397. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> renderFront </td>
  398. <td>(</td>
  399. <td class="paramtype">bool&#160;</td>
  400. <td class="paramname"><em>enable</em></td><td>)</td>
  401. <td></td>
  402. </tr>
  403. </table>
  404. </div><div class="memdoc">
  405. </div>
  406. </div>
  407. <a id="ac827b978aa122f136a14c198687ad80f" name="ac827b978aa122f136a14c198687ad80f"></a>
  408. <h2 class="memtitle"><span class="permalink"><a href="#ac827b978aa122f136a14c198687ad80f">&#9670;&#160;</a></span>repaint()</h2>
  409. <div class="memitem">
  410. <div class="memproto">
  411. <table class="memname">
  412. <tr>
  413. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> repaint </td>
  414. <td>(</td>
  415. <td class="paramname"></td><td>)</td>
  416. <td></td>
  417. </tr>
  418. </table>
  419. </div><div class="memdoc">
  420. <p>Use the repaint method to force the canvas to redraw all elements. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  421. </div>
  422. </div>
  423. <a id="ad20897c5c8bd47f5d4005989bead0e55" name="ad20897c5c8bd47f5d4005989bead0e55"></a>
  424. <h2 class="memtitle"><span class="permalink"><a href="#ad20897c5c8bd47f5d4005989bead0e55">&#9670;&#160;</a></span>reset()</h2>
  425. <div class="memitem">
  426. <div class="memproto">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> reset </td>
  430. <td>(</td>
  431. <td class="paramname"></td><td>)</td>
  432. <td></td>
  433. </tr>
  434. </table>
  435. </div><div class="memdoc">
  436. <p>Use the reset method to reset the current canvas update region. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  437. </div>
  438. </div>
  439. <a id="a47117fdbef6b3a112c25f0856190e970" name="a47117fdbef6b3a112c25f0856190e970"></a>
  440. <h2 class="memtitle"><span class="permalink"><a href="#a47117fdbef6b3a112c25f0856190e970">&#9670;&#160;</a></span>resetCursor()</h2>
  441. <div class="memitem">
  442. <div class="memproto">
  443. <table class="memname">
  444. <tr>
  445. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> resetCursor </td>
  446. <td>(</td>
  447. <td class="paramname"></td><td>)</td>
  448. <td></td>
  449. </tr>
  450. </table>
  451. </div><div class="memdoc">
  452. <p>Returns the cursor to the system default. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  453. </div>
  454. </div>
  455. <a id="a384c3ead0aa0c633ec5aeecd96bb766d" name="a384c3ead0aa0c633ec5aeecd96bb766d"></a>
  456. <h2 class="memtitle"><span class="permalink"><a href="#a384c3ead0aa0c633ec5aeecd96bb766d">&#9670;&#160;</a></span>setBackgroundColor()</h2>
  457. <div class="memitem">
  458. <div class="memproto">
  459. <table class="memname">
  460. <tr>
  461. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setBackgroundColor </td>
  462. <td>(</td>
  463. <td class="paramtype">float&#160;</td>
  464. <td class="paramname"><em>red</em>, </td>
  465. </tr>
  466. <tr>
  467. <td class="paramkey"></td>
  468. <td></td>
  469. <td class="paramtype">float&#160;</td>
  470. <td class="paramname"><em>green</em>, </td>
  471. </tr>
  472. <tr>
  473. <td class="paramkey"></td>
  474. <td></td>
  475. <td class="paramtype">float&#160;</td>
  476. <td class="paramname"><em>blue</em>&#160;</td>
  477. </tr>
  478. <tr>
  479. <td></td>
  480. <td>)</td>
  481. <td></td><td></td>
  482. </tr>
  483. </table>
  484. </div><div class="memdoc">
  485. <p>Sets the background color for the canvas. </p><dl class="params"><dt>Parameters</dt><dd>
  486. <table class="params">
  487. <tr><td class="paramname">red</td><td>The red value. </td></tr>
  488. <tr><td class="paramname">green</td><td>The green value. </td></tr>
  489. <tr><td class="paramname">blue</td><td>The blue value. </td></tr>
  490. <tr><td class="paramname">alpha</td><td>The alpha value. </td></tr>
  491. </table>
  492. </dd>
  493. </dl>
  494. <dl class="section return"><dt>Returns</dt><dd>No return Value. </dd></dl>
  495. </div>
  496. </div>
  497. <a id="ad44ea8ffb2b28e5e15b62fa109f045cb" name="ad44ea8ffb2b28e5e15b62fa109f045cb"></a>
  498. <h2 class="memtitle"><span class="permalink"><a href="#ad44ea8ffb2b28e5e15b62fa109f045cb">&#9670;&#160;</a></span>setContent()</h2>
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setContent </td>
  504. <td>(</td>
  505. <td class="paramtype">handle&#160;</td>
  506. <td class="paramname"></td><td>)</td>
  507. <td></td>
  508. </tr>
  509. </table>
  510. </div><div class="memdoc">
  511. <p>Use the setContent method to set the control identified by handle as the current canvas content. </p><dl class="params"><dt>Parameters</dt><dd>
  512. <table class="params">
  513. <tr><td class="paramname">handle</td><td>The numeric ID or name of the control to be made the canvas contents. </td></tr>
  514. </table>
  515. </dd>
  516. </dl>
  517. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  518. </div>
  519. </div>
  520. <a id="a7e7ac249b0968d3a584cdb6e977019c5" name="a7e7ac249b0968d3a584cdb6e977019c5"></a>
  521. <h2 class="memtitle"><span class="permalink"><a href="#a7e7ac249b0968d3a584cdb6e977019c5">&#9670;&#160;</a></span>setCursor()</h2>
  522. <div class="memitem">
  523. <div class="memproto">
  524. <table class="memname">
  525. <tr>
  526. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setCursor </td>
  527. <td>(</td>
  528. <td class="paramtype">cursorHandle&#160;</td>
  529. <td class="paramname"></td><td>)</td>
  530. <td></td>
  531. </tr>
  532. </table>
  533. </div><div class="memdoc">
  534. <p>Use the setCursor method to select the current cursor. </p><dl class="params"><dt>Parameters</dt><dd>
  535. <table class="params">
  536. <tr><td class="paramname">cursorHandle</td><td>The ID of a previously defined GuiCursor object. </td></tr>
  537. </table>
  538. </dd>
  539. </dl>
  540. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  541. </div>
  542. </div>
  543. <a id="a0a1c00269a5da1001689a609dd105fa5" name="a0a1c00269a5da1001689a609dd105fa5"></a>
  544. <h2 class="memtitle"><span class="permalink"><a href="#a0a1c00269a5da1001689a609dd105fa5">&#9670;&#160;</a></span>setCursorPos()</h2>
  545. <div class="memitem">
  546. <div class="memproto">
  547. <table class="memname">
  548. <tr>
  549. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setCursorPos </td>
  550. <td>(</td>
  551. <td class="paramname"></td><td>)</td>
  552. <td></td>
  553. </tr>
  554. </table>
  555. </div><div class="memdoc">
  556. <p>Use the setCursorPos method to set the position of the cursor in the cavas. </p><dl class="params"><dt>Parameters</dt><dd>
  557. <table class="params">
  558. <tr><td class="paramname">position</td><td>An \x y\ position vector specifying the new location of the cursor. </td></tr>
  559. </table>
  560. </dd>
  561. </dl>
  562. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  563. </div>
  564. </div>
  565. <a id="a9c45cb3718256770fb91160f6190c123" name="a9c45cb3718256770fb91160f6190c123"></a>
  566. <h2 class="memtitle"><span class="permalink"><a href="#a9c45cb3718256770fb91160f6190c123">&#9670;&#160;</a></span>setDoubleClickDelay()</h2>
  567. <div class="memitem">
  568. <div class="memproto">
  569. <table class="memname">
  570. <tr>
  571. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setDoubleClickDelay </td>
  572. <td>(</td>
  573. <td class="paramname"></td><td>)</td>
  574. <td></td>
  575. </tr>
  576. </table>
  577. </div><div class="memdoc">
  578. </div>
  579. </div>
  580. <a id="a844ae18610873efc52cfcdc1ef5d43a7" name="a844ae18610873efc52cfcdc1ef5d43a7"></a>
  581. <h2 class="memtitle"><span class="permalink"><a href="#a844ae18610873efc52cfcdc1ef5d43a7">&#9670;&#160;</a></span>setDoubleClickMoveBuffer()</h2>
  582. <div class="memitem">
  583. <div class="memproto">
  584. <table class="memname">
  585. <tr>
  586. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setDoubleClickMoveBuffer </td>
  587. <td>(</td>
  588. <td class="paramname"></td><td>)</td>
  589. <td></td>
  590. </tr>
  591. </table>
  592. </div><div class="memdoc">
  593. </div>
  594. </div>
  595. <a id="add8f202c1c9216c297ca9303647c832d" name="add8f202c1c9216c297ca9303647c832d"></a>
  596. <h2 class="memtitle"><span class="permalink"><a href="#add8f202c1c9216c297ca9303647c832d">&#9670;&#160;</a></span>setUseBackgroundColor()</h2>
  597. <div class="memitem">
  598. <div class="memproto">
  599. <table class="memname">
  600. <tr>
  601. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setUseBackgroundColor </td>
  602. <td>(</td>
  603. <td class="paramtype">&#160;</td>
  604. <td class="paramname"><em>...</em></td><td>)</td>
  605. <td></td>
  606. </tr>
  607. </table>
  608. </div><div class="memdoc">
  609. <p>Sets whether to use the canvas background color or not. </p><dl class="params"><dt>Parameters</dt><dd>
  610. <table class="params">
  611. <tr><td class="paramname">useBackgroundColor</td><td>Whether to use the canvas background color or not. </td></tr>
  612. </table>
  613. </dd>
  614. </dl>
  615. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  616. </div>
  617. </div>
  618. <a id="ad84ea3ef3bfa8f70f3c8d28a56423a22" name="ad84ea3ef3bfa8f70f3c8d28a56423a22"></a>
  619. <h2 class="memtitle"><span class="permalink"><a href="#ad84ea3ef3bfa8f70f3c8d28a56423a22">&#9670;&#160;</a></span>showCursor()</h2>
  620. <div class="memitem">
  621. <div class="memproto">
  622. <table class="memname">
  623. <tr>
  624. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> showCursor </td>
  625. <td>(</td>
  626. <td class="paramname"></td><td>)</td>
  627. <td></td>
  628. </tr>
  629. </table>
  630. </div><div class="memdoc">
  631. </div>
  632. </div>
  633. </div><!-- contents -->
  634. <!-- start footer part -->
  635. <hr class="footer"/><address class="footer"><small>
  636. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  637. </small></address>
  638. </body>
  639. </html>