footprint_preview_widget.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017-2023 KiCad Developers, see AUTHORS.txt for contributors.
 * Copyright (C) 2017 Chris Pavlina <[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 3 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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef FOOTPRINT_PREVIEW_WIDGET_H
#define FOOTPRINT_PREVIEW_WIDGET_H
 
#include <wx/panel.h>
#include <functional>
#include <import_export.h>
#include <lib_id.h>
#include <eda_units.h>
#include <gal/color4d.h>
 
class FOOTPRINT_PREVIEW_PANEL_BASE;
class FOOTPRINT;
class KIWAY;
class wxStaticText;
class wxSizer;
 
 
class FOOTPRINT_PREVIEW_WIDGET: public wxPanel
{
public:
 
    FOOTPRINT_PREVIEW_WIDGET( wxWindow* aParent, KIWAY& aKiway );
 
    bool IsInitialized() const { return m_prev_panel != nullptr; }
 
    void SetStatusText( const wxString& aText );
 
    void ClearStatus();
 
    void SetUserUnits( EDA_UNITS aUnits );
 
    void SetPinFunctions( const std::map<wxString, wxString>& aPinFunctions );
 
    void DisplayFootprint( const LIB_ID& aFPID );
 
    void DisplayFootprints( std::shared_ptr<FOOTPRINT> aFootprintA,
                            std::shared_ptr<FOOTPRINT> aFootprintB );
 
    void RefreshAll();
 
    FOOTPRINT_PREVIEW_PANEL_BASE* GetPreviewPanel() { return m_prev_panel; }
 
protected:
    FOOTPRINT_PREVIEW_PANEL_BASE* m_prev_panel;
 
    wxStaticText*                 m_status;
    wxPanel*                      m_statusPanel;
    wxSizer*                      m_statusSizer;
    wxSizer*                      m_outerSizer;
    LIB_ID                        m_libid;
};
 
 
class APIEXPORT FOOTPRINT_PREVIEW_PANEL_BASE
{
public:
    virtual ~FOOTPRINT_PREVIEW_PANEL_BASE() {}
 
    virtual void SetUserUnits( EDA_UNITS aUnits ) = 0;
 
    virtual void SetPinFunctions( const std::map<wxString, wxString>& aPinFunctions ) = 0;
 
    virtual bool DisplayFootprint( LIB_ID const& aFPID ) = 0;
 
    virtual void DisplayFootprints( std::shared_ptr<FOOTPRINT> aFootprintA,
                                    std::shared_ptr<FOOTPRINT> aFootprintB ) = 0;
 
    virtual void RefreshAll() = 0;
 
    virtual wxWindow* GetWindow() = 0;
 
    virtual const KIGFX::COLOR4D& GetBackgroundColor() const = 0;
    virtual const KIGFX::COLOR4D& GetForegroundColor() const = 0;
 
    static FOOTPRINT_PREVIEW_PANEL_BASE* Create( wxWindow* aParent, KIWAY& aKiway );
};
 
 
#endif // FOOTPRINT_PREVIEW_WIDGET_H