class `ShortcutManager`

Inherits: Module<ShortcutManager>

Allows you to register global keyboard shortcuts that trigger callbacks when a certain key, or a key combination is pressed.

Public

Constructors

ShortcutManager

ShortcutManager()

Methods

~ShortcutManager

~ShortcutManager() noexcept

AddShortcut

void AddShortcut(const ShortcutKey &key, std::function<void ()> callback)

Registers a new shortcut key and a callback to be called when the shortcut key is triggered.

RemoveShortcut

void RemoveShortcut(const ShortcutKey &key)

Removes an existing shortcut key (it's callback will no longer be triggered when this combination is pressed).

staticInstance

static T &Instance()

Returns a reference to the module instance.

Module has to have been started up first otherwise an exception will be thrown.

staticInstancePtr

static T *InstancePtr()

Returns a pointer to the module instance.

Module has to have been started up first otherwise an exception will be thrown.

staticShutDown

static void ShutDown()

Shuts down this module and frees any resources it is using.

staticIsStarted

static bool IsStarted()

Query if the module has been started.

Protected

Methods

~Module<T>

virtual ~Module<T>() = default

OnStartUp

virtual void OnStartUp()

Override if you want your module to be notified once it has been constructed and started.

OnShutDown

virtual void OnShutDown()

Override if you want your module to be notified just before it is deleted.

staticInstanceInternal

static T *&InstanceInternal()

Returns a singleton instance of this module.

staticIsDestroyed

static bool &IsDestroyed()

Checks has the Module been shut down.

staticIsStartedUp

static bool &IsStartedUp()

Checks has the Module been started up.

Private

Methods

OnButtonDown

void OnButtonDown(const ButtonEvent &event)

Triggered whenever a user presses a button.

Fields

mShortcuts

UnorderedMap<ShortcutKey, std::function<void ()>, ShortcutKey::Hash, ShortcutKey::Equals> mShortcuts

mOnButtonDownConn

HEvent mOnButtonDownConn