pg_properties.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2020-2023 CERN
 * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @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 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef PG_PROPERTIES_H
#define PG_PROPERTIES_H
 
#include <wx/propgrid/propgrid.h>
#include <wx/propgrid/property.h>
#include <wx/propgrid/props.h>
#include <wx/propgrid/advprops.h>
#include <common.h>
#include <gal/color4d.h>
#include <origin_transforms.h>
 
class PROPERTY_BASE;
class REGEX_VALIDATOR;
class EDA_DRAW_FRAME;
 
wxPGProperty* PGPropertyFactory( const PROPERTY_BASE* aProperty, EDA_DRAW_FRAME* aFrame );
 
class PGPROPERTY_DISTANCE
{
public:
 PGPROPERTY_DISTANCE( EDA_DRAW_FRAME* aParentFrame,
 ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType );
 virtual ~PGPROPERTY_DISTANCE() = 0;
 
 ORIGIN_TRANSFORMS::COORD_TYPES_T CoordType() const { return m_coordType; }
 
protected:
#if wxCHECK_VERSION( 3, 3, 0 )
 bool StringToDistance( wxVariant& aVariant, const wxString& aText,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const;
 wxString DistanceToString( wxVariant& aVariant,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const;
#else
 bool StringToDistance( wxVariant& aVariant, const wxString& aText, int aArgFlags = 0 ) const;
 wxString DistanceToString( wxVariant& aVariant, int aArgFlags = 0 ) const;
#endif
 
protected:
 EDA_DRAW_FRAME* m_parentFrame;
 ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType;
};
 
 
class PGPROPERTY_AREA : public wxIntProperty
{
public:
 PGPROPERTY_AREA( EDA_DRAW_FRAME* aParentFrame );
 
 virtual ~PGPROPERTY_AREA() = default;
 
protected:
#if wxCHECK_VERSION( 3, 3, 0 )
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
 
 wxString ValueToString( wxVariant& aVariant,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
#else
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 int aArgFlags = 0 ) const override;
 
 wxString ValueToString( wxVariant& aVariant, int aArgFlags = 0 ) const override;
#endif
 
 wxValidator* DoGetValidator() const override;
 
protected:
 EDA_DRAW_FRAME* m_parentFrame;
};
 
 
class PGPROPERTY_SIZE : public wxUIntProperty, public PGPROPERTY_DISTANCE
{
public:
 PGPROPERTY_SIZE( EDA_DRAW_FRAME* aParentFrame );
 
 virtual ~PGPROPERTY_SIZE() = default;
 
#if wxCHECK_VERSION( 3, 3, 0 )
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override
 {
 return StringToDistance( aVariant, aText, aFlags );
 }
 
 wxString ValueToString( wxVariant& aVariant,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override
 {
 return DistanceToString( aVariant, aFlags );
 }
#else
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 int aArgFlags = 0 ) const override
 {
 return StringToDistance( aVariant, aText, aArgFlags );
 }
 
 wxString ValueToString( wxVariant& aVariant, int aArgFlags = 0 ) const override
 {
 return DistanceToString( aVariant, aArgFlags );
 }
#endif
 
 bool ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const override;
 
 wxValidator* DoGetValidator() const override;
};
 
 
class PGPROPERTY_COORD : public wxIntProperty, public PGPROPERTY_DISTANCE
{
public:
 PGPROPERTY_COORD( EDA_DRAW_FRAME* aParentFrame, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType );
 
 virtual ~PGPROPERTY_COORD() = default;
 
#if wxCHECK_VERSION( 3, 3, 0 )
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override
 {
 return StringToDistance( aVariant, aText, aFlags );
 }
 
 wxString ValueToString( wxVariant& aVariant,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override
 {
 return DistanceToString( aVariant, aFlags );
 }
#else
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 int aArgFlags = 0 ) const override
 {
 return StringToDistance( aVariant, aText, aArgFlags );
 }
 
 wxString ValueToString( wxVariant& aVariant, int aArgFlags = 0 ) const override
 {
 return DistanceToString( aVariant, aArgFlags );
 }
#endif
 
 wxValidator* DoGetValidator() const override;
};
 
 
class PGPROPERTY_ANGLE : public wxFloatProperty
{
public:
 PGPROPERTY_ANGLE() :
 wxFloatProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
 m_scale( 1.0 )
 {
 }
 
 virtual ~PGPROPERTY_ANGLE() = default;
 
#if wxCHECK_VERSION( 3, 3, 0 )
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
 
 wxString ValueToString( wxVariant& aVariant,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
#else
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 int aArgFlags = 0 ) const override;
 wxString ValueToString( wxVariant& aVariant, int aArgFlags = 0 ) const override;
#endif
 
 void SetScale( double aScale )
 {
 m_scale = aScale;
 }
 
 wxValidator* DoGetValidator() const override;
 
 bool ValidateValue( wxVariant&, wxPGValidationInfo& ) const override { return true; }
 
protected:
 double m_scale;
};
 
 
class PGPROPERTY_COLORENUM : public wxEnumProperty
{
public:
 PGPROPERTY_COLORENUM( wxPGChoices* aChoices ) :
 wxEnumProperty( wxPG_LABEL, wxPG_LABEL, *aChoices, 0 ),
 m_colorFunc( []( int aDummy ) { return wxNullColour; } )
 {
#if wxCHECK_VERSION( 3, 3, 0 )
 SetFlag( wxPGPropertyFlags::CustomImage );
#else
 SetFlag( wxPG_PROP_CUSTOMIMAGE );
#endif
 }
 
 virtual ~PGPROPERTY_COLORENUM() = default;
 
 wxSize OnMeasureImage( int aItem = -1 ) const override;
 
 void OnCustomPaint( wxDC& aDC, const wxRect& aRect, wxPGPaintData& aPaintData ) override;
 
 void SetColorFunc( std::function<wxColour( int aValue )> aFunc )
 {
 m_colorFunc = aFunc;
 }
 
 wxColour GetColor( int aValue )
 {
 return m_colorFunc( aValue );
 }
 
protected:
 std::function<wxColour( int aValue )> m_colorFunc;
};
 
 
class PGPROPERTY_RATIO : public wxFloatProperty
{
public:
 PGPROPERTY_RATIO();
 
 const wxPGEditor* DoGetEditorClass() const override;
 
 virtual ~PGPROPERTY_RATIO() = default;
 
#if wxCHECK_VERSION( 3, 3, 0 )
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
 
 wxString ValueToString( wxVariant& aVariant,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
#else
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 int aArgFlags = 0 ) const override;
 
 wxString ValueToString( wxVariant& aVariant, int aArgFlags = 0 ) const override;
#endif
 
 bool ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const override;
 
 wxValidator* DoGetValidator() const override;
};
 
 
class PGPROPERTY_STRING : public wxStringProperty
{
public:
 PGPROPERTY_STRING() :
 wxStringProperty( wxPG_LABEL, wxPG_LABEL, wxEmptyString )
 {}
 
 virtual ~PGPROPERTY_STRING() = default;
 
#if wxCHECK_VERSION( 3, 3, 0 )
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
 
 wxString ValueToString( wxVariant& aVariant,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
#else
 wxString ValueToString( wxVariant& aValue, int aFlags = 0 ) const override;
 
 bool StringToValue( wxVariant& aVariant, const wxString& aString,
 int aFlags = 0 ) const override;
#endif
};
 
 
class PGPROPERTY_BOOL : public wxBoolProperty
{
public:
 PGPROPERTY_BOOL( const wxString& aLabel = wxPG_LABEL, const wxString& aName = wxPG_LABEL,
 bool aValue = false );
 
 virtual ~PGPROPERTY_BOOL() = default;
 
 const wxPGEditor* DoGetEditorClass() const override;
};
 
 
class PGPROPERTY_COLOR4D : public wxStringProperty
{
public:
 PGPROPERTY_COLOR4D( const wxString& aLabel = wxPG_LABEL, const wxString& aName = wxPG_LABEL,
 KIGFX::COLOR4D aValue = KIGFX::COLOR4D::UNSPECIFIED,
 KIGFX::COLOR4D aBackground = KIGFX::COLOR4D::UNSPECIFIED );
 
 virtual ~PGPROPERTY_COLOR4D() = default;
 
#if wxCHECK_VERSION( 3, 3, 0 )
 bool StringToValue( wxVariant& aVariant, const wxString& aText,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
 
 wxString ValueToString( wxVariant& aVariant,
 wxPGPropValFormatFlags aFlags = wxPGPropValFormatFlags::Null ) const override;
#else
 wxString ValueToString( wxVariant& aValue, int aFlags = 0 ) const override;
 
 bool StringToValue( wxVariant &aVariant, const wxString &aText,
 int aFlags = 0 ) const override;
#endif
 
 void SetBackgroundColor( const KIGFX::COLOR4D& aColor ) { m_backgroundColor = aColor; }
 const KIGFX::COLOR4D& GetBackgroundColor() const { return m_backgroundColor; }
 
 private:
 KIGFX::COLOR4D m_backgroundColor;
};
 
#endif /* PG_PROPERTIES_H */