panel_toolbar_customization.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
 #ifndef PANEL_TOOLBAR_CUSTOMIZATION_H_
 #define PANEL_TOOLBAR_CUSTOMIZATION_H_
 
#include <dialogs/panel_toolbar_customization_base.h>
 
#include <tool/action_toolbar.h>
#include <tool/ui/toolbar_configuration.h>
 
#include <wx/bmpbndl.h>
 
class wxImageList;
 
class APP_SETTINGS_BASE;
class TOOL_ACTION;
 

class TOOLBAR_TREE : public wxTreeCtrl
{
public:
    TOOLBAR_TREE( wxWindow *parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize, long style = wxTR_DEFAULT_STYLE ) :
            wxTreeCtrl( parent, id, pos, size, style )
    {
    }
 
    int OnCompareItems( const wxTreeItemId& item1, const wxTreeItemId& item2 ) override;
 
private:
    // Need to use wxRTTI macros in order for OnCompareItems to work properly
    // See: https://docs.wxwidgets.org/3.1/classwx_tree_ctrl.html#ab90a465793c291ca7aa827a576b7d146
    wxDECLARE_ABSTRACT_CLASS( TOOLBAR_TREE );
};
 
 
class PANEL_TOOLBAR_CUSTOMIZATION : public PANEL_TOOLBAR_CUSTOMIZATION_BASE
{
public:
    struct ACTION_LIST_ENTRY
    {
        wxString                label;
        wxString                tooltip;
        wxString                search_text;
        TOOL_ACTION*            action = nullptr;
        ACTION_TOOLBAR_CONTROL* control = nullptr;
        int                     image_index = -1;
    };
 
    PANEL_TOOLBAR_CUSTOMIZATION( wxWindow* aParent, APP_SETTINGS_BASE* aCfg, TOOLBAR_SETTINGS* aTbSettings,
                                 FRAME_T aActionContext, const std::vector<TOOL_ACTION*>& aTools,
                                 const std::vector<ACTION_TOOLBAR_CONTROL*>& aControls );
 
    ~PANEL_TOOLBAR_CUSTOMIZATION();
 
    void ResetPanel() override;
 
    bool TransferDataFromWindow() override;
    bool TransferDataToWindow() override;
 
protected:
    std::optional<TOOLBAR_CONFIGURATION> parseToolbarTree();
 
    void populateToolbarTree();
 
    void populateActions();
    void applyActionFilter();
    bool isActionSupported( const TOOL_ACTION& aAction ) const;
    bool actionMatchesFilter( const ACTION_LIST_ENTRY& aEntry, const wxString& aFilter ) const;
 
    void enableCustomControls( bool enable );
    void enableToolbarControls( bool enable );
 
    void onGroupPress( wxCommandEvent& aEvent );
    void onSpacerPress( wxCommandEvent& aEvent );
    void onSeparatorPress( wxCommandEvent& aEvent );
 
    // From the base class
    void onCustomizeTbCb( wxCommandEvent& event ) override;
    void onToolDelete( wxCommandEvent& event ) override;
    void onToolMoveUp( wxCommandEvent& event ) override;
    void onToolMoveDown( wxCommandEvent& event ) override;
    void onBtnAddAction( wxCommandEvent& event ) override;
    void onTreeBeginLabelEdit( wxTreeEvent& event ) override;
    void onTreeEndLabelEdit( wxTreeEvent& event ) override;
    void onTbChoiceSelect( wxCommandEvent& event ) override;
    void onListItemActivated( wxListEvent& event ) override;
    void onActionFilterText( wxCommandEvent& event );
    void onActionListMouseMove( wxMouseEvent& event );
    void onTreeItemActivated( wxTreeEvent& event );
 
    void removeControlFromOtherToolbars( const std::string& aControlName );
    void removeControlFromCurrentTree( const std::string& aControlName );
protected:
    wxVector<wxBitmapBundle>   m_actionImageBundleVector;
    std::map<std::string, int> m_actionImageListMap;
    std::vector<ACTION_LIST_ENTRY> m_actionEntries;
    long m_hoveredActionEntry = -1;
 
    // Actual settings for the frame
    APP_SETTINGS_BASE* m_appSettings;
    TOOLBAR_SETTINGS*  m_appTbSettings;
 
    // The toolbar currently being viewed
    TOOLBAR_LOC              m_currentToolbar;
    FRAME_T                  m_actionContext;
    std::vector<TOOLBAR_LOC> m_toolbarChoices;
 
    // Shadow copy of the toolbar configurations used to store the changes in the dialog
    std::map<TOOLBAR_LOC, TOOLBAR_CONFIGURATION>   m_toolbars;
 
    std::map<std::string, TOOL_ACTION*>            m_availableTools;
    std::map<std::string, ACTION_TOOLBAR_CONTROL*> m_availableControls;
};
 
 #endif /* PANEL_TOOLBAR_CUSTOMIZATION_H_ */