classActionMap.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: ActionMap Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classActionMap-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">ActionMap Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58. Public Member Functions</h2></td></tr>
  59. <tr class="memitem:a22b06bd6a96d9622f9b7376c64ea31f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind</a> (device, action,[modifier, mod...], command)</td></tr>
  60. <tr class="separator:a22b06bd6a96d9622f9b7376c64ea31f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ad11f018ebdf715aadcf19e64a68d7348"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> (device, action, makeCmd, breakCmd)</td></tr>
  62. <tr class="separator:ad11f018ebdf715aadcf19e64a68d7348"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:a89e87c59b76cd52b52177050a8b3a485"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a89e87c59b76cd52b52177050a8b3a485">bindObj</a> (device, action,[modifier spec, mod...], command, object)</td></tr>
  64. <tr class="separator:a89e87c59b76cd52b52177050a8b3a485"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a436d3b101d84f700f1b6b4ce93a10ced"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a436d3b101d84f700f1b6b4ce93a10ced">getBinding</a> (command)</td></tr>
  66. <tr class="separator:a436d3b101d84f700f1b6b4ce93a10ced"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a63cd7f471fb9ef18dab60d50726c976d"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a63cd7f471fb9ef18dab60d50726c976d">getCommand</a> (device, action)</td></tr>
  68. <tr class="separator:a63cd7f471fb9ef18dab60d50726c976d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a61eb8271a483b018a6650276e4f956ab"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a61eb8271a483b018a6650276e4f956ab">getDeadZone</a> (device, action)</td></tr>
  70. <tr class="separator:a61eb8271a483b018a6650276e4f956ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:acbaf45fb05f687f1df20e195db4d11e4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#acbaf45fb05f687f1df20e195db4d11e4">getScale</a> (device, action)</td></tr>
  72. <tr class="separator:acbaf45fb05f687f1df20e195db4d11e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:aaec98a2724174b9c57ecd51741feccce"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#aaec98a2724174b9c57ecd51741feccce">isInverted</a> (device, action)</td></tr>
  74. <tr class="separator:aaec98a2724174b9c57ecd51741feccce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a312e7f6c761a199c1369fbe651e084f0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a312e7f6c761a199c1369fbe651e084f0">pop</a> ()</td></tr>
  76. <tr class="separator:a312e7f6c761a199c1369fbe651e084f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a98b45e0a7ed122b6710df00209b67827"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#a98b45e0a7ed122b6710df00209b67827">push</a> ()</td></tr>
  78. <tr class="separator:a98b45e0a7ed122b6710df00209b67827"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:aba70d852a967c89a18a2dbf4cb117927"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#aba70d852a967c89a18a2dbf4cb117927">save</a> ([<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>][, append])</td></tr>
  80. <tr class="separator:aba70d852a967c89a18a2dbf4cb117927"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:aa5d2f9815fbd6b12e9e923692d3d7c87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind</a> (device, action)</td></tr>
  82. <tr class="separator:aa5d2f9815fbd6b12e9e923692d3d7c87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:abcd284cf37de45f782dea6b79843b663"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classActionMap.html#abcd284cf37de45f782dea6b79843b663">unbindObj</a> (device, action, object)</td></tr>
  84. <tr class="separator:abcd284cf37de45f782dea6b79843b663"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  86. <tr class="memitem:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1c1f9babb145bfdf63e60223663dff3c">call</a> (functionName,[args]*)</td></tr>
  87. <tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3b4f0f3ccdfa27b8008f8559a83539bc">clone</a> ([bool copyDynamicFields?=false]?)</td></tr>
  89. <tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
  91. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
  93. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
  95. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adeaebc2111072105cbb6961df917d223">getClassName</a> ()</td></tr>
  97. <tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afbb3b5d0356df264b7343d135b697bcf">getClassNamespace</a> ()</td></tr>
  99. <tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a771f0adf4c566c3ac2f7c5c32e75d43c">getDynamicField</a> (index)</td></tr>
  101. <tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#affd866a31305bc1e70c572b2be76069b">getDynamicFieldCount</a> ()</td></tr>
  103. <tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af219f6b5498fbd8671e298303c28b1dc">getField</a> (int index)</td></tr>
  105. <tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0d14fc4334b31b14e243de86cc1609a4">getFieldCount</a> ()</td></tr>
  107. <tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6c87209e1a998d8b35e1cde74839bfcc">getFieldType</a> (fieldName)</td></tr>
  109. <tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adf03af9303912906eada72ccf10115e8">getFieldValue</a> (fieldName)</td></tr>
  111. <tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad35d7fe358fa34d2eba803c7506791f3">getGroup</a> ()</td></tr>
  113. <tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a67283be3f45257d1e0c474c563ebb6b6">getId</a> ()</td></tr>
  115. <tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a137797d39611f3f3108b30852d28622c">getInternalName</a> ()</td></tr>
  117. <tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a510119ff902e4e96165a7475370be836">getName</a> ()</td></tr>
  119. <tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa71cf6ba84b0de85019204261a9136b7">getProgenitorFile</a> ()</td></tr>
  121. <tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f693104a44b07db870d4e54f2db4c08">getSuperClassNamespace</a> ()</td></tr>
  123. <tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aec389cbe6ac7aff8ce7196e7dbc007df">getType</a> ()</td></tr>
  125. <tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af4da33de69819e293d90cf52fcbda6da">isChildOfGroup</a> ()</td></tr>
  127. <tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a35273f559aecabece437c22ee8aee443">isMemberOfClass</a> (string classname)</td></tr>
  129. <tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8a1d5ac5403526378c7abb0916c55c3c">isMethod</a> (const char *methodName)</td></tr>
  131. <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8ca0e6f21ff100da6bcd59f51d34fb8e">isMethod</a> (string method name)</td></tr>
  133. <tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9fed7ee24702928365ad45e6eaba4d12">isTimerActive</a> ()</td></tr>
  135. <tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa92c3478d4ff5780f0f027598480d772">save</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>,[selectedOnly]?)</td></tr>
  137. <tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aabc265010a7a59dcec211ddd8f0ac5a7">schedule</a> (time, command,[arg]*)</td></tr>
  139. <tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa3e15ecdee7ab3ece234913bc4e783c0">setClassNamespace</a> ()</td></tr>
  141. <tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae099b2a1810ca2e23ac11d239ae0197e">setFieldValue</a> (fieldName, value)</td></tr>
  143. <tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
  145. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
  147. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
  149. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
  151. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5447439ba5620b2ac00dc0ef97ef2142">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
  153. <tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
  155. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. </table><table class="memberdecls">
  157. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  158. Additional Inherited Members</h2></td></tr>
  159. <tr class="inherit_header pub_static_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  160. <tr class="memitem:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">static S32 QSORT_CALLBACK&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac7926551c6df020f767d8d87f5a3d575">compareFields</a> (const void *a, const void *b)</td></tr>
  161. <tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. </table>
  163. <h2 class="groupheader">Member Function Documentation</h2>
  164. <a class="anchor" id="a22b06bd6a96d9622f9b7376c64ea31f7"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">void bind </td>
  170. <td>(</td>
  171. <td class="paramtype">device&#160;</td>
  172. <td class="paramname">, </td>
  173. </tr>
  174. <tr>
  175. <td class="paramkey"></td>
  176. <td></td>
  177. <td class="paramtype">action&#160;</td>
  178. <td class="paramname">, </td>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <td class="paramtype">command&#160;</td>
  184. <td class="paramname">&#160;</td>
  185. </tr>
  186. <tr>
  187. <td></td>
  188. <td>)</td>
  189. <td></td><td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Use the bind method to associate a function to a keystroke or other device input. The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed. </p>
  194. <dl class="params"><dt>Parameters</dt><dd>
  195. <table class="params">
  196. <tr><td class="paramname">device</td><td>Name of the device to bind the command to. </td></tr>
  197. <tr><td class="paramname">action</td><td>Name of the action to watch for. </td></tr>
  198. <tr><td class="paramname">modifier</td><td>Special modifiers (mouse only), such as dead spot, etc. </td></tr>
  199. <tr><td class="paramname">command</td><td>The function to be called on make and break. </td></tr>
  200. </table>
  201. </dd>
  202. </dl>
  203. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  204. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a>, <a class="el" href="classActionMap.html#a436d3b101d84f700f1b6b4ce93a10ced">getBinding</a>, <a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind</a> </dd></dl>
  205. </div>
  206. </div>
  207. <a class="anchor" id="ad11f018ebdf715aadcf19e64a68d7348"></a>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">void bindCmd </td>
  213. <td>(</td>
  214. <td class="paramtype">device&#160;</td>
  215. <td class="paramname">, </td>
  216. </tr>
  217. <tr>
  218. <td class="paramkey"></td>
  219. <td></td>
  220. <td class="paramtype">action&#160;</td>
  221. <td class="paramname">, </td>
  222. </tr>
  223. <tr>
  224. <td class="paramkey"></td>
  225. <td></td>
  226. <td class="paramtype">makeCmd&#160;</td>
  227. <td class="paramname">, </td>
  228. </tr>
  229. <tr>
  230. <td class="paramkey"></td>
  231. <td></td>
  232. <td class="paramtype">breakCmd&#160;</td>
  233. <td class="paramname">&#160;</td>
  234. </tr>
  235. <tr>
  236. <td></td>
  237. <td>)</td>
  238. <td></td><td></td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Use the bindCmd method to associate up to two functions to a keystroke or other device input. The makeCmd is bound to the make event and the breakCmd is bound to the break event and in both cases, the commands are specified as complete scripts, with all arguments, elipses, and the terminating semi-colon. Either of these commands may be non-specified (NULL strings). For clarification, see 'Bind Sample' example below. </p>
  243. <dl class="params"><dt>Parameters</dt><dd>
  244. <table class="params">
  245. <tr><td class="paramname">device</td><td>Name of the device to bind the command to (see 'Device Table' below). </td></tr>
  246. <tr><td class="paramname">action</td><td>Name of the action to watch for(see 'Action Table' below). </td></tr>
  247. <tr><td class="paramname">makeCmd</td><td>The function to be called on make event. </td></tr>
  248. <tr><td class="paramname">breakCmd</td><td>The function to be called on break event. </td></tr>
  249. </table>
  250. </dd>
  251. </dl>
  252. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  253. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind</a>, <a class="el" href="classActionMap.html#a436d3b101d84f700f1b6b4ce93a10ced">getBinding</a>, <a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind</a> </dd></dl>
  254. </div>
  255. </div>
  256. <a class="anchor" id="a89e87c59b76cd52b52177050a8b3a485"></a>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname">void bindObj </td>
  262. <td>(</td>
  263. <td class="paramtype">device&#160;</td>
  264. <td class="paramname">, </td>
  265. </tr>
  266. <tr>
  267. <td class="paramkey"></td>
  268. <td></td>
  269. <td class="paramtype">action&#160;</td>
  270. <td class="paramname">, </td>
  271. </tr>
  272. <tr>
  273. <td class="paramkey"></td>
  274. <td></td>
  275. <td class="paramtype">command&#160;</td>
  276. <td class="paramname">, </td>
  277. </tr>
  278. <tr>
  279. <td class="paramkey"></td>
  280. <td></td>
  281. <td class="paramtype">object&#160;</td>
  282. <td class="paramname">&#160;</td>
  283. </tr>
  284. <tr>
  285. <td></td>
  286. <td>)</td>
  287. <td></td><td></td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <p>Use the bindObj method to associate a function to a keystroke or other device input. The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed. </p>
  292. <dl class="params"><dt>Parameters</dt><dd>
  293. <table class="params">
  294. <tr><td class="paramname">device</td><td>Name of the device to bind the command to. </td></tr>
  295. <tr><td class="paramname">action</td><td>Name of the action to watch for. </td></tr>
  296. <tr><td class="paramname">modifier</td><td>Special modifiers (mouse only), such as dead spot, etc. </td></tr>
  297. <tr><td class="paramname">command</td><td>The function to be called on make and break. </td></tr>
  298. <tr><td class="paramname">object</td><td>The explicit object (it defaults to NULL when you call <a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind()</a> ) </td></tr>
  299. </table>
  300. </dd>
  301. </dl>
  302. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  303. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a>, <a class="el" href="classActionMap.html#a436d3b101d84f700f1b6b4ce93a10ced">getBinding</a>, <a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind</a> </dd></dl>
  304. </div>
  305. </div>
  306. <a class="anchor" id="a436d3b101d84f700f1b6b4ce93a10ced"></a>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">string getBinding </td>
  312. <td>(</td>
  313. <td class="paramtype">command&#160;</td>
  314. <td class="paramname"></td><td>)</td>
  315. <td></td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>Use the getBinding method to get the binding for a specified command. </p>
  320. <dl class="params"><dt>Parameters</dt><dd>
  321. <table class="params">
  322. <tr><td class="paramname">command</td><td>The function to seek a binding for. </td></tr>
  323. </table>
  324. </dd>
  325. </dl>
  326. <dl class="section return"><dt>Returns</dt><dd>Returns a string containing the binding as a field (TAB separated string), or a NULL string meaning 'no binding found'. </dd></dl>
  327. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
  328. </div>
  329. </div>
  330. <a class="anchor" id="a63cd7f471fb9ef18dab60d50726c976d"></a>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname">string getCommand </td>
  336. <td>(</td>
  337. <td class="paramtype">device&#160;</td>
  338. <td class="paramname">, </td>
  339. </tr>
  340. <tr>
  341. <td class="paramkey"></td>
  342. <td></td>
  343. <td class="paramtype">action&#160;</td>
  344. <td class="paramname">&#160;</td>
  345. </tr>
  346. <tr>
  347. <td></td>
  348. <td>)</td>
  349. <td></td><td></td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Use the getCommand method to get the function associated with a specific device + action pair. </p>
  354. <dl class="params"><dt>Parameters</dt><dd>
  355. <table class="params">
  356. <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
  357. <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
  358. </table>
  359. </dd>
  360. </dl>
  361. <dl class="section return"><dt>Returns</dt><dd>Returns the function name or specification associated with the specified device + action pair, or a NULL-string meaning 'no binding found'. </dd></dl>
  362. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a>, <a class="el" href="classActionMap.html#a436d3b101d84f700f1b6b4ce93a10ced">getBinding</a> </dd></dl>
  363. </div>
  364. </div>
  365. <a class="anchor" id="a61eb8271a483b018a6650276e4f956ab"></a>
  366. <div class="memitem">
  367. <div class="memproto">
  368. <table class="memname">
  369. <tr>
  370. <td class="memname">string getDeadZone </td>
  371. <td>(</td>
  372. <td class="paramtype">device&#160;</td>
  373. <td class="paramname">, </td>
  374. </tr>
  375. <tr>
  376. <td class="paramkey"></td>
  377. <td></td>
  378. <td class="paramtype">action&#160;</td>
  379. <td class="paramname">&#160;</td>
  380. </tr>
  381. <tr>
  382. <td></td>
  383. <td>)</td>
  384. <td></td><td></td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Use the getDeadZone method to get the dead-zone associated with a specific device + action pair. </p>
  389. <dl class="params"><dt>Parameters</dt><dd>
  390. <table class="params">
  391. <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
  392. <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
  393. </table>
  394. </dd>
  395. </dl>
  396. <dl class="section return"><dt>Returns</dt><dd>Returns a dead-zone specification, or \0 0\ meaning that there is no dead-zone, or a NULL string meaning the mapping was not found. </dd></dl>
  397. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
  398. </div>
  399. </div>
  400. <a class="anchor" id="acbaf45fb05f687f1df20e195db4d11e4"></a>
  401. <div class="memitem">
  402. <div class="memproto">
  403. <table class="memname">
  404. <tr>
  405. <td class="memname">float getScale </td>
  406. <td>(</td>
  407. <td class="paramtype">device&#160;</td>
  408. <td class="paramname">, </td>
  409. </tr>
  410. <tr>
  411. <td class="paramkey"></td>
  412. <td></td>
  413. <td class="paramtype">action&#160;</td>
  414. <td class="paramname">&#160;</td>
  415. </tr>
  416. <tr>
  417. <td></td>
  418. <td>)</td>
  419. <td></td><td></td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. <p>Use the getScale method to get the scale associated with a specific device + action pair. </p>
  424. <dl class="params"><dt>Parameters</dt><dd>
  425. <table class="params">
  426. <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
  427. <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
  428. </table>
  429. </dd>
  430. </dl>
  431. <dl class="section return"><dt>Returns</dt><dd>Returns 1 if no scale is associated with the specified device + action pair, or the mapping was not found. </dd></dl>
  432. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
  433. </div>
  434. </div>
  435. <a class="anchor" id="aaec98a2724174b9c57ecd51741feccce"></a>
  436. <div class="memitem">
  437. <div class="memproto">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname">bool isInverted </td>
  441. <td>(</td>
  442. <td class="paramtype">device&#160;</td>
  443. <td class="paramname">, </td>
  444. </tr>
  445. <tr>
  446. <td class="paramkey"></td>
  447. <td></td>
  448. <td class="paramtype">action&#160;</td>
  449. <td class="paramname">&#160;</td>
  450. </tr>
  451. <tr>
  452. <td></td>
  453. <td>)</td>
  454. <td></td><td></td>
  455. </tr>
  456. </table>
  457. </div><div class="memdoc">
  458. <p>Use the Purpose method to determine if a specific device + action pair in inverted. This only applies to scrolling devices. </p>
  459. <dl class="params"><dt>Parameters</dt><dd>
  460. <table class="params">
  461. <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
  462. <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
  463. </table>
  464. </dd>
  465. </dl>
  466. <dl class="section return"><dt>Returns</dt><dd>Returns 1 if the mouse (or other scrolling device) is inverted, 0 otherwise. </dd></dl>
  467. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
  468. </div>
  469. </div>
  470. <a class="anchor" id="a312e7f6c761a199c1369fbe651e084f0"></a>
  471. <div class="memitem">
  472. <div class="memproto">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname">void pop </td>
  476. <td>(</td>
  477. <td class="paramname"></td><td>)</td>
  478. <td></td>
  479. </tr>
  480. </table>
  481. </div><div class="memdoc">
  482. <p>Use the pop method to de-activate an <a class="el" href="classActionMap.html">ActionMap</a> and remove it from non-global <a class="el" href="classActionMap.html">ActionMap</a> stack. </p>
  483. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  484. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a98b45e0a7ed122b6710df00209b67827">push</a> </dd></dl>
  485. </div>
  486. </div>
  487. <a class="anchor" id="a98b45e0a7ed122b6710df00209b67827"></a>
  488. <div class="memitem">
  489. <div class="memproto">
  490. <table class="memname">
  491. <tr>
  492. <td class="memname">void push </td>
  493. <td>(</td>
  494. <td class="paramname"></td><td>)</td>
  495. <td></td>
  496. </tr>
  497. </table>
  498. </div><div class="memdoc">
  499. <p>Use the push method to activate an <a class="el" href="classActionMap.html">ActionMap</a> and place it at the top of the non-global <a class="el" href="classActionMap.html">ActionMap</a> stack. </p>
  500. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  501. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a312e7f6c761a199c1369fbe651e084f0">pop</a> </dd></dl>
  502. </div>
  503. </div>
  504. <a class="anchor" id="aba70d852a967c89a18a2dbf4cb117927"></a>
  505. <div class="memitem">
  506. <div class="memproto">
  507. <table class="memname">
  508. <tr>
  509. <td class="memname">void save </td>
  510. <td>(</td>
  511. <td class="paramname"></td><td>)</td>
  512. <td></td>
  513. </tr>
  514. </table>
  515. </div><div class="memdoc">
  516. <p>Use the save method to save an entire action map specification to a file. If append is not specified, or specified as false, fileName will be overwritten, otherwise the action map will be appended to the file. </p>
  517. <dl class="params"><dt>Parameters</dt><dd>
  518. <table class="params">
  519. <tr><td class="paramname">fileName</td><td>Full path to file in which to store action map definition. </td></tr>
  520. <tr><td class="paramname">append</td><td>If true, do not overwrite the file, else start from scratch. </td></tr>
  521. </table>
  522. </dd>
  523. </dl>
  524. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  525. </div>
  526. </div>
  527. <a class="anchor" id="aa5d2f9815fbd6b12e9e923692d3d7c87"></a>
  528. <div class="memitem">
  529. <div class="memproto">
  530. <table class="memname">
  531. <tr>
  532. <td class="memname">void unbind </td>
  533. <td>(</td>
  534. <td class="paramtype">device&#160;</td>
  535. <td class="paramname">, </td>
  536. </tr>
  537. <tr>
  538. <td class="paramkey"></td>
  539. <td></td>
  540. <td class="paramtype">action&#160;</td>
  541. <td class="paramname">&#160;</td>
  542. </tr>
  543. <tr>
  544. <td></td>
  545. <td>)</td>
  546. <td></td><td></td>
  547. </tr>
  548. </table>
  549. </div><div class="memdoc">
  550. <p>Use the unbind method to remove a previosly specified device + action pair from the action map. </p>
  551. <dl class="params"><dt>Parameters</dt><dd>
  552. <table class="params">
  553. <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
  554. <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
  555. </table>
  556. </dd>
  557. </dl>
  558. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  559. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
  560. </div>
  561. </div>
  562. <a class="anchor" id="abcd284cf37de45f782dea6b79843b663"></a>
  563. <div class="memitem">
  564. <div class="memproto">
  565. <table class="memname">
  566. <tr>
  567. <td class="memname">void unbindObj </td>
  568. <td>(</td>
  569. <td class="paramtype">device&#160;</td>
  570. <td class="paramname">, </td>
  571. </tr>
  572. <tr>
  573. <td class="paramkey"></td>
  574. <td></td>
  575. <td class="paramtype">action&#160;</td>
  576. <td class="paramname">, </td>
  577. </tr>
  578. <tr>
  579. <td class="paramkey"></td>
  580. <td></td>
  581. <td class="paramtype">object&#160;</td>
  582. <td class="paramname">&#160;</td>
  583. </tr>
  584. <tr>
  585. <td></td>
  586. <td>)</td>
  587. <td></td><td></td>
  588. </tr>
  589. </table>
  590. </div><div class="memdoc">
  591. <p>Use the unbind method to remove a previosly specified device + action pair from the action map. </p>
  592. <dl class="params"><dt>Parameters</dt><dd>
  593. <table class="params">
  594. <tr><td class="paramname">device</td><td>Name of the device to bound to a command (see 'Device Table' below). </td></tr>
  595. <tr><td class="paramname">action</td><td>Name of the action to watch for (see 'Action Table' below). </td></tr>
  596. <tr><td class="paramname">object</td><td>Explicit object (it defaults to NULL when you call <a class="el" href="classActionMap.html#aa5d2f9815fbd6b12e9e923692d3d7c87">unbind()</a> ). </td></tr>
  597. </table>
  598. </dd>
  599. </dl>
  600. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  601. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classActionMap.html#a22b06bd6a96d9622f9b7376c64ea31f7">bind</a>, <a class="el" href="classActionMap.html#ad11f018ebdf715aadcf19e64a68d7348">bindCmd</a> </dd></dl>
  602. </div>
  603. </div>
  604. </div><!-- contents -->
  605. <!-- start footer part -->
  606. <hr class="footer"/><address class="footer"><small>
  607. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  608. <img class="footer" src="doxygen.png" alt="doxygen"/>
  609. </a> 1.8.3.1
  610. </small></address>
  611. </body>
  612. </html>