summaryrefslogtreecommitdiff
path: root/freebsdtvision/doc/html/structTEvent.html
blob: d2c99ca39b283447746f828172f6767039725a67 (plain)
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>TEvent struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>TEvent Struct Reference</h1>Information about events. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="system_8h-source.html">system.h</a>&gt;</code>
<p>
<a href="structTEvent-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a0">ushort</a>&nbsp;</td><td valign=bottom><a class="el" href="structTEvent.html#m0">what</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structMouseEventType.html">MouseEventType</a>&nbsp;</td><td valign=bottom><a class="el" href="structTEvent.html#m1">mouse</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structKeyDownEvent.html">KeyDownEvent</a>&nbsp;</td><td valign=bottom><a class="el" href="structTEvent.html#m2">keyDown</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structMessageEvent.html">MessageEvent</a>&nbsp;</td><td valign=bottom><a class="el" href="structTEvent.html#m3">message</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
TEvent holds a union of objects of type:
<p>
<a class="el" href="structKeyDownEvent.html">KeyDownEvent</a> <a class="el" href="structMessageEvent.html">MessageEvent</a> <a class="el" href="structMouseEventType.html">MouseEventType</a>
<p>
keyed by the what field. The <a class="el" href="classTView.html#a41">TView::handleEvent()</a> member functions and its derived classes take a TEvent object as argument and respond with the appropriate action. 
<p>

<p>
Definition at line <a class="el" href="system_8h-source.html#l00349">349</a> of file <a class="el" href="system_8h-source.html">system.h</a>.<hr><h2>Member Data Documentation</h2>
<a name="m2" doxytag="TEvent::keyDown"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="structKeyDownEvent.html">KeyDownEvent</a> TEvent::keyDown
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Undocumented. 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00401">401</a> of file <a class="el" href="system_8h-source.html">system.h</a>.    </td>
  </tr>
</table>
<a name="m3" doxytag="TEvent::message"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="structMessageEvent.html">MessageEvent</a> TEvent::message
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Undocumented. 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00405">405</a> of file <a class="el" href="system_8h-source.html">system.h</a>.    </td>
  </tr>
</table>
<a name="m1" doxytag="TEvent::mouse"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="structMouseEventType.html">MouseEventType</a> TEvent::mouse
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Undocumented. 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00397">397</a> of file <a class="el" href="system_8h-source.html">system.h</a>.    </td>
  </tr>
</table>
<a name="m0" doxytag="TEvent::what"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="ttypes_8h.html#a0">ushort</a> TEvent::what
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This field reports the event's type. Some mnemonics are defined to indicate types of events to TVision event handlers. The following evXXXX constants are used in several places: in the what data member of an TEvent structure, in the <a class="el" href="classTView.html#m3">TView::eventMask</a> data member of a view object, and in the <a class="el" href="views_8h.html#a107">positionalEvents</a> and <a class="el" href="views_8h.html#a108">focusedEvents</a> variables.
<p>
The following event values designate standard event types:
<p>
<pre>
 Constant    Value  Meaning

 <a class="el" href="system_8h.html#a0">evMouseDown</a> 0x0001 Mouse button pressed
 <a class="el" href="system_8h.html#a1">evMouseUp</a>   0x0002 Mouse button released
 <a class="el" href="system_8h.html#a2">evMouseMove</a> 0x0004 Mouse changed location
 <a class="el" href="system_8h.html#a3">evMouseAuto</a> 0x0008 Periodic event while mouse button held down
 <a class="el" href="system_8h.html#a4">evKeyDown</a>   0x0010 Key pressed
 <a class="el" href="system_8h.html#a5">evCommand</a>   0x0100 Command event
 <a class="el" href="system_8h.html#a6">evBroadcast</a> 0x0200 Broadcast event
 </pre>
<p>
The following constants can be used to mask types of events:
<p>
<pre>
 Constant   Value  Meaning

 <a class="el" href="system_8h.html#a7">evNothing</a>  0x0000 Event already handled
 <a class="el" href="system_8h.html#a8">evMouse</a>    0x000F Mouse event
 <a class="el" href="system_8h.html#a9">evKeyboard</a> 0x0010 Keyboard event
 <a class="el" href="system_8h.html#a10">evMessage</a>  0xFF00 Message (command, broadcast, or user-defined) event
 </pre>
<p>
The above standard event masks can be used to determine whether an event belongs to a particular "family" of events. For example:
<p>
<pre>
 if ((event.what &amp; <a class="el" href="system_8h.html#a8">evMouse</a>) != 0) doMouseEvent();
 </pre> 
<p>
Definition at line <a class="el" href="system_8h-source.html#l00391">391</a> of file <a class="el" href="system_8h-source.html">system.h</a>.    </td>
  </tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="system_8h-source.html">system.h</a></ul>
<hr><address style="align: right;"><small>Generated on Wed Apr 2 22:13:13 2003 for TVision by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>