drc_re_overlay_field.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef DRC_RE_OVERLAY_FIELD_H
#define DRC_RE_OVERLAY_FIELD_H
 
#include <functional>
#include <wx/string.h>
 
#include "drc_re_overlay_types.h"
 
class wxWindow;
class wxControl;
class wxStaticText;
class FIELD_WARNING_ICON;
class UNIT_BINDER;
 

class DRC_RE_OVERLAY_FIELD
{
public:
    using Getter = std::function<double()>;
    using Setter = std::function<void( double )>;

    DRC_RE_OVERLAY_FIELD( wxWindow* aParent, const wxString& aFieldId, wxControl* aControl,
                          const DRC_RE_FIELD_POSITION& aPosition );
 
    ~DRC_RE_OVERLAY_FIELD();

    wxControl* GetControl() const { return m_control; }

    const wxString& GetFieldId() const { return m_fieldId; }

    const DRC_RE_FIELD_POSITION& GetPosition() const { return m_position; }

    bool TransferToWindow();

    bool TransferFromWindow();

    void SetGetter( Getter aGetter ) { m_getter = std::move( aGetter ); }

    void SetSetter( Setter aSetter ) { m_setter = std::move( aSetter ); }

    void SetUnitBinder( UNIT_BINDER* aBinder ) { m_unitBinder = aBinder; }

    UNIT_BINDER* GetUnitBinder() const { return m_unitBinder; }

    void ShowError( const wxString& aMessage );

    void ClearError();

    bool IsShowingError() const;

    wxStaticText* GetLabel() const { return m_label; }

    bool HasLabel() const { return m_label != nullptr; }

    wxStaticText* GetPrefixLabel() const { return m_prefixLabel; }

    bool HasPrefixLabel() const { return m_prefixLabel != nullptr; }

    void CreateLabels();
 
private:
    wxWindow*            m_parent;
    wxString             m_fieldId;
    wxControl*           m_control;
    DRC_RE_FIELD_POSITION m_position;
 
    Getter               m_getter;
    Setter               m_setter;
    UNIT_BINDER*         m_unitBinder;
 
    FIELD_WARNING_ICON*  m_errorIcon; 
 
    wxStaticText*        m_label;
    wxStaticText*        m_prefixLabel;
};
 
#endif // DRC_RE_OVERLAY_FIELD_H