#include <panel_hotkeys_editor.h>

Inheritance diagram for PANEL_HOTKEYS_EDITOR:

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

 :
 RESETTABLE_PANEL( aWindow, wxID_ANY, wxDefaultPosition, wxDefaultSize ),
 m_frame( aFrame ),
 m_readOnly( aReadOnly ),
 m_hotkeyStore()
{
 const auto margin = KIUI::GetStdMargin();
 wxBoxSizer* mainSizer = new wxBoxSizer( wxVERTICAL );
 
 const int side_margins = margin * 2;
 wxBoxSizer* bMargins = new wxBoxSizer( wxVERTICAL );
 
 wxSearchCtrl* filterSearch = CreateTextFilterBox( this, _( "Type filter text" ) );
 bMargins->Add( filterSearch, 0, wxALL | wxEXPAND, margin );
 
 m_hotkeyListCtrl = new WIDGET_HOTKEY_LIST( this, m_hotkeyStore, m_readOnly );
 bMargins->Add( m_hotkeyListCtrl, 1, wxALL | wxEXPAND, margin );
 
 if( !m_readOnly )
 installButtons( bMargins );
 
 mainSizer->Add( bMargins, 1, wxEXPAND | wxRIGHT | wxLEFT, side_margins );
 
#ifdef __WXGTK__
 // Work around a bug that clips the text vertically in the wxSearchCtrl on GTK
 filterSearch->SetMinSize( wxSize( filterSearch->GetSize().x,
 int( filterSearch->GetSize().y * 1.6 ) ) );
#endif
 
 SetSizer( mainSizer );
 Layout();
 
 // Connect Events
 filterSearch->Bind( wxEVT_COMMAND_TEXT_UPDATED, &PANEL_HOTKEYS_EDITOR::OnFilterSearch, this );
}

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

Member Function Documentation

◆ ActionsList()

std::vector< TOOL_ACTION * > & PANEL_HOTKEYS_EDITOR::ActionsList ( )

inline

Definition at line 46 of file panel_hotkeys_editor.h.

46{ return m_actions; }

PANEL_HOTKEYS_EDITOR::m_actions

std::vector< TOOL_ACTION * > m_actions

Definition: panel_hotkeys_editor.h:91

References m_actions.

Referenced by DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), and EDA_BASE_FRAME::ShowPreferences().

◆ dumpHotkeys()

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

{
 wxString filename = wxFileSelector( wxT( "Hotkeys File" ), m_frame->GetMruPath(),
 wxEmptyString, TextFileExtension, TextFileWildcard(),
 wxFD_SAVE, this );
 
 if( filename.IsEmpty() )
 return;
 
 wxFileName fn( filename );
 
 wxFFileOutputStream fileStream( fn.GetFullPath(), "w" );
 wxTextOutputStream stream( fileStream );
 
 if( !fn.IsDirWritable() || ( fn.Exists() && !fn.IsFileWritable() ) )
 return;
 
 for( HOTKEY_SECTION& section : m_hotkeyStore.GetSections() )
 {
 stream << wxT( "=== " ) << section.m_SectionName << endl << endl;
 
 stream << wxT( "[width=\"100%\",options=\"header\",cols=\"20%,15%,65%\"]" ) << endl;
 stream << wxT( "|===" ) << endl;
 stream << _( "| Action | Default Hotkey | Description" ) << endl;
 
 for( HOTKEY& hk : section.m_HotKeys )
 {
 stream << wxT( "| " ) << hk.m_Actions[0]->GetLabel() << endl;
 
 if( hk.m_EditKeycode > 0 )
 {
 stream << wxT( " | kbd:[" ) << KeyNameFromKeyCode( hk.m_EditKeycode ) << ']'
 << endl;
 }
 else
 {
 stream << wxT( " |" ) << endl;
 }
 
 stream << wxT( " | " ) << hk.m_Actions[0]->GetDescription( false ) << endl;
 }
 
 stream << wxT( "|===" ) << endl << endl;
 }
 
 stream.Flush();
 fileStream.Close();
}

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()

wxString RESETTABLE_PANEL::GetHelpTextAtPoint	(	const wxPoint &	aPt,
		wxHelpEvent::Origin	aOrigin
	)		const

inlineoverrideinherited

Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }.

Definition at line 72 of file resettable_panel.h.

 {
 if( aPt == wxPoint( -INT_MAX, INT_MAX ) )
 return GetResetTooltip();
 else
 return wxPanel::GetHelpTextAtPoint( aPt, aOrigin );
 }

References RESETTABLE_PANEL::GetResetTooltip().

◆ GetResetTooltip()

wxString PANEL_HOTKEYS_EDITOR::GetResetTooltip ( ) const

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.

 {
 return _( "Reset all hotkeys to the built-in KiCad defaults" );
 }

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

