KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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:
STATUS_POPUP

Public Member Functions

 STATUS_TEXT_POPUP (wxWindow *aParent)
 
virtual ~STATUS_TEXT_POPUP ()
 
void SetText (const wxString &aText)
 Display a text.
 
void SetTextColor (const wxColour &aColor)
 Change text color.
 
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.
 
wxWindow * GetPanel ()
 

Protected Member Functions

void updateSize ()
 
void onCharHook (wxKeyEvent &aEvent)
 Expire timer even handler.
 
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 83 of file status_popup.h.

Constructor & Destructor Documentation

◆ STATUS_TEXT_POPUP()

STATUS_TEXT_POPUP::STATUS_TEXT_POPUP ( wxWindow *  aParent)

Definition at line 119 of file status_popup.cpp.

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 87 of file status_popup.h.

Member Function Documentation

◆ Expire()

void STATUS_POPUP::Expire ( int  aMsecs)
inherited

Hide the popup after a specified time.

Parameters
aMsecsis the time expressed in milliseconds

Definition at line 100 of file status_popup.cpp.

References STATUS_POPUP::m_expireTimer.

Referenced by STATUS_POPUP::PopupFor().

◆ GetPanel()

wxWindow * STATUS_POPUP::GetPanel ( )
inlineinherited

Definition at line 63 of file status_popup.h.

References STATUS_POPUP::m_panel.

Referenced by PAD_TOOL::EnumeratePads().

◆ Move() [1/2]

void STATUS_POPUP::Move ( const VECTOR2I aWhere)
virtualinherited

Definition at line 88 of file status_popup.cpp.

References ToWxPoint().

◆ Move() [2/2]

void STATUS_POPUP::Move ( const wxPoint &  aWhere)
virtualinherited

Definition at line 94 of file status_popup.cpp.

Referenced by PAD_TOOL::EnumeratePads().

◆ onCharHook()

void STATUS_POPUP::onCharHook ( wxKeyEvent &  aEvent)
protectedinherited

Expire timer even handler.

Definition at line 58 of file status_popup.cpp.

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 113 of file status_popup.cpp.

Referenced by STATUS_POPUP::STATUS_POPUP().

◆ Popup()

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

Definition at line 74 of file status_popup.cpp.

Referenced by PAD_TOOL::EnumeratePads(), and STATUS_POPUP::PopupFor().

◆ PopupFor()

void STATUS_POPUP::PopupFor ( int  aMsecs)
virtualinherited

Definition at line 81 of file status_popup.cpp.

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

◆ SetText()

void STATUS_TEXT_POPUP::SetText ( const wxString &  aText)

Display a text.

Parameters
aTexttext to be displayed.

Definition at line 131 of file status_popup.cpp.

References m_statusLine, and STATUS_POPUP::updateSize().

Referenced by PAD_TOOL::EnumeratePads().

◆ SetTextColor()

void STATUS_TEXT_POPUP::SetTextColor ( const wxColour &  aColor)

Change text color.

Parameters
aColornew text color.

Definition at line 138 of file status_popup.cpp.

References m_statusLine.

◆ updateSize()

void STATUS_POPUP::updateSize ( )
protectedinherited

Definition at line 106 of file status_popup.cpp.

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 76 of file status_popup.h.

Referenced by STATUS_POPUP::Expire().

◆ m_panel

wxPanel* STATUS_POPUP::m_panel
protectedinherited

◆ m_statusLine

wxStaticText* STATUS_TEXT_POPUP::m_statusLine
protected

Definition at line 104 of file status_popup.h.

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

◆ m_topSizer

wxBoxSizer* STATUS_POPUP::m_topSizer
protectedinherited

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