icl::qt::GUIHandleBase Class Reference

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

#include <GUIHandleBase.h>

Inheritance diagram for icl::qt::GUIHandleBase:

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

Protected Member Functions
	GUIHandleBase (GUIWidget *w=0)
	create a new GUIHandleBase More...

Private Attributes
GUIWidget *	m_poGUIWidget

Detailed Description

Base class for GUIHandles providing functions to register callbacks.

Constructor & Destructor Documentation

GUIHandleBase()

icl::qt::GUIHandleBase::GUIHandleBase ( GUIWidget *  w = 0 )

inlineprotected

create a new GUIHandleBase

~GUIHandleBase()

virtual icl::qt::GUIHandleBase::~GUIHandleBase ( )

inlinevirtual

virtual destructor

Member Function Documentation

cb()

virtual void icl::qt::GUIHandleBase::cb ( )

inlinevirtual

envokes all registered callbacks

getGUIWidget()

GUIWidget* icl::qt::GUIHandleBase::getGUIWidget ( )

inline

returns parent GUIWidget pointer

registerCallback() [1/2]

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

inlinevirtual

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.

registerCallback() [2/2]

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

inlinevirtual

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.

removeCallbacks()

virtual void icl::qt::GUIHandleBase::removeCallbacks ( )

inlinevirtual

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

m_poGUIWidget

GUIWidget* icl::qt::GUIHandleBase::m_poGUIWidget

private

---

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

• /Users/alneuman/vm/icl/ICLQt/src/ICLQt/GUIHandleBase.h