properties_panel.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 CERN
 * @author Maciej Suminski <[email protected]>
 *
 * 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 PROPERTIES_PANEL_H
#define PROPERTIES_PANEL_H
 
#include <wx/panel.h>
#include <wx/propgrid/propgrid.h>
#include <wx/timer.h>
 
#include <tool/selection.h>
 
#include <bitmaps/bitmaps_list.h>
#include <vector>
#include <memory>
#include <functional>
 
class EDA_BASE_FRAME;
class EDA_ITEM;
class PROPERTY_BASE;
class BITMAP_BUTTON;
class wxPropertyGridEvent;
class wxStaticText;
 
enum PROPERTIES_PANEL_CONTEXT_MENU_IDS
{
    ID_CTX_ADD_FIELD = wxID_HIGHEST + 1000,
    ID_CTX_ADD_CUSTOM_PROPERTY,
    ID_CTX_REMOVE_FIELD,
    ID_CTX_REMOVE_CUSTOM_PROPERTY,
};
 
class PROPERTIES_PANEL : public wxPanel
{
    friend class PROPERTIES_PANEL_GRID;
 
public:
    PROPERTIES_PANEL( wxWindow* aParent, EDA_BASE_FRAME* aFrame );
    virtual ~PROPERTIES_PANEL();
 
    virtual void UpdateData() = 0;
 
    virtual void AfterCommit() {}
 
    wxPropertyGrid* GetPropertyGrid()
    {
        return m_grid;
    }
 
    int PropertiesCount() const
    {
        return m_displayed.size();
    }
 
    const std::vector<PROPERTY_BASE*>& Properties() const
    {
        return m_displayed;
    }
 
    void RecalculateSplitterPos();
 
    void SetSplitterProportion( float aProportion );
    float SplitterProportion() const { return m_splitter_key_proportion; }
 
protected:
    virtual void rebuildProperties( const SELECTION& aSelection );
 
    virtual wxPGProperty* createPGProperty( const PROPERTY_BASE* aProperty ) const = 0;
 
    // Event handlers
    virtual void valueChanging( wxPropertyGridEvent& aEvent ) { aEvent.Skip(); }
    virtual void valueChanged( wxPropertyGridEvent& aEvent ) { aEvent.Skip(); }
    void onCharHook( wxKeyEvent& aEvent );
    void onShow( wxShowEvent& aEvent );
 
    virtual void OnLanguageChanged( wxCommandEvent& aEvent );
 
    virtual bool isKeyEditable( const wxPGProperty* aPGProp ) const { return false; }
    virtual bool isKeyNameInUse( const wxString& aName ) const { return false; }
    virtual void onKeyRenamed( const wxString& aOldName, const wxString& aNewName ) {}
 
    virtual void onLabelEditBegin( wxPropertyGridEvent& aEvent );
    virtual void onLabelEditEnding( wxPropertyGridEvent& aEvent );
 
    virtual bool buildContextMenu( wxMenu& aMenu, wxPGProperty* aPGProp ) { return false; }
    virtual void onNewItemLeftBlank( const wxString& aKey ) {}
    void onRightClick( wxPropertyGridEvent& aEvent );
 
    void beginLabelEdit( const wxString& aKey, bool aStartBlank = false );

    void settlePendingLabelEdit();

    virtual bool getItemValue( EDA_ITEM* aItem, PROPERTY_BASE* aProperty, wxVariant& aValue );

    bool extractValueAndWritability( const SELECTION& aSelection, const wxString& aPropName,
                                     wxVariant& aValue, bool& aWritable, wxPGChoices& aChoices );

    void addCategoryButton( const wxString& aGroupKey, const wxString& aTooltip,
                            BITMAPS aBitmap, std::function<void()> aAction,
                            std::function<bool()> aEnableFunc = nullptr,
                            bool aForceCategory = false );

    void updateCategoryButtons();

    void hideCategoryButtons();
 
    void positionCategoryButtons();

    wxPGProperty* categoryForGroup( const wxString& aGroupKey ) const;
 
    wxStaticText*               m_caption;
 
public:
    int                         m_SuppressGridChangeEvents;
 
protected:
    std::vector<PROPERTY_BASE*> m_displayed;    // no ownership of pointers
    wxPropertyGrid*             m_grid;
    EDA_BASE_FRAME*             m_frame;

    float m_splitter_key_proportion;

    wxTimer   m_deferredRebuildTimer;
    SELECTION m_deferredSelection;
 
    wxString m_editingOriginalLabel;
 
    wxString m_contextMenuPropertyName;
 
    struct CATEGORY_BUTTON
    {
        BITMAP_BUTTON*           button;
        wxString                 groupKey;      
        std::function<void()>    action;
        std::function<bool()>    enableFunc;    

        bool                     forceCategory = false;
    };
 
    std::vector<CATEGORY_BUTTON> m_categoryButtons;

    bool m_resolvingPendingKey = false;

    wxString m_pendingNewKey;
};
 
 
class SUPPRESS_GRID_CHANGED_EVENTS
{
public:
    SUPPRESS_GRID_CHANGED_EVENTS( PROPERTIES_PANEL* aPanel );
    ~SUPPRESS_GRID_CHANGED_EVENTS();
 
private:
    PROPERTIES_PANEL* m_panel;
};
 
#endif /* PROPERTIES_PANEL_H */