KiCad PCB EDA Suite
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 PNS_TUNE_STATUS_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...
 

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

Constructor & Destructor Documentation

◆ STATUS_TEXT_POPUP()

STATUS_TEXT_POPUP::STATUS_TEXT_POPUP ( wxWindow *  aParent)

Definition at line 115 of file status_popup.cpp.

115  :
116  STATUS_POPUP( aParent )
117 {
118  m_panel->SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNSHADOW ) );
119  m_panel->SetForegroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) );
120 
121  m_statusLine = new wxStaticText( m_panel, wxID_ANY, wxEmptyString ) ;
122  m_topSizer->Add( m_statusLine, 1, wxALL | wxEXPAND, 5 );
123 }
STATUS_POPUP(wxWindow *aParent)
Transient mouse following popup window implementation.
wxPanel * m_panel
Definition: status_popup.h:70
wxStaticText * m_statusLine
Definition: status_popup.h:100
wxBoxSizer * m_topSizer
Definition: status_popup.h:71

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

83 {}

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

97 {
98  m_expireTimer.StartOnce( aMsecs );
99 }
wxTimer m_expireTimer
Definition: status_popup.h:72

References STATUS_POPUP::m_expireTimer.

Referenced by STATUS_POPUP::PopupFor().

◆ Move() [1/2]

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

Definition at line 90 of file status_popup.cpp.

91 {
92  SetPosition( aWhere );
93 }
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)

References PCAD2KICAD::SetPosition().

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

◆ Move() [2/2]

void STATUS_POPUP::Move ( const VECTOR2I aWhere)
virtualinherited

Definition at line 84 of file status_popup.cpp.

85 {
86  SetPosition( wxPoint( aWhere.x, aWhere.y ) );
87 }
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)

References PCAD2KICAD::SetPosition(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ onCharHook()

void STATUS_POPUP::onCharHook ( wxKeyEvent &  aEvent)
protectedinherited

Expire timer even handler.

Definition at line 54 of file status_popup.cpp.

55 {
56  // Key events from the status popup don't get put through the wxWidgets event system on
57  // OSX, so we have to fall back to the CHAR_HOOK to forward hotkeys from the popup to
58  // the canvas / frame.
59  aEvent.SetEventType( wxEVT_CHAR );
60 
61  EDA_DRAW_FRAME* frame = dynamic_cast<EDA_DRAW_FRAME*>( GetParent() );
62 
63  if( frame )
64  frame->GetCanvas()->OnEvent( aEvent );
65  else
66  GetParent()->GetEventHandler()->ProcessEvent( aEvent );
67 }
void OnEvent(wxEvent &aEvent)
Used to forward events to the canvas from popups, etc.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
The base class for create windows for drawing purpose.

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

110 {
111  Hide();
112 }

Referenced by STATUS_POPUP::STATUS_POPUP().

◆ Popup()

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

Definition at line 70 of file status_popup.cpp.

71 {
72  Show( true );
73  Raise();
74 }

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

◆ PopupFor()

void STATUS_POPUP::PopupFor ( int  aMsecs)
virtualinherited

Definition at line 77 of file status_popup.cpp.

78 {
79  Popup();
80  Expire( aMsecs );
81 }
virtual void Popup(wxWindow *aFocus=nullptr)
void Expire(int aMsecs)
Hide the popup after a specified time.

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

◆ SetText()

void STATUS_TEXT_POPUP::SetText ( const wxString &  aText)

Display a text.

Parameters
aTextis the text to be displayed.

Definition at line 126 of file status_popup.cpp.

127 {
128  m_statusLine->SetLabel( aText );
129  updateSize();
130 }
wxStaticText * m_statusLine
Definition: status_popup.h:100

References m_statusLine, and STATUS_POPUP::updateSize().

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

◆ SetTextColor()

void STATUS_TEXT_POPUP::SetTextColor ( const wxColour &  aColor)

Change text color.

Parameters
aColoris the new text color.

Definition at line 133 of file status_popup.cpp.

134 {
135  m_statusLine->SetForegroundColour( aColor );
136 }
wxStaticText * m_statusLine
Definition: status_popup.h:100

References m_statusLine.

Referenced by PNS_TUNE_STATUS_POPUP::UpdateStatus().

◆ updateSize()

void STATUS_POPUP::updateSize ( )
protectedinherited

Definition at line 102 of file status_popup.cpp.

103 {
104  m_topSizer->Fit( m_panel );
105  SetClientSize( m_panel->GetSize() );
106 }
wxPanel * m_panel
Definition: status_popup.h:70
wxBoxSizer * m_topSizer
Definition: status_popup.h:71

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 72 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 100 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: