KeyInput Class Reference

#include <keyinput.h>

Public Member Functions
	KeyInput ()
	KeyInput (const KeyInput &k)
KeyInput &	operator= (const KeyInput &k)
	~KeyInput ()
void	setType (KeyEventTypeT type)
KeyEventTypeT	getType () const
void	setKey (const Key &key)
const Key &	getKey () const
void	setActionId (const InputActionT n)
InputActionT	getActionId () const

Protected Attributes
Key	mKey
KeyEventTypeT	mType
InputActionT	mActionId

Detailed Description

Definition at line 80 of file keyinput.h.

Constructor & Destructor Documentation

KeyInput() [1/2]

KeyInput::KeyInput ( )

inline

Definition at line 83 of file keyinput.h.

                             :
            mKey(0),
            mType(KeyEventType::PRESSED),
#ifdef USE_SDL2
            mText(),
#endif  // USE_SDL2
            mActionId(InputAction::UNDEFINED_VALUE)
        { }

KeyInput() [2/2]

KeyInput::KeyInput ( const KeyInput &  k )

inline

Definition at line 92 of file keyinput.h.

                                              :
            mKey(k.mKey),
            mType(k.mType),
#ifdef USE_SDL2
            mText(k.mText),
#endif  // USE_SDL2
            mActionId(k.mActionId)
        {
        }

~KeyInput()

KeyInput::~KeyInput ( )

inline

Definition at line 115 of file keyinput.h.

        { }

Member Function Documentation

getActionId()

InputActionT KeyInput::getActionId ( ) const

inline

Definition at line 143 of file keyinput.h.

        {
            return mActionId;
        }

References mActionId.

Referenced by Gui::handleKeyInput().

getKey()

const Key& KeyInput::getKey ( ) const

inline

Definition at line 133 of file keyinput.h.

        {
            return mKey;
        }

References mKey.

Referenced by Gui::handleKeyInput().

getType()

KeyEventTypeT KeyInput::getType ( ) const

inline

Definition at line 123 of file keyinput.h.

        {
            return mType;
        }

References mType.

Referenced by Gui::handleKeyInput().

operator=()

KeyInput& KeyInput::operator= ( const KeyInput &  k )

inline

Definition at line 104 of file keyinput.h.

        {
            mKey = k.mKey;
            mType = k.mType;
#ifdef USE_SDL2
            mText = k.mText;
#endif  // USE_SDL2
            mActionId = k.mActionId;
            return *this;
        }

References mActionId, mKey, and mType.

setActionId()

void KeyInput::setActionId ( const InputActionT  n )

inline

Definition at line 138 of file keyinput.h.

        {
            mActionId = n;
        }

References mActionId.

Referenced by SDLInput::convertKeyEventToKey(), and SDLInput::simulateKey().

setKey()

void KeyInput::setKey ( const Key &  key )

inline

Definition at line 128 of file keyinput.h.

        {
            mKey = key;
        }

References mKey.

Referenced by SDLInput::convertKeyEventToKey(), SDLInput::pushInput(), and SDLInput::simulateKey().

setType()

void KeyInput::setType ( KeyEventTypeT  type )

inline

Definition at line 118 of file keyinput.h.

        {
            mType = type;
        }

References mType.

Referenced by SDLInput::pushInput(), and SDLInput::simulateKey().

Field Documentation

mActionId

InputActionT KeyInput::mActionId

protected

Definition at line 175 of file keyinput.h.

Referenced by getActionId(), operator=(), and setActionId().

mKey

Key KeyInput::mKey

protected

Holds the key of the key input.

Definition at line 164 of file keyinput.h.

Referenced by getKey(), operator=(), and setKey().

mType

KeyEventTypeT KeyInput::mType

protected

Holds the type of the key input.

Definition at line 169 of file keyinput.h.

Referenced by getType(), operator=(), and setType().

---

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

• src/input/keyinput.h (986a3bf)