| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.3.1"/>
- <title>TorqueScript Reference: GuiCanvas Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="classGuiCanvas-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">GuiCanvas Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Inherits <a class="el" href="classGuiControl.html">GuiControl</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a64b07a262cc429c9d45cf39f239c6c35"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a64b07a262cc429c9d45cf39f239c6c35">cursorOff</a> ()</td></tr>
- <tr class="separator:a64b07a262cc429c9d45cf39f239c6c35"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa757b5f3c22eff72288ba049eab34ed1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#aa757b5f3c22eff72288ba049eab34ed1">cursorOn</a> ()</td></tr>
- <tr class="separator:aa757b5f3c22eff72288ba049eab34ed1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a94f091f2112f16749e972330299f2554"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a94f091f2112f16749e972330299f2554">getBackgroundColor</a> (...)</td></tr>
- <tr class="separator:a94f091f2112f16749e972330299f2554"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af502596f1859f2abce33770ad9101512"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#af502596f1859f2abce33770ad9101512">getContent</a> ()</td></tr>
- <tr class="separator:af502596f1859f2abce33770ad9101512"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a411c7297210a54ab69c75278db8a11bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a411c7297210a54ab69c75278db8a11bf">getCursorPos</a> ()</td></tr>
- <tr class="separator:a411c7297210a54ab69c75278db8a11bf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a83cab1eba647a8757f3636f91a8faa0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a83cab1eba647a8757f3636f91a8faa0d">getMouseControl</a> ()</td></tr>
- <tr class="separator:a83cab1eba647a8757f3636f91a8faa0d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9ac5f4177566cb90111ba5056bd8603f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a9ac5f4177566cb90111ba5056bd8603f">getUseBackgroundColor</a> (...)</td></tr>
- <tr class="separator:a9ac5f4177566cb90111ba5056bd8603f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab3108839b75614c3c5e93409e187732e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ab3108839b75614c3c5e93409e187732e">hideCursor</a> ()</td></tr>
- <tr class="separator:ab3108839b75614c3c5e93409e187732e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a803215fa18ca4506a55aac400bb9488d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a803215fa18ca4506a55aac400bb9488d">isCursorOn</a> ()</td></tr>
- <tr class="separator:a803215fa18ca4506a55aac400bb9488d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a95022c396df6b951276ec7e164900466"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a95022c396df6b951276ec7e164900466">popDialog</a> (handle)</td></tr>
- <tr class="separator:a95022c396df6b951276ec7e164900466"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8a917bb8ea6e5970a887b1291efcbfb5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a8a917bb8ea6e5970a887b1291efcbfb5">popLayer</a> (layer)</td></tr>
- <tr class="separator:a8a917bb8ea6e5970a887b1291efcbfb5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae3f4285cd6aa7a65a0adaff55d138ceb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ae3f4285cd6aa7a65a0adaff55d138ceb">pushDialog</a> (handle[, layer])</td></tr>
- <tr class="separator:ae3f4285cd6aa7a65a0adaff55d138ceb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a566282c49958139882ff8068c1d3ea50"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a566282c49958139882ff8068c1d3ea50">renderFront</a> (bool enable)</td></tr>
- <tr class="separator:a566282c49958139882ff8068c1d3ea50"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac827b978aa122f136a14c198687ad80f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ac827b978aa122f136a14c198687ad80f">repaint</a> ()</td></tr>
- <tr class="separator:ac827b978aa122f136a14c198687ad80f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad20897c5c8bd47f5d4005989bead0e55"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
- <tr class="separator:ad20897c5c8bd47f5d4005989bead0e55"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5768dc3012f2d8ca162387dd8af738d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a5768dc3012f2d8ca162387dd8af738d9">setBackgroundColor</a> (float red, float green, float blue,[float alpha=1.0])</td></tr>
- <tr class="separator:a5768dc3012f2d8ca162387dd8af738d9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad44ea8ffb2b28e5e15b62fa109f045cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ad44ea8ffb2b28e5e15b62fa109f045cb">setContent</a> (handle)</td></tr>
- <tr class="separator:ad44ea8ffb2b28e5e15b62fa109f045cb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7e7ac249b0968d3a584cdb6e977019c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a7e7ac249b0968d3a584cdb6e977019c5">setCursor</a> (cursorHandle)</td></tr>
- <tr class="separator:a7e7ac249b0968d3a584cdb6e977019c5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0a1c00269a5da1001689a609dd105fa5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a0a1c00269a5da1001689a609dd105fa5">setCursorPos</a> ()</td></tr>
- <tr class="separator:a0a1c00269a5da1001689a609dd105fa5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9c45cb3718256770fb91160f6190c123"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a9c45cb3718256770fb91160f6190c123">setDoubleClickDelay</a> ()</td></tr>
- <tr class="separator:a9c45cb3718256770fb91160f6190c123"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a844ae18610873efc52cfcdc1ef5d43a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#a844ae18610873efc52cfcdc1ef5d43a7">setDoubleClickMoveBuffer</a> ()</td></tr>
- <tr class="separator:a844ae18610873efc52cfcdc1ef5d43a7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:add8f202c1c9216c297ca9303647c832d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#add8f202c1c9216c297ca9303647c832d">setUseBackgroundColor</a> (...)</td></tr>
- <tr class="separator:add8f202c1c9216c297ca9303647c832d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad84ea3ef3bfa8f70f3c8d28a56423a22"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiCanvas.html#ad84ea3ef3bfa8f70f3c8d28a56423a22">showCursor</a> ()</td></tr>
- <tr class="separator:ad84ea3ef3bfa8f70f3c8d28a56423a22"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classGuiControl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classGuiControl')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classGuiControl.html">GuiControl</a></td></tr>
- <tr class="memitem:af286d6a5582d8a0457f5e1c3436ef76d inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#af286d6a5582d8a0457f5e1c3436ef76d">addGuiControl</a> (int controlId)</td></tr>
- <tr class="separator:af286d6a5582d8a0457f5e1c3436ef76d inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acc8d4330cd289e30b039d62f2e83dd94 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#acc8d4330cd289e30b039d62f2e83dd94">findHitControl</a> (int x, int y)</td></tr>
- <tr class="separator:acc8d4330cd289e30b039d62f2e83dd94 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a154e102ba3f65bebd68161dbba397089 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a154e102ba3f65bebd68161dbba397089">getCenter</a> ()</td></tr>
- <tr class="separator:a154e102ba3f65bebd68161dbba397089 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae82815e20c56ea6d156f96d4da8674c1 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ae82815e20c56ea6d156f96d4da8674c1">getExtent</a> (...)</td></tr>
- <tr class="separator:ae82815e20c56ea6d156f96d4da8674c1 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afe6fe960cf56f2572d869cb35a94af15 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#afe6fe960cf56f2572d869cb35a94af15">getGlobalCenter</a> ()</td></tr>
- <tr class="separator:afe6fe960cf56f2572d869cb35a94af15 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abf4c88928ff0639d87005959f1cd075e inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#abf4c88928ff0639d87005959f1cd075e">getGlobalPosition</a> ()</td></tr>
- <tr class="separator:abf4c88928ff0639d87005959f1cd075e inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7200f6d1e76e582fdb7d2163e52b0d7a inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a7200f6d1e76e582fdb7d2163e52b0d7a">getMinExtent</a> ()</td></tr>
- <tr class="separator:a7200f6d1e76e582fdb7d2163e52b0d7a inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a93311cced3fcabc401afdc846bc1b3b6 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a93311cced3fcabc401afdc846bc1b3b6">getParent</a> ()</td></tr>
- <tr class="separator:a93311cced3fcabc401afdc846bc1b3b6 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0cc8e3fc4543d86236287679ed5be652 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a0cc8e3fc4543d86236287679ed5be652">getPosition</a> ()</td></tr>
- <tr class="separator:a0cc8e3fc4543d86236287679ed5be652 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a574b29843fb09dff2bf8edd82341f051 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a574b29843fb09dff2bf8edd82341f051">getValue</a> ()</td></tr>
- <tr class="separator:a574b29843fb09dff2bf8edd82341f051 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea5d649c3c9c8380b9cc22486dc05fae inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#aea5d649c3c9c8380b9cc22486dc05fae">isActive</a> ()</td></tr>
- <tr class="separator:aea5d649c3c9c8380b9cc22486dc05fae inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aefffd8942bc2da8487e4d5e47516bbd8 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#aefffd8942bc2da8487e4d5e47516bbd8">isAwake</a> ()</td></tr>
- <tr class="separator:aefffd8942bc2da8487e4d5e47516bbd8 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab57d4e846b3cbeedf99356a0d4e4fd87 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ab57d4e846b3cbeedf99356a0d4e4fd87">isVisible</a> ()</td></tr>
- <tr class="separator:ab57d4e846b3cbeedf99356a0d4e4fd87 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7da97bf20870fab15fc5847e71439399 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a7da97bf20870fab15fc5847e71439399">makeFirstResponder</a> (isFirst)</td></tr>
- <tr class="separator:a7da97bf20870fab15fc5847e71439399 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0b7ff8d450172b5f169a2efb6cfac684 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a0b7ff8d450172b5f169a2efb6cfac684">pointInControl</a> (int x, int y)</td></tr>
- <tr class="separator:a0b7ff8d450172b5f169a2efb6cfac684 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a895cc03d6f060d82263c56b1a3cac8ce inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a895cc03d6f060d82263c56b1a3cac8ce">reorderChild</a> (child1, child2)</td></tr>
- <tr class="separator:a895cc03d6f060d82263c56b1a3cac8ce inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1c8691ea146391976a079c2dbe32d98f inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:a1c8691ea146391976a079c2dbe32d98f inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8f28561f4fe9f2f8ba30ecb8ad586c6d inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:a8f28561f4fe9f2f8ba30ecb8ad586c6d inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae96a357d63d095bace0284f579edb993 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ae96a357d63d095bace0284f579edb993">setCanSave</a> (bool canSave)</td></tr>
- <tr class="separator:ae96a357d63d095bace0284f579edb993 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa964464577a29d704e5fb091ebec0807 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#aa964464577a29d704e5fb091ebec0807">setCenter</a> (int x, int y)</td></tr>
- <tr class="separator:aa964464577a29d704e5fb091ebec0807 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae02549eb9fb23ba73889e6f7c545e2c0 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ae02549eb9fb23ba73889e6f7c545e2c0">setExtent</a> (int width, int height)</td></tr>
- <tr class="separator:ae02549eb9fb23ba73889e6f7c545e2c0 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a027d7313dfaca48ac22f8d0fef1d3c73 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a027d7313dfaca48ac22f8d0fef1d3c73">setFirstResponder</a> ()</td></tr>
- <tr class="separator:a027d7313dfaca48ac22f8d0fef1d3c73 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad6c107fadf835c74a229f8cac0cc98ab inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ad6c107fadf835c74a229f8cac0cc98ab">setPosition</a> (int x, int y)</td></tr>
- <tr class="separator:ad6c107fadf835c74a229f8cac0cc98ab inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a98098c5cbd63eeb7885723b1266822e2 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a98098c5cbd63eeb7885723b1266822e2">setPositionGlobal</a> (int x, int y)</td></tr>
- <tr class="separator:a98098c5cbd63eeb7885723b1266822e2 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae285a02aa287b0fc1c6dd25af891ca93 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#ae285a02aa287b0fc1c6dd25af891ca93">setProfile</a> (GuiControlProfile p)</td></tr>
- <tr class="separator:ae285a02aa287b0fc1c6dd25af891ca93 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85de7207005ddac355bc228383053fc7 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGuiControl.html#a85de7207005ddac355bc228383053fc7">setValue</a> (value)</td></tr>
- <tr class="separator:a85de7207005ddac355bc228383053fc7 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af205cf4b7908a58b75b2bbf0ea41b100 inherit pub_methods_classGuiControl"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:af205cf4b7908a58b75b2bbf0ea41b100 inherit pub_methods_classGuiControl"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="a64b07a262cc429c9d45cf39f239c6c35"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void cursorOff </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the cursorOff method to disable the cursor. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aa757b5f3c22eff72288ba049eab34ed1"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void cursorOn </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the cursorOn method to enable the cursor. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a94f091f2112f16749e972330299f2554"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getBackgroundColor </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>...</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="af502596f1859f2abce33770ad9101512"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getContent </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a411c7297210a54ab69c75278db8a11bf"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getCursorPos </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a83cab1eba647a8757f3636f91a8faa0d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getMouseControl </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the gui control under the mouse. </p>
- </div>
- </div>
- <a class="anchor" id="a9ac5f4177566cb90111ba5056bd8603f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getUseBackgroundColor </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>...</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="ab3108839b75614c3c5e93409e187732e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void hideCursor </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a803215fa18ca4506a55aac400bb9488d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isCursorOn </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a95022c396df6b951276ec7e164900466"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void popDialog </td>
- <td>(</td>
- <td class="paramtype">handle </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">handle</td><td>The ID or a previously pushed dialog. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a8a917bb8ea6e5970a887b1291efcbfb5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void popLayer </td>
- <td>(</td>
- <td class="paramtype">layer </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the popLayer method to remove (close) all dialogs in the specified canvas ???layer???. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">layer</td><td>A integer value in the range [ 0 , inf ) specifying the canvas layer to clear. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ae3f4285cd6aa7a65a0adaff55d138ceb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void pushDialog </td>
- <td>(</td>
- <td class="paramtype">handle </td>
- <td class="paramname">[, layer]</td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">handle</td><td>The numeric ID or name of the dialog to be opened. </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a566282c49958139882ff8068c1d3ea50"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void renderFront </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>enable</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="ac827b978aa122f136a14c198687ad80f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void repaint </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="ad20897c5c8bd47f5d4005989bead0e55"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void reset </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a5768dc3012f2d8ca162387dd8af738d9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setBackgroundColor </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>red</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>green</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>blue</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the background color for the canvas. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">red</td><td>The red value. </td></tr>
- <tr><td class="paramname">green</td><td>The green value. </td></tr>
- <tr><td class="paramname">blue</td><td>The blue value. </td></tr>
- <tr><td class="paramname">alpha</td><td>The alpha value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return Value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ad44ea8ffb2b28e5e15b62fa109f045cb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setContent </td>
- <td>(</td>
- <td class="paramtype">handle </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">handle</td><td>The numeric ID or name of the control to be made the canvas contents. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a7e7ac249b0968d3a584cdb6e977019c5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setCursor </td>
- <td>(</td>
- <td class="paramtype">cursorHandle </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the setCursor method to select the current cursor. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">cursorHandle</td><td>The ID of a previously defined GuiCursor object. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a0a1c00269a5da1001689a609dd105fa5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setCursorPos </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the setCursorPos method to set the position of the cursor in the cavas. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">position</td><td>An y\ position vector specifying the new location of the cursor. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a9c45cb3718256770fb91160f6190c123"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setDoubleClickDelay </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a844ae18610873efc52cfcdc1ef5d43a7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setDoubleClickMoveBuffer </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="add8f202c1c9216c297ca9303647c832d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setUseBackgroundColor </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>...</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets whether to use the canvas background color or not. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">useBackgroundColor</td><td>Whether to use the canvas background color or not. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ad84ea3ef3bfa8f70f3c8d28a56423a22"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void showCursor </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.3.1
- </small></address>
- </body>
- </html>
|