dtCore::MouseListener Class Reference

An interface for objects interested in mouse events. More...

#include <mouse.h>

Inheritance diagram for dtCore::MouseListener:

List of all members.

Public Member Functions
virtual bool	HandleButtonPressed (const Mouse *mouse, Mouse::MouseButton button)=0
	Called when a button is pressed.
virtual bool	HandleButtonReleased (const Mouse *mouse, Mouse::MouseButton button)=0
	Called when a button is released.
virtual bool	HandleButtonClicked (const Mouse *mouse, Mouse::MouseButton button, int clickCount)=0
	Called when a button is clicked.
virtual bool	HandleMouseMoved (const Mouse *mouse, float x, float y)=0
	Called when the mouse pointer is moved.
virtual bool	HandleMouseDragged (const Mouse *mouse, float x, float y)=0
	Called when the mouse pointer is dragged.
virtual bool	HandleMouseScrolled (const Mouse *mouse, int delta)=0
	Called when the mouse is scrolled.
Protected Member Functions
virtual	~MouseListener ()

---

Detailed Description

An interface for objects interested in mouse events.

---

Constructor & Destructor Documentation

virtual dtCore::MouseListener::~MouseListener

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual bool dtCore::MouseListener::HandleButtonPressed	(	const Mouse *	mouse,
		Mouse::MouseButton	button
	)			[pure virtual]

Called when a button is pressed.

Parameters:

	mouse	the source of the event
	button	the button pressed

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implemented in dtCore::GenericMouseListener, dtGame::InputComponentMouseListener, and dtGUI::CEGUIMouseListener.

virtual bool dtCore::MouseListener::HandleButtonReleased	(	const Mouse *	mouse,
		Mouse::MouseButton	button
	)			[pure virtual]

Called when a button is released.

Parameters:

	mouse	the source of the event
	button	the button released

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implemented in dtCore::GenericMouseListener, dtGame::InputComponentMouseListener, and dtGUI::CEGUIMouseListener.

virtual bool dtCore::MouseListener::HandleButtonClicked	(	const Mouse *	mouse,
		Mouse::MouseButton	button,
		int	clickCount
	)			[pure virtual]

Called when a button is clicked.

Parameters:

	mouse	the source of the event
	button	the button clicked
	clickCount	the click count

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implemented in dtCore::GenericMouseListener, dtGame::InputComponentMouseListener, and dtGUI::CEGUIMouseListener.

virtual bool dtCore::MouseListener::HandleMouseMoved	(	const Mouse *	mouse,
		float	x,
		float	y
	)			[pure virtual]

Called when the mouse pointer is moved.

Parameters:

	mouse	the source of the event
	x	the x coordinate
	y	the y coordinate

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implemented in dtCore::GenericMouseListener, dtGame::InputComponentMouseListener, and dtGUI::CEGUIMouseListener.

virtual bool dtCore::MouseListener::HandleMouseDragged	(	const Mouse *	mouse,
		float	x,
		float	y
	)			[pure virtual]

Called when the mouse pointer is dragged.

Parameters:

	mouse	the source of the event
	x	the x coordinate
	y	the y coordinate

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implemented in dtCore::GenericMouseListener, dtGame::InputComponentMouseListener, and dtGUI::CEGUIMouseListener.

virtual bool dtCore::MouseListener::HandleMouseScrolled	(	const Mouse *	mouse,
		int	delta
	)			[pure virtual]

Called when the mouse is scrolled.

Parameters:

	mouse	the source of the event
	delta	the scroll delta (+1 for up one, -1 for down one)

Returns:

true if this MouseListener handled the event. The Mouse calling this function is responsbile for using this return value or not.

Implemented in dtCore::GenericMouseListener, dtGame::InputComponentMouseListener, and dtGUI::CEGUIMouseListener.

---