TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: GuiEvent Struct 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_gui_event-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">GuiEvent Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;guiTypes.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a66e07a3540f7f6870868ce7978191bd7" id="r_a66e07a3540f7f6870868ce7978191bd7"><td class="memItemLeft" align="right" valign="top">U16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gui_event.html#a66e07a3540f7f6870868ce7978191bd7">ascii</a></td></tr>
<tr class="memdesc:a66e07a3540f7f6870868ce7978191bd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">ascii character code 'a', 'A', 'b', '*', etc (if device==keyboard) - possibly a uchar or something  <br /></td></tr>
<tr class="separator:a66e07a3540f7f6870868ce7978191bd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a299469bf356e149ff7c7e2d6f4a777c4" id="r_a299469bf356e149ff7c7e2d6f4a777c4"><td class="memItemLeft" align="right" valign="top">U8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gui_event.html#a299469bf356e149ff7c7e2d6f4a777c4">modifier</a></td></tr>
<tr class="memdesc:a299469bf356e149ff7c7e2d6f4a777c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">SI_LSHIFT, etc.  <br /></td></tr>
<tr class="separator:a299469bf356e149ff7c7e2d6f4a777c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c81faf94470d23fa7f164c4d4da255c" id="r_a0c81faf94470d23fa7f164c4d4da255c"><td class="memItemLeft" align="right" valign="top">U8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gui_event.html#a0c81faf94470d23fa7f164c4d4da255c">keyCode</a></td></tr>
<tr class="memdesc:a0c81faf94470d23fa7f164c4d4da255c"><td class="mdescLeft">&#160;</td><td class="mdescRight">for unprintables, 'tab', 'return', ...  <br /></td></tr>
<tr class="separator:a0c81faf94470d23fa7f164c4d4da255c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec4b82274a288c557b63d70b66fae216" id="r_aec4b82274a288c557b63d70b66fae216"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point2_i.html">Point2I</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gui_event.html#aec4b82274a288c557b63d70b66fae216">mousePoint</a></td></tr>
<tr class="memdesc:aec4b82274a288c557b63d70b66fae216"><td class="mdescLeft">&#160;</td><td class="mdescRight">for mouse events  <br /></td></tr>
<tr class="separator:aec4b82274a288c557b63d70b66fae216"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2e59c9684c06a8f67f5f664160cd9e0" id="r_ad2e59c9684c06a8f67f5f664160cd9e0"><td class="memItemLeft" align="right" valign="top">U8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gui_event.html#ad2e59c9684c06a8f67f5f664160cd9e0">mouseClickCount</a></td></tr>
<tr class="memdesc:ad2e59c9684c06a8f67f5f664160cd9e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">to determine double clicks, etc...  <br /></td></tr>
<tr class="separator:ad2e59c9684c06a8f67f5f664160cd9e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3ccd29a433d93932a6762c8c26268a2" id="r_ac3ccd29a433d93932a6762c8c26268a2"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gui_event.html#ac3ccd29a433d93932a6762c8c26268a2">eventID</a></td></tr>
<tr class="memdesc:ac3ccd29a433d93932a6762c8c26268a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">assigns mouse or touch ID to the event  <br /></td></tr>
<tr class="separator:ac3ccd29a433d93932a6762c8c26268a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a single GUI event.</p>
<p>This is passed around to all the relevant controls so they know what's going on. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a66e07a3540f7f6870868ce7978191bd7" name="a66e07a3540f7f6870868ce7978191bd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66e07a3540f7f6870868ce7978191bd7">&#9670;&#160;</a></span>ascii</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U16 ascii</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>ascii character code 'a', 'A', 'b', '*', etc (if device==keyboard) - possibly a uchar or something </p>

</div>
</div>
<a id="ac3ccd29a433d93932a6762c8c26268a2" name="ac3ccd29a433d93932a6762c8c26268a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3ccd29a433d93932a6762c8c26268a2">&#9670;&#160;</a></span>eventID</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">S32 eventID</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>assigns mouse or touch ID to the event </p>

</div>
</div>
<a id="a0c81faf94470d23fa7f164c4d4da255c" name="a0c81faf94470d23fa7f164c4d4da255c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c81faf94470d23fa7f164c4d4da255c">&#9670;&#160;</a></span>keyCode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U8 keyCode</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>for unprintables, 'tab', 'return', ... </p>

</div>
</div>
<a id="a299469bf356e149ff7c7e2d6f4a777c4" name="a299469bf356e149ff7c7e2d6f4a777c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a299469bf356e149ff7c7e2d6f4a777c4">&#9670;&#160;</a></span>modifier</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U8 modifier</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SI_LSHIFT, etc. </p>

</div>
</div>
<a id="ad2e59c9684c06a8f67f5f664160cd9e0" name="ad2e59c9684c06a8f67f5f664160cd9e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2e59c9684c06a8f67f5f664160cd9e0">&#9670;&#160;</a></span>mouseClickCount</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U8 mouseClickCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>to determine double clicks, etc... </p>

</div>
</div>
<a id="aec4b82274a288c557b63d70b66fae216" name="aec4b82274a288c557b63d70b66fae216"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec4b82274a288c557b63d70b66fae216">&#9670;&#160;</a></span>mousePoint</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_point2_i.html">Point2I</a> mousePoint</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>for mouse events </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>gui/<b>guiTypes.h</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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
</small></address>
</body>
</html>