UI::MouseEvent Class Reference

#include <ui.h>

Public Member Functions
void	setCoords (int mouse_x, int mouse_y)
Constructors
	MouseEvent (enum Mouse t, int b, enum Modifiers md=NO_MOD, int mouse_x=-1, int mouse_y=-1)
MouseEvent class accessors
enum Mouse	getMouse () const
int	getButton () const
enum Modifiers	getModifiers () const
void	getCoords (int &mouse_x, int &mouse_y) const
bool	noMod () const
bool	shiftMod () const
bool	altMod () const
	operator bool () const
Help member functions
std::size_t	hash () const
bool	equals (const MouseEvent &e) const
MouseEvent &	operator= (const MouseEvent &e)
std::string	toString () const

Private Attributes
enum Mouse	m_type
	Mouse click type.
int	m_button
	Number of button pressed.
enum Modifiers	m_mod
	Modifiers state.
int	m_x
	mouse x-coordinate.
int	m_y
	mouse y-coordinate.

Detailed Description

Milo UI Mouse Event. All milo UI mouse events are uniquely stored in this class. It is designed to uniquely designate an event for the unordered map of mouse events to function calls.

Constructor & Destructor Documentation

UI::MouseEvent::MouseEvent ( enum Mouse  t, int  b, enum Modifiers  md = NO_MOD, int  mouse_x = -1, int  mouse_y = -1  )

inline

Universal event constructor.

Parameters

t	Mouse press type
b	Button number pressed
m	Modifiers key states.
mouse_x	mouse x coordinate.
mouse_y	mouse y coordinate.

Member Function Documentation

bool UI::MouseEvent::altMod ( ) const

inline

Check mouse event for alt mouse modifier.

Returns

True if there is alt mouse modifier.

bool UI::MouseEvent::equals ( const MouseEvent &  e ) const

inline

Return true is this mouse event is equal to parameter

Parameters

e	Mouse event to compare

Returns

True if equal

int UI::MouseEvent::getButton ( ) const

inline

Returns

button pressed

void UI::MouseEvent::getCoords ( int &  mouse_x, int &  mouse_y  ) const

inline

Get mouse coordinates

Parameters

[out]	mouse_x	x-coordinate of mouse event
[out]	mouse_y	y-coordinate of mouse event

enum Modifiers UI::MouseEvent::getModifiers ( ) const

inline

Returns

Modifiers state.

enum Mouse UI::MouseEvent::getMouse ( ) const

inline

Returns

Mouse click type

std::size_t UI::MouseEvent::hash ( ) const

inline

Calculate hash for this class object. Used by unordered map.

Returns

Hash value.

bool UI::MouseEvent::noMod ( ) const

inline

Check mouse event for no mouse modifiers.

Returns

True if there are no mouse modifiers.

UI::MouseEvent::operator bool ( ) const

inline

Return true if valid mouse

MouseEvent& UI::MouseEvent::operator= ( const MouseEvent &  e )

inline

Assign value of mouse event paramter

Parameters

e	Mouse event to assign

Returns

Reference to this mouse event

void UI::MouseEvent::setCoords ( int  mouse_x, int  mouse_y  )

inline

Set mouse coordinates

Parameters

mouse_x	x-coordinate of mouse event
mouse_y	y-coordinate of mouse event

bool UI::MouseEvent::shiftMod ( ) const

inline

Check mouse event for shift mouse modifier.

Returns

True if there is shift mouse modifier.

string MouseEvent::toString

(

)

const

Create string representing event.

Returns

String representing event

---

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

• ui.h
• ui.cpp