Event Struct Reference

List of all members.

---

Detailed Description

An event sent to a Dispatcher.

Public Types
enum	Scroll {   Bottom, End, LineDown, LineUp,   PageDown, PageUp, Drop, Track,   Top }
	Indicates the user's scrolling request. More...
Public Attributes
int	x
	X position of mouse in client-relative coordinates.
int	y
	Y position of mouse in client-relative coordinates.
int	deltax
	Cursor delta from previous location, or zero.
int	deltay
	Cursor delta from previous location, or zero.
bit	control
	Control key is down.
bit	lbutton
	Left mouse button is down.
bit	mbutton
	Middle mouse button is down.
bit	rbutton
	Right mouse button is down.
bit	shift
	Shift key is down.
int	left
	For the onPaint event, the left bound for the update region.
int	top
	For the onPaint event, the top bound for the update region.
int	right
	For the onPaint event, the right bound for the update region, inclusive.
int	bottom
	For the onPaint event, the bottom bound for the update region, inclusive.
float	wheel
	For the onMouseWheel event, the number of units that the wheel has been spun.
Scroll	scrollType
	Type of the scrolling request.
int	scrollPoint
	Current scrolling point.
int	scrollDest
	The current scroll point with some good default changes according to the scrollType.
char[]	keyCode
	Relevant key name for a keyDown event, or the character for the key in a char event.
int	keyRepeat
	Number of times the keystroke is auto-repeated.
bit	keyPrevious
	Previous key state; true if it was down, false if it was up.

---

Member Enumeration Documentation

enum Event::Scroll

Indicates the user's scrolling request. Enumeration values: Bottom  Scrolls to the bottom or right. End  No longer scrolling. LineDown  Scrolls one line down or right. LineUp  Scrolls one line up or left. PageDown  Scrolls one page down or right. PageUp  Scrolls one page up or left. Drop  The scroll box has been dragged and is now released. Track  The scroll box is being dragged. Top  Scrolls to the top or left.

---

Member Data Documentation

char [] Event.keyCode

Relevant key name for a keyDown event, or the character for the key in a char event. For a keyDown event, it can be one of the following: "BackSpace". "Return"; return/enter key. "Shift"; either shift key. "Space". "Control"; either control key. "Delete". "Insert". "Tab". "Escape". "Pause". "NumLock"; numeric keypad lock. "CapsLock". "ScrollLock". "Down"; down arrow key. "Left"; left arrow key. "Right"; right arrow key. "Up"; up arrow key. "Home", "End", "PageUp", "PageDown". "A", "B", ... "Z". "0", "1", ... "9". "NumPad0", "NumPad1", ... "NumPad9". "Slash"; numeric pad slash. "Asterisk"; numeric pad asterisk. "Dash"; numeric pad dash. "Plus"; numeric pad plus. "Period"; numeric pad period. "NoNumLock5"; numeric pad 5 when numeric lock is off. "F1", "F2", ... "F24".

float Event.wheel

For the onMouseWheel event, the number of units that the wheel has been spun. Positive for spinning it away from the user. Negative for spinning it towards the user.

---

The documentation for this struct was generated from the following file:

• event.d

---