STATUS_POPUP Class Reference

A tiny, headerless popup window used to display useful status (e.g. More...

#include <status_popup.h>

Inheritance diagram for STATUS_POPUP:

Public Member Functions
	STATUS_POPUP (wxWindow *aParent)
	Transient mouse following popup window implementation.
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)
	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
wxPanel *	m_panel
wxBoxSizer *	m_topSizer
wxTimer	m_expireTimer

Detailed Description

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

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

~STATUS_POPUP()

virtual STATUS_POPUP::~STATUS_POPUP ( )

inlinevirtual

Definition at line 49 of file status_popup.h.

Member Function Documentation

Expire()

void STATUS_POPUP::Expire

(

int

aMsecs

)

Hide the popup after a specified time.

Parameters

aMsecs

is the time expressed in milliseconds

Definition at line 100 of file status_popup.cpp.

References m_expireTimer.

Referenced by PopupFor().

GetPanel()

wxWindow * STATUS_POPUP::GetPanel ( )

inline

Definition at line 63 of file status_popup.h.

References m_panel.

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

Move() [1/2]

void STATUS_POPUP::Move ( const VECTOR2I &  aWhere )

virtual

Definition at line 88 of file status_popup.cpp.

References ToWxPoint().

Move() [2/2]

void STATUS_POPUP::Move ( const wxPoint &  aWhere )

virtual

Definition at line 94 of file status_popup.cpp.

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

onCharHook()

void STATUS_POPUP::onCharHook ( wxKeyEvent &  aEvent )

protected

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().

onExpire()

void STATUS_POPUP::onExpire ( wxTimerEvent &  aEvent )

protected

Definition at line 113 of file status_popup.cpp.

Referenced by STATUS_POPUP().

Popup()

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

virtual

Definition at line 74 of file status_popup.cpp.

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

PopupFor()

void STATUS_POPUP::PopupFor ( int  aMsecs )

virtual

Definition at line 81 of file status_popup.cpp.

References Expire(), and Popup().

updateSize()

void STATUS_POPUP::updateSize ( )

protected

Definition at line 106 of file status_popup.cpp.

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

Referenced by Expire().

m_panel

wxPanel* STATUS_POPUP::m_panel

protected

Definition at line 74 of file status_popup.h.

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

m_topSizer

wxBoxSizer* STATUS_POPUP::m_topSizer

protected

Definition at line 75 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:

• status_popup.h
• status_popup.cpp