#include <panel_hotkeys_editor.h>
Public Member Functions | |
| PANEL_HOTKEYS_EDITOR (EDA_BASE_FRAME *aFrame, wxWindow *aWindow, bool aReadOnly) | |
| std::vector< TOOL_ACTION * > & | ActionsList () |
| bool | TransferDataToWindow () override |
| bool | TransferDataFromWindow () override |
| void | ResetPanel () override |
| Reset the contents of this panel. More... | |
| wxString | GetResetTooltip () const override |
| Get the tooltip the reset button should display when showing this panel. More... | |
| wxString | GetHelpTextAtPoint (const wxPoint &aPt, wxHelpEvent::Origin aOrigin) const override |
| Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }. More... | |
Protected Attributes | |
| EDA_BASE_FRAME * | m_frame |
| bool | m_readOnly |
| std::vector< TOOL_ACTION * > | m_actions |
| HOTKEY_STORE | m_hotkeyStore |
| WIDGET_HOTKEY_LIST * | m_hotkeyListCtrl |
Private Member Functions | |
| void | installButtons (wxSizer *aSizer) |
| Install the button panel (global reset/default, import/export) More... | |
| void | OnFilterSearch (wxCommandEvent &aEvent) |
| Handle a change in the hotkey filter text. More... | |
| void | ImportHotKeys () |
| Put up a dialog allowing the user to select a hotkeys file and then overlays those hotkeys onto the current hotkey store. More... | |
| void | dumpHotkeys () |
| Dump all actions and their hotkeys to a text file for inclusion in documentation. More... | |
Detailed Description
Definition at line 41 of file panel_hotkeys_editor.h.
Constructor & Destructor Documentation
◆ PANEL_HOTKEYS_EDITOR()
| PANEL_HOTKEYS_EDITOR::PANEL_HOTKEYS_EDITOR | ( | EDA_BASE_FRAME * | aFrame, |
| wxWindow * | aWindow, | ||
| bool | aReadOnly | ||
| ) |
Definition at line 68 of file panel_hotkeys_editor.cpp.
References _, CreateTextFilterBox(), installButtons(), m_hotkeyListCtrl, m_hotkeyStore, m_readOnly, and OnFilterSearch().
Member Function Documentation
◆ ActionsList()
|
inline |
Definition at line 46 of file panel_hotkeys_editor.h.
References m_actions.
Referenced by DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), and EDA_BASE_FRAME::ShowPreferences().
◆ dumpHotkeys()
|
private |
Dump all actions and their hotkeys to a text file for inclusion in documentation.
The format is asciidoc-compatible table rows. This function is hidden behind an advanced config flag and not intended for users.
Definition at line 215 of file panel_hotkeys_editor.cpp.
References _, EDA_BASE_FRAME::GetMruPath(), HOTKEY_STORE::GetSections(), KeyNameFromKeyCode(), HOTKEY::m_Actions, HOTKEY::m_EditKeycode, m_frame, m_hotkeyStore, TextFileExtension, and TextFileWildcard().
Referenced by installButtons().
◆ GetHelpTextAtPoint()
|
inlineoverrideinherited |
Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }.
Definition at line 72 of file resettable_panel.h.
References RESETTABLE_PANEL::GetResetTooltip().
◆ GetResetTooltip()
|
inlineoverridevirtual |
Get the tooltip the reset button should display when showing this panel.
- Returns
- the tooltip
Reimplemented from RESETTABLE_PANEL.
Definition at line 53 of file panel_hotkeys_editor.h.
References _.
◆ ImportHotKeys()
|
private |
Put up a dialog allowing the user to select a hotkeys file and then overlays those hotkeys onto the current hotkey store.
Definition at line 185 of file panel_hotkeys_editor.cpp.
References _, EDA_BASE_FRAME::GetMruPath(), HOTKEY_STORE::GetSections(), HotkeyFileExtension, HotkeyFileWildcard(), HOTKEY::m_Actions, HOTKEY::m_EditKeycode, HOTKEY::m_EditKeycodeAlt, m_frame, m_hotkeyListCtrl, m_hotkeyStore, ReadHotKeyConfig(), EDA_BASE_FRAME::SetMruPath(), and WIDGET_HOTKEY_LIST::TransferDataToControl().
Referenced by installButtons().
◆ installButtons()
|
private |
Install the button panel (global reset/default, import/export)
- Parameters
-
aSizer the dialog to install on.
Definition at line 109 of file panel_hotkeys_editor.cpp.
References _, dumpHotkeys(), ADVANCED_CFG::GetCfg(), KIUI::GetStdMargin(), ImportHotKeys(), m_hotkeyListCtrl, and WIDGET_HOTKEY_LIST::ResetAllHotkeys().
Referenced by PANEL_HOTKEYS_EDITOR().
◆ OnFilterSearch()
|
private |
Handle a change in the hotkey filter text.
- Parameters
-
aEvent is the search event, used to get the search query.
Definition at line 178 of file panel_hotkeys_editor.cpp.
References WIDGET_HOTKEY_LIST::ApplyFilterString(), and m_hotkeyListCtrl.
Referenced by PANEL_HOTKEYS_EDITOR().
◆ ResetPanel()
|
overridevirtual |
Reset the contents of this panel.
Implements RESETTABLE_PANEL.
Definition at line 103 of file panel_hotkeys_editor.cpp.
References m_hotkeyListCtrl, and WIDGET_HOTKEY_LIST::ResetAllHotkeys().
◆ TransferDataFromWindow()
|
override |
Definition at line 164 of file panel_hotkeys_editor.cpp.
References m_actions, m_hotkeyListCtrl, m_readOnly, WIDGET_HOTKEY_LIST::TransferDataFromControl(), and WriteHotKeyConfig().
◆ TransferDataToWindow()
|
override |
Definition at line 153 of file panel_hotkeys_editor.cpp.
References HOTKEY_STORE::Init(), m_actions, m_hotkeyListCtrl, m_hotkeyStore, m_readOnly, and WIDGET_HOTKEY_LIST::TransferDataToControl().
Referenced by DIALOG_LIST_HOTKEYS::TransferDataToWindow().
Member Data Documentation
◆ m_actions
|
protected |
Definition at line 91 of file panel_hotkeys_editor.h.
Referenced by ActionsList(), TransferDataFromWindow(), and TransferDataToWindow().
◆ m_frame
|
protected |
Definition at line 88 of file panel_hotkeys_editor.h.
Referenced by dumpHotkeys(), and ImportHotKeys().
◆ m_hotkeyListCtrl
|
protected |
Definition at line 93 of file panel_hotkeys_editor.h.
Referenced by ImportHotKeys(), installButtons(), OnFilterSearch(), PANEL_HOTKEYS_EDITOR(), ResetPanel(), TransferDataFromWindow(), and TransferDataToWindow().
◆ m_hotkeyStore
|
protected |
Definition at line 92 of file panel_hotkeys_editor.h.
Referenced by dumpHotkeys(), ImportHotKeys(), PANEL_HOTKEYS_EDITOR(), and TransferDataToWindow().
◆ m_readOnly
|
protected |
Definition at line 89 of file panel_hotkeys_editor.h.
Referenced by PANEL_HOTKEYS_EDITOR(), TransferDataFromWindow(), and TransferDataToWindow().
The documentation for this class was generated from the following files:
