KiCad PCB EDA Suite
PANEL_HOTKEYS_EDITOR Class Reference

#include <panel_hotkeys_editor.h>

Inheritance diagram for PANEL_HOTKEYS_EDITOR:
RESETTABLE_PANEL

Public Member Functions

 PANEL_HOTKEYS_EDITOR (EDA_BASE_FRAME *aFrame, wxWindow *aWindow, bool aReadOnly)
 
void AddHotKeys (TOOL_MANAGER *aToolMgr)
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
void ResetPanel () override
 Reset the contents of this panel. More...
 
wxString GetResetTooltip () override
 Get the tooltip the reset button should display when showing this panel. More...
 

Protected Attributes

EDA_BASE_FRAMEm_frame
 
bool m_readOnly
 
std::vector< TOOL_MANAGER * > m_toolManagers
 
HOTKEY_STORE m_hotkeyStore
 
WIDGET_HOTKEY_LISTm_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 ()
 Dumps 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 63 of file panel_hotkeys_editor.cpp.

64  :
65  RESETTABLE_PANEL( aWindow, wxID_ANY, wxDefaultPosition, default_dialog_size ),
66  m_frame( aFrame ),
67  m_readOnly( aReadOnly ),
69 {
70  const auto margin = KIUI::GetStdMargin();
71  wxBoxSizer* mainSizer = new wxBoxSizer( wxVERTICAL );
72 
73  const int side_margins = margin * 2;
74  wxBoxSizer* bMargins = new wxBoxSizer( wxVERTICAL );
75 
76  wxSearchCtrl* filterSearch = CreateTextFilterBox( this, _( "Type filter text" ) );
77  bMargins->Add( filterSearch, 0, wxALL | wxEXPAND, margin );
78 
80  bMargins->Add( m_hotkeyListCtrl, 1, wxALL | wxEXPAND, margin );
81 
82  if( !m_readOnly )
83  installButtons( bMargins );
84 
85  mainSizer->Add( bMargins, 1, wxEXPAND | wxRIGHT | wxLEFT, side_margins );
86 
87 #ifdef __WXGTK__
88  // Work around a bug that clips the text vertically in the wxSearchCtrl on GTK
89  filterSearch->SetMinSize( wxSize( filterSearch->GetSize().x,
90  int( filterSearch->GetSize().y * 1.6 ) ) );
91 #endif
92 
93  SetSizer( mainSizer );
94  Layout();
95 
96  // Connect Events
97  filterSearch->Bind( wxEVT_COMMAND_TEXT_UPDATED, &PANEL_HOTKEYS_EDITOR::OnFilterSearch, this );
98 }
void OnFilterSearch(wxCommandEvent &aEvent)
Handle a change in the hotkey filter text.
static wxSearchCtrl * CreateTextFilterBox(wxWindow *aParent, const wxString &aDescriptiveText)
Helper function to add a filter box to a panel, with some sensible defaults for that purpose.
RESETTABLE_PANEL(wxWindow *aParent, wxWindowID aId=wxID_ANY, const wxPoint &aPos=wxDefaultPosition, const wxSize &aSize=wxSize(-1,-1), long aStyle=wxTAB_TRAVERSAL, const wxString &aName=wxEmptyString)
static const wxSize default_dialog_size
int GetStdMargin()
Get the standard margin around a widget in the KiCad UI.
Definition: ui_common.cpp:29
EDA_BASE_FRAME * m_frame
void installButtons(wxSizer *aSizer)
Install the button panel (global reset/default, import/export)
#define _(s)
Definition: 3d_actions.cpp:33
WIDGET_HOTKEY_LIST * m_hotkeyListCtrl

References _, CreateTextFilterBox(), KIUI::GetStdMargin(), installButtons(), m_hotkeyListCtrl, m_hotkeyStore, m_readOnly, and OnFilterSearch().

Member Function Documentation

◆ AddHotKeys()

◆ dumpHotkeys()

void PANEL_HOTKEYS_EDITOR::dumpHotkeys ( )
private

Dumps 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 216 of file panel_hotkeys_editor.cpp.

