FOOTPRINT_PREVIEW_PANEL_BASE Class Reference

Base class for the actual viewer panel. More...

#include <footprint_preview_widget.h>

Inheritance diagram for FOOTPRINT_PREVIEW_PANEL_BASE:

Public Member Functions
virtual	~FOOTPRINT_PREVIEW_PANEL_BASE ()
virtual void	SetUserUnits (EDA_UNITS aUnits)=0
virtual void	SetPinFunctions (const std::map< wxString, wxString > &aPinFunctions)=0
	Set the pin functions from the symbol's netlist.
virtual bool	DisplayFootprint (LIB_ID const &aFPID)=0
	Set the currently displayed footprint.
virtual void	DisplayFootprints (std::shared_ptr< FOOTPRINT > aFootprintA, std::shared_ptr< FOOTPRINT > aFootprintB)=0
	Display a pair of footprints.
virtual void	RefreshAll ()=0
	Force the redrawing of all contents.
virtual EDA_DRAW_PANEL_GAL *	GetCanvas ()=0
	Get the GAL canvas.
virtual BOARD *	GetBoard ()=0
virtual const KIGFX::COLOR4D &	GetBackgroundColor () const =0
	Get the colors to use in a preview widget to match the preview panel.
virtual const KIGFX::COLOR4D &	GetForegroundColor () const =0

Static Public Member Functions
static FOOTPRINT_PREVIEW_PANEL_BASE *	Create (wxWindow *aParent, KIWAY &aKiway)
	Return a footprint preview panel instance via Kiface.

Detailed Description

Base class for the actual viewer panel.

The implementation is in pcbnew/footprint_preview_panel.cpp, accessed via kiface.

Definition at line 115 of file footprint_preview_widget.h.

Constructor & Destructor Documentation

~FOOTPRINT_PREVIEW_PANEL_BASE()

virtual FOOTPRINT_PREVIEW_PANEL_BASE::~FOOTPRINT_PREVIEW_PANEL_BASE ( )

inlinevirtual

Definition at line 118 of file footprint_preview_widget.h.

Member Function Documentation

Create()

FOOTPRINT_PREVIEW_PANEL_BASE * FOOTPRINT_PREVIEW_PANEL_BASE::Create ( wxWindow *  aParent, KIWAY &  aKiway  )

static

Return a footprint preview panel instance via Kiface.

May return null if Kiway is not available or there is any error on load.

Definition at line 150 of file footprint_preview_widget.cpp.

References IFACE::CreateKiWindow(), KIWAY::FACE_PCB, FRAME_FOOTPRINT_PREVIEW, kiface(), and KIWAY::KiFACE().

Referenced by FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET().

DisplayFootprint()

virtual bool FOOTPRINT_PREVIEW_PANEL_BASE::DisplayFootprint ( LIB_ID const &  aFPID )

pure virtual

Set the currently displayed footprint.

Any footprint passed in here MUST have been passed to CacheFootprint before.

Implemented in FOOTPRINT_PREVIEW_PANEL.

Referenced by FOOTPRINT_PREVIEW_WIDGET::DisplayFootprint().

DisplayFootprints()

virtual void FOOTPRINT_PREVIEW_PANEL_BASE::DisplayFootprints ( std::shared_ptr< FOOTPRINT >  aFootprintA, std::shared_ptr< FOOTPRINT >  aFootprintB  )

pure virtual

Display a pair of footprints.

(Normally used for diff'ing.)

Implemented in FOOTPRINT_PREVIEW_PANEL.

Referenced by FOOTPRINT_PREVIEW_WIDGET::DisplayFootprints().

GetBackgroundColor()

virtual const KIGFX::COLOR4D & FOOTPRINT_PREVIEW_PANEL_BASE::GetBackgroundColor ( ) const

pure virtual

Get the colors to use in a preview widget to match the preview panel.

Implemented in FOOTPRINT_PREVIEW_PANEL.

Referenced by FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET().

GetBoard()

virtual BOARD * FOOTPRINT_PREVIEW_PANEL_BASE::GetBoard ( )

pure virtual

Implemented in FOOTPRINT_PREVIEW_PANEL.

Referenced by FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME().

GetCanvas()

virtual EDA_DRAW_PANEL_GAL * FOOTPRINT_PREVIEW_PANEL_BASE::GetCanvas ( )

pure virtual

Get the GAL canvas.

Implemented in FOOTPRINT_PREVIEW_PANEL.

Referenced by FOOTPRINT_PREVIEW_WIDGET::ClearStatus(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET(), FOOTPRINT_PREVIEW_WIDGET::SetStatusText(), and PANEL_SYMBOL_CHOOSER::ShutdownCanvases().

GetForegroundColor()

virtual const KIGFX::COLOR4D & FOOTPRINT_PREVIEW_PANEL_BASE::GetForegroundColor ( ) const

pure virtual

Implemented in FOOTPRINT_PREVIEW_PANEL.

Referenced by FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET().

RefreshAll()

virtual void FOOTPRINT_PREVIEW_PANEL_BASE::RefreshAll ( )

pure virtual

Force the redrawing of all contents.

Implemented in FOOTPRINT_PREVIEW_PANEL.

Referenced by FOOTPRINT_PREVIEW_WIDGET::RefreshAll().

SetPinFunctions()

virtual void FOOTPRINT_PREVIEW_PANEL_BASE::SetPinFunctions ( const std::map< wxString, wxString > &  aPinFunctions )

pure virtual

Set the pin functions from the symbol's netlist.

This allows us to display them in the corresponding pads.

Parameters

aPinFunctions

a map from pin_number to pin_function

Implemented in FOOTPRINT_PREVIEW_PANEL.

Referenced by FOOTPRINT_PREVIEW_WIDGET::SetPinFunctions().

SetUserUnits()

virtual void FOOTPRINT_PREVIEW_PANEL_BASE::SetUserUnits ( EDA_UNITS  aUnits )

pure virtual

Implemented in FOOTPRINT_PREVIEW_PANEL.

Referenced by FOOTPRINT_PREVIEW_WIDGET::SetUserUnits().

---

The documentation for this class was generated from the following files:

• footprint_preview_widget.h
• footprint_preview_widget.cpp