unit_binder.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014-2015 CERN
 * Copyright The 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 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 __UNIT_BINDER_H_
#define __UNIT_BINDER_H_
 
#include <span>
 
#include <base_units.h>
#include <units_provider.h>
#include <libeval/numeric_evaluator.h>
#include <wx/event.h>
 
class DIALOG_SHIM;
class EDA_BASE_FRAME;
class EDA_DRAW_FRAME;
class wxTextEntry;
class wxSpinButton;
class wxStaticText;
 
class UNIT_BINDER : public wxEvtHandler
{
public:

    UNIT_BINDER( EDA_DRAW_FRAME* aParent,
                 wxStaticText* aLabel, wxWindow* aValueCtrl, wxStaticText* aUnitLabel,
                 bool aAllowEval = true, bool aBindFocusEvent = true );
 
    UNIT_BINDER( UNITS_PROVIDER* aUnitsProvider, wxWindow* aEventSource,
                 wxStaticText* aLabel, wxWindow* aValueCtrl, wxStaticText* aUnitLabel,
                 bool aAllowEval = true, bool aBindFocusEvent = true );
 
    virtual ~UNIT_BINDER() override;

    virtual void SetUnits( EDA_UNITS aUnits );
 
    bool UnitsInvariant() const
    {
        return m_units == EDA_UNITS::UNSCALED || m_units == EDA_UNITS::DEGREES || m_units == EDA_UNITS::PERCENT;
    }
 
    virtual void SetNegativeZero() { m_negativeZero = true; }

    virtual void SetPrecision( int aLength );

    void SetDataType( EDA_DATA_TYPE aDataType );

    virtual void SetValue( long long int aValue );
 
    void SetValue( const wxString& aValue );

    virtual void SetDoubleValue( double aValue );
 
    virtual void SetAngleValue( const EDA_ANGLE& aValue );

    virtual void ChangeValue( int aValue );
 
    void ChangeValue( const wxString& aValue );

    virtual void ChangeDoubleValue( double aValue );
 
    virtual void ChangeAngleValue( const EDA_ANGLE& aValue );

    virtual long long int GetValue() const;
 
    int GetIntValue() const
    {
        const long long int value = GetValue();
        const long long int clamped =
                std::clamp<long long>( value, static_cast<long long>( std::numeric_limits<int>::lowest() ),
                                       static_cast<long long>( std::numeric_limits<int>::max() ) );
 
        return static_cast<int>( clamped );
    }

    virtual double GetDoubleValue() const;
 
    virtual EDA_ANGLE GetAngleValue();

    virtual void SetOptionsList( std::span<const long long int> aOptions );
    virtual void SetDoubleOptionsList( std::span<const double> aOptions );
 

    bool IsIndeterminate() const;

    bool IsNull() const;
    void SetNull();

    virtual bool Validate( double aMin, double aMax, EDA_UNITS aUnits = EDA_UNITS::UNSCALED );
 
    void SetLabel( const wxString& aLabel );

    void Enable( bool aEnable );

    void Show( bool aShow, bool aResize = false );

    ORIGIN_TRANSFORMS::COORD_TYPES_T GetCoordType() const
    {
        return m_coordType;
    }

    void SetCoordType( ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType )
    {
        m_coordType = aCoordType;
    }

    void RequireEval()
    {
        m_needsEval = true;
    }
 
protected:
    void onClick( wxMouseEvent& aEvent );
    void onComboBox( wxCommandEvent& aEvent );
 
    void onSetFocus( wxFocusEvent& aEvent );
    void onKillFocus( wxFocusEvent& aEvent );
    void delayedFocusHandler( wxCommandEvent& aEvent );
 
    void onValueCtrlDestroyed( wxWindowDestroyEvent& aEvent );
 
    void onUnitsChanged( wxCommandEvent& aEvent );

    double setPrecision( double aValue, bool aValueUsesUserUnits ) const;
 
    wxString getTextForValue( long long int aValue ) const;
    wxString getTextForDoubleValue( double aValue ) const;
 
protected:
    bool                m_bindFocusEvent;

    wxStaticText*       m_label;
    wxWindow*           m_valueCtrl;
    wxWindow*           m_eventSource;
    wxStaticText*       m_unitLabel;      

    const EDA_IU_SCALE* m_iuScale;
    EDA_UNITS           m_units;
    bool                m_negativeZero;   
    EDA_DATA_TYPE       m_dataType;
    int                 m_precision;      
 
    wxString            m_errorMessage;
 
    mutable NUMERIC_EVALUATOR   m_eval;
    bool                m_allowEval;
    bool                m_needsEval;
 
    long                m_selStart;       
    long                m_selEnd;
 
    bool                m_unitsInValue;   

    ORIGIN_TRANSFORMS&  m_originTransforms;

    ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType;

    DIALOG_SHIM*        m_dialogShim;
 
public:
    void DetachFromDialogShim() { m_dialogShim = nullptr; }
};
 

class PROPERTY_EDITOR_UNIT_BINDER : public UNIT_BINDER
{
public:
    PROPERTY_EDITOR_UNIT_BINDER( EDA_DRAW_FRAME* aParent );
 
    virtual ~PROPERTY_EDITOR_UNIT_BINDER();
 
    void SetControl( wxWindow* aControl );
};
 
#endif /* __UNIT_BINDER_H_ */