217 {
218  wxString filename = EDA_FILE_SELECTOR( wxT( "Dump Hotkeys File:" ), m_frame->GetMruPath(),
219  wxEmptyString, wxT( "txt" ), wxT( "*.txt" ), this,
220  wxFD_SAVE, true );
221 
222  if( filename.IsEmpty() )
223  return;
224 
225  wxFileName fn( filename );
226 
227  wxFFileOutputStream fileStream( fn.GetFullPath(), "w" );
228  wxTextOutputStream stream( fileStream );
229 
230  if( !fn.IsDirWritable() || ( fn.Exists() && !fn.IsFileWritable() ) )
231  return;
232 
233  for( HOTKEY_SECTION& section : m_hotkeyStore.GetSections() )
234  {
235  stream << wxT( "=== " ) << section.m_SectionName << endl << endl;
236 
237  stream << wxT( "[width=\"100%\",options=\"header\",cols=\"20%,15%,65%\"]" ) << endl;
238  stream << wxT( "|===" ) << endl;
239  stream << _( "| Action | Default Hotkey | Description" ) << endl;
240 
241  for( HOTKEY& hk : section.m_HotKeys )
242  {
243  stream << wxT( "| " ) << hk.m_Actions[0]->GetLabel() << endl;
244 
245  if( hk.m_EditKeycode > 0 )
246  stream << wxT( " | `" ) << KeyNameFromKeyCode( hk.m_EditKeycode ) << '`' << endl;
247  else
248  stream << wxT( " |" ) << endl;
249 
250  stream << wxT( " | " ) << hk.m_Actions[0]->GetDescription( false ) << endl;
251  }
252 
253  stream << wxT( "|===" ) << endl << endl;
254  }
255 
256  stream.Flush();
257  fileStream.Close();
258 }
EDA_BASE_FRAME * m_frame
wxString GetMruPath() const
wxString EDA_FILE_SELECTOR(const wxString &aTitle, const wxString &aPath, const wxString &aFileName, const wxString &aExtension, const wxString &aWildcard, wxWindow *aParent, int aStyle, const bool aKeepWorkingDirectory, const wxPoint &aPosition, wxString *aMruPath)
A helper function that wraps a call to wxFileSelector.
Definition: gestfich.cpp:52
std::vector< TOOL_ACTION * > m_Actions
Definition: hotkey_store.h:36
std::vector< HOTKEY_SECTION > & GetSections()
Get the list of sections managed by this store.
#define _(s)
Definition: 3d_actions.cpp:33
wxString KeyNameFromKeyCode(int aKeycode, bool *aIsFound)
Return the key name from the key code.
int m_EditKeycode
Definition: hotkey_store.h:37

References _, EDA_FILE_SELECTOR(), EDA_BASE_FRAME::GetMruPath(), HOTKEY_STORE::GetSections(), KeyNameFromKeyCode(), HOTKEY::m_Actions, HOTKEY::m_EditKeycode, m_frame, and m_hotkeyStore.

Referenced by installButtons().

◆ GetResetTooltip()

wxString PANEL_HOTKEYS_EDITOR::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.

54  {
55  return _( "Reset all hotkeys to the built-in KiCad defaults" );
56  }
#define _(s)
Definition: 3d_actions.cpp:33

References _.

◆ ImportHotKeys()

void PANEL_HOTKEYS_EDITOR::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 188 of file panel_hotkeys_editor.cpp.

189 {
190  wxString ext = DEFAULT_HOTKEY_FILENAME_EXT;
191  wxString mask = wxT( "*." ) + ext;
192  wxString filename = EDA_FILE_SELECTOR( _( "Import Hotkeys File:" ), m_frame->GetMruPath(),
193  wxEmptyString, ext, mask, this, wxFD_OPEN, true );
194 
195  if( filename.IsEmpty() )
196  return;
197 
198  std::map<std::string, int> importedHotKeys;
199  ReadHotKeyConfig( filename, importedHotKeys );
200  m_frame->SetMruPath( wxFileName( filename ).GetPath() );
201 
202  // Overlay the imported hotkeys onto the hotkey store
203  for( HOTKEY_SECTION& section: m_hotkeyStore.GetSections() )
204  {
205  for( HOTKEY& hotkey: section.m_HotKeys )
206  {
207  if( importedHotKeys.count( hotkey.m_Actions[ 0 ]->GetName() ) )
208  hotkey.m_EditKeycode = importedHotKeys[ hotkey.m_Actions[ 0 ]->GetName() ];
209  }
210  }
211 
213 }
void SetMruPath(const wxString &aPath)
bool TransferDataToControl()
Method TransferDataToControl Load the hotkey data from the store into the control.
void ReadHotKeyConfig(const wxString &aFileName, std::map< std::string, int > &aHotKeys)
Reads a hotkey config file into a map.
EDA_BASE_FRAME * m_frame
wxString GetMruPath() const
wxString EDA_FILE_SELECTOR(const wxString &aTitle, const wxString &aPath, const wxString &aFileName, const wxString &aExtension, const wxString &aWildcard, wxWindow *aParent, int aStyle, const bool aKeepWorkingDirectory, const wxPoint &aPosition, wxString *aMruPath)
A helper function that wraps a call to wxFileSelector.
Definition: gestfich.cpp:52
std::vector< TOOL_ACTION * > m_Actions
Definition: hotkey_store.h:36
std::vector< HOTKEY_SECTION > & GetSections()
Get the list of sections managed by this store.
#define _(s)
Definition: 3d_actions.cpp:33
WIDGET_HOTKEY_LIST * m_hotkeyListCtrl
#define DEFAULT_HOTKEY_FILENAME_EXT
Definition: hotkeys_basic.h:30
int m_EditKeycode
Definition: hotkey_store.h:37

