PLGui::Modifier Class Reference

Modifier base class. More...

#include <Modifier.h>

Inheritance diagram for PLGui::Modifier:

List of all members.

Public Member Functions
PLGUI_API	Modifier ()
	Constructor.
virtual PLGUI_API	~Modifier ()
	Destructor.
PLGUI_API Widget *	GetWidget () const
	Return the widget to which the modifier belongs.
PLGUI_API PLCore::String	GetName () const
	Get name of modifier.
Protected Member Functions
PLGUI_API void	SetName (const PLCore::String &sName)
	Set name of modifier.
PLGUI_API void	Attach (Widget &cWidget)
	Attach the modifier to a widget.
PLGUI_API void	Detach ()
	Detach the modifier.
virtual void	OnAttach (Widget &cWidget)
	Called when the modifier is attached to a widget.
virtual void	OnDetach (Widget &cWidget)
	Called when the modifier is detached from a widget.
virtual PLGUI_API void	OnMessage (const GuiMessage &cMessage)
	Process GUI message.
Protected Attributes
Widget *	m_pWidget
PLCore::String	m_sName

---

Detailed Description

Modifier base class.

---

Constructor & Destructor Documentation

PLGUI_API PLGui::Modifier::Modifier

(

)

Constructor.

virtual PLGUI_API PLGui::Modifier::~Modifier

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLGUI_API Widget* PLGui::Modifier::GetWidget

(

)

const

Return the widget to which the modifier belongs.

Returns:

Widget that contains the modifier

PLGUI_API PLCore::String PLGui::Modifier::GetName

(

)

const

Get name of modifier.

Returns:

Name

PLGUI_API void PLGui::Modifier::SetName

(

const PLCore::String &

sName

)

[protected]

Set name of modifier.

Parameters:

[in]

sName

Name

PLGUI_API void PLGui::Modifier::Attach

(

Widget &

cWidget

)

[protected]

Attach the modifier to a widget.

Parameters:

[in]

cWidget

Widget to which the modifier is attached

PLGUI_API void PLGui::Modifier::Detach

(

)

[protected]

Detach the modifier.

virtual void PLGui::Modifier::OnAttach

(

Widget &

cWidget

)

[protected, virtual]

Called when the modifier is attached to a widget.

Parameters:

[in]

cWidget

Widget to which the modifier is attached

Reimplemented in PLGui::ModTooltip, PLGui::ModBlend, PLGui::ModTimeout, PLGui::ModClose, PLGui::ModSnap, and PLGui::ModFullscreen.

virtual void PLGui::Modifier::OnDetach

(

Widget &

cWidget

)

[protected, virtual]

Called when the modifier is detached from a widget.

Parameters:

[in]

cWidget

Widget from which the modifier is detached

Reimplemented in PLGui::ModTooltip, PLGui::ModBlend, PLGui::ModTimeout, PLGui::ModClose, PLGui::ModSnap, and PLGui::ModFullscreen.

virtual PLGUI_API void PLGui::Modifier::OnMessage

(

const GuiMessage &

cMessage

)

[protected, virtual]

Process GUI message.

Parameters:

[in]

cMessage

GUI message

Remarks:

Usually, you should not override this method, but rather use the virtual functions that are called after a specific message arrived (e.g. OnShow(), OnClose() etc.). If you decide to override this method, make sure to call the base implementation first, otherwise the messages will not be processed and no virtual functions or events will be called anymore.

Reimplemented from PLGui::WidgetFunctions.

---

Member Data Documentation

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

Widget to which the modifier belongs

PLCore::String PLGui::Modifier::m_sName [protected]

Name of modifier

---

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

• Modifier.h