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 (C) 2020-2021 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, 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 __UNIT_BINDER_H_
#define __UNIT_BINDER_H_

#include <eda_units.h>
#include <base_units.h>
#include <origin_transforms.h>
#include <libeval/numeric_evaluator.h>
#include <wx/event.h>

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 );

 ~UNIT_BINDER() override;

 virtual void SetUnits( EDA_UNITS aUnits );

 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 ChangeValue( int aValue );

 void ChangeValue( const wxString& aValue );

 virtual void ChangeDoubleValue( double aValue );

 virtual long long int GetValue();

 virtual double GetDoubleValue();

 bool IsIndeterminate() const;

 wxString GetOriginalText() const;

 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 onSetFocus( wxFocusEvent& aEvent );
 void onKillFocus( wxFocusEvent& aEvent );
 void delayedFocusHandler( wxCommandEvent& aEvent );

 void onUnitsChanged( wxCommandEvent& aEvent );

 double setPrecision( double aValue, bool aValueUsesUserUnits );

 EDA_DRAW_FRAME* m_frame;

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

 EDA_UNITS m_units;
 bool m_negativeZero; 
 EDA_DATA_TYPE m_dataType;
 int m_precision; 

 wxString m_errorMessage;

 NUMERIC_EVALUATOR m_eval;
 bool m_allowEval;
 bool m_needsEval;

 long m_selStart; 
 long m_selEnd;

 ORIGIN_TRANSFORMS& m_originTransforms;

 ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType;
};

#endif /* __UNIT_BINDER_H_ */