AgateLib: ERY.AgateLib.Mouse Class Reference


Public Types
enum	MouseButtons { None = 0x00, Primary = 0x01, Secondary = 0x02, Middle = 0x04, ExtraButton1 = 0x08, ExtraButton2 = 0x10, ExtraButton3 = 0x11 }
	Mouse Buttons enum. More...
Static Public Member Functions
static void	Show ()
	Shows the OS cursor.
static void	Hide ()
	Hides the OS cursor.
static void	OnMouseMove ()
	Raises the MouseMove event.
static void	OnMouseDoubleClick (MouseButtons btn)
	Raises the MouseDoubleClick event.
Static Public Attributes
static event InputEventHandler	MouseMove
	Event which occurs when the mouse is moved.
static event InputEventHandler	MouseDown
	Event which occurs when a mouse button is pressed.
static event InputEventHandler	MouseUp
	Event which occurs when a mouse button is released.
static event InputEventHandler	MouseDoubleClickEvent
	Event which occurs when a mouse button is double-clicked.
Properties
static Point	Position `[get, set]`
	Gets or sets the position of the cursor, in client coordinates of the current display window.
static int	X `[get, set]`
	Gets or sets the X position of the cursor, in client coordinates of the current display window.
static int	Y `[get, set]`
	Gets or sets the Y position of the cursor, in client coordinates of the current display window.
static MouseState	Buttons `[get]`
	Gets the MouseState structure which indicates which buttons are pressed.
Classes
class	MouseState
	Class which encapsulates the state of the mouse. More...

Detailed Description

Member Enumeration Documentation

Mouse Buttons enum.

Enumerator:

None	No mouse buttons.
Primary	Primary button, typically the left button.
Secondary	Secondary button, typically the right button.
Middle	Middle button on some mice.
ExtraButton1	Extra Button.
ExtraButton2	Extra Button.
ExtraButton3	Extra Button.

Member Function Documentation

static void ERY.AgateLib.Mouse.Show ( ) [static]

Shows the OS cursor.

static void ERY.AgateLib.Mouse.Hide ( ) [static]

Hides the OS cursor.

static void ERY.AgateLib.Mouse.OnMouseMove ( ) [static]

Raises the MouseMove event.

static void ERY.AgateLib.Mouse.OnMouseDoubleClick ( MouseButtons btn ) [static]

Raises the MouseDoubleClick event.

Parameters:

btn

Member Data Documentation

event InputEventHandler ERY.AgateLib.Mouse.MouseMove [static]

Event which occurs when the mouse is moved.

event InputEventHandler ERY.AgateLib.Mouse.MouseDown [static]

Event which occurs when a mouse button is pressed.

event InputEventHandler ERY.AgateLib.Mouse.MouseUp [static]

Event which occurs when a mouse button is released.

event InputEventHandler ERY.AgateLib.Mouse.MouseDoubleClickEvent [static]

Event which occurs when a mouse button is double-clicked.

Property Documentation

Point ERY.AgateLib.Mouse.Position [static, get, set]

Gets or sets the position of the cursor, in client coordinates of the current display window.

int ERY.AgateLib.Mouse.X [static, get, set]

Gets or sets the X position of the cursor, in client coordinates of the current display window.

int ERY.AgateLib.Mouse.Y [static, get, set]

Gets or sets the Y position of the cursor, in client coordinates of the current display window.

MouseState ERY.AgateLib.Mouse.Buttons [static, get]

Gets the MouseState structure which indicates which buttons are pressed.

ERY.AgateLib.Mouse Class Reference