icl::qt::GUIHandleBase Class Reference

Base class for GUIHandles providing functions to register callbacks. More...

#include <GUIHandleBase.h>

Inheritance diagram for icl::qt::GUIHandleBase:

List of all members.

Public Member Functions
virtual	~GUIHandleBase ()
	virtual destructor
GUIWidget *	getGUIWidget ()
	returns parent GUIWidget pointer
virtual void	registerCallback (const GUI::Callback &cb, const std::string &events="all")
	registers a callback on this gui widget
virtual void	registerCallback (const GUI::ComplexCallback &cb, const std::string &events="all")
	registers a complex callback on this gui component
virtual void	removeCallbacks ()
	removes all callbacks from parent GUIWidget component
virtual void	cb ()
	envokes all registered callbacks
Protected Member Functions
	GUIHandleBase (GUIWidget *w=0)
	create a new GUIHandleBase
Private Attributes
GUIWidget *	m_poGUIWidget

---

Detailed Description

Base class for GUIHandles providing functions to register callbacks.

---

Constructor & Destructor Documentation

icl::qt::GUIHandleBase::GUIHandleBase

(

GUIWidget *

w = 0

)

[inline, protected]

create a new GUIHandleBase

virtual icl::qt::GUIHandleBase::~GUIHandleBase

(

)

[inline, virtual]

virtual destructor

---

Member Function Documentation

virtual void icl::qt::GUIHandleBase::cb

(

)

[inline, virtual]

envokes all registered callbacks

GUIWidget* icl::qt::GUIHandleBase::getGUIWidget

(

)

[inline]

returns parent GUIWidget pointer

virtual void icl::qt::GUIHandleBase::registerCallback	(	const GUI::Callback &	cb,
		const std::string &	events = "all"
	)		[inline, virtual]

registers a callback on this gui widget

This function can be re-implemented to bypass event propagation. By default, events are passed to the parent GUIWidget which, then again passes the events implementation-dependently to the actual widget.

Parameters:

cb	callback functor to call
events	comma separated list of event types to register on. This list is handled internally by each special GUIHandlerBase implementation currently only the ImageHandle DrawHandle and DrawHandle3D re-implement this functionality. By default, the paremter 'events' is not regarded at all

Reimplemented in icl::qt::SliderHandle, icl::qt::FSliderHandle, icl::qt::ImageHandle, icl::qt::DrawHandle, icl::qt::DrawHandle3D, icl::geom::PlotHandle3D, and icl::qt::PlotHandle.

virtual void icl::qt::GUIHandleBase::registerCallback	(	const GUI::ComplexCallback &	cb,
		const std::string &	events = "all"
	)		[inline, virtual]

registers a complex callback on this gui component

Reimplemented in icl::qt::ImageHandle, icl::qt::DrawHandle, icl::qt::DrawHandle3D, icl::geom::PlotHandle3D, and icl::qt::PlotHandle.

virtual void icl::qt::GUIHandleBase::removeCallbacks

(

)

[inline, virtual]

removes all callbacks from parent GUIWidget component

Reimplemented in icl::qt::SliderHandle, icl::qt::FSliderHandle, icl::qt::ImageHandle, icl::qt::DrawHandle, and icl::qt::DrawHandle3D.

---

Member Data Documentation

GUIWidget* icl::qt::GUIHandleBase::m_poGUIWidget [private]

---

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

• /home/jenkins/workspace/icl-manual-trunk/icl-manual/ICLQt/src/ICLQt/GUIHandleBase.h