KiCad PCB EDA Suite
FOOTPRINT_PREVIEW_PANEL_BASE Class Referenceabstract

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

#include <footprint_preview_widget.h>

Inheritance diagram for FOOTPRINT_PREVIEW_PANEL_BASE:
FOOTPRINT_PREVIEW_PANEL

Public Member Functions

virtual ~FOOTPRINT_PREVIEW_PANEL_BASE ()
 
virtual void SetUserUnits (EDA_UNITS aUnits)=0
 
virtual bool DisplayFootprint (LIB_ID const &aFPID)=0
 Set the currently displayed footprint. More...
 
virtual wxWindow * GetWindow ()=0
 Get the underlying wxWindow. More...
 
virtual const KIGFX::COLOR4DGetBackgroundColor () const =0
 Get the colors to use in a preview widget to match the preview panel. More...
 
virtual const KIGFX::COLOR4DGetForegroundColor () const =0
 

Static Public Member Functions

static FOOTPRINT_PREVIEW_PANEL_BASECreate (wxWindow *aParent, KIWAY &aKiway)
 Return a footprint preview panel instance via Kiface. More...
 

Detailed Description

Base class for the actual viewer panel.

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

Definition at line 92 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 95 of file footprint_preview_widget.h.

95{}

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 115 of file footprint_preview_widget.cpp.

117{
118 FOOTPRINT_PREVIEW_PANEL_BASE* panel = nullptr;
119
120 try
121 {
122 KIFACE* kiface = aKiway.KiFACE( KIWAY::FACE_PCB );
123 wxWindow* window = kiface->CreateKiWindow( aParent, FRAME_FOOTPRINT_PREVIEW, &aKiway );
124
125 panel = dynamic_cast<FOOTPRINT_PREVIEW_PANEL_BASE*>( window );
126
127 if( window && !panel )
128 delete window;
129 }
130 catch( ... )
131 {
132 }
133
134 return panel;
135}
Base class for the actual viewer panel.
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
Definition: kiway.cpp:198
@ FACE_PCB
pcbnew DSO
Definition: kiway.h:287
return & kiface
Definition: cvpcb.cpp:112
@ FRAME_FOOTPRINT_PREVIEW
Definition: frame_type.h:46
Implement a participant in the KIWAY alchemy.
Definition: kiway.h:151

References 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().

◆ 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().

◆ GetForegroundColor()

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

◆ GetWindow()

virtual wxWindow * FOOTPRINT_PREVIEW_PANEL_BASE::GetWindow ( )
pure virtual

◆ SetUserUnits()

virtual void FOOTPRINT_PREVIEW_PANEL_BASE::SetUserUnits ( EDA_UNITS  aUnits)
pure virtual

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