PLGui::GuiMessage Class Reference

GUI message/event. More...

#include <GuiMessage.h>

List of all members.

Public Member Functions
PLGUI_API	GuiMessage (Widget *pWidget=nullptr, EMessageType nType=MessageOnUnknown)
	Constructor.
PLGUI_API	GuiMessage (const GuiMessage &cOther)
	Copy constructor.
PLGUI_API	~GuiMessage ()
	Destructor.
PLGUI_API bool	operator== (const GuiMessage &cOther) const
	Comparison operator.
PLGUI_API GuiMessage &	operator= (const GuiMessage &cOther)
	Assignment operator.
PLGUI_API PLCore::String	ToString () const
	Get message representation as string.
Widget *	GetWidget () const
	Get message target.
EMessageType	GetType () const
	Get message type.
PLCore::uint32	GetData () const
	Get message data.
int	GetDelta () const
	Get delta.
EWindowState	GetWindowState () const
	Get window state.
EMouseButton	GetMouseButton () const
	Get mouse button.
PLCore::uint32	GetKey () const
	Get key.
bool	GetState () const
	Get boolean state.
void *	GetDataPointer () const
	Get data pointer.
PLCore::uint32	GetExtData () const
	Get secondary data.
DataObject *	GetDataObject () const
	Get data object.
Widget *	GetChildWidget () const
	Get child widget.
Graphics *	GetGraphics () const
	Get graphics object.
Timer *	GetTimer () const
	Get timer object.
const PLCore::uint32	GetModifiers () const
	Get modifier keys.
const PLMath::Vector2i &	GetPosSize () const
	Get position or size.
Static Public Member Functions
static PLGUI_API GuiMessage	OnWakeup ()
static PLGUI_API GuiMessage	OnExit ()
static PLGUI_API GuiMessage	OnTimer (Timer *pTimer)
static PLGUI_API GuiMessage	OnUserMessage (Widget *pWidget, PLCore::uint32 nData, void *pData)
static PLGUI_API GuiMessage	OnInternalMessage (PLCore::uint32 nData, PLCore::uint32 nExtData)
static PLGUI_API GuiMessage	OnThemeChanged (Widget *pWidget)
static PLGUI_API GuiMessage	OnUpdateContent (Widget *pWidget)
static PLGUI_API GuiMessage	OnUpdateChildWidget (Widget *pWidget, Widget *pChildWidget)
static PLGUI_API GuiMessage	OnAddChildWidget (Widget *pWidget, Widget *pChildWidget)
static PLGUI_API GuiMessage	OnRemoveChildWidget (Widget *pWidget, Widget *pChildWidget)
static PLGUI_API GuiMessage	OnClose (Widget *pWidget)
static PLGUI_API GuiMessage	OnCreate (Widget *pWidget)
static PLGUI_API GuiMessage	OnDestroy (Widget *pWidget)
static PLGUI_API GuiMessage	OnShow (Widget *pWidget)
static PLGUI_API GuiMessage	OnHide (Widget *pWidget)
static PLGUI_API GuiMessage	OnEnable (Widget *pWidget)
static PLGUI_API GuiMessage	OnDisable (Widget *pWidget)
static PLGUI_API GuiMessage	OnGetFocus (Widget *pWidget)
static PLGUI_API GuiMessage	OnLooseFocus (Widget *pWidget)
static PLGUI_API GuiMessage	OnActivate (Widget *pWidget, bool bActivate)
static PLGUI_API GuiMessage	OnDrawBackground (Widget *pWidget, Graphics *pGraphics)
static PLGUI_API GuiMessage	OnDraw (Widget *pWidget, Graphics *pGraphics)
static PLGUI_API GuiMessage	OnMove (Widget *pWidget, const PLMath::Vector2i &vPos)
static PLGUI_API GuiMessage	OnSize (Widget *pWidget, const PLMath::Vector2i &vSize)
static PLGUI_API GuiMessage	OnWindowState (Widget *pWidget, EWindowState nWindowState)
static PLGUI_API GuiMessage	OnEnterFullscreen (Widget *pWidget)
static PLGUI_API GuiMessage	OnLeaveFullscreen (Widget *pWidget)
static PLGUI_API GuiMessage	OnPreferredSize (Widget *pWidget, const PLMath::Vector2i &vSize)
static PLGUI_API GuiMessage	OnAdjustContent (Widget *pWidget)
static PLGUI_API GuiMessage	OnMouseEnter (Widget *pWidget)
static PLGUI_API GuiMessage	OnMouseLeave (Widget *pWidget)
static PLGUI_API GuiMessage	OnMouseOver (Widget *pWidget, bool bMouseOver)
static PLGUI_API GuiMessage	OnMouseMove (Widget *pWidget, const PLMath::Vector2i &vPos)
static PLGUI_API GuiMessage	OnMouseHover (Widget *pWidget)
static PLGUI_API GuiMessage	OnMousePosUpdate (Widget *pWidget, const PLMath::Vector2i &vPos)
static PLGUI_API GuiMessage	OnMouseButtonDown (Widget *pWidget, EMouseButton nButton, const PLMath::Vector2i &vPos)
static PLGUI_API GuiMessage	OnMouseButtonUp (Widget *pWidget, EMouseButton nButton, const PLMath::Vector2i &vPos)
static PLGUI_API GuiMessage	OnMouseButtonClick (Widget *pWidget, EMouseButton nButton, const PLMath::Vector2i &vPos)
static PLGUI_API GuiMessage	OnMouseButtonDoubleClick (Widget *pWidget, EMouseButton nButton, const PLMath::Vector2i &vPos)
static PLGUI_API GuiMessage	OnMouseWheel (Widget *pWidget, int nDelta)
static PLGUI_API GuiMessage	OnKeyDown (Widget *pWidget, PLCore::uint32 nKey, PLCore::uint32 nModifiers)
static PLGUI_API GuiMessage	OnKeyUp (Widget *pWidget, PLCore::uint32 nKey, PLCore::uint32 nModifiers)
static PLGUI_API GuiMessage	OnHotkey (Widget *pWidget, PLCore::uint32 nHotkey)
static PLGUI_API GuiMessage	OnDrop (Widget *pWidget, DataObject *pDataObject)
Protected Attributes
Widget *	m_pWidget
EMessageType	m_nType
union {
PLCore::uint32   m_nData
int   m_nDelta
EWindowState   m_nWindowState
EMouseButton   m_nMouseButton
PLCore::uint32   m_nKey
bool   m_bState
};
union {
void *   m_pDataPtr
PLCore::uint32   m_nExtData
DataObject *   m_pDataObject
Widget *   m_pChildWidget
Graphics *   m_pGraphics
Timer *   m_pTimer
PLCore::uint32   m_nModifiers
};
PLMath::Vector2i	m_vPosSize

