STATUS_TEXT_POPUP Class Reference

Extension of STATUS_POPUP for displaying a single line text. More...

#include <status_popup.h>

Inheritance diagram for STATUS_TEXT_POPUP:

Public Member Functions
	STATUS_TEXT_POPUP (wxWindow *aParent)
virtual	~STATUS_TEXT_POPUP ()
void	SetText (const wxString &aText)
	Display a text. More...
void	SetTextColor (const wxColour &aColor)
	Change text color. More...
virtual void	Popup (wxWindow *aFocus=nullptr)
virtual void	PopupFor (int aMsecs)
virtual void	Move (const wxPoint &aWhere)
virtual void	Move (const VECTOR2I &aWhere)
void	Expire (int aMsecs)
	Hide the popup after a specified time. More...
wxWindow *	GetPanel ()

Protected Member Functions
void	updateSize ()
void	onCharHook (wxKeyEvent &aEvent)
	Expire timer even handler. More...
void	onExpire (wxTimerEvent &aEvent)

Protected Attributes
wxStaticText *	m_statusLine
wxPanel *	m_panel
wxBoxSizer *	m_topSizer
wxTimer	m_expireTimer

Detailed Description

Extension of STATUS_POPUP for displaying a single line text.

Definition at line 82 of file status_popup.h.

Constructor & Destructor Documentation

STATUS_TEXT_POPUP()

STATUS_TEXT_POPUP::STATUS_TEXT_POPUP

(

wxWindow *

aParent

)

Definition at line 116 of file status_popup.cpp.

 :
 STATUS_POPUP( aParent )
{
 m_panel->SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNSHADOW ) );
 m_panel->SetForegroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) );
 
 m_statusLine = new wxStaticText( m_panel, wxID_ANY, wxEmptyString ) ;
 m_topSizer->Add( m_statusLine, 1, wxALL | wxEXPAND, 5 );
}

References STATUS_POPUP::m_panel, m_statusLine, and STATUS_POPUP::m_topSizer.

~STATUS_TEXT_POPUP()

virtual STATUS_TEXT_POPUP::~STATUS_TEXT_POPUP ( )

inlinevirtual

Definition at line 86 of file status_popup.h.

{}

Member Function Documentation

Expire()

void STATUS_POPUP::Expire ( int  aMsecs )

inherited

Hide the popup after a specified time.

Parameters

aMsecs

is the time expressed in milliseconds

Definition at line 97 of file status_popup.cpp.

{
 m_expireTimer.StartOnce( aMsecs );
}

References STATUS_POPUP::m_expireTimer.

Referenced by STATUS_POPUP::PopupFor().

GetPanel()

wxWindow * STATUS_POPUP::GetPanel ( )

inlineinherited

Definition at line 62 of file status_popup.h.

{ return m_panel; }

References STATUS_POPUP::m_panel.

Referenced by EDIT_TOOL::doMoveSelection(), PAD_TOOL::EnumeratePads(), and LENGTH_TUNER_TOOL::performTuning().

Move() [1/2]

void STATUS_POPUP::Move ( const VECTOR2I &  aWhere )

virtualinherited

Definition at line 85 of file status_popup.cpp.

{
 SetPosition( ToWxPoint( aWhere ) );
}

References PCAD2KICAD::SetPosition(), and ToWxPoint().

Move() [2/2]

void STATUS_POPUP::Move ( const wxPoint &  aWhere )

virtualinherited

Definition at line 91 of file status_popup.cpp.

{
 SetPosition( aWhere );
}

References PCAD2KICAD::SetPosition().

Referenced by EDIT_TOOL::doMoveSelection(), PAD_TOOL::EnumeratePads(), and LENGTH_TUNER_TOOL::updateStatusPopup().

onCharHook()

void STATUS_POPUP::onCharHook ( wxKeyEvent &  aEvent )

protectedinherited

Expire timer even handler.

Definition at line 55 of file status_popup.cpp.

