yaze::gui::Shortcut Struct Reference

Represents a keyboard shortcut with its associated action. More...

#include <keyboard_shortcuts.h>

Public Member Functions
std::string	GetDisplayString () const
bool	Matches (ImGuiKey pressed_key, bool ctrl, bool shift, bool alt) const

Public Attributes
std::string	id
std::string	description
ImGuiKey	key
bool	requires_ctrl = false
bool	requires_shift = false
bool	requires_alt = false
std::string	category
ShortcutContext	context
std::function< void()>	action
bool	enabled = true

Detailed Description

Represents a keyboard shortcut with its associated action.

Definition at line 43 of file keyboard_shortcuts.h.

Member Function Documentation

GetDisplayString()

std::string yaze::gui::Shortcut::GetDisplayString

(

)

const

Definition at line 112 of file keyboard_shortcuts.cc.

References yaze::gui::GetAltDisplayName(), yaze::gui::GetCtrlDisplayName(), yaze::gui::GetKeyName(), key, requires_alt, requires_ctrl, and requires_shift.

Referenced by yaze::gui::KeyboardShortcuts::DrawShortcutRow().

Here is the call graph for this function:

Matches()

bool yaze::gui::Shortcut::Matches	(	ImGuiKey	pressed_key,
		bool	ctrl,
		bool	shift,
		bool	alt ) const

Definition at line 134 of file keyboard_shortcuts.cc.

References enabled, key, requires_alt, requires_ctrl, and requires_shift.

Member Data Documentation

id

std::string yaze::gui::Shortcut::id

Definition at line 44 of file keyboard_shortcuts.h.

Referenced by yaze::gui::KeyboardShortcuts::RegisterShortcut(), and yaze::gui::KeyboardShortcuts::RegisterShortcut().

description

std::string yaze::gui::Shortcut::description

Definition at line 45 of file keyboard_shortcuts.h.

Referenced by yaze::gui::KeyboardShortcuts::DrawShortcutRow(), and yaze::gui::KeyboardShortcuts::RegisterShortcut().

key

ImGuiKey yaze::gui::Shortcut::key

Definition at line 46 of file keyboard_shortcuts.h.

Referenced by GetDisplayString(), Matches(), and yaze::gui::KeyboardShortcuts::RegisterShortcut().

requires_ctrl

bool yaze::gui::Shortcut::requires_ctrl = false

Definition at line 47 of file keyboard_shortcuts.h.

Referenced by GetDisplayString(), Matches(), and yaze::gui::KeyboardShortcuts::RegisterShortcut().

requires_shift

bool yaze::gui::Shortcut::requires_shift = false

Definition at line 48 of file keyboard_shortcuts.h.

Referenced by GetDisplayString(), Matches(), and yaze::gui::KeyboardShortcuts::RegisterShortcut().

requires_alt

bool yaze::gui::Shortcut::requires_alt = false

Definition at line 49 of file keyboard_shortcuts.h.

Referenced by GetDisplayString(), Matches(), and yaze::gui::KeyboardShortcuts::RegisterShortcut().

category

std::string yaze::gui::Shortcut::category

Definition at line 50 of file keyboard_shortcuts.h.

Referenced by yaze::gui::KeyboardShortcuts::RegisterShortcut().

context

ShortcutContext yaze::gui::Shortcut::context

Definition at line 51 of file keyboard_shortcuts.h.

Referenced by yaze::gui::KeyboardShortcuts::DrawShortcutRow(), yaze::gui::KeyboardShortcuts::IsShortcutActiveInContext(), and yaze::gui::KeyboardShortcuts::RegisterShortcut().

action

std::function<void()> yaze::gui::Shortcut::action

Definition at line 52 of file keyboard_shortcuts.h.

Referenced by yaze::gui::KeyboardShortcuts::RegisterShortcut().

enabled

bool yaze::gui::Shortcut::enabled = true

Definition at line 53 of file keyboard_shortcuts.h.

Referenced by Matches(), and yaze::gui::KeyboardShortcuts::RegisterShortcut().

---

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

• src/app/gui/keyboard_shortcuts.h
• src/app/gui/keyboard_shortcuts.cc