---

Detailed Description

GUI message/event.

---

Constructor & Destructor Documentation

PLGUI_API PLGui::GuiMessage::GuiMessage	(	Widget *	pWidget = nullptr,
		EMessageType	nType = MessageOnUnknown
	)

Constructor.

Parameters:

[in]	pWidget	Message target
[in]	nType	Message type

PLGUI_API PLGui::GuiMessage::GuiMessage

(

const GuiMessage &

cOther

)

Copy constructor.

Parameters:

[in]

cOther

GUI message

PLGUI_API PLGui::GuiMessage::~GuiMessage

(

)

Destructor.

---

Member Function Documentation

static PLGUI_API GuiMessage PLGui::GuiMessage::OnWakeup

(

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnExit

(

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnTimer

(

Timer *

pTimer

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnUserMessage	(	Widget *	pWidget,
		PLCore::uint32	nData,
		void *	pData
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnInternalMessage	(	PLCore::uint32	nData,
		PLCore::uint32	nExtData
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnThemeChanged

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnUpdateContent

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnUpdateChildWidget	(	Widget *	pWidget,
		Widget *	pChildWidget
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnAddChildWidget	(	Widget *	pWidget,
		Widget *	pChildWidget
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnRemoveChildWidget	(	Widget *	pWidget,
		Widget *	pChildWidget
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnClose

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnCreate

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnDestroy

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnShow

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnHide

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnEnable

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnDisable

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnGetFocus

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnLooseFocus

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnActivate	(	Widget *	pWidget,
		bool	bActivate
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnDrawBackground	(	Widget *	pWidget,
		Graphics *	pGraphics
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnDraw	(	Widget *	pWidget,
		Graphics *	pGraphics
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMove	(	Widget *	pWidget,
		const PLMath::Vector2i &	vPos
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnSize	(	Widget *	pWidget,
		const PLMath::Vector2i &	vSize
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnWindowState	(	Widget *	pWidget,
		EWindowState	nWindowState
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnEnterFullscreen

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnLeaveFullscreen

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnPreferredSize	(	Widget *	pWidget,
		const PLMath::Vector2i &	vSize
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnAdjustContent

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseEnter

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseLeave

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseOver	(	Widget *	pWidget,
		bool	bMouseOver
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseMove	(	Widget *	pWidget,
		const PLMath::Vector2i &	vPos
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseHover

(

Widget *

pWidget

)

[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMousePosUpdate	(	Widget *	pWidget,
		const PLMath::Vector2i &	vPos
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseButtonDown	(	Widget *	pWidget,
		EMouseButton	nButton,
		const PLMath::Vector2i &	vPos
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseButtonUp	(	Widget *	pWidget,
		EMouseButton	nButton,
		const PLMath::Vector2i &	vPos
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseButtonClick	(	Widget *	pWidget,
		EMouseButton	nButton,
		const PLMath::Vector2i &	vPos
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseButtonDoubleClick	(	Widget *	pWidget,
		EMouseButton	nButton,
		const PLMath::Vector2i &	vPos
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnMouseWheel	(	Widget *	pWidget,
		int	nDelta
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnKeyDown	(	Widget *	pWidget,
		PLCore::uint32	nKey,
		PLCore::uint32	nModifiers
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnKeyUp	(	Widget *	pWidget,
		PLCore::uint32	nKey,
		PLCore::uint32	nModifiers
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnHotkey	(	Widget *	pWidget,
		PLCore::uint32	nHotkey
	)		[static]

static PLGUI_API GuiMessage PLGui::GuiMessage::OnDrop	(	Widget *	pWidget,
		DataObject *	pDataObject
	)		[static]

PLGUI_API bool PLGui::GuiMessage::operator==

(

const GuiMessage &

cOther

)

const

Comparison operator.

Parameters:

[in]

cOther

GUI message

Returns:

'true' if equal, else 'false'

PLGUI_API GuiMessage& PLGui::GuiMessage::operator=

(

const GuiMessage &

cOther

)

Assignment operator.

Parameters:

[in]

cOther

GUI message

Returns:

Reference to this object

PLGUI_API PLCore::String PLGui::GuiMessage::ToString

(

)

const

Get message representation as string.

Returns:

Message as string

Widget* PLGui::GuiMessage::GetWidget

(

)

const [inline]

Get message target.

Returns:

Widget

EMessageType PLGui::GuiMessage::GetType

(

)

const [inline]

Get message type.

Returns:

Message type

PLCore::uint32 PLGui::GuiMessage::GetData

(

)

const [inline]

Get message data.

Returns:

Message data

int PLGui::GuiMessage::GetDelta

(

)

const [inline]

Get delta.

Returns:

Delta value

EWindowState PLGui::GuiMessage::GetWindowState

(

)

const [inline]

Get window state.

Returns:

Window state

EMouseButton PLGui::GuiMessage::GetMouseButton

(

)

const [inline]

Get mouse button.

Returns:

Mouse button

PLCore::uint32 PLGui::GuiMessage::GetKey

(

)

const [inline]

Get key.

Returns:

Key

bool PLGui::GuiMessage::GetState

(

)

const [inline]

Get boolean state.

Returns:

State

void* PLGui::GuiMessage::GetDataPointer

(

)

const [inline]

Get data pointer.

Returns:

Data pointer

PLCore::uint32 PLGui::GuiMessage::GetExtData

(

)

const [inline]

Get secondary data.

Returns:

Message data

DataObject* PLGui::GuiMessage::GetDataObject

(

)

const [inline]

Get data object.

Returns:

Data pointer

Widget* PLGui::GuiMessage::GetChildWidget

(

)

const [inline]

Get child widget.

Returns:

Widget

Graphics* PLGui::GuiMessage::GetGraphics

(

)

const [inline]

Get graphics object.

Returns:

Graphics object

Timer* PLGui::GuiMessage::GetTimer

(

)

const [inline]

Get timer object.

Returns:

Timer object

const PLCore::uint32 PLGui::GuiMessage::GetModifiers

(

)

const [inline]

Get modifier keys.

Returns:

Modifiers

const PLMath::Vector2i& PLGui::GuiMessage::GetPosSize

(

)

const [inline]

Get position or size.

Returns:

Vector

---

Member Data Documentation

Widget* PLGui::GuiMessage::m_pWidget [protected]

Widget

EMessageType PLGui::GuiMessage::m_nType [protected]

Message type

PLCore::uint32 PLGui::GuiMessage::m_nData

Message data

int PLGui::GuiMessage::m_nDelta

Movement delta

EWindowState PLGui::GuiMessage::m_nWindowState

Window state

EMouseButton PLGui::GuiMessage::m_nMouseButton

Mouse button

PLCore::uint32 PLGui::GuiMessage::m_nKey

Key code

bool PLGui::GuiMessage::m_bState

Boolean state

union { ... } [protected]

void* PLGui::GuiMessage::m_pDataPtr

Message data pointer

PLCore::uint32 PLGui::GuiMessage::m_nExtData

Secondary data

DataObject* PLGui::GuiMessage::m_pDataObject

Data object

Widget* PLGui::GuiMessage::m_pChildWidget

Child widget

Graphics* PLGui::GuiMessage::m_pGraphics

Graphics object

Timer* PLGui::GuiMessage::m_pTimer

Timer object

PLCore::uint32 PLGui::GuiMessage::m_nModifiers

Key modifiers

union { ... } [protected]

PLMath::Vector2i PLGui::GuiMessage::m_vPosSize [protected]

Position or size

---

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

• GuiMessage.h