File: classCEGUI_1_1MouseEventArgs.html

package info (click to toggle)
cegui-mk2 0.7.6-3.3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 105,388 kB
  • ctags: 82,178
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (148 lines) | stat: -rw-r--r-- 10,715 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<!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"/>
<title>Crazy Eddies GUI System: CEGUI::MouseEventArgs Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}

function addClass(ele,cls) {
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}

function removeClass(ele,cls) {
  if (hasClass(ele,cls)) {
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
    ele.className=ele.className.replace(reg,' ');
  }
}

function toggleVisibility(linkObj) {
 var base = linkObj.getAttribute('id');
 var summary = document.getElementById(base + '-summary');
 var content = document.getElementById(base + '-content');
 var trigger = document.getElementById(base + '-trigger');
 if ( hasClass(linkObj,'closed') ) {
   summary.style.display = 'none';
   content.style.display = 'block';
   trigger.src = 'open.png';
   removeClass(linkObj,'closed');
   addClass(linkObj,'opened');
 } else if ( hasClass(linkObj,'opened') ) {
   summary.style.display = 'block';
   content.style.display = 'none';
   trigger.src = 'closed.png';
   removeClass(linkObj,'opened');
   addClass(linkObj,'closed');
 }
 return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Crazy Eddies GUI System&#160;<span id="projectnumber">0.7.6</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
      <li class="navelem"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::MouseEventArgs Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::MouseEventArgs" --><!-- doxytag: inherits="CEGUI::WindowEventArgs" -->
<p><a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> based class that is used for objects passed to input event handlers concerning mouse input.  
 <a href="classCEGUI_1_1MouseEventArgs.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::MouseEventArgs:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1MouseEventArgs__inherit__graph.gif" border="0" usemap="#CEGUI_1_1MouseEventArgs_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1MouseEventArgs_inherit__map" id="CEGUI_1_1MouseEventArgs_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som..." alt="" coords="5,83,187,112"/><area shape="rect" id="node4" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object." alt="" coords="29,5,163,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::MouseEventArgs:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1MouseEventArgs__coll__graph.gif" border="0" usemap="#CEGUI_1_1MouseEventArgs_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1MouseEventArgs_coll__map" id="CEGUI_1_1MouseEventArgs_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som..." alt="" coords="5,85,187,115"/><area shape="rect" id="node4" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object." alt="" coords="29,5,163,35"/><area shape="rect" id="node6" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)" alt="" coords="211,85,328,115"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1MouseEventArgs-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc07ff6447384f194cca5383a2dd2f1b"></a><!-- doxytag: member="CEGUI::MouseEventArgs::MouseEventArgs" ref="afc07ff6447384f194cca5383a2dd2f1b" args="(Window *wnd)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>MouseEventArgs</b> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> *wnd)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18347427458581ef70e9b10d3750b89e"></a><!-- doxytag: member="CEGUI::MouseEventArgs::position" ref="a18347427458581ef70e9b10d3750b89e" args="" -->
<a class="el" href="classCEGUI_1_1Vector2.html">Point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseEventArgs.html#a18347427458581ef70e9b10d3750b89e">position</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">holds current mouse position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af25b9eec1ec347a8283c2c99371f9d1c"></a><!-- doxytag: member="CEGUI::MouseEventArgs::moveDelta" ref="af25b9eec1ec347a8283c2c99371f9d1c" args="" -->
<a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseEventArgs.html#af25b9eec1ec347a8283c2c99371f9d1c">moveDelta</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">holds variation of mouse position from last mouse input <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e773bf82b408fe454374ed2e6cf19ef"></a><!-- doxytag: member="CEGUI::MouseEventArgs::button" ref="a1e773bf82b408fe454374ed2e6cf19ef" args="" -->
<a class="el" href="namespaceCEGUI.html#aa445483fd17f02e7d119e9be540a4976">MouseButton</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseEventArgs.html#a1e773bf82b408fe454374ed2e6cf19ef">button</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">one of the MouseButton enumerated values describing the mouse button causing the event (for button inputs only) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8cefdb73ab42c57e279b7ee4db356ee"></a><!-- doxytag: member="CEGUI::MouseEventArgs::sysKeys" ref="ad8cefdb73ab42c57e279b7ee4db356ee" args="" -->
uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseEventArgs.html#ad8cefdb73ab42c57e279b7ee4db356ee">sysKeys</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">current state of the system keys and mouse buttons. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2640ddda05541aad912d9313aa17623c"></a><!-- doxytag: member="CEGUI::MouseEventArgs::wheelChange" ref="a2640ddda05541aad912d9313aa17623c" args="" -->
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseEventArgs.html#a2640ddda05541aad912d9313aa17623c">wheelChange</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the amount the scroll wheel has changed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6488c2e0e17ed4325e3601b4de8eaf2"></a><!-- doxytag: member="CEGUI::MouseEventArgs::clickCount" ref="aa6488c2e0e17ed4325e3601b4de8eaf2" args="" -->
uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MouseEventArgs.html#aa6488c2e0e17ed4325e3601b4de8eaf2">clickCount</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds number of mouse button down events currently counted in a multi-click sequence (for button inputs only). <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1EventArgs.html" title="Base class used as the argument to all subscribers Event object.">EventArgs</a> based class that is used for objects passed to input event handlers concerning mouse input. </p>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 for Crazy Eddies GUI System by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>