{
 // Key events from the status popup don't get put through the wxWidgets event system on
 // OSX, so we have to fall back to the CHAR_HOOK to forward hotkeys from the popup to
 // the canvas / frame.
 aEvent.SetEventType( wxEVT_CHAR );
 
 EDA_DRAW_FRAME* frame = dynamic_cast<EDA_DRAW_FRAME*>( GetParent() );
 
 if( frame )
 frame->GetCanvas()->OnEvent( aEvent );
 else
 GetParent()->GetEventHandler()->ProcessEvent( aEvent );
}

References EDA_DRAW_FRAME::GetCanvas(), and EDA_DRAW_PANEL_GAL::OnEvent().

Referenced by STATUS_POPUP::STATUS_POPUP().

onExpire()

void STATUS_POPUP::onExpire ( wxTimerEvent &  aEvent )

protectedinherited

Definition at line 110 of file status_popup.cpp.

{
 Hide();
}

Referenced by STATUS_POPUP::STATUS_POPUP().

Popup()

void STATUS_POPUP::Popup ( wxWindow *  aFocus = nullptr )

virtualinherited

Definition at line 71 of file status_popup.cpp.

{
 Show( true );
 Raise();
}

Referenced by EDIT_TOOL::doMoveSelection(), PAD_TOOL::EnumeratePads(), LENGTH_TUNER_TOOL::performTuning(), and STATUS_POPUP::PopupFor().

PopupFor()

void STATUS_POPUP::PopupFor ( int  aMsecs )

virtualinherited

Definition at line 78 of file status_popup.cpp.

{
 Popup();
 Expire( aMsecs );
}

References STATUS_POPUP::Expire(), and STATUS_POPUP::Popup().

SetText()

void STATUS_TEXT_POPUP::SetText

(

const wxString &

aText

)

Display a text.

Parameters

aText

is the text to be displayed.

Definition at line 127 of file status_popup.cpp.

{
 m_statusLine->SetLabel( aText );
 updateSize();
}

References m_statusLine, and STATUS_POPUP::updateSize().

Referenced by EDIT_TOOL::doMoveSelection(), PAD_TOOL::EnumeratePads(), and PNS_TUNE_STATUS_POPUP::UpdateStatus().

SetTextColor()

void STATUS_TEXT_POPUP::SetTextColor

(

const wxColour &

aColor

)

Change text color.

Parameters

aColor

is the new text color.

Definition at line 134 of file status_popup.cpp.

{
 m_statusLine->SetForegroundColour( aColor );
}

References m_statusLine.

Referenced by PNS_TUNE_STATUS_POPUP::UpdateStatus().

updateSize()

void STATUS_POPUP::updateSize ( )

protectedinherited

Definition at line 103 of file status_popup.cpp.

{
 m_topSizer->Fit( m_panel );
 SetClientSize( m_panel->GetSize() );
}

References STATUS_POPUP::m_panel, and STATUS_POPUP::m_topSizer.

Referenced by SetText().

Member Data Documentation

m_expireTimer

wxTimer STATUS_POPUP::m_expireTimer

protectedinherited

Definition at line 75 of file status_popup.h.

Referenced by STATUS_POPUP::Expire().

m_panel

wxPanel* STATUS_POPUP::m_panel

protectedinherited

Definition at line 73 of file status_popup.h.

Referenced by STATUS_POPUP::GetPanel(), STATUS_POPUP::STATUS_POPUP(), STATUS_TEXT_POPUP(), and STATUS_POPUP::updateSize().

m_statusLine

wxStaticText* STATUS_TEXT_POPUP::m_statusLine

protected

Definition at line 103 of file status_popup.h.

Referenced by SetText(), SetTextColor(), and STATUS_TEXT_POPUP().

m_topSizer

wxBoxSizer* STATUS_POPUP::m_topSizer

protectedinherited

Definition at line 74 of file status_popup.h.

Referenced by STATUS_POPUP::STATUS_POPUP(), STATUS_TEXT_POPUP(), and STATUS_POPUP::updateSize().

---

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

• status_popup.h
• status_popup.cpp