PLGui::TrayIcon Class Reference

Tray icon class. More...

#include <TrayIcon.h>

List of all members.

Public Member Functions
PLGUI_API	TrayIcon (Gui &cGui)
	Constructor.
virtual PLGUI_API	~TrayIcon ()
	Destructor.
PLGUI_API Gui *	GetGui () const
	Get owner GUI.
PLGUI_API TrayIconImpl *	GetImpl () const
	Get implementation.
PLGUI_API bool	IsVisible () const
	Get visibility.
PLGUI_API void	SetVisible (bool bVisible)
	Set visibility.
PLGUI_API const Image &	GetIcon () const
	Get icon.
PLGUI_API void	SetIcon (const Image &cIcon)
	Set icon.
PLGUI_API PLCore::String	GetTooltip () const
	Get tooltip.
PLGUI_API void	SetTooltip (const PLCore::String &sTooltip)
	Set tooltip.
PLGUI_API void	ShowNotification (const PLCore::String &sTitle, const PLCore::String &sText)
	Show a notification text.
virtual PLGUI_API void	OnMouseMove (const PLMath::Vector2i &vPos)
	Called when the mouse is moved within the tray icon.
virtual PLGUI_API void	OnMouseButtonDown (PLCore::uint32 nButton, const PLMath::Vector2i &vPos)
	Called when a mouse button is pressed.
virtual PLGUI_API void	OnMouseButtonUp (PLCore::uint32 nButton, const PLMath::Vector2i &vPos)
	Called when a mouse button is released.
virtual PLGUI_API void	OnMouseButtonClick (PLCore::uint32 nButton, const PLMath::Vector2i &vPos)
	Called when a mouse button is clicked.
virtual PLGUI_API void	OnMouseButtonDoubleClick (PLCore::uint32 nButton, const PLMath::Vector2i &vPos)
	Called when a mouse button is double-clicked.
Public Attributes
PLCore::Event< const PLMath::Vector2i & >	EventMouseMove
PLCore::Event< PLCore::uint32, const PLMath::Vector2i & >	EventMouseButtonDown
PLCore::Event< PLCore::uint32, const PLMath::Vector2i & >	EventMouseButtonUp
PLCore::Event< PLCore::uint32, const PLMath::Vector2i & >	EventMouseButtonClick
PLCore::Event< PLCore::uint32, const PLMath::Vector2i & >	EventMouseButtonDoubleClick
Protected Attributes
Gui *	m_pGui
TrayIconImpl *	m_pImpl
bool	m_bVisible
Image	m_cIcon
PLCore::String	m_sTooltip

---

Detailed Description

Tray icon class.

Note:

• Implementation of the bridge design pattern, this class is the abstraction

---

Constructor & Destructor Documentation

PLGUI_API PLGui::TrayIcon::TrayIcon

(

Gui &

cGui

)

Constructor.

Parameters:

[in]

cGui

Owner GUI

virtual PLGUI_API PLGui::TrayIcon::~TrayIcon

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLGUI_API Gui* PLGui::TrayIcon::GetGui

(

)

const

Get owner GUI.

Returns:

Pointer to GUI object

PLGUI_API TrayIconImpl* PLGui::TrayIcon::GetImpl

(

)

const

Get implementation.

Returns:

Pointer to platform specific implementation

PLGUI_API bool PLGui::TrayIcon::IsVisible

(

)

const

Get visibility.

Returns:

'true' if tray icon is visible, else 'false'

PLGUI_API void PLGui::TrayIcon::SetVisible

(

bool

bVisible

)

Set visibility.

Parameters:

[in]

bVisible

'true' if tray icon is visible, else 'false'

PLGUI_API const Image& PLGui::TrayIcon::GetIcon

(

)

const

Get icon.

Returns:

Icon that is displayed in the tray

PLGUI_API void PLGui::TrayIcon::SetIcon

(

const Image &

cIcon

)

