KeyEvent Class Reference

#include <keyevent.h>

Inheritance diagram for KeyEvent:

Public Member Functions
	KeyEvent (Widget *const source, KeyEventTypeT type, const InputActionT actionId, const Key &key)
KeyEventTypeT	getType () const
const Key &	getKey () const
InputActionT	getActionId () const
Public Member Functions inherited from InputGuiEvent
	InputGuiEvent (Widget *const source)
void	consume ()
bool	isConsumed () const
Public Member Functions inherited from Event
	Event (Widget *const source)
virtual	~Event ()
Widget *	getSource () const

Protected Attributes
Key	mKey
KeyEventTypeT	mType
InputActionT	mActionId
Protected Attributes inherited from InputGuiEvent
bool	mIsConsumed
Protected Attributes inherited from Event
Widget *	mSource

Detailed Description

Represents a key event.

Definition at line 85 of file keyevent.h.

Constructor & Destructor Documentation

KeyEvent()

KeyEvent::KeyEvent ( Widget *const  source, KeyEventTypeT  type, const InputActionT  actionId, const Key &  key  )

inline

Constructor.

Parameters

source	The source widget of the event.
type	The type of the event. A value from KeyEventType. false otherwise.
key	The key of the event.

Definition at line 96 of file keyevent.h.

                                 :
            InputGuiEvent(source),
            mKey(key),
#ifdef USE_SDL2
            mText(),
#endif  // USE_SDL2
            mType(type),
            mActionId(actionId)
        { }

Member Function Documentation

getActionId()

InputActionT KeyEvent::getActionId ( ) const

inline

Definition at line 127 of file keyevent.h.

        { return mActionId; }

References mActionId.

Referenced by InventoryWindow::keyPressed(), ServerDialog::keyPressed(), and InventoryWindow::keyReleased().

getKey()

const Key& KeyEvent::getKey ( ) const

inline

Gets the key of the event.

Returns

The key of the event.

Definition at line 124 of file keyevent.h.

        { return mKey; }

References mKey.

Referenced by IntTextField::keyPressed(), and ChatWindow::keyPressed().

getType()

KeyEventTypeT KeyEvent::getType ( ) const

inline

Gets the type of the event.

Returns

The type of the event.

Definition at line 116 of file keyevent.h.

        { return mType; }

References mType.

Field Documentation

mActionId

InputActionT KeyEvent::mActionId

protected

Definition at line 153 of file keyevent.h.

Referenced by getActionId().

mKey

Key KeyEvent::mKey

protected

Holds the key of the key event.

Definition at line 142 of file keyevent.h.

Referenced by getKey().

mType

KeyEventTypeT KeyEvent::mType

protected

Holds the type of the key event.

Definition at line 151 of file keyevent.h.

Referenced by getType().

---

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

• src/events/keyevent.h (986a3bf)