Inputable Class Reference

#include <Inputable.h>

Inheritance diagram for Inputable:

Collaboration diagram for Inputable:

Classes
struct	InputableData
	An inputable data. More...

Public Types
enum	EVENT_TYPE { KEY_PRESS, KEY_RELEASE }
	Values that represent event types. More...
typedef std::pair< AZUL_KEY, EVENT_TYPE >	KeyEvent
	Defines an alias representing the key event. More...
typedef std::map< KeyEvent, InputableData >	InputDataMap
	Defines an alias representing the input data map. More...
typedef InputDataMap::iterator	InputDataRef
	Defines an alias representing the input data reference. More...

Public Member Functions
	Inputable ()
	Default constructor. More...
	Inputable (const Inputable &)=delete
	Copy constructor. More...
	Inputable (Inputable &&)=delete
	Move constructor. More...
Inputable &	operator= (const Inputable &)=delete
	Assignment operator. More...
Inputable &	operator= (Inputable &&)=delete
	Move assignment operator. More...
virtual	~Inputable ()
	Deconstructor. More...

Public Attributes
InputDataMap	inMap
	The inputable map. More...

Protected Member Functions
void	SubmitKeyRegistration (AZUL_KEY inputKey, EVENT_TYPE e)
	Submit key registration. More...
void	SubmitKeyDeregistration (AZUL_KEY inputKey, EVENT_TYPE e)
	Submit key deregistration. More...

Private Member Functions
virtual void	KeyPressed (AZUL_KEY inputKey)
	Key pressed callback. More...
virtual void	KeyReleased (AZUL_KEY inputKey)
	Key released callback. More...
void	SceneRegistration (AZUL_KEY inputKey, EVENT_TYPE e)
	Scene registration. More...
void	SceneDeregistration (AZUL_KEY inputKey, EVENT_TYPE e)
	Scene deregistration. More...

Friends
class	InputableAttorney

Member Typedef Documentation

InputDataMap

std::map< KeyEvent, InputableData > Inputable::InputDataMap

Defines an alias representing the input data map.

InputDataRef

InputDataMap::iterator Inputable::InputDataRef

Defines an alias representing the input data reference.

KeyEvent

std::pair< AZUL_KEY, EVENT_TYPE > Inputable::KeyEvent

Defines an alias representing the key event.

Member Enumeration Documentation

EVENT_TYPE

enum Inputable::EVENT_TYPE

Values that represent event types.

Enumerator
KEY_PRESS
KEY_RELEASE

Constructor & Destructor Documentation

Inputable() [1/3]

Inputable::Inputable

(

)

Default constructor.

Inputable() [2/3]

Inputable::Inputable ( const Inputable &  )

delete

Copy constructor.

Inputable() [3/3]

Inputable::Inputable ( Inputable &&  )

delete

Move constructor.

~Inputable()

Inputable::~Inputable ( )

virtual

Deconstructor.

Member Function Documentation

KeyPressed()

void Inputable::KeyPressed ( AZUL_KEY  inputKey )

privatevirtual

Key pressed callback.

Parameters

inputKey

The input key.

Here is the caller graph for this function:

KeyReleased()

void Inputable::KeyReleased ( AZUL_KEY  inputKey )

privatevirtual

Key released callback.

Parameters

inputKey

The input key.

Here is the caller graph for this function:

operator=() [1/2]

Inputable& Inputable::operator= ( const Inputable &  )

delete

Assignment operator.

operator=() [2/2]

Inputable& Inputable::operator= ( Inputable &&  )

delete

Move assignment operator.

SceneDeregistration()

void Inputable::SceneDeregistration ( AZUL_KEY  inputKey, EVENT_TYPE  e  )

private

Scene deregistration.

Parameters

inputKey	The input key.
e	An EVENT_TYPE to process.

Here is the call graph for this function:

Here is the caller graph for this function:

SceneRegistration()

void Inputable::SceneRegistration ( AZUL_KEY  inputKey, EVENT_TYPE  e  )

private

Scene registration.

Parameters

inputKey	The input key.
e	An EVENT_TYPE to process.

Here is the call graph for this function:

Here is the caller graph for this function:

SubmitKeyDeregistration()

void Inputable::SubmitKeyDeregistration ( AZUL_KEY  inputKey, EVENT_TYPE  e  )

protected

Submit key deregistration.

Parameters

inputKey	The input key.
e	An EVENT_TYPE to process.

Here is the call graph for this function:

SubmitKeyRegistration()

void Inputable::SubmitKeyRegistration ( AZUL_KEY  inputKey, EVENT_TYPE  e  )

protected

Submit key registration.

Parameters

inputKey	The input key.
e	An EVENT_TYPE to process.

Here is the call graph for this function:

Friends And Related Function Documentation

InputableAttorney

friend class InputableAttorney

friend

Member Data Documentation

inMap

InputDataMap Inputable::inMap

The inputable map.

---

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

• Inputable.h
• Inputable.cpp