map widget events into callbacks More...

#include <vtkWidgetCallbackMapper.h>

Inheritance diagram for vtkWidgetCallbackMapper:

Collaboration diagram for vtkWidgetCallbackMapper:

Public Types

typedef void(*	CallbackType) (vtkAbstractWidget *)

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
void	InvokeCallback (unsigned long widgetEvent)


void	SetEventTranslator (vtkWidgetEventTranslator *t)

virtual vtkWidgetEventTranslator *	GetEventTranslator ()


void	SetCallbackMethod (unsigned long VTKEvent, unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f)

void	SetCallbackMethod (unsigned long VTKEvent, int modifiers, char keyCode, int repeatCount, const char keySym, unsigned long widgetEvent, vtkAbstractWidget w, CallbackType f)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkWidgetCallbackMapper *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
	vtkWidgetCallbackMapper ()

	~vtkWidgetCallbackMapper ()


void	SetCallbackMethod (unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkWidgetEventTranslator *	EventTranslator

vtkCallbackMap *	CallbackMap

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkObject	Superclass

static int	IsTypeOf (const char *type)

static vtkWidgetCallbackMapper *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkWidgetCallbackMapper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

map widget events into callbacks

vtkWidgetCallbackMapper maps widget events (defined in vtkWidgetEvent.h) into static class methods, and provides facilities to invoke the methods. This class is templated and meant to be used as an internal helper class by the widget classes. The class works in combination with the class vtkWidgetEventTranslator, which translates VTK events into widget events.

See also: vtkWidgetEvent vtkWidgetEventTranslator

Definition at line 40 of file vtkWidgetCallbackMapper.h.

Member Typedef Documentation

typedef vtkObject vtkWidgetCallbackMapper::Superclass

Standard macros.

Definition at line 48 of file vtkWidgetCallbackMapper.h.

typedef void(* vtkWidgetCallbackMapper::CallbackType) (vtkAbstractWidget *)

Convenient typedef for working with callbacks.

Definition at line 61 of file vtkWidgetCallbackMapper.h.

Constructor & Destructor Documentation

vtkWidgetCallbackMapper::vtkWidgetCallbackMapper ( )

protected

vtkWidgetCallbackMapper::~vtkWidgetCallbackMapper ( )

protected

Member Function Documentation

static vtkWidgetCallbackMapper* vtkWidgetCallbackMapper::New ( )

static

Instantiate the class.

static int vtkWidgetCallbackMapper::IsTypeOf ( const char * type )

static

Standard macros.

virtual int vtkWidgetCallbackMapper::IsA ( const char * type )

virtual

Standard macros.

Reimplemented from vtkObject.

static vtkWidgetCallbackMapper* vtkWidgetCallbackMapper::SafeDownCast ( vtkObjectBase * o )

static

Standard macros.

virtual vtkObjectBase* vtkWidgetCallbackMapper::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

Reimplemented from vtkObject.

vtkWidgetCallbackMapper* vtkWidgetCallbackMapper::NewInstance ( ) const

Standard macros.

void vtkWidgetCallbackMapper::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Standard macros.

Reimplemented from vtkObject.

void vtkWidgetCallbackMapper::SetEventTranslator ( vtkWidgetEventTranslator * t )

Specify the vtkWidgetEventTranslator to coordinate with.

virtual vtkWidgetEventTranslator* vtkWidgetCallbackMapper::GetEventTranslator ( )

virtual

Specify the vtkWidgetEventTranslator to coordinate with.

void vtkWidgetCallbackMapper::SetCallbackMethod	(	unsigned long	VTKEvent,
		unsigned long	widgetEvent,
		vtkAbstractWidget *	w,
		CallbackType	f
	)

This class works with the class vtkWidgetEventTranslator to set up the initial coorespondence between VTK events, widget events, and callbacks. Different flavors of the SetCallbackMethod() are available depending on what sort of modifiers are to be associated with a particular event. Typically the widgets should use this method to set up their event callbacks. If modifiers are not provided (i.e., the VTKEvent is a unsigned long eventId) then modifiers are ignored. Otherwise, a vtkEvent instance is used to fully quality the events.

void vtkWidgetCallbackMapper::SetCallbackMethod	(	unsigned long	VTKEvent,
		int	modifiers,
		char	keyCode,
		int	repeatCount,
		const char *	keySym,
		unsigned long	widgetEvent,
		vtkAbstractWidget *	w,
		CallbackType	f
	)

This class works with the class vtkWidgetEventTranslator to set up the initial coorespondence between VTK events, widget events, and callbacks. Different flavors of the SetCallbackMethod() are available depending on what sort of modifiers are to be associated with a particular event. Typically the widgets should use this method to set up their event callbacks. If modifiers are not provided (i.e., the VTKEvent is a unsigned long eventId) then modifiers are ignored. Otherwise, a vtkEvent instance is used to fully quality the events.

void vtkWidgetCallbackMapper::InvokeCallback ( unsigned long widgetEvent )

This method invokes the callback given a widget event. A non-zero value is returned if the listed event is registered.

void vtkWidgetCallbackMapper::SetCallbackMethod	(	unsigned long	widgetEvent,
		vtkAbstractWidget *	w,
		CallbackType	f
	)

protected

This method is used to assign a callback (implemented as a static class method) to a particular widget event. This is an internal method used by widgets to map widget events into invocations of class methods.

Member Data Documentation

vtkWidgetEventTranslator* vtkWidgetCallbackMapper::EventTranslator

protected

Definition at line 93 of file vtkWidgetCallbackMapper.h.

vtkCallbackMap* vtkWidgetCallbackMapper::CallbackMap

protected

Definition at line 96 of file vtkWidgetCallbackMapper.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkWidgetCallbackMapper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation