FOOTPRINT_PREVIEW_WIDGET Class Reference

#include <footprint_preview_widget.h>

Inheritance diagram for FOOTPRINT_PREVIEW_WIDGET:

Public Member Functions
	FOOTPRINT_PREVIEW_WIDGET (wxWindow *aParent, KIWAY &aKiway)
	Construct a footprint preview widget. More...
bool	IsInitialized () const
	Return whether the widget initialized properly. More...
void	SetStatusText (const wxString &aText)
	Set the contents of the status label and display it. More...
void	ClearStatus ()
	Clear the contents of the status label and hide it. More...
void	DisplayFootprint (const LIB_ID &aFPID)
	Set the currently displayed footprint. More...

Private 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 38 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 28 of file footprint_preview_widget.cpp.

                                                                                     :
        wxPanel( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize,
                 wxFULL_REPAINT_ON_RESIZE | wxTAB_TRAVERSAL ),
        m_prev_panel( nullptr ),
        m_status( nullptr ),
        m_statusPanel( nullptr ),
        m_statusSizer( nullptr ),
        m_outerSizer( nullptr )
{
    m_prev_panel = FOOTPRINT_PREVIEW_PANEL_BASE::Create( this, aKiway );

    if( !m_prev_panel )
        return;

    m_statusPanel = new wxPanel( this );
    m_status = new wxStaticText( m_statusPanel, wxID_ANY, wxEmptyString );
    m_statusSizer = new wxBoxSizer( wxVERTICAL );
    m_statusSizer->Add( 0, 0, 1 );  // add a spacer
    m_statusSizer->Add( m_status, 0, wxALIGN_CENTER );
    m_statusSizer->Add( 0, 0, 1 );  // add a spacer
    m_statusPanel->SetSizer( m_statusSizer );

    // Give the status panel the same color scheme as the canvas so it isn't jarring when
    // switched to
    m_statusPanel->SetBackgroundColour( m_prev_panel->GetBackgroundColor().ToColour() );
    m_statusPanel->SetForegroundColour( m_prev_panel->GetForegroundColor().ToColour() );
    m_status->SetForegroundColour( m_prev_panel->GetForegroundColor().ToColour() );

    // Set our background so wx doesn't render a normal control background momentarily when
    // rapidly navigating with arrow keys
    SetBackgroundColour( m_prev_panel->GetBackgroundColor().ToColour() );
    SetForegroundColour( m_prev_panel->GetForegroundColor().ToColour() );

    m_outerSizer = new wxBoxSizer( wxVERTICAL );
    m_outerSizer->Add( m_prev_panel->GetWindow(), 1, wxALL | wxEXPAND, 0 );
    m_outerSizer->Add( m_statusPanel, 1, wxALL | wxEXPAND, 0 );

    SetSizer( m_outerSizer );

    SetStatusText( wxEmptyString );
}

References FOOTPRINT_PREVIEW_PANEL_BASE::Create(), FOOTPRINT_PREVIEW_PANEL_BASE::GetBackgroundColor(), FOOTPRINT_PREVIEW_PANEL_BASE::GetForegroundColor(), FOOTPRINT_PREVIEW_PANEL_BASE::GetWindow(), m_outerSizer, m_prev_panel, m_status, m_statusPanel, m_statusSizer, and SetStatusText().

Member Function Documentation

ClearStatus()

void FOOTPRINT_PREVIEW_WIDGET::ClearStatus

(

)

Clear the contents of the status label and hide it.

Definition at line 80 of file footprint_preview_widget.cpp.

{
    m_status->SetLabel( wxEmptyString );
    m_statusPanel->Hide();
    m_prev_panel->GetWindow()->Show();
    Layout();
}

References FOOTPRINT_PREVIEW_PANEL_BASE::GetWindow(), m_prev_panel, m_status, and m_statusPanel.

Referenced by DisplayFootprint(), DIALOG_CHOOSE_FOOTPRINT::OnComponentPreselected(), and DIALOG_CHOOSE_SYMBOL::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 89 of file footprint_preview_widget.cpp.

{
    if( !m_prev_panel || m_libid == aFPID )
        return;

    wxBusyCursor busy;

    if( m_prev_panel->DisplayFootprint( aFPID ) )
    {
        ClearStatus();
        m_libid = aFPID;
    }
    else
    {
        SetStatusText( _( "Footprint not found." ) );
        m_libid.clear();
    }
}

References _, LIB_ID::clear(), ClearStatus(), FOOTPRINT_PREVIEW_PANEL_BASE::DisplayFootprint(), m_libid, m_prev_panel, and SetStatusText().

Referenced by DIALOG_CHOOSE_FOOTPRINT::OnComponentPreselected(), and DIALOG_CHOOSE_SYMBOL::ShowFootprint().

IsInitialized()

bool FOOTPRINT_PREVIEW_WIDGET::IsInitialized ( ) const

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 55 of file footprint_preview_widget.h.

{ return m_prev_panel != nullptr; }

References m_prev_panel.

Referenced by DIALOG_CHOOSE_FOOTPRINT::OnComponentPreselected(), DIALOG_CHOOSE_SYMBOL::OnComponentPreselected(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CHOOSE_SYMBOL::ShowFootprint(), and DIALOG_CHOOSE_SYMBOL::ShowFootprintFor().

SetStatusText()

void FOOTPRINT_PREVIEW_WIDGET::SetStatusText

(

const wxString &

aText

)

Set the contents of the status label and display it.

Definition at line 71 of file footprint_preview_widget.cpp.

{
    m_status->SetLabel( aText );
    m_statusPanel->Show();
    m_prev_panel->GetWindow()->Hide();
    Layout();
}

References FOOTPRINT_PREVIEW_PANEL_BASE::GetWindow(), m_prev_panel, m_status, and m_statusPanel.

Referenced by DisplayFootprint(), FOOTPRINT_PREVIEW_WIDGET(), DIALOG_CHOOSE_FOOTPRINT::OnComponentPreselected(), DIALOG_CHOOSE_SYMBOL::OnComponentPreselected(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), and DIALOG_CHOOSE_SYMBOL::ShowFootprint().

Member Data Documentation

m_libid

LIB_ID FOOTPRINT_PREVIEW_WIDGET::m_libid

private

Definition at line 80 of file footprint_preview_widget.h.

Referenced by DisplayFootprint().

m_outerSizer

wxSizer* FOOTPRINT_PREVIEW_WIDGET::m_outerSizer

private

Definition at line 79 of file footprint_preview_widget.h.

Referenced by FOOTPRINT_PREVIEW_WIDGET().

m_prev_panel

FOOTPRINT_PREVIEW_PANEL_BASE* FOOTPRINT_PREVIEW_WIDGET::m_prev_panel

private

Definition at line 74 of file footprint_preview_widget.h.

Referenced by ClearStatus(), DisplayFootprint(), FOOTPRINT_PREVIEW_WIDGET(), IsInitialized(), and SetStatusText().

m_status

wxStaticText* FOOTPRINT_PREVIEW_WIDGET::m_status

private

Definition at line 76 of file footprint_preview_widget.h.

Referenced by ClearStatus(), FOOTPRINT_PREVIEW_WIDGET(), and SetStatusText().

m_statusPanel

wxPanel* FOOTPRINT_PREVIEW_WIDGET::m_statusPanel

private

Definition at line 77 of file footprint_preview_widget.h.

Referenced by ClearStatus(), FOOTPRINT_PREVIEW_WIDGET(), and SetStatusText().

m_statusSizer

wxSizer* FOOTPRINT_PREVIEW_WIDGET::m_statusSizer

private

Definition at line 78 of file footprint_preview_widget.h.

Referenced by FOOTPRINT_PREVIEW_WIDGET().

---

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

• footprint_preview_widget.h
• footprint_preview_widget.cpp