margin_offset_binder.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 MARGIN_OFFSET_BINDER_H
#define MARGIN_OFFSET_BINDER_H
 
#include <optional>
#include <base_units.h>
#include <units_provider.h>
#include <libeval/numeric_evaluator.h>
#include <wx/event.h>
 
class EDA_DRAW_FRAME;
class wxTextEntry;
class wxStaticText;

class MARGIN_OFFSET_BINDER : public wxEvtHandler
{
public:
    MARGIN_OFFSET_BINDER( EDA_DRAW_FRAME* aParent,
                          wxStaticText* aLabel, wxWindow* aValueCtrl, wxStaticText* aUnitLabel );
 
    MARGIN_OFFSET_BINDER( UNITS_PROVIDER* aUnitsProvider, wxWindow* aEventSource,
                          wxStaticText* aLabel, wxWindow* aValueCtrl, wxStaticText* aUnitLabel );
 
    virtual ~MARGIN_OFFSET_BINDER() override;

    void SetOffsetValue( std::optional<int> aValue );

    void SetRatioValue( std::optional<double> aRatio );

    std::optional<int> GetOffsetValue() const;

    std::optional<double> GetRatioValue() const;

    bool IsNull() const;

    void Enable( bool aEnable );

    void Show( bool aShow, bool aResize = false );
 
protected:
    void onSetFocus( wxFocusEvent& aEvent );
    void onKillFocus( wxFocusEvent& aEvent );
    void onUnitsChanged( wxCommandEvent& aEvent );

    bool parseInput( const wxString& aInput, std::optional<int>& aOffset,
                     std::optional<double>& aRatio ) const;

    wxString formatValue( std::optional<int> aOffset, std::optional<double> aRatio ) const;

    wxString getTextValue() const;

    void setTextValue( const wxString& aValue );
 
protected:
    wxStaticText*       m_label;
    wxWindow*           m_valueCtrl;
    wxWindow*           m_eventSource;
    wxStaticText*       m_unitLabel;      
 
    const EDA_IU_SCALE* m_iuScale;
    EDA_UNITS           m_units;
 
    mutable NUMERIC_EVALUATOR m_eval;
 
    // Cached parsed values (updated on focus loss)
    mutable std::optional<int>    m_cachedOffset;
    mutable std::optional<double> m_cachedRatio;
    mutable bool                  m_needsParsing;
};
 
#endif // MARGIN_OFFSET_BINDER_H