drc_re_bitmap_overlay_panel.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_BITMAP_OVERLAY_PANEL_H
#define DRC_RE_BITMAP_OVERLAY_PANEL_H
 
#include <map>
#include <memory>
#include <vector>
 
#include <wx/bitmap.h>
#include <wx/panel.h>
 
#include <bitmaps.h>
#include "drc_re_content_panel_base.h"
#include "drc_re_overlay_field.h"
#include "drc_re_overlay_types.h"
 
class wxControl;
class wxCheckBox;
class wxPaintEvent;
class wxDPIChangedEvent;
class wxSysColourChangedEvent;
class wxFocusEvent;
class UNIT_BINDER;
 

class DRC_RE_BITMAP_OVERLAY_PANEL : public wxPanel,
                                    public DRC_RULE_EDITOR_CONTENT_PANEL_BASE
{
public:
    DRC_RE_BITMAP_OVERLAY_PANEL( wxWindow* aParent, wxWindowID aId = wxID_ANY );
 
    virtual ~DRC_RE_BITMAP_OVERLAY_PANEL();

    void SetBackgroundBitmap( BITMAPS aBitmap );
 
    bool TransferDataToWindow() override;
    bool TransferDataFromWindow() override;

    void ClearFieldErrors();

    void ShowFieldError( const wxString& aFieldId, const wxString& aMessage );
 
protected:
    template <typename T>
    DRC_RE_OVERLAY_FIELD* AddControl( const wxString& aId, const DRC_RE_FIELD_POSITION& aPosition, T* aControl );

    template <typename T>
    DRC_RE_OVERLAY_FIELD* AddField( const wxString& aId, const DRC_RE_FIELD_POSITION& aPosition,
                                    long aStyle = 0 );

    template <typename T>
    DRC_RE_OVERLAY_FIELD* AddFieldWithUnits( const wxString& aId,
                                              const DRC_RE_FIELD_POSITION& aPosition,
                                              UNIT_BINDER* aUnitBinder,
                                              long aStyle = 0 );

    DRC_RE_OVERLAY_FIELD* AddCheckbox( const wxString& aId, const DRC_RE_FIELD_POSITION& aPosition );

    void LoadBitmap();

    void PositionFields();

    void SetupFieldStyling( wxControl* aControl );
 
private:
    void OnPaint( wxPaintEvent& aEvent );
    void OnDPIChanged( wxDPIChangedEvent& aEvent );
    void OnThemeChange( wxSysColourChangedEvent& aEvent );
    void OnFieldFocus( wxFocusEvent& aEvent );
    void OnFieldBlur( wxFocusEvent& aEvent );

    void PositionLabel( DRC_RE_OVERLAY_FIELD* aField );

    void PositionPrefixLabel( DRC_RE_OVERLAY_FIELD* aField );
 
protected:
    wxBitmap                                        m_bitmap;       
    BITMAPS                                         m_bitmapId;     
    wxSize                                          m_logicalBitmapSize; 
    std::vector<std::unique_ptr<DRC_RE_OVERLAY_FIELD>> m_fields;    
    std::map<wxString, DRC_RE_OVERLAY_FIELD*>       m_fieldIdMap;   
};
 
 
template <typename T>
DRC_RE_OVERLAY_FIELD* DRC_RE_BITMAP_OVERLAY_PANEL::AddControl( const wxString&              aId,
                                                               const DRC_RE_FIELD_POSITION& aPosition, T* aControl )
{
    // Create the overlay field wrapper
    auto                  field = std::make_unique<DRC_RE_OVERLAY_FIELD>( this, aId, aControl, aPosition );
    DRC_RE_OVERLAY_FIELD* fieldPtr = field.get();
 
    // Set up styling
    SetupFieldStyling( aControl );
 
    if( !aPosition.tooltipText.IsEmpty() )
        aControl->SetToolTip( aPosition.tooltipText );
 
    // Position the field (yCenter is vertical mid-point of the control)
    int     height = aControl->GetBestSize().GetHeight();
    int     width = aPosition.xEnd - aPosition.xStart;
    wxPoint pos( aPosition.xStart, aPosition.yCenter - ( height + 1 ) / 2 );
    wxSize  size( width, height );
    aControl->SetPosition( pos );
    aControl->SetSize( size );
 
    // Create labels if specified
    fieldPtr->CreateLabels();
 
    if( fieldPtr->HasLabel() )
        PositionLabel( fieldPtr );
 
    if( fieldPtr->HasPrefixLabel() )
        PositionPrefixLabel( fieldPtr );
 
    // Store in collections
    m_fieldIdMap[aId] = fieldPtr;
    m_fields.push_back( std::move( field ) );
 
    return fieldPtr;
}
 
 
template <typename T>
DRC_RE_OVERLAY_FIELD* DRC_RE_BITMAP_OVERLAY_PANEL::AddField( const wxString&              aId,
                                                             const DRC_RE_FIELD_POSITION& aPosition, long aStyle )
{
    // Create the control
    T* control = new T( this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, aStyle );
 
    return AddControl( aId, aPosition, control );
}
 
 
template <typename T>
DRC_RE_OVERLAY_FIELD* DRC_RE_BITMAP_OVERLAY_PANEL::AddFieldWithUnits( const wxString& aId,
                                                                       const DRC_RE_FIELD_POSITION& aPosition,
                                                                       UNIT_BINDER* aUnitBinder,
                                                                       long aStyle )
{
    // Create the field using the base AddField method
    DRC_RE_OVERLAY_FIELD* field = AddField<T>( aId, aPosition, aStyle );
 
    // Associate the unit binder for value conversion
    field->SetUnitBinder( aUnitBinder );
 
    return field;
}
 
#endif // DRC_RE_BITMAP_OVERLAY_PANEL_H