kicad/common/widgets/properties_panel.h

120 lines
3.8 KiB
C
Raw Normal View History

2020-02-04 08:40:25 +00:00
/*
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright (C) 2016 CERN
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* 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
*/
#ifndef PROPERTIES_PANEL_H
#define PROPERTIES_PANEL_H
#include <wx/panel.h>
#include <wx/propgrid/propgrid.h>
#include <vector>
#include <memory>
2020-02-04 08:40:25 +00:00
class EDA_BASE_FRAME;
class EDA_ITEM;
2020-02-04 08:40:25 +00:00
class SELECTION;
class PROPERTY_BASE;
2021-08-22 14:15:49 +00:00
class wxStaticText;
2020-02-04 08:40:25 +00:00
class PROPERTIES_PANEL : public wxPanel
{
public:
PROPERTIES_PANEL( wxWindow* aParent, EDA_BASE_FRAME* aFrame );
virtual ~PROPERTIES_PANEL()
{
}
virtual void UpdateData() = 0;
2020-02-04 08:40:25 +00:00
virtual void AfterCommit() {}
2020-02-04 08:40:25 +00:00
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; }
void OnLanguageChanged();
2020-02-04 08:40:25 +00:00
protected:
/**
* Generates the property grid for a given selection of items.
*
* @param aSelection is a set of items to show properties for.
*/
virtual void rebuildProperties( const SELECTION& aSelection );
2020-02-04 08:40:25 +00:00
virtual wxPGProperty* createPGProperty( const PROPERTY_BASE* aProperty ) const = 0;
// Event handlers
virtual void valueChanging( wxPropertyGridEvent& aEvent ) {}
virtual void valueChanged( wxPropertyGridEvent& aEvent ) {}
void onCharHook( wxKeyEvent& aEvent );
void onShow( wxShowEvent& aEvent );
2020-02-04 08:40:25 +00:00
/**
* Utility to fetch a property value and convert to wxVariant
* Precondition: aItem is known to have property aProperty
* @return true if conversion succeeded
*/
bool getItemValue( EDA_ITEM* aItem, PROPERTY_BASE* aProperty, wxVariant& aValue );
2023-01-24 17:08:37 +00:00
/**
* Processes a selection and determines whether the given property should be available or not
* and what the common value should be for the items in the selection.
* @param aSelection is a set of EDA_ITEMs to process
* @param aProperty is the property to look up
* @param aValue will be filled with the value common to the selection, or null if different
* @param aWritable will be set to whether or not the property can be written for the selection
* @return true if the property is available for all the items in the selection
*/
bool extractValueAndWritability( const SELECTION& aSelection, PROPERTY_BASE* aProperty,
wxVariant& aValue, bool& aWritable );
protected:
2020-02-04 08:40:25 +00:00
std::vector<PROPERTY_BASE*> m_displayed;
wxPropertyGrid* m_grid;
EDA_BASE_FRAME* m_frame;
2021-08-22 14:15:49 +00:00
wxStaticText* m_caption;
/// Proportion of the grid column splitter that is used for the key column (0.0 - 1.0)
float m_splitter_key_proportion;
2020-02-04 08:40:25 +00:00
};
#endif /* PROPERTIES_PANEL_H */