PLGui::WidgetHandler Class Reference

Widget handler class. More...

#include <WidgetHandler.h>

List of all members.

Public Member Functions
PLGUI_API	WidgetHandler ()
	Constructor.
PLGUI_API	WidgetHandler (const WidgetHandler &cOther)
	Copy constructor.
PLGUI_API	~WidgetHandler ()
	Destructor.
PLGUI_API Widget *	GetWidget () const
	Get widget pointer.
PLGUI_API bool	SetWidget (Widget *pWidget)
	Set widget pointer.
PLGUI_API void	Clear ()
	Clear widget pointer.
PLGUI_API bool	IsValid () const
	Check if the widget pointer is valid.
PLGUI_API bool	operator== (const WidgetHandler &cOther) const
	Compare operator.
PLGUI_API WidgetHandler &	operator= (const WidgetHandler &cOther)
	Assignment operator.

---

Detailed Description

Widget handler class.

Remarks:

A widget handler is a smart pointer to widgets. Use it whenever you want to store a pointer to a widget for a longer time, this way you can be sure that the pointer will be reset to a null pointer if the widget has been destroyed in the meantime.

---

Constructor & Destructor Documentation

PLGUI_API PLGui::WidgetHandler::WidgetHandler

(

)

Constructor.

PLGUI_API PLGui::WidgetHandler::WidgetHandler

(

const WidgetHandler &

cOther

)

Copy constructor.

Parameters:

[in]

cOther

Widget handler

PLGUI_API PLGui::WidgetHandler::~WidgetHandler

(

)

Destructor.

---

Member Function Documentation

PLGUI_API Widget* PLGui::WidgetHandler::GetWidget

(

)

const

Get widget pointer.

Returns:

Pointer to widget, can be a null pointer

PLGUI_API bool PLGui::WidgetHandler::SetWidget

(

Widget *

pWidget

)

Set widget pointer.

Parameters:

[in]

pWidget

Pointer to widget, can be a null pointer

Returns:

'true' if all went fine, else 'false'

PLGUI_API void PLGui::WidgetHandler::Clear

(

)

Clear widget pointer.

PLGUI_API bool PLGui::WidgetHandler::IsValid

(

)

const

Check if the widget pointer is valid.

Returns:

'true' if the handler points to a valid widget, else 'false'

PLGUI_API bool PLGui::WidgetHandler::operator==

(

const WidgetHandler &

cOther

)

const

Compare operator.

Parameters:

[in]

cOther

Widget handler

Returns:

'true' if equal, else 'false'

PLGUI_API WidgetHandler& PLGui::WidgetHandler::operator=

(

const WidgetHandler &

cOther

)

Assignment operator.

Parameters:

[in]

cOther

Widget handler

Returns:

Reference to this object

---

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

• WidgetHandler.h