References _, DEFAULT_HOTKEY_FILENAME_EXT, EDA_FILE_SELECTOR(), EDA_BASE_FRAME::GetMruPath(), HOTKEY_STORE::GetSections(), HOTKEY::m_Actions, HOTKEY::m_EditKeycode, m_frame, m_hotkeyListCtrl, m_hotkeyStore, ReadHotKeyConfig(), EDA_BASE_FRAME::SetMruPath(), and WIDGET_HOTKEY_LIST::TransferDataToControl().

Referenced by installButtons().

◆ installButtons()

void PANEL_HOTKEYS_EDITOR::installButtons ( wxSizer *  aSizer)
private

Install the button panel (global reset/default, import/export)

Parameters
aSizerthe dialog to install on.

Definition at line 113 of file panel_hotkeys_editor.cpp.

114 {
115  BUTTON_ROW_PANEL::BTN_DEF_LIST l_btn_defs = {
116  {
117  wxID_RESET,
118  _( "Undo All Changes" ),
119  _( "Undo all changes made so far in this dialog" ),
120  [this]( wxCommandEvent& )
121  {
123  }
124  },
125  {
126  wxID_ANY,
127  _( "Import Hotkeys..." ),
128  _( "Import hotkey definitions from an external file, replacing the current values" ),
129  [this]( wxCommandEvent& )
130  {
131  ImportHotKeys();
132  }
133  }
134  };
135 
136 
137  if( ADVANCED_CFG::GetCfg().m_HotkeysDumper )
138  {
139  // Add hotkeys dumper (does not need translation, it's a dev tool only)
140  l_btn_defs.push_back( {
141  wxID_ANY, wxT( "Dump Hotkeys" ), wxEmptyString,
142  [this]( wxCommandEvent& )
143  {
144  dumpHotkeys();
145  }
146  } );
147  }
148 
149  const BUTTON_ROW_PANEL::BTN_DEF_LIST r_btn_defs = {
150  };
151 
152  auto btnPanel = std::make_unique<BUTTON_ROW_PANEL>( this, l_btn_defs, r_btn_defs );
153 
154  aSizer->Add( btnPanel.release(), 0, wxEXPAND | wxTOP, KIUI::GetStdMargin() );
155 }
void ImportHotKeys()
Put up a dialog allowing the user to select a hotkeys file and then overlays those hotkeys onto the c...
int GetStdMargin()
Get the standard margin around a widget in the KiCad UI.
Definition: ui_common.cpp:29
void dumpHotkeys()
Dumps all actions and their hotkeys to a text file for inclusion in documentation.
#define _(s)
Definition: 3d_actions.cpp:33
std::vector< BTN_DEF > BTN_DEF_LIST
A list of BTN_DEFs, used to group buttons into the left/right groups.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
WIDGET_HOTKEY_LIST * m_hotkeyListCtrl
void ResetAllHotkeys(bool aResetToDefault)
Set hotkeys in the control to default or original values.

References _, dumpHotkeys(), ADVANCED_CFG::GetCfg(), KIUI::GetStdMargin(), ImportHotKeys(), m_hotkeyListCtrl, and WIDGET_HOTKEY_LIST::ResetAllHotkeys().

Referenced by PANEL_HOTKEYS_EDITOR().

