KiCad PCB EDA Suite
STATUS_POPUP Class Reference

STATUS_POPUP. More...

#include <status_popup.h>

Inheritance diagram for STATUS_POPUP:
STATUS_TEXT_POPUP PNS_TUNE_STATUS_POPUP

Public Member Functions

 STATUS_POPUP (wxWindow *aParent)
 Transient mouse following popup window implementation. More...
 
virtual ~STATUS_POPUP ()
 
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)
 Hides the popup after a specified time. More...
 

Protected Member Functions

void updateSize ()
 
void onCharHook (wxKeyEvent &aEvent)
 
void onExpire (wxTimerEvent &aEvent)
 

Expire timer even handler

More...
 

Protected Attributes

wxPanel * m_panel
 
wxBoxSizer * m_topSizer
 
wxTimer m_expireTimer
 

Detailed Description

STATUS_POPUP.

A tiny, headerless popup window used to display useful status (e.g. line length tuning info) next to the mouse cursor.

Definition at line 45 of file status_popup.h.

Constructor & Destructor Documentation

◆ STATUS_POPUP()

STATUS_POPUP::STATUS_POPUP ( wxWindow *  aParent)

Transient mouse following popup window implementation.

Definition at line 33 of file status_popup.cpp.

33  :
34  wxPopupWindow( aParent ),
35  m_expireTimer( this )
36 {
37  m_panel = new wxPanel( this, wxID_ANY );
38  m_topSizer = new wxBoxSizer( wxVERTICAL );
39  m_panel->SetSizer( m_topSizer );
40  m_panel->SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW ) );
41 
42  Connect( wxEVT_TIMER, wxTimerEventHandler( STATUS_POPUP::onExpire ), NULL, this );
43 
44 #ifdef __WXOSX_MAC__
45  // Key events from popups don't get put through the wxWidgets event system on OSX,
46  // so we have to fall back to the CHAR_HOOK to forwared hotkeys from the popup to
47  // the canvas / frame.
48  Connect( wxEVT_CHAR_HOOK, wxKeyEventHandler( STATUS_POPUP::onCharHook ), nullptr, this );
49 #endif
50 }
void onExpire(wxTimerEvent &aEvent)
Expire timer even handler
wxPanel * m_panel
Definition: status_popup.h:71
void onCharHook(wxKeyEvent &aEvent)
#define NULL
wxTimer m_expireTimer
Definition: status_popup.h:73
wxBoxSizer * m_topSizer
Definition: status_popup.h:72

References m_panel, m_topSizer, NULL, onCharHook(), and onExpire().

◆ ~STATUS_POPUP()

virtual STATUS_POPUP::~STATUS_POPUP ( )
inlinevirtual

Definition at line 49 of file status_popup.h.

49 {}

Member Function Documentation

◆ Expire()

void STATUS_POPUP::Expire ( int  aMsecs)

Hides the popup after a specified time.

Parameters
aMsecsis the time expressed in milliseconds

Definition at line 95 of file status_popup.cpp.

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

References m_expireTimer.

Referenced by PopupFor().

◆ Move() [1/2]

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

Definition at line 89 of file status_popup.cpp.

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

References PCAD2KICAD::SetPosition().

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

◆ Move() [2/2]

void STATUS_POPUP::Move ( const VECTOR2I aWhere)
virtual

Definition at line 83 of file status_popup.cpp.

84 {
85  SetPosition( wxPoint( aWhere.x, aWhere.y ) );
86 }
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)
protected

Definition at line 53 of file status_popup.cpp.

54 {
55  // Key events from the status popup don't get put through the wxWidgets event system on
56  // OSX, so we have to fall back to the CHAR_HOOK to forward hotkeys from the popup to
57  // the canvas / frame.
58  aEvent.SetEventType( wxEVT_CHAR );
59 
60  EDA_DRAW_FRAME* frame = dynamic_cast<EDA_DRAW_FRAME*>( GetParent() );
61 
62  if( frame )
63  frame->GetCanvas()->OnEvent( aEvent );
64  else
65  GetParent()->GetEventHandler()->ProcessEvent( aEvent );
66 }
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().

◆ onExpire()

void STATUS_POPUP::onExpire ( wxTimerEvent &  aEvent)
protected

Expire timer even handler

Definition at line 108 of file status_popup.cpp.

109 {
110  Hide();
111 }

Referenced by STATUS_POPUP().

◆ Popup()

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

Definition at line 69 of file status_popup.cpp.

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

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

◆ PopupFor()

void STATUS_POPUP::PopupFor ( int  aMsecs)
virtual

Definition at line 76 of file status_popup.cpp.

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

References Expire(), and Popup().

Referenced by SCH_EDIT_TOOL::DeleteItemCursor(), and PCBNEW_CONTROL::DeleteItemCursor().

◆ updateSize()

void STATUS_POPUP::updateSize ( )
protected

Definition at line 101 of file status_popup.cpp.

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

References m_panel, and m_topSizer.

Referenced by STATUS_TEXT_POPUP::SetText().

Member Data Documentation

◆ m_expireTimer

wxTimer STATUS_POPUP::m_expireTimer
protected

Definition at line 73 of file status_popup.h.

Referenced by Expire().

◆ m_panel

wxPanel* STATUS_POPUP::m_panel
protected

◆ m_topSizer

wxBoxSizer* STATUS_POPUP::m_topSizer
protected

Definition at line 72 of file status_popup.h.

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


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