#include <footprint_preview_widget.h>
Public Member Functions | |
| FOOTPRINT_PREVIEW_WIDGET (wxWindow *aParent, KIWAY &aKiway) | |
| Construct a footprint preview widget. | |
| bool | IsInitialized () const |
| Return whether the widget initialized properly. | |
| void | SetStatusText (const wxString &aText) |
| Set the contents of the status label and display it. | |
| void | ClearStatus () |
| Clear the contents of the status label and hide it. | |
| void | SetUserUnits (EDA_UNITS aUnits) |
| Set the units for the preview. | |
| void | SetPinFunctions (const std::map< wxString, wxString > &aPinFunctions) |
| Set the pin functions from the symbol's netlist. | |
| void | DisplayFootprint (const LIB_ID &aFPID) |
| Set the currently displayed footprint. | |
| void | DisplayFootprints (std::shared_ptr< FOOTPRINT > aFootprintA, std::shared_ptr< FOOTPRINT > aFootprintB) |
| Display a pair of footprints. | |
| void | RefreshAll () |
| Force the redrawing of all contents. | |
| FOOTPRINT_PREVIEW_PANEL_BASE * | GetPreviewPanel () |
Protected Attributes | |
| FOOTPRINT_PREVIEW_PANEL_BASE * | m_prev_panel |
| wxStaticText * | m_status |
| wxPanel * | m_statusPanel |
| wxSizer * | m_statusSizer |
| wxSizer * | m_outerSizer |
| LIB_ID | m_libid |
Detailed Description
Definition at line 41 of file footprint_preview_widget.h.
Constructor & Destructor Documentation
◆ FOOTPRINT_PREVIEW_WIDGET()
| FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET | ( | wxWindow * | aParent, |
| KIWAY & | aKiway | ||
| ) |
Construct a footprint preview widget.
- Parameters
-
aParent - parent window aKiway - an active Kiway instance
Definition at line 29 of file footprint_preview_widget.cpp.
References FOOTPRINT_PREVIEW_PANEL_BASE::Create(), FOOTPRINT_PREVIEW_PANEL_BASE::GetBackgroundColor(), FOOTPRINT_PREVIEW_PANEL_BASE::GetCanvas(), FOOTPRINT_PREVIEW_PANEL_BASE::GetForegroundColor(), m_outerSizer, m_prev_panel, m_status, m_statusPanel, m_statusSizer, SetStatusText(), and KIGFX::COLOR4D::ToColour().
Member Function Documentation
◆ ClearStatus()
| void FOOTPRINT_PREVIEW_WIDGET::ClearStatus | ( | ) |
Clear the contents of the status label and hide it.
Definition at line 87 of file footprint_preview_widget.cpp.
References FOOTPRINT_PREVIEW_PANEL_BASE::GetCanvas(), m_prev_panel, m_status, and m_statusPanel.
Referenced by DisplayFootprint(), DisplayFootprints(), PANEL_FOOTPRINT_CHOOSER::onFootprintSelected(), and PANEL_SYMBOL_CHOOSER::showFootprint().
◆ DisplayFootprint()
| void FOOTPRINT_PREVIEW_WIDGET::DisplayFootprint | ( | const LIB_ID & | aFPID | ) |
Set the currently displayed footprint.
Any footprint passed in here MUST have been passed to CacheFootprint before.
Definition at line 113 of file footprint_preview_widget.cpp.
References _, LIB_ID::clear(), ClearStatus(), FOOTPRINT_PREVIEW_PANEL_BASE::DisplayFootprint(), m_libid, m_prev_panel, and SetStatusText().
Referenced by PANEL_FOOTPRINT_CHOOSER::onFootprintSelected(), and PANEL_SYMBOL_CHOOSER::showFootprint().
◆ DisplayFootprints()
| void FOOTPRINT_PREVIEW_WIDGET::DisplayFootprints | ( | std::shared_ptr< FOOTPRINT > | aFootprintA, |
| std::shared_ptr< FOOTPRINT > | aFootprintB | ||
| ) |
Display a pair of footprints.
(Normally used for diff'ing.)
Definition at line 133 of file footprint_preview_widget.cpp.
References ClearStatus(), FOOTPRINT_PREVIEW_PANEL_BASE::DisplayFootprints(), and m_prev_panel.
Referenced by FOOTPRINT_DIFF_WIDGET::DisplayDiff().
◆ GetPreviewPanel()
|
inline |
Definition at line 98 of file footprint_preview_widget.h.
References m_prev_panel.
Referenced by FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_CHOOSER_FRAME::GetModel(), PANEL_FOOTPRINT_CHOOSER::onFootprintSelected(), PANEL_SYMBOL_CHOOSER::ShutdownCanvases(), and FOOTPRINT_CHOOSER_FRAME::~FOOTPRINT_CHOOSER_FRAME().
◆ IsInitialized()
|
inline |
Return whether the widget initialized properly.
This could return false if Kiway is not available. If this returns false, no other methods should be called.
Definition at line 57 of file footprint_preview_widget.h.
References m_prev_panel.
Referenced by PANEL_SYMBOL_CHOOSER::FinishSetup(), PANEL_FOOTPRINT_CHOOSER::onFootprintSelected(), PANEL_SYMBOL_CHOOSER::onSymbolSelected(), PANEL_SYMBOL_CHOOSER::showFootprint(), and PANEL_SYMBOL_CHOOSER::showFootprintFor().
◆ RefreshAll()
| void FOOTPRINT_PREVIEW_WIDGET::RefreshAll | ( | ) |
Force the redrawing of all contents.
Definition at line 143 of file footprint_preview_widget.cpp.
References m_prev_panel, and FOOTPRINT_PREVIEW_PANEL_BASE::RefreshAll().
Referenced by FOOTPRINT_DIFF_WIDGET::onSlider().
◆ SetPinFunctions()
| void FOOTPRINT_PREVIEW_WIDGET::SetPinFunctions | ( | const std::map< wxString, wxString > & | aPinFunctions | ) |
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
Definition at line 106 of file footprint_preview_widget.cpp.
References m_prev_panel, and FOOTPRINT_PREVIEW_PANEL_BASE::SetPinFunctions().
Referenced by FOOTPRINT_CHOOSER_FRAME::KiwayMailIn().
◆ SetStatusText()
| void FOOTPRINT_PREVIEW_WIDGET::SetStatusText | ( | const wxString & | aText | ) |
Set the contents of the status label and display it.
Definition at line 75 of file footprint_preview_widget.cpp.
References FOOTPRINT_PREVIEW_PANEL_BASE::GetCanvas(), m_prev_panel, m_status, and m_statusPanel.
Referenced by DisplayFootprint(), PANEL_SYMBOL_CHOOSER::FinishSetup(), FOOTPRINT_PREVIEW_WIDGET(), PANEL_FOOTPRINT_CHOOSER::onFootprintSelected(), PANEL_SYMBOL_CHOOSER::onSymbolSelected(), and PANEL_SYMBOL_CHOOSER::showFootprint().
◆ SetUserUnits()
| void FOOTPRINT_PREVIEW_WIDGET::SetUserUnits | ( | EDA_UNITS | aUnits | ) |
Set the units for the preview.
Definition at line 99 of file footprint_preview_widget.cpp.
References m_prev_panel, and FOOTPRINT_PREVIEW_PANEL_BASE::SetUserUnits().
Referenced by PANEL_SYMBOL_CHOOSER::constructRightPanel(), and PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER().
Member Data Documentation
◆ m_libid
|
protected |
Definition at line 107 of file footprint_preview_widget.h.
Referenced by DisplayFootprint().
◆ m_outerSizer
|
protected |
Definition at line 106 of file footprint_preview_widget.h.
Referenced by FOOTPRINT_DIFF_WIDGET::FOOTPRINT_DIFF_WIDGET(), and FOOTPRINT_PREVIEW_WIDGET().
◆ m_prev_panel
|
protected |
Definition at line 101 of file footprint_preview_widget.h.
Referenced by ClearStatus(), DisplayFootprint(), DisplayFootprints(), FOOTPRINT_PREVIEW_WIDGET(), GetPreviewPanel(), IsInitialized(), RefreshAll(), SetPinFunctions(), SetStatusText(), and SetUserUnits().
◆ m_status
|
protected |
Definition at line 103 of file footprint_preview_widget.h.
Referenced by ClearStatus(), FOOTPRINT_PREVIEW_WIDGET(), and SetStatusText().
◆ m_statusPanel
|
protected |
Definition at line 104 of file footprint_preview_widget.h.
Referenced by ClearStatus(), FOOTPRINT_PREVIEW_WIDGET(), and SetStatusText().
◆ m_statusSizer
|
protected |
Definition at line 105 of file footprint_preview_widget.h.
Referenced by FOOTPRINT_PREVIEW_WIDGET().
The documentation for this class was generated from the following files:
