nom::KeyboardAction Struct Reference

A structure containing information on a keyboard action. More...

#include <InputAction.hpp>

Inheritance diagram for nom::KeyboardAction:

Public Member Functions
	KeyboardAction (int32 sym, InputState state=InputState::PRESSED)
	Constructor for initializing an object to a valid action state.
	KeyboardAction (int32 sym, uint16 mod, InputState state=InputState::PRESSED)
	Constructor for initializing an object to a valid action state.
	KeyboardAction (int32 sym, uint16 mod, uint8 repeat, InputState state=InputState::PRESSED)
	Constructor for initializing an object to a valid action state.
Public Member Functions inherited from nom::InputAction
	InputAction ()
	Default constructor; constructs an invalid action state.
virtual const Event &	event (void) const
	Get the underlying event associated with the input action.
const nom::event_callback &	callback (void) const
	Get the callback assigned to the input action.
void	set_callback (const nom::event_callback &delegate)
void	operator() (const Event &evt) const
	C++ functor; execute the callback assigned for the input action.

Additional Inherited Members
Public Attributes inherited from nom::InputAction
Event	event_
	The event type and relevant input data; the criteria is used to match against user input.

Detailed Description

A structure containing information on a keyboard action.

Definition at line 73 of file InputAction.hpp.

Constructor & Destructor Documentation

KeyboardAction() [1/3]

nom::KeyboardAction::KeyboardAction	(	int32	sym,
		InputState	state = InputState::PRESSED )

Constructor for initializing an object to a valid action state.

Parameters

state

One of the nom::InputState enumeration values.

Remarks

The key modifier is initialized to KMOD_NONE.

KeyboardAction() [2/3]

nom::KeyboardAction::KeyboardAction	(	int32	sym,
		uint16	mod,
		InputState	state = InputState::PRESSED )

Constructor for initializing an object to a valid action state.

Parameters

mod	An enumeration of key modifier masks; see also: the SDL2 wiki documentation page for SDL_Keymod.
state	One of the nom::InputState enumeration values.

KeyboardAction() [3/3]

nom::KeyboardAction::KeyboardAction	(	int32	sym,
		uint16	mod,
		uint8	repeat,
		InputState	state = InputState::PRESSED )

Constructor for initializing an object to a valid action state.

Parameters

mod	An enumeration of key modifier masks; see also: the SDL2 wiki documentation page for SDL_Keymod.
state	One of the nom::InputState enumeration values.

---

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

• /home/jeff/Projects/nomlib.git/include/nomlib/system/InputMapper/InputAction.hpp