PANEL_HOTKEYS_EDITOR Class Reference

#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)
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_FRAME *	m_frame
bool	m_readOnly
std::vector< TOOL_MANAGER * >	m_toolManagers
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 ()
	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.

                                                             :
        RESETTABLE_PANEL( aWindow, wxID_ANY, wxDefaultPosition, default_dialog_size ),
        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

AddHotKeys()

void PANEL_HOTKEYS_EDITOR::AddHotKeys

(

TOOL_MANAGER *

aToolMgr

)

Definition at line 101 of file panel_hotkeys_editor.cpp.

{
    m_toolManagers.push_back( aToolMgr );
}

References m_toolManagers.

Referenced by DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), and SCH_EDIT_FRAME::InstallPreferences().

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.

{
    wxString filename = EDA_FILE_SELECTOR( wxT( "Dump Hotkeys File:" ), m_frame->GetMruPath(),
                                           wxEmptyString, wxT( "txt" ), wxT( "*.txt" ), this,
                                           wxFD_SAVE, true );

    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( "  | `" ) << 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_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.

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

{
    wxString ext  = DEFAULT_HOTKEY_FILENAME_EXT;
    wxString mask = wxT( "*." ) + ext;
    wxString filename = EDA_FILE_SELECTOR( _( "Import Hotkeys File:" ), m_frame->GetMruPath(),
                                           wxEmptyString, ext, mask, this, wxFD_OPEN, true );

    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 _, 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

aSizer

the dialog to install on.

Definition at line 113 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 181 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 107 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 165 of file panel_hotkeys_editor.cpp.

{
    if( !m_hotkeyListCtrl->TransferDataFromControl() )
        return false;

    if( m_readOnly )
        return true;

    // save the hotkeys
    for( TOOL_MANAGER* toolMgr : m_toolManagers )
        WriteHotKeyConfig( toolMgr->GetActions() );

    return true;
}

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.

{
    m_hotkeyStore.Init( m_toolManagers, m_readOnly );
    return m_hotkeyListCtrl->TransferDataToControl();
}

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

Definition at line 92 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 91 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 88 of file panel_hotkeys_editor.h.

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

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:

• panel_hotkeys_editor.h
• panel_hotkeys_editor.cpp