om::gui::input::MouseButtonCodeMap Class Reference

A class that maps from one set of mouse button codes to another. More...

#include <omGUIInputMouseButtonCodeMap.h>

Public Member Functions
	MouseButtonCodeMap ()
	Create a new mouse button code map which has the default initial size. More...
	MouseButtonCodeMap (Size mapSize)
	Create a new mouse button code map which has the specified initial size. More...
	MouseButtonCodeMap (const MouseButtonCodeMap &other)
	Create a copy of this mouse button code map. More...
	~MouseButtonCodeMap ()
	Destroy this mouse button code map, releasing all internal data. More...
MouseButtonCodeMap &	operator= (const MouseButtonCodeMap &other)
	Assign the state of another mouse button code map to this one. More...
MouseButtonCode	getCode (MouseButtonCode inputCode) const
	Map the specified input mouse button code to an output mouse button code. More...
void	setCode (MouseButtonCode inputCode, MouseButtonCode outputCode)
	Set the specified input code mapping for this mouse button code map. More...
void	clearCodes ()
	Remove all code mappings from this mouse button code map. More...

Detailed Description

A class that maps from one set of mouse button codes to another.

The usual purpose of this class is to provide an efficient way to convert from platform-specific mouse button codes to a generic set of mouse button codes.

Constructor & Destructor Documentation

om::gui::input::MouseButtonCodeMap::MouseButtonCodeMap

(

)

Create a new mouse button code map which has the default initial size.

om::gui::input::MouseButtonCodeMap::MouseButtonCodeMap

(

Size

mapSize

)

Create a new mouse button code map which has the specified initial size.

om::gui::input::MouseButtonCodeMap::MouseButtonCodeMap

(

const MouseButtonCodeMap &

other

)

Create a copy of this mouse button code map.

om::gui::input::MouseButtonCodeMap::~MouseButtonCodeMap

(

)

Destroy this mouse button code map, releasing all internal data.

Member Function Documentation

MouseButtonCodeMap& om::gui::input::MouseButtonCodeMap::operator=

(

const MouseButtonCodeMap &

other

)

Assign the state of another mouse button code map to this one.

MouseButtonCode om::gui::input::MouseButtonCodeMap::getCode

(

MouseButtonCode

inputCode

)

const

Map the specified input mouse button code to an output mouse button code.

If there is no mapping for the specified input code, a Key::UNDEFINED code is returned.

void om::gui::input::MouseButtonCodeMap::setCode	(	MouseButtonCode	inputCode,
		MouseButtonCode	outputCode
	)

Set the specified input code mapping for this mouse button code map.

If there is already an input mapping for that code, it is replaced with the new output mouse button code.

void om::gui::input::MouseButtonCodeMap::clearCodes

(

)

Remove all code mappings from this mouse button code map.

---

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

• omGUIInputMouseButtonCodeMap.h