kicad/common/dialogs/panel_hotkeys_editor.cpp

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 1992-2018 Kicad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#include <bitmaps.h>
#include <confirm.h>
#include <eda_base_frame.h>
#include <panel_hotkeys_editor.h>

#include <wx/button.h>
#include <wx/panel.h>
#include <wx/sizer.h>
#include <wx/srchctrl.h>
#include <wx/statline.h>

#include <widgets/button_row_panel.h>
#include <widgets/ui_common.h>


static const wxSize default_dialog_size { 500, 350 };
static const wxSize min_dialog_size { -1, 350 };

/**
 * Helper function to add a filter box to a panel, with some
 * sensible defaults for that purpose.
 *
 * @param  aParent          The panrent widget/panel
 * @param  aDescriptiveText The text to show when the box is empty.
 * @return                  A newly constructed filter box - the caller owns it
 */
static wxSearchCtrl* CreateTextFilterBox( wxWindow* aParent, const wxString& aDescriptiveText )
{
    auto search_widget = new wxSearchCtrl( aParent, wxID_ANY );

    search_widget->ShowSearchButton( false );
    search_widget->ShowCancelButton( true );

    search_widget->SetDescriptiveText( aDescriptiveText);

    return search_widget;
}


PANEL_HOTKEYS_EDITOR::PANEL_HOTKEYS_EDITOR( EDA_BASE_FRAME* aFrame, wxWindow* aWindow,
                                            bool aReadOnly,
                                            EDA_HOTKEY_CONFIG* aHotkeys,
                                            EDA_HOTKEY_CONFIG* aShowHotkeys,
                                            const wxString& aNickname ) :
        wxPanel( aWindow, wxID_ANY, wxDefaultPosition, default_dialog_size ),
        m_frame( aFrame ),
        m_readOnly( aReadOnly ),
        m_hotkeys( aHotkeys ),
        m_nickname( aNickname ),
        m_hotkeyStore( aShowHotkeys )
{
    const auto margin = KIUI::GetStdMargin();

    m_mainSizer = new wxBoxSizer( wxVERTICAL );
    m_errorMessageSizer = new wxBoxSizer( wxVERTICAL );

    // Setup the sub-sizer to contain the bitmap and header text
    wxBoxSizer* errImgHeadSizer = new wxBoxSizer( wxHORIZONTAL );

    wxStaticBitmap* valid_img = new wxStaticBitmap(
            this, wxID_ANY, KiBitmap( cancel_xpm ), wxDefaultPosition, wxDefaultSize, 0 );
    wxStaticText* err_head = new wxStaticText( this, wxID_ANY, _( "Hotkey errors detected" ),
            wxDefaultPosition, wxDefaultSize, wxALIGN_LEFT );
    errImgHeadSizer->Add( valid_img, 0, wxALL, 5 );
    errImgHeadSizer->Add( err_head, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
    m_errorMessageSizer->Add( errImgHeadSizer, 0, wxTOP | wxLEFT | wxRIGHT, margin );

    // Setup the error message to give the user information about any problems with the hotkeys,
    // but only do this if they can actually change them
    if( !m_readOnly )
    {
        m_errorMessage = new wxStaticText(
                this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxALIGN_LEFT );
        m_errorMessageSizer->Add( m_errorMessage, 0, wxALL, 5 );
    }
    m_errorMessageSizer->Add( new wxStaticLine( this ), 0, wxALL | wxEXPAND, 2 );

    // Add the validity text to the main sizer and hide the entire sizer
    m_mainSizer->Add( m_errorMessageSizer, 0, wxTOP | wxLEFT | wxRIGHT | wxEXPAND, margin );

    // Sub-sizer for setting a wider side margin
    // TODO: Can this be set by the parent widget- doesn't seem to be
    // this panel's responsibility?
    const int side_margins = 10; // seems to be hardcoded in wxFB
    auto bMargins = new wxBoxSizer( wxVERTICAL );

    auto filterSearch = CreateTextFilterBox( this, _( "Type filter text" ) );
    bMargins->Add( filterSearch, 0, wxBOTTOM | wxEXPAND | wxTOP, 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 );

    m_mainSizer->Add( bMargins, 1, wxEXPAND | wxRIGHT | wxLEFT, side_margins );

    this->SetSizer( m_mainSizer );
    this->Layout();

    // Connect Events
    filterSearch->Bind( wxEVT_COMMAND_TEXT_UPDATED,
        &PANEL_HOTKEYS_EDITOR::OnFilterSearch, this );
}


void PANEL_HOTKEYS_EDITOR::installButtons( wxSizer* aSizer )
{
    const BUTTON_ROW_PANEL::BTN_DEF_LIST l_btn_defs = {
        {
            wxID_RESET,
            _( "Reset Hotkeys" ),
            _( "Undo all changes made so far in this dialog" ),
            [this]( wxCommandEvent& ){
                m_hotkeyListCtrl->ResetAllHotkeys( false );
            }
        },
        {
            wxID_ANY,
            _( "Set to Defaults" ),
            _( "Set all hotkeys to the built-in KiCad defaults" ),
            [this]( wxCommandEvent& ){
                m_hotkeyListCtrl->ResetAllHotkeys( true );
            }
        }
    };

    const BUTTON_ROW_PANEL::BTN_DEF_LIST r_btn_defs = {
        {
            wxID_ANY,
            _( "Import..." ),
            _( "Import hotkey definitions from an external file, replacing the current values" ),
            [this]( wxCommandEvent& ){
                onImportHotkeyConfigFromFile();
            }
        },
        {
            wxID_ANY,
            _( "Export..." ),
            _( "Export these hotkey definitions to an external file" ),
            [this]( wxCommandEvent& ){
                m_frame->ExportHotkeyConfigToFile( m_hotkeys, m_nickname );
            }
        },
    };

    auto btnPanel = std::make_unique<BUTTON_ROW_PANEL>( this, l_btn_defs, r_btn_defs );

    aSizer->Add( btnPanel.release(), 0, wxEXPAND | wxTOP, KIUI::GetStdMargin() );
}


void PANEL_HOTKEYS_EDITOR::onImportHotkeyConfigFromFile()
{
    m_frame->ImportHotkeyConfigFromFile( m_hotkeys, m_nickname );

    if( !m_hotkeyStore.TestStoreValidity() )
    {
        wxString msg = _( "The imported file contains invalid hotkeys. "
                          "Please correct the errors before continuing." );

        wxString errKeys;
        m_hotkeyStore.GetStoreValidityMessage( errKeys );
        DisplayErrorMessage( this, msg, errKeys );
    }
}


bool PANEL_HOTKEYS_EDITOR::TransferDataToWindow()
{
    return m_hotkeyListCtrl->TransferDataToControl();
}


bool PANEL_HOTKEYS_EDITOR::TransferDataFromWindow()
{
    if( !m_hotkeyListCtrl->TransferDataFromControl() )
        return false;

    // save the hotkeys
    m_frame->WriteHotkeyConfig( m_hotkeys );

    return true;
}


void PANEL_HOTKEYS_EDITOR::OnFilterSearch( wxCommandEvent& aEvent )
{
    const auto searchStr = aEvent.GetString();
    m_hotkeyListCtrl->ApplyFilterString( searchStr );
}


void PANEL_HOTKEYS_EDITOR::UpdateErrorMessage()
{
    wxString validMessage;
    bool     isValid = m_hotkeyStore.GetStoreValidityMessage( validMessage );

    if( isValid )
    {
        // Hide the error message sizer if all the hotkeys are valid
        if( !m_readOnly )
        {
            m_errorMessage->SetLabelText( wxEmptyString );
            m_errorMessage->Update();
        }

        m_mainSizer->Hide( m_errorMessageSizer );
    }
    else
    {
        // Update the message text and ensure it is showing if there are errors
        if( !m_readOnly )
        {
            m_errorMessage->SetLabelText( validMessage );
            m_errorMessage->Update();
        }

        m_mainSizer->Show( m_errorMessageSizer );
    }
    m_mainSizer->Layout();
}