◆ OnFilterSearch()

void PANEL_HOTKEYS_EDITOR::OnFilterSearch ( wxCommandEvent &  aEvent)
private

Handle a change in the hotkey filter text.

Parameters
aEventis the search event, used to get the search query.

Definition at line 181 of file panel_hotkeys_editor.cpp.

182 {
183  const auto searchStr = aEvent.GetString();
184  m_hotkeyListCtrl->ApplyFilterString( searchStr );
185 }
void ApplyFilterString(const wxString &aFilterStr)
Method ApplyFilterString Apply a filter string to the hotkey list, selecting which hotkeys to show.
WIDGET_HOTKEY_LIST * m_hotkeyListCtrl

References WIDGET_HOTKEY_LIST::ApplyFilterString(), and m_hotkeyListCtrl.

Referenced by PANEL_HOTKEYS_EDITOR().

◆ ResetPanel()

void PANEL_HOTKEYS_EDITOR::ResetPanel ( )
overridevirtual

Reset the contents of this panel.

Implements RESETTABLE_PANEL.

Definition at line 107 of file panel_hotkeys_editor.cpp.

108 {
110 }
WIDGET_HOTKEY_LIST * m_hotkeyListCtrl
void ResetAllHotkeys(bool aResetToDefault)
Set hotkeys in the control to default or original values.

References m_hotkeyListCtrl, and WIDGET_HOTKEY_LIST::ResetAllHotkeys().

◆ TransferDataFromWindow()

bool PANEL_HOTKEYS_EDITOR::TransferDataFromWindow ( )
override

Definition at line 165 of file panel_hotkeys_editor.cpp.

166 {
168  return false;
169 
170  if( m_readOnly )
171  return true;
172 
173  // save the hotkeys
174  for( TOOL_MANAGER* toolMgr : m_toolManagers )
175  WriteHotKeyConfig( toolMgr->GetActions() );
176 
177  return true;
178 }
std::vector< TOOL_MANAGER * > m_toolManagers
Master controller class:
Definition: tool_manager.h:52
WIDGET_HOTKEY_LIST * m_hotkeyListCtrl
int WriteHotKeyConfig(const std::map< std::string, TOOL_ACTION * > &aActionMap)
Update the hotkeys config file with the hotkeys from the given actions map.
bool TransferDataFromControl()
Method TransferDataFromControl Save the hotkey data from the control.

References m_hotkeyListCtrl, m_readOnly, m_toolManagers, WIDGET_HOTKEY_LIST::TransferDataFromControl(), and WriteHotKeyConfig().

◆ TransferDataToWindow()

bool PANEL_HOTKEYS_EDITOR::TransferDataToWindow ( )
override

Definition at line 158 of file panel_hotkeys_editor.cpp.

159 {
162 }
bool TransferDataToControl()
Method TransferDataToControl Load the hotkey data from the store into the control.
std::vector< TOOL_MANAGER * > m_toolManagers
WIDGET_HOTKEY_LIST * m_hotkeyListCtrl
void Init(std::vector< TOOL_MANAGER * > aToolManagerList, bool aIncludeGestures)

References HOTKEY_STORE::Init(), m_hotkeyListCtrl, m_hotkeyStore, m_readOnly, m_toolManagers, and WIDGET_HOTKEY_LIST::TransferDataToControl().

Referenced by DIALOG_LIST_HOTKEYS::TransferDataToWindow().

Member Data Documentation

◆ m_frame

EDA_BASE_FRAME* PANEL_HOTKEYS_EDITOR::m_frame
protected

Definition at line 87 of file panel_hotkeys_editor.h.

Referenced by dumpHotkeys(), and ImportHotKeys().

◆ m_hotkeyListCtrl

WIDGET_HOTKEY_LIST* PANEL_HOTKEYS_EDITOR::m_hotkeyListCtrl
protected

◆ m_hotkeyStore

HOTKEY_STORE PANEL_HOTKEYS_EDITOR::m_hotkeyStore
protected

◆ m_readOnly

bool PANEL_HOTKEYS_EDITOR::m_readOnly
protected

◆ m_toolManagers

std::vector<TOOL_MANAGER*> PANEL_HOTKEYS_EDITOR::m_toolManagers
protected

Definition at line 90 of file panel_hotkeys_editor.h.

Referenced by AddHotKeys(), TransferDataFromWindow(), and TransferDataToWindow().


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