Set icon.

Parameters:

[in]

cIcon

Icon that is displayed in the tray

PLGUI_API PLCore::String PLGui::TrayIcon::GetTooltip

(

)

const

Get tooltip.

Returns:

Text that is displayed as a tooltip

PLGUI_API void PLGui::TrayIcon::SetTooltip

(

const PLCore::String &

sTooltip

)

Set tooltip.

Parameters:

[in]

sTooltip

Text that is displayed as a tooltip

PLGUI_API void PLGui::TrayIcon::ShowNotification	(	const PLCore::String &	sTitle,
		const PLCore::String &	sText
	)

Show a notification text.

Parameters:

[in]	sTitle	Title
[in]	sText	Text

virtual PLGUI_API void PLGui::TrayIcon::OnMouseMove

(

const PLMath::Vector2i &

vPos

)

[virtual]

Called when the mouse is moved within the tray icon.

Parameters:

[in]

vPos

Mouse position within the tray icon

virtual PLGUI_API void PLGui::TrayIcon::OnMouseButtonDown	(	PLCore::uint32	nButton,
		const PLMath::Vector2i &	vPos
	)		[virtual]

Called when a mouse button is pressed.

Parameters:

[in]	nButton	Mouse button that is pressed
[in]	vPos	Mouse position within the tray icon

virtual PLGUI_API void PLGui::TrayIcon::OnMouseButtonUp	(	PLCore::uint32	nButton,
		const PLMath::Vector2i &	vPos
	)		[virtual]

Called when a mouse button is released.

Parameters:

[in]	nButton	Mouse button that is released
[in]	vPos	Mouse position within the tray icon

virtual PLGUI_API void PLGui::TrayIcon::OnMouseButtonClick	(	PLCore::uint32	nButton,
		const PLMath::Vector2i &	vPos
	)		[virtual]

Called when a mouse button is clicked.

Parameters:

[in]	nButton	Mouse button that is clicked
[in]	vPos	Mouse position within the tray icon

virtual PLGUI_API void PLGui::TrayIcon::OnMouseButtonDoubleClick	(	PLCore::uint32	nButton,
		const PLMath::Vector2i &	vPos
	)		[virtual]

Called when a mouse button is double-clicked.

Parameters:

[in]	nButton	Mouse button that is double-clicked
[in]	vPos	Mouse position within the tray icon

---

Member Data Documentation

PLCore::Event<const PLMath::Vector2i&> PLGui::TrayIcon::EventMouseMove

Mouse moves inside the tray icon, mouse position within the widget as parameter

PLCore::Event<PLCore::uint32, const PLMath::Vector2i&> PLGui::TrayIcon::EventMouseButtonDown

Mouse button is pressed, mouse button and mouse position within the widget as parameters

PLCore::Event<PLCore::uint32, const PLMath::Vector2i&> PLGui::TrayIcon::EventMouseButtonUp

Mouse button is released, mouse button and mouse position within the widget as parameters

PLCore::Event<PLCore::uint32, const PLMath::Vector2i&> PLGui::TrayIcon::EventMouseButtonClick

Mouse button has been clicked, mouse button and mouse position within the widget as parameters

PLCore::Event<PLCore::uint32, const PLMath::Vector2i&> PLGui::TrayIcon::EventMouseButtonDoubleClick

Mouse button has been double-clicked, mouse button and mouse position within the widget as parameters

Gui* PLGui::TrayIcon::m_pGui [protected]

Pointer to GUI instance

TrayIconImpl* PLGui::TrayIcon::m_pImpl [protected]

Tray icon implementation

bool PLGui::TrayIcon::m_bVisible [protected]

Is the tray icon visible?

Image PLGui::TrayIcon::m_cIcon [protected]

Displayed icon

PLCore::String PLGui::TrayIcon::m_sTooltip [protected]

Displayed tooltip

---

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

• TrayIcon.h