AgateLib.InputLib.Mouse Class Reference

Class which encapsulates input from the mouse. More...

List of all members.

Classes
class	MouseState
	Class which encapsulates the state of the mouse. More...
Public Types
enum	MouseButtons {   None, Primary, Secondary, Middle,   ExtraButton1, ExtraButton2, ExtraButton3 }
	Mouse Buttons enum. More...
Static Public Member Functions
static void	Show ()
	Shows the OS cursor.
static void	Hide ()
	Hides the OS cursor.
static void	OnMouseWheel (int delta)
	Raises the MouseWheel event.
static void	OnMouseMove ()
	Raises the MouseMove event.
static void	OnMouseDoubleClick (MouseButtons btn)
	Raises the MouseDoubleClick event.
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 bool	IsHidden [get, set]
	Returns true if the mouse pointer is hidden.
static MouseState	Buttons [get]
	Gets the MouseState structure which indicates which buttons are pressed.
Events
static InputEventHandler	MouseMove
	Event which occurs when the mouse is moved.
static InputEventHandler	MouseDown
	Event which occurs when a mouse button is pressed.
static InputEventHandler	MouseUp
	Event which occurs when a mouse button is released.
static InputEventHandler	MouseDoubleClick
	Event which occurs when a mouse button is double-clicked.
static InputEventHandler	MouseWheel
	Event which occurs when the mouse wheel is scrolled. Positive numbers indicate scrolling down, while negative numbers indicate scrolling up. A value of 100 means to scroll one line.

---

Detailed Description

Class which encapsulates input from the mouse.

---

Member Enumeration Documentation

enum AgateLib::InputLib::Mouse::MouseButtons

Mouse Buttons enum.

Enumerator:

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

---

Member Function Documentation

static void AgateLib.InputLib.Mouse.Hide

(

)

[static]

Hides the OS cursor.

static void AgateLib.InputLib.Mouse.OnMouseDoubleClick

(

MouseButtons

btn

)

[static]

Raises the MouseDoubleClick event.

Parameters:

btn

static void AgateLib.InputLib.Mouse.OnMouseMove

(

)

[static]

Raises the MouseMove event.

static void AgateLib.InputLib.Mouse.OnMouseWheel

(

int

delta

)

[static]

Raises the MouseWheel event.

Parameters:

delta

static void AgateLib.InputLib.Mouse.Show

(

)

[static]

Shows the OS cursor.

---

Property Documentation

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

Gets the MouseState structure which indicates which buttons are pressed.

bool AgateLib.InputLib.Mouse.IsHidden [static, get, set]

Returns true if the mouse pointer is hidden.

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

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

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

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

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

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

---

Event Documentation

InputEventHandler AgateLib.InputLib.Mouse.MouseDoubleClick [static]

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

InputEventHandler AgateLib.InputLib.Mouse.MouseDown [static]

Event which occurs when a mouse button is pressed.

InputEventHandler AgateLib.InputLib.Mouse.MouseMove [static]

Event which occurs when the mouse is moved.

InputEventHandler AgateLib.InputLib.Mouse.MouseUp [static]

Event which occurs when a mouse button is released.

InputEventHandler AgateLib.InputLib.Mouse.MouseWheel [static]

Event which occurs when the mouse wheel is scrolled. Positive numbers indicate scrolling down, while negative numbers indicate scrolling up. A value of 100 means to scroll one line.

---

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

• InputLib/Mouse.cs