widget_hotkey_list.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 Chris Pavlina <pavlina.chris@gmail.com>
 * Copyright (C) 2016-2017 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 3
 * 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
 */

#ifndef __widget_hotkey_list__
#define __widget_hotkey_list__

#include <unordered_map>
#include <utility>
#include <vector>

#include <wx/treelist.h>
#include <wx/dataview.h>

#include <hotkeys_basic.h>
#include <hotkey_store.h>


class WIDGET_HOTKEY_CLIENT_DATA;

class WIDGET_HOTKEY_LIST : public wxTreeListCtrl
{
public:
    WIDGET_HOTKEY_LIST( wxWindow* aParent, HOTKEY_STORE& aHotkeyStore, bool aReadOnly );

    void ApplyFilterString( const wxString& aFilterStr );

    void ResetAllHotkeys( bool aResetToDefault );

    bool TransferDataToControl();

    bool TransferDataFromControl();

    static long MapKeypressToKeycode( const wxKeyEvent& aEvent );

protected:
    void editItem( wxTreeListItem aItem );

    void resetItem( wxTreeListItem aItem, int aResetId );

    void onActivated( wxTreeListEvent& aEvent );

    void onContextMenu( wxTreeListEvent& aEvent );

    void onMenu( wxCommandEvent& aEvent );

    bool resolveKeyConflicts( TOOL_ACTION* aAction, long aKey );

private:
    WIDGET_HOTKEY_CLIENT_DATA* getHKClientData( wxTreeListItem aItem );

    WIDGET_HOTKEY_CLIENT_DATA* getExpectedHkClientData( wxTreeListItem aItem );

    void updateFromClientData();

    void updateShownItems( const wxString& aFilterStr );

    void changeHotkey( HOTKEY& aHotkey, long aKey );

    void updateColumnWidths();

private:
    HOTKEY_STORE&  m_hk_store;
    bool           m_readOnly;

    std::unordered_map<long, wxString> m_reservedHotkeys;

    wxTreeListItem m_context_menu_item;
};

#endif // __widget_hotkey_list__