classGuiControl.html 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939
  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: GuiControl 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="classGuiControl-members.html">List of all members</a> </div>
  46. <div class="headertitle"><div class="title">GuiControl Class Reference</div></div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p><code>#include &lt;guiControl_ScriptBinding.h&gt;</code></p>
  50. <p>Inherits <a class="el" href="classSimGroup.html">SimGroup</a>.</p>
  51. <p>Inherited by <a class="el" href="classGuiButtonCtrl.html">GuiButtonCtrl</a>, <a class="el" href="classGuiCanvas.html">GuiCanvas</a>, <a class="el" href="classGuiChainCtrl.html">GuiChainCtrl</a>, <a class="el" href="classGuiColorPickerCtrl.html">GuiColorPickerCtrl</a>, <a class="el" href="classGuiColorPopupCtrl.html">GuiColorPopupCtrl</a>, <a class="el" href="classGuiDragAndDropCtrl.html">GuiDragAndDropCtrl</a>, <a class="el" href="classGuiDropDownCtrl.html">GuiDropDownCtrl</a>, <a class="el" href="classGuiExpandCtrl.html">GuiExpandCtrl</a>, <a class="el" href="classGuiFrameSetCtrl.html">GuiFrameSetCtrl</a>, <a class="el" href="classGuiGridCtrl.html">GuiGridCtrl</a>, <a class="el" href="classGuiListBoxCtrl.html">GuiListBoxCtrl</a>, <a class="el" href="classGuiMenuBarCtrl.html">GuiMenuBarCtrl</a>, <a class="el" href="classGuiPanelCtrl.html">GuiPanelCtrl</a>, <a class="el" href="classGuiParticleGraphInspector.html">GuiParticleGraphInspector</a>, <a class="el" href="classGuiProgressCtrl.html">GuiProgressCtrl</a>, <a class="el" href="classGuiScrollCtrl.html">GuiScrollCtrl</a>, <a class="el" href="classGuiTextEditCtrl.html">GuiTextEditCtrl</a>, <a class="el" href="classGuiWindowCtrl.html">GuiWindowCtrl</a>, and <a class="el" href="classSceneWindow.html">SceneWindow</a>.</p>
  52. <table class="memberdecls">
  53. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  54. Public Member Functions</h2></td></tr>
  55. <tr class="memitem:af286d6a5582d8a0457f5e1c3436ef76d" 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>
  56. <tr class="separator:af286d6a5582d8a0457f5e1c3436ef76d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:acc8d4330cd289e30b039d62f2e83dd94" 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>
  58. <tr class="separator:acc8d4330cd289e30b039d62f2e83dd94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:a154e102ba3f65bebd68161dbba397089" 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>
  60. <tr class="separator:a154e102ba3f65bebd68161dbba397089"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ae82815e20c56ea6d156f96d4da8674c1" 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>
  62. <tr class="separator:ae82815e20c56ea6d156f96d4da8674c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:afe6fe960cf56f2572d869cb35a94af15" 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>
  64. <tr class="separator:afe6fe960cf56f2572d869cb35a94af15"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:abf4c88928ff0639d87005959f1cd075e" 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>
  66. <tr class="separator:abf4c88928ff0639d87005959f1cd075e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a7200f6d1e76e582fdb7d2163e52b0d7a" 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>
  68. <tr class="separator:a7200f6d1e76e582fdb7d2163e52b0d7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a93311cced3fcabc401afdc846bc1b3b6" 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>
  70. <tr class="separator:a93311cced3fcabc401afdc846bc1b3b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a0cc8e3fc4543d86236287679ed5be652" 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>
  72. <tr class="separator:a0cc8e3fc4543d86236287679ed5be652"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:afab766445043570e6a82c14851366933" 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>
  74. <tr class="separator:afab766445043570e6a82c14851366933"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:aaa26252d86c2ce51bf0396ca64d70aed" 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>
  76. <tr class="separator:aaa26252d86c2ce51bf0396ca64d70aed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:af3cb252caff861f28e5201d3523b7b34" 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>
  78. <tr class="separator:af3cb252caff861f28e5201d3523b7b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a574b29843fb09dff2bf8edd82341f051" 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>
  80. <tr class="separator:a574b29843fb09dff2bf8edd82341f051"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:aea5d649c3c9c8380b9cc22486dc05fae" 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>
  82. <tr class="separator:aea5d649c3c9c8380b9cc22486dc05fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:aefffd8942bc2da8487e4d5e47516bbd8" 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>
  84. <tr class="separator:aefffd8942bc2da8487e4d5e47516bbd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ab57d4e846b3cbeedf99356a0d4e4fd87" 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>
  86. <tr class="separator:ab57d4e846b3cbeedf99356a0d4e4fd87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a7da97bf20870fab15fc5847e71439399" 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>
  88. <tr class="separator:a7da97bf20870fab15fc5847e71439399"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a505a51805f8630c17b1951b15b50a382" 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>
  90. <tr class="separator:a505a51805f8630c17b1951b15b50a382"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a0b7ff8d450172b5f169a2efb6cfac684" 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>
  92. <tr class="separator:a0b7ff8d450172b5f169a2efb6cfac684"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a895cc03d6f060d82263c56b1a3cac8ce" 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>
  94. <tr class="separator:a895cc03d6f060d82263c56b1a3cac8ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a1c8691ea146391976a079c2dbe32d98f" 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>
  96. <tr class="separator:a1c8691ea146391976a079c2dbe32d98f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a8f28561f4fe9f2f8ba30ecb8ad586c6d" 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>
  98. <tr class="separator:a8f28561f4fe9f2f8ba30ecb8ad586c6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ae96a357d63d095bace0284f579edb993" 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>
  100. <tr class="separator:ae96a357d63d095bace0284f579edb993"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:aa964464577a29d704e5fb091ebec0807" 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>
  102. <tr class="separator:aa964464577a29d704e5fb091ebec0807"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ae02549eb9fb23ba73889e6f7c545e2c0" 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>
  104. <tr class="separator:ae02549eb9fb23ba73889e6f7c545e2c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a027d7313dfaca48ac22f8d0fef1d3c73" 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>
  106. <tr class="separator:a027d7313dfaca48ac22f8d0fef1d3c73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ad6c107fadf835c74a229f8cac0cc98ab" 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>
  108. <tr class="separator:ad6c107fadf835c74a229f8cac0cc98ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a98098c5cbd63eeb7885723b1266822e2" 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>
  110. <tr class="separator:a98098c5cbd63eeb7885723b1266822e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ae285a02aa287b0fc1c6dd25af891ca93" 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>
  112. <tr class="separator:ae285a02aa287b0fc1c6dd25af891ca93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a322803a0b6092a7f432517e3bbd6e614" 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>
  114. <tr class="separator:a322803a0b6092a7f432517e3bbd6e614"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:af1cca41bf7d04decc73b99c1befbbac2" 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>
  116. <tr class="separator:af1cca41bf7d04decc73b99c1befbbac2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:abf0c06f0453bde4f0f9ed7682dedbb93" 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>
  118. <tr class="separator:abf0c06f0453bde4f0f9ed7682dedbb93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:aef0aa14a4c602deede303ce92f7d7610" 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>
  120. <tr class="separator:aef0aa14a4c602deede303ce92f7d7610"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a85de7207005ddac355bc228383053fc7" 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>
  122. <tr class="separator:a85de7207005ddac355bc228383053fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:af205cf4b7908a58b75b2bbf0ea41b100" 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>
  124. <tr class="separator:af205cf4b7908a58b75b2bbf0ea41b100"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. </table>
  126. <h2 class="groupheader">Member Function Documentation</h2>
  127. <a id="af286d6a5582d8a0457f5e1c3436ef76d" name="af286d6a5582d8a0457f5e1c3436ef76d"></a>
  128. <h2 class="memtitle"><span class="permalink"><a href="#af286d6a5582d8a0457f5e1c3436ef76d">&#9670;&#160;</a></span>addGuiControl()</h2>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> addGuiControl </td>
  134. <td>(</td>
  135. <td class="paramtype">int&#160;</td>
  136. <td class="paramname"><em>controlId</em></td><td>)</td>
  137. <td></td>
  138. </tr>
  139. </table>
  140. </div><div class="memdoc">
  141. <p>Adds the gui control </p><dl class="params"><dt>Parameters</dt><dd>
  142. <table class="params">
  143. <tr><td class="paramname">controlId</td><td>integer ID of the control to add </td></tr>
  144. </table>
  145. </dd>
  146. </dl>
  147. <dl class="section return"><dt>Returns</dt><dd>No Return value </dd></dl>
  148. </div>
  149. </div>
  150. <a id="acc8d4330cd289e30b039d62f2e83dd94" name="acc8d4330cd289e30b039d62f2e83dd94"></a>
  151. <h2 class="memtitle"><span class="permalink"><a href="#acc8d4330cd289e30b039d62f2e83dd94">&#9670;&#160;</a></span>findHitControl()</h2>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> findHitControl </td>
  157. <td>(</td>
  158. <td class="paramtype">int&#160;</td>
  159. <td class="paramname"><em>x</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">int&#160;</td>
  165. <td class="paramname"><em>y</em>&#160;</td>
  166. </tr>
  167. <tr>
  168. <td></td>
  169. <td>)</td>
  170. <td></td><td></td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Searches for the control at the given point </p><dl class="section return"><dt>Returns</dt><dd>Returns the Id of the control at the point </dd></dl>
  175. </div>
  176. </div>
  177. <a id="a154e102ba3f65bebd68161dbba397089" name="a154e102ba3f65bebd68161dbba397089"></a>
  178. <h2 class="memtitle"><span class="permalink"><a href="#a154e102ba3f65bebd68161dbba397089">&#9670;&#160;</a></span>getCenter()</h2>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getCenter </td>
  184. <td>(</td>
  185. <td class="paramname"></td><td>)</td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <dl class="section return"><dt>Returns</dt><dd>Returns center of control, as space seperated ints </dd></dl>
  191. </div>
  192. </div>
  193. <a id="ae82815e20c56ea6d156f96d4da8674c1" name="ae82815e20c56ea6d156f96d4da8674c1"></a>
  194. <h2 class="memtitle"><span class="permalink"><a href="#ae82815e20c56ea6d156f96d4da8674c1">&#9670;&#160;</a></span>getExtent()</h2>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getExtent </td>
  200. <td>(</td>
  201. <td class="paramtype">&#160;</td>
  202. <td class="paramname"><em>...</em></td><td>)</td>
  203. <td></td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <p>Get the width and height of the control. </p><dl class="section return"><dt>Returns</dt><dd>The height and width as a string with space-separated integers </dd></dl>
  208. </div>
  209. </div>
  210. <a id="afe6fe960cf56f2572d869cb35a94af15" name="afe6fe960cf56f2572d869cb35a94af15"></a>
  211. <h2 class="memtitle"><span class="permalink"><a href="#afe6fe960cf56f2572d869cb35a94af15">&#9670;&#160;</a></span>getGlobalCenter()</h2>
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getGlobalCenter </td>
  217. <td>(</td>
  218. <td class="paramname"></td><td>)</td>
  219. <td></td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <dl class="section return"><dt>Returns</dt><dd>Returns center of control, as space seperated ints </dd></dl>
  224. </div>
  225. </div>
  226. <a id="abf4c88928ff0639d87005959f1cd075e" name="abf4c88928ff0639d87005959f1cd075e"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#abf4c88928ff0639d87005959f1cd075e">&#9670;&#160;</a></span>getGlobalPosition()</h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getGlobalPosition </td>
  233. <td>(</td>
  234. <td class="paramname"></td><td>)</td>
  235. <td></td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <dl class="section return"><dt>Returns</dt><dd>Returns the control's position converted to global coordinates (position as space-separted integers) </dd></dl>
  240. </div>
  241. </div>
  242. <a id="a7200f6d1e76e582fdb7d2163e52b0d7a" name="a7200f6d1e76e582fdb7d2163e52b0d7a"></a>
  243. <h2 class="memtitle"><span class="permalink"><a href="#a7200f6d1e76e582fdb7d2163e52b0d7a">&#9670;&#160;</a></span>getMinExtent()</h2>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getMinExtent </td>
  249. <td>(</td>
  250. <td class="paramname"></td><td>)</td>
  251. <td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Get the minimum allowed size of the control. </p><dl class="section return"><dt>Returns</dt><dd>Returns the minimum extent as a string with space separated point values &lt;width&gt; &lt;height&gt; </dd></dl>
  256. </div>
  257. </div>
  258. <a id="a93311cced3fcabc401afdc846bc1b3b6" name="a93311cced3fcabc401afdc846bc1b3b6"></a>
  259. <h2 class="memtitle"><span class="permalink"><a href="#a93311cced3fcabc401afdc846bc1b3b6">&#9670;&#160;</a></span>getParent()</h2>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getParent </td>
  265. <td>(</td>
  266. <td class="paramname"></td><td>)</td>
  267. <td></td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <dl class="section return"><dt>Returns</dt><dd>Returns the Id of the parent control </dd></dl>
  272. </div>
  273. </div>
  274. <a id="a0cc8e3fc4543d86236287679ed5be652" name="a0cc8e3fc4543d86236287679ed5be652"></a>
  275. <h2 class="memtitle"><span class="permalink"><a href="#a0cc8e3fc4543d86236287679ed5be652">&#9670;&#160;</a></span>getPosition()</h2>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getPosition </td>
  281. <td>(</td>
  282. <td class="paramname"></td><td>)</td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <dl class="section return"><dt>Returns</dt><dd>A string set up as &lt;pos.x&gt; &lt;pos.y&gt;\ </dd></dl>
  288. </div>
  289. </div>
  290. <a id="afab766445043570e6a82c14851366933" name="afab766445043570e6a82c14851366933"></a>
  291. <h2 class="memtitle"><span class="permalink"><a href="#afab766445043570e6a82c14851366933">&#9670;&#160;</a></span>getText()</h2>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="memname">
  295. <tr>
  296. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getText </td>
  297. <td>(</td>
  298. <td class="paramname"></td><td>)</td>
  299. <td></td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>returns the text of the control. </p>
  304. </div>
  305. </div>
  306. <a id="aaa26252d86c2ce51bf0396ca64d70aed" name="aaa26252d86c2ce51bf0396ca64d70aed"></a>
  307. <h2 class="memtitle"><span class="permalink"><a href="#aaa26252d86c2ce51bf0396ca64d70aed">&#9670;&#160;</a></span>getTextExtend()</h2>
  308. <div class="memitem">
  309. <div class="memproto">
  310. <table class="memname">
  311. <tr>
  312. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getTextExtend </td>
  313. <td>(</td>
  314. <td class="paramname"></td><td>)</td>
  315. <td></td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>Returns if text extend is on. </p><dl class="section return"><dt>Returns</dt><dd>Returns the state of text extend. </dd></dl>
  320. </div>
  321. </div>
  322. <a id="af3cb252caff861f28e5201d3523b7b34" name="af3cb252caff861f28e5201d3523b7b34"></a>
  323. <h2 class="memtitle"><span class="permalink"><a href="#af3cb252caff861f28e5201d3523b7b34">&#9670;&#160;</a></span>getTextWrap()</h2>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getTextWrap </td>
  329. <td>(</td>
  330. <td class="paramname"></td><td>)</td>
  331. <td></td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <p>Returns if text wrap is on. </p><dl class="section return"><dt>Returns</dt><dd>Returns the state of text wrap. </dd></dl>
  336. </div>
  337. </div>
  338. <a id="a574b29843fb09dff2bf8edd82341f051" name="a574b29843fb09dff2bf8edd82341f051"></a>
  339. <h2 class="memtitle"><span class="permalink"><a href="#a574b29843fb09dff2bf8edd82341f051">&#9670;&#160;</a></span>getValue()</h2>
  340. <div class="memitem">
  341. <div class="memproto">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getValue </td>
  345. <td>(</td>
  346. <td class="paramname"></td><td>)</td>
  347. <td></td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. <p>Use the getValue method to get the control-specific 'value' for this control. </p><dl class="section return"><dt>Returns</dt><dd>Returns a control-specific specific value. Varies by control </dd></dl>
  352. </div>
  353. </div>
  354. <a id="aea5d649c3c9c8380b9cc22486dc05fae" name="aea5d649c3c9c8380b9cc22486dc05fae"></a>
  355. <h2 class="memtitle"><span class="permalink"><a href="#aea5d649c3c9c8380b9cc22486dc05fae">&#9670;&#160;</a></span>isActive()</h2>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isActive </td>
  361. <td>(</td>
  362. <td class="paramname"></td><td>)</td>
  363. <td></td>
  364. </tr>
  365. </table>
  366. </div><div class="memdoc">
  367. <p>Use the isActive method to determine if this control is active. An inactive control may be visible, but will not accept inputs. It will also normally re-shade or re-skin itself to reflect its inactive state </p><dl class="section return"><dt>Returns</dt><dd>Returns true if this control is active. </dd></dl>
  368. </div>
  369. </div>
  370. <a id="aefffd8942bc2da8487e4d5e47516bbd8" name="aefffd8942bc2da8487e4d5e47516bbd8"></a>
  371. <h2 class="memtitle"><span class="permalink"><a href="#aefffd8942bc2da8487e4d5e47516bbd8">&#9670;&#160;</a></span>isAwake()</h2>
  372. <div class="memitem">
  373. <div class="memproto">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isAwake </td>
  377. <td>(</td>
  378. <td class="paramname"></td><td>)</td>
  379. <td></td>
  380. </tr>
  381. </table>
  382. </div><div class="memdoc">
  383. <p>Use the isAwake method to determine if this control is awake. </p><dl class="section return"><dt>Returns</dt><dd>Returns true if this control is awake and ready to display </dd></dl>
  384. </div>
  385. </div>
  386. <a id="ab57d4e846b3cbeedf99356a0d4e4fd87" name="ab57d4e846b3cbeedf99356a0d4e4fd87"></a>
  387. <h2 class="memtitle"><span class="permalink"><a href="#ab57d4e846b3cbeedf99356a0d4e4fd87">&#9670;&#160;</a></span>isVisible()</h2>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isVisible </td>
  393. <td>(</td>
  394. <td class="paramname"></td><td>)</td>
  395. <td></td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Use the isVisible method to determine if this control is visible. This can return true, even if the entire control covered by another. This merely means that the control will render if not covered </p><dl class="section return"><dt>Returns</dt><dd>Returns true if the control is visible. </dd></dl>
  400. </div>
  401. </div>
  402. <a id="a7da97bf20870fab15fc5847e71439399" name="a7da97bf20870fab15fc5847e71439399"></a>
  403. <h2 class="memtitle"><span class="permalink"><a href="#a7da97bf20870fab15fc5847e71439399">&#9670;&#160;</a></span>makeFirstResponder()</h2>
  404. <div class="memitem">
  405. <div class="memproto">
  406. <table class="memname">
  407. <tr>
  408. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> makeFirstResponder </td>
  409. <td>(</td>
  410. <td class="paramtype">isFirst&#160;</td>
  411. <td class="paramname"></td><td>)</td>
  412. <td></td>
  413. </tr>
  414. </table>
  415. </div><div class="memdoc">
  416. <p>Use the makeFirstResponder method to force this control to become the first responder. </p><dl class="params"><dt>Parameters</dt><dd>
  417. <table class="params">
  418. <tr><td class="paramname">isFirst</td><td>A boolean value. If true, then this control become first reponder and at captures inputs before all other controls, excluding dialogs above this control. </td></tr>
  419. </table>
  420. </dd>
  421. </dl>
  422. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  423. </div>
  424. </div>
  425. <a id="a505a51805f8630c17b1951b15b50a382" name="a505a51805f8630c17b1951b15b50a382"></a>
  426. <h2 class="memtitle"><span class="permalink"><a href="#a505a51805f8630c17b1951b15b50a382">&#9670;&#160;</a></span>performClick()</h2>
  427. <div class="memitem">
  428. <div class="memproto">
  429. <table class="memname">
  430. <tr>
  431. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> performClick </td>
  432. <td>(</td>
  433. <td class="paramname"></td><td>)</td>
  434. <td></td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Simulates a click on the control. </p>
  439. </div>
  440. </div>
  441. <a id="a0b7ff8d450172b5f169a2efb6cfac684" name="a0b7ff8d450172b5f169a2efb6cfac684"></a>
  442. <h2 class="memtitle"><span class="permalink"><a href="#a0b7ff8d450172b5f169a2efb6cfac684">&#9670;&#160;</a></span>pointInControl()</h2>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="memname">
  446. <tr>
  447. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> pointInControl </td>
  448. <td>(</td>
  449. <td class="paramtype">int&#160;</td>
  450. <td class="paramname"><em>x</em>, </td>
  451. </tr>
  452. <tr>
  453. <td class="paramkey"></td>
  454. <td></td>
  455. <td class="paramtype">int&#160;</td>
  456. <td class="paramname"><em>y</em>&#160;</td>
  457. </tr>
  458. <tr>
  459. <td></td>
  460. <td>)</td>
  461. <td></td><td></td>
  462. </tr>
  463. </table>
  464. </div><div class="memdoc">
  465. <p>Check if point id in the control </p><dl class="params"><dt>Parameters</dt><dd>
  466. <table class="params">
  467. <tr><td class="paramname">x</td><td>Point x coordinate in parent coords </td></tr>
  468. <tr><td class="paramname">y</td><td>Point y coordinate in parent coords </td></tr>
  469. </table>
  470. </dd>
  471. </dl>
  472. <dl class="section return"><dt>Returns</dt><dd>Returns true if the point is in the control, false otherwise </dd></dl>
  473. </div>
  474. </div>
  475. <a id="a895cc03d6f060d82263c56b1a3cac8ce" name="a895cc03d6f060d82263c56b1a3cac8ce"></a>
  476. <h2 class="memtitle"><span class="permalink"><a href="#a895cc03d6f060d82263c56b1a3cac8ce">&#9670;&#160;</a></span>reorderChild()</h2>
  477. <div class="memitem">
  478. <div class="memproto">
  479. <table class="memname">
  480. <tr>
  481. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> reorderChild </td>
  482. <td>(</td>
  483. <td class="paramtype">child1&#160;</td>
  484. <td class="paramname">, </td>
  485. </tr>
  486. <tr>
  487. <td class="paramkey"></td>
  488. <td></td>
  489. <td class="paramtype">child2&#160;</td>
  490. <td class="paramname">&#160;</td>
  491. </tr>
  492. <tr>
  493. <td></td>
  494. <td>)</td>
  495. <td></td><td></td>
  496. </tr>
  497. </table>
  498. </div><div class="memdoc">
  499. <p>uses simset reorder to push child 1 after child 2 - both must already be child controls of this control </p>
  500. </div>
  501. </div>
  502. <a id="a1c8691ea146391976a079c2dbe32d98f" name="a1c8691ea146391976a079c2dbe32d98f"></a>
  503. <h2 class="memtitle"><span class="permalink"><a href="#a1c8691ea146391976a079c2dbe32d98f">&#9670;&#160;</a></span>resize()</h2>
  504. <div class="memitem">
  505. <div class="memproto">
  506. <table class="memname">
  507. <tr>
  508. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> resize </td>
  509. <td>(</td>
  510. <td class="paramtype">int&#160;</td>
  511. <td class="paramname"><em>x</em>, </td>
  512. </tr>
  513. <tr>
  514. <td class="paramkey"></td>
  515. <td></td>
  516. <td class="paramtype">int&#160;</td>
  517. <td class="paramname"><em>y</em>, </td>
  518. </tr>
  519. <tr>
  520. <td class="paramkey"></td>
  521. <td></td>
  522. <td class="paramtype">int&#160;</td>
  523. <td class="paramname"><em>w</em>, </td>
  524. </tr>
  525. <tr>
  526. <td class="paramkey"></td>
  527. <td></td>
  528. <td class="paramtype">int&#160;</td>
  529. <td class="paramname"><em>h</em>&#160;</td>
  530. </tr>
  531. <tr>
  532. <td></td>
  533. <td>)</td>
  534. <td></td><td></td>
  535. </tr>
  536. </table>
  537. </div><div class="memdoc">
  538. <p>Resizes the control to the given dimensions </p>
  539. </div>
  540. </div>
  541. <a id="a8f28561f4fe9f2f8ba30ecb8ad586c6d" name="a8f28561f4fe9f2f8ba30ecb8ad586c6d"></a>
  542. <h2 class="memtitle"><span class="permalink"><a href="#a8f28561f4fe9f2f8ba30ecb8ad586c6d">&#9670;&#160;</a></span>setActive()</h2>
  543. <div class="memitem">
  544. <div class="memproto">
  545. <table class="memname">
  546. <tr>
  547. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setActive </td>
  548. <td>(</td>
  549. <td class="paramtype"><a class="el" href="classGuiControl.html#aea5d649c3c9c8380b9cc22486dc05fae">isActive</a>&#160;</td>
  550. <td class="paramname"></td><td>)</td>
  551. <td></td>
  552. </tr>
  553. </table>
  554. </div><div class="memdoc">
  555. <p>Use the setActive method to (de)activate this control. Once active, a control can accept inputs. Controls automatically re-shade/skin themselves to reflect their active/inactive state. </p><dl class="params"><dt>Parameters</dt><dd>
  556. <table class="params">
  557. <tr><td class="paramname">isActive</td><td>A boolean value. If isActive is true, this control is activated, else it is set to inactive. </td></tr>
  558. </table>
  559. </dd>
  560. </dl>
  561. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  562. </div>
  563. </div>
  564. <a id="ae96a357d63d095bace0284f579edb993" name="ae96a357d63d095bace0284f579edb993"></a>
  565. <h2 class="memtitle"><span class="permalink"><a href="#ae96a357d63d095bace0284f579edb993">&#9670;&#160;</a></span>setCanSave()</h2>
  566. <div class="memitem">
  567. <div class="memproto">
  568. <table class="memname">
  569. <tr>
  570. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setCanSave </td>
  571. <td>(</td>
  572. <td class="paramtype">bool&#160;</td>
  573. <td class="paramname"><em>canSave</em></td><td>)</td>
  574. <td></td>
  575. </tr>
  576. </table>
  577. </div><div class="memdoc">
  578. <p>Sets whether this control can serialize itself to the hard disk </p><dl class="params"><dt>Parameters</dt><dd>
  579. <table class="params">
  580. <tr><td class="paramname">Flag</td><td>setting </td></tr>
  581. </table>
  582. </dd>
  583. </dl>
  584. <dl class="section return"><dt>Returns</dt><dd>No Return Value </dd></dl>
  585. </div>
  586. </div>
  587. <a id="aa964464577a29d704e5fb091ebec0807" name="aa964464577a29d704e5fb091ebec0807"></a>
  588. <h2 class="memtitle"><span class="permalink"><a href="#aa964464577a29d704e5fb091ebec0807">&#9670;&#160;</a></span>setCenter()</h2>
  589. <div class="memitem">
  590. <div class="memproto">
  591. <table class="memname">
  592. <tr>
  593. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setCenter </td>
  594. <td>(</td>
  595. <td class="paramtype">int&#160;</td>
  596. <td class="paramname"><em>x</em>, </td>
  597. </tr>
  598. <tr>
  599. <td class="paramkey"></td>
  600. <td></td>
  601. <td class="paramtype">int&#160;</td>
  602. <td class="paramname"><em>y</em>&#160;</td>
  603. </tr>
  604. <tr>
  605. <td></td>
  606. <td>)</td>
  607. <td></td><td></td>
  608. </tr>
  609. </table>
  610. </div><div class="memdoc">
  611. <p>Sets control position, by center - coords are local not global </p><dl class="section return"><dt>Returns</dt><dd>No Return value. </dd></dl>
  612. </div>
  613. </div>
  614. <a id="ae02549eb9fb23ba73889e6f7c545e2c0" name="ae02549eb9fb23ba73889e6f7c545e2c0"></a>
  615. <h2 class="memtitle"><span class="permalink"><a href="#ae02549eb9fb23ba73889e6f7c545e2c0">&#9670;&#160;</a></span>setExtent()</h2>
  616. <div class="memitem">
  617. <div class="memproto">
  618. <table class="memname">
  619. <tr>
  620. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setExtent </td>
  621. <td>(</td>
  622. <td class="paramtype">int&#160;</td>
  623. <td class="paramname"><em>width</em>, </td>
  624. </tr>
  625. <tr>
  626. <td class="paramkey"></td>
  627. <td></td>
  628. <td class="paramtype">int&#160;</td>
  629. <td class="paramname"><em>height</em>&#160;</td>
  630. </tr>
  631. <tr>
  632. <td></td>
  633. <td>)</td>
  634. <td></td><td></td>
  635. </tr>
  636. </table>
  637. </div><div class="memdoc">
  638. <p>Sets the width &amp; height of the control. </p><dl class="section return"><dt>Returns</dt><dd>No Return Value. </dd></dl>
  639. </div>
  640. </div>
  641. <a id="a027d7313dfaca48ac22f8d0fef1d3c73" name="a027d7313dfaca48ac22f8d0fef1d3c73"></a>
  642. <h2 class="memtitle"><span class="permalink"><a href="#a027d7313dfaca48ac22f8d0fef1d3c73">&#9670;&#160;</a></span>setFirstResponder()</h2>
  643. <div class="memitem">
  644. <div class="memproto">
  645. <table class="memname">
  646. <tr>
  647. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setFirstResponder </td>
  648. <td>(</td>
  649. <td class="paramname"></td><td>)</td>
  650. <td></td>
  651. </tr>
  652. </table>
  653. </div><div class="memdoc">
  654. <p>Sets this control as the first responder </p>
  655. </div>
  656. </div>
  657. <a id="ad6c107fadf835c74a229f8cac0cc98ab" name="ad6c107fadf835c74a229f8cac0cc98ab"></a>
  658. <h2 class="memtitle"><span class="permalink"><a href="#ad6c107fadf835c74a229f8cac0cc98ab">&#9670;&#160;</a></span>setPosition()</h2>
  659. <div class="memitem">
  660. <div class="memproto">
  661. <table class="memname">
  662. <tr>
  663. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setPosition </td>
  664. <td>(</td>
  665. <td class="paramtype">int&#160;</td>
  666. <td class="paramname"><em>x</em>, </td>
  667. </tr>
  668. <tr>
  669. <td class="paramkey"></td>
  670. <td></td>
  671. <td class="paramtype">int&#160;</td>
  672. <td class="paramname"><em>y</em>&#160;</td>
  673. </tr>
  674. <tr>
  675. <td></td>
  676. <td>)</td>
  677. <td></td><td></td>
  678. </tr>
  679. </table>
  680. </div><div class="memdoc">
  681. <p>Sets the current control position in local space </p><dl class="section return"><dt>Returns</dt><dd>No Return Value. </dd></dl>
  682. </div>
  683. </div>
  684. <a id="a98098c5cbd63eeb7885723b1266822e2" name="a98098c5cbd63eeb7885723b1266822e2"></a>
  685. <h2 class="memtitle"><span class="permalink"><a href="#a98098c5cbd63eeb7885723b1266822e2">&#9670;&#160;</a></span>setPositionGlobal()</h2>
  686. <div class="memitem">
  687. <div class="memproto">
  688. <table class="memname">
  689. <tr>
  690. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setPositionGlobal </td>
  691. <td>(</td>
  692. <td class="paramtype">int&#160;</td>
  693. <td class="paramname"><em>x</em>, </td>
  694. </tr>
  695. <tr>
  696. <td class="paramkey"></td>
  697. <td></td>
  698. <td class="paramtype">int&#160;</td>
  699. <td class="paramname"><em>y</em>&#160;</td>
  700. </tr>
  701. <tr>
  702. <td></td>
  703. <td>)</td>
  704. <td></td><td></td>
  705. </tr>
  706. </table>
  707. </div><div class="memdoc">
  708. <p>Sets the control's position in global space </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  709. </div>
  710. </div>
  711. <a id="ae285a02aa287b0fc1c6dd25af891ca93" name="ae285a02aa287b0fc1c6dd25af891ca93"></a>
  712. <h2 class="memtitle"><span class="permalink"><a href="#ae285a02aa287b0fc1c6dd25af891ca93">&#9670;&#160;</a></span>setProfile()</h2>
  713. <div class="memitem">
  714. <div class="memproto">
  715. <table class="memname">
  716. <tr>
  717. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setProfile </td>
  718. <td>(</td>
  719. <td class="paramtype">GuiControlProfile&#160;</td>
  720. <td class="paramname"><em>p</em></td><td>)</td>
  721. <td></td>
  722. </tr>
  723. </table>
  724. </div><div class="memdoc">
  725. <p>Sets the currently used from for the <a class="el" href="classGuiControl.html">GuiControl</a> </p><dl class="params"><dt>Parameters</dt><dd>
  726. <table class="params">
  727. <tr><td class="paramname">p</td><td>The profile you wish to set the control to use </td></tr>
  728. </table>
  729. </dd>
  730. </dl>
  731. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  732. </div>
  733. </div>
  734. <a id="a322803a0b6092a7f432517e3bbd6e614" name="a322803a0b6092a7f432517e3bbd6e614"></a>
  735. <h2 class="memtitle"><span class="permalink"><a href="#a322803a0b6092a7f432517e3bbd6e614">&#9670;&#160;</a></span>setText()</h2>
  736. <div class="memitem">
  737. <div class="memproto">
  738. <table class="memname">
  739. <tr>
  740. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setText </td>
  741. <td>(</td>
  742. <td class="paramtype">text&#160;</td>
  743. <td class="paramname"></td><td>)</td>
  744. <td></td>
  745. </tr>
  746. </table>
  747. </div><div class="memdoc">
  748. <p>Sets the text of the control to the string. </p>
  749. </div>
  750. </div>
  751. <a id="af1cca41bf7d04decc73b99c1befbbac2" name="af1cca41bf7d04decc73b99c1befbbac2"></a>
  752. <h2 class="memtitle"><span class="permalink"><a href="#af1cca41bf7d04decc73b99c1befbbac2">&#9670;&#160;</a></span>setTextExtend()</h2>
  753. <div class="memitem">
  754. <div class="memproto">
  755. <table class="memname">
  756. <tr>
  757. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setTextExtend </td>
  758. <td>(</td>
  759. <td class="paramtype">setting&#160;</td>
  760. <td class="paramname"></td><td>)</td>
  761. <td></td>
  762. </tr>
  763. </table>
  764. </div><div class="memdoc">
  765. <p>Turns on or off text Extend. </p><dl class="params"><dt>Parameters</dt><dd>
  766. <table class="params">
  767. <tr><td class="paramname">setting</td><td>True turns on text extend. </td></tr>
  768. </table>
  769. </dd>
  770. </dl>
  771. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  772. </div>
  773. </div>
  774. <a id="abf0c06f0453bde4f0f9ed7682dedbb93" name="abf0c06f0453bde4f0f9ed7682dedbb93"></a>
  775. <h2 class="memtitle"><span class="permalink"><a href="#abf0c06f0453bde4f0f9ed7682dedbb93">&#9670;&#160;</a></span>setTextID()</h2>
  776. <div class="memitem">
  777. <div class="memproto">
  778. <table class="memname">
  779. <tr>
  780. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setTextID </td>
  781. <td>(</td>
  782. <td class="paramtype">id&#160;</td>
  783. <td class="paramname"></td><td>)</td>
  784. <td></td>
  785. </tr>
  786. </table>
  787. </div><div class="memdoc">
  788. <p>Sets the text of the control to the localized string. </p>
  789. </div>
  790. </div>
  791. <a id="aef0aa14a4c602deede303ce92f7d7610" name="aef0aa14a4c602deede303ce92f7d7610"></a>
  792. <h2 class="memtitle"><span class="permalink"><a href="#aef0aa14a4c602deede303ce92f7d7610">&#9670;&#160;</a></span>setTextWrap()</h2>
  793. <div class="memitem">
  794. <div class="memproto">
  795. <table class="memname">
  796. <tr>
  797. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setTextWrap </td>
  798. <td>(</td>
  799. <td class="paramtype">setting&#160;</td>
  800. <td class="paramname"></td><td>)</td>
  801. <td></td>
  802. </tr>
  803. </table>
  804. </div><div class="memdoc">
  805. <p>Turns on or off text wrap. </p><dl class="params"><dt>Parameters</dt><dd>
  806. <table class="params">
  807. <tr><td class="paramname">setting</td><td>True turns on text wrap. </td></tr>
  808. </table>
  809. </dd>
  810. </dl>
  811. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  812. </div>
  813. </div>
  814. <a id="a85de7207005ddac355bc228383053fc7" name="a85de7207005ddac355bc228383053fc7"></a>
  815. <h2 class="memtitle"><span class="permalink"><a href="#a85de7207005ddac355bc228383053fc7">&#9670;&#160;</a></span>setValue()</h2>
  816. <div class="memitem">
  817. <div class="memproto">
  818. <table class="memname">
  819. <tr>
  820. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setValue </td>
  821. <td>(</td>
  822. <td class="paramtype">value&#160;</td>
  823. <td class="paramname"></td><td>)</td>
  824. <td></td>
  825. </tr>
  826. </table>
  827. </div><div class="memdoc">
  828. <p>Use the setValue method to set the control specific value to value. Purpose and type varies by control type. </p><dl class="params"><dt>Parameters</dt><dd>
  829. <table class="params">
  830. <tr><td class="paramname">value</td><td>Some control specific value. </td></tr>
  831. </table>
  832. </dd>
  833. </dl>
  834. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  835. </div>
  836. </div>
  837. <a id="af205cf4b7908a58b75b2bbf0ea41b100" name="af205cf4b7908a58b75b2bbf0ea41b100"></a>
  838. <h2 class="memtitle"><span class="permalink"><a href="#af205cf4b7908a58b75b2bbf0ea41b100">&#9670;&#160;</a></span>setVisible()</h2>
  839. <div class="memitem">
  840. <div class="memproto">
  841. <table class="memname">
  842. <tr>
  843. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setVisible </td>
  844. <td>(</td>
  845. <td class="paramtype"><a class="el" href="classGuiControl.html#ab57d4e846b3cbeedf99356a0d4e4fd87">isVisible</a>&#160;</td>
  846. <td class="paramname"></td><td>)</td>
  847. <td></td>
  848. </tr>
  849. </table>
  850. </div><div class="memdoc">
  851. <p>Use the setVisible method to (un)hide this control. </p><dl class="params"><dt>Parameters</dt><dd>
  852. <table class="params">
  853. <tr><td class="paramname">isVisible</td><td>A boolean value. If true, the control will be made visible, otherwise the control will be hidden. </td></tr>
  854. </table>
  855. </dd>
  856. </dl>
  857. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  858. </div>
  859. </div>
  860. </div><!-- contents -->
  861. <!-- start footer part -->
  862. <hr class="footer"/><address class="footer"><small>
  863. 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
  864. </small></address>
  865. </body>
  866. </html>