{
 wxString filename = wxFileSelector( _( "Import Hotkeys File:" ), m_frame->GetMruPath(),
 wxEmptyString, HotkeyFileExtension,
 HotkeyFileWildcard(), wxFD_OPEN, this );
 
 if( filename.IsEmpty() )
 return;
 
 std::map<std::string, int> importedHotKeys;
 ReadHotKeyConfig( filename, importedHotKeys );
 m_frame->SetMruPath( wxFileName( filename ).GetPath() );
 
 // Overlay the imported hotkeys onto the hotkey store
 for( HOTKEY_SECTION& section: m_hotkeyStore.GetSections() )
 {
 for( HOTKEY& hotkey: section.m_HotKeys )
 {
 if( importedHotKeys.count( hotkey.m_Actions[ 0 ]->GetName() ) )
 hotkey.m_EditKeycode = importedHotKeys[ hotkey.m_Actions[ 0 ]->GetName() ];
 }
 }
 
 m_hotkeyListCtrl->TransferDataToControl();
}

References _, EDA_BASE_FRAME::GetMruPath(), HOTKEY_STORE::GetSections(), HotkeyFileExtension, HotkeyFileWildcard(), 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

aSizer the dialog to install on.

Definition at line 115 of file panel_hotkeys_editor.cpp.

{
 BUTTON_ROW_PANEL::BTN_DEF_LIST l_btn_defs = {
 {
 wxID_RESET,
 _( "Undo All Changes" ),
 _( "Undo all changes made so far in this dialog" ),
 [this]( wxCommandEvent& )
 {
 m_hotkeyListCtrl->ResetAllHotkeys( false );
 }
 },
 {
 wxID_ANY,
 _( "Import Hotkeys..." ),
 _( "Import hotkey definitions from an external file, replacing the current values" ),
 [this]( wxCommandEvent& )
 {
 ImportHotKeys();
 }
 }
 };
 
 if( ADVANCED_CFG::GetCfg().m_HotkeysDumper )
 {
 // Add hotkeys dumper (does not need translation, it's a dev tool only)
 l_btn_defs.push_back( {
 wxID_ANY, wxT( "Dump Hotkeys" ), wxEmptyString,
 [this]( wxCommandEvent& )
 {
 dumpHotkeys();
 }
 } );
 }
 
 const BUTTON_ROW_PANEL::BTN_DEF_LIST r_btn_defs = {
 };
 
 auto btnPanel = std::make_unique<BUTTON_ROW_PANEL>( this, l_btn_defs, r_btn_defs );
 
 aSizer->Add( btnPanel.release(), 0, wxEXPAND | wxTOP, KIUI::GetStdMargin() );
}

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

aEvent is the search event, used to get the search query.

Definition at line 184 of file panel_hotkeys_editor.cpp.

{
 const auto searchStr = aEvent.GetString();
 m_hotkeyListCtrl->ApplyFilterString( searchStr );
}

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

{
 m_hotkeyListCtrl->ResetAllHotkeys( true );
}

References m_hotkeyListCtrl, and WIDGET_HOTKEY_LIST::ResetAllHotkeys().

◆ TransferDataFromWindow()

bool PANEL_HOTKEYS_EDITOR::TransferDataFromWindow ( )

override

Definition at line 170 of file panel_hotkeys_editor.cpp.

{
 if( m_readOnly )
 return true;
 
 if( !m_hotkeyListCtrl->TransferDataFromControl() )
 return false;
 
 WriteHotKeyConfig( m_actions );
 
 return true;
}

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

◆ TransferDataToWindow()

bool PANEL_HOTKEYS_EDITOR::TransferDataToWindow ( )

override

Definition at line 159 of file panel_hotkeys_editor.cpp.

{
 m_hotkeyStore.Init( m_actions, m_readOnly );
 
 if( !m_hotkeyListCtrl->TransferDataToControl() )
 return false;
 
 return true;
}

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

std::vector<TOOL_ACTION*> PANEL_HOTKEYS_EDITOR::m_actions

protected

Definition at line 91 of file panel_hotkeys_editor.h.

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

◆ m_frame

EDA_BASE_FRAME* PANEL_HOTKEYS_EDITOR::m_frame

protected

Definition at line 88 of file panel_hotkeys_editor.h.

Referenced by dumpHotkeys(), and ImportHotKeys().

◆ m_hotkeyListCtrl

WIDGET_HOTKEY_LIST* PANEL_HOTKEYS_EDITOR::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

HOTKEY_STORE PANEL_HOTKEYS_EDITOR::m_hotkeyStore

protected

Definition at line 92 of file panel_hotkeys_editor.h.

Referenced by dumpHotkeys(), ImportHotKeys(), PANEL_HOTKEYS_EDITOR(), and TransferDataToWindow().

◆ m_readOnly

bool PANEL_HOTKEYS_EDITOR::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:

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_HOTKEYS_EDITOR()

Member Function Documentation

◆ ActionsList()

◆ dumpHotkeys()

◆ GetHelpTextAtPoint()

◆ GetResetTooltip()

◆ ImportHotKeys()

◆ installButtons()

◆ OnFilterSearch()

◆ ResetPanel()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

Member Data Documentation

◆ m_actions

◆ m_frame

◆ m_hotkeyListCtrl

◆ m_hotkeyStore

◆ m_readOnly