map VTK events into widget events More...

#include <vtkWidgetEventTranslator.h>

Inheritance diagram for vtkWidgetEventTranslator:

Collaboration diagram for vtkWidgetEventTranslator:

Public Member Functions
void	ClearEvents ()


void	SetTranslation (unsigned long VTKEvent, unsigned long widgetEvent)

void	SetTranslation (const char VTKEvent, const char widgetEvent)

void	SetTranslation (unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent)

void	SetTranslation (vtkEvent *VTKevent, unsigned long widgetEvent)


unsigned long	GetTranslation (unsigned long VTKEvent)

const char *	GetTranslation (const char *VTKEvent)

unsigned long	GetTranslation (unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, char *keySym)

unsigned long	GetTranslation (vtkEvent *VTKEvent)


int	RemoveTranslation (unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, char *keySym)

int	RemoveTranslation (vtkEvent *e)

int	RemoveTranslation (unsigned long VTKEvent)

int	RemoveTranslation (const char *VTKEvent)


void	AddEventsToParent (vtkAbstractWidget , vtkCallbackCommand , float priority)

void	AddEventsToInteractor (vtkRenderWindowInteractor , vtkCallbackCommand , float priority)

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 vtkWidgetEventTranslator *	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
	vtkWidgetEventTranslator ()

	~vtkWidgetEventTranslator ()

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
vtkEventMap *	EventMap

vtkEvent *	Event

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 vtkWidgetEventTranslator *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkWidgetEventTranslator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Detailed Description

map VTK events into widget events

vtkWidgetEventTranslator maps VTK events (defined on vtkCommand) into widget events (defined in vtkWidgetEvent.h). This class is typically used in combination with vtkWidgetCallbackMapper, which is responsible for translating widget events into method callbacks, and then invoking the callbacks.

This class can be used to define different mappings of VTK events into the widget events. Thus widgets can be reconfigured to use different event bindings.

See also: vtkWidgetEvent vtkCommand vtkInteractorObserver

Tests:: vtkWidgetEventTranslator (Tests)

Definition at line 50 of file vtkWidgetEventTranslator.h.

Member Typedef Documentation

typedef vtkObject vtkWidgetEventTranslator::Superclass

Standard macros.

Definition at line 58 of file vtkWidgetEventTranslator.h.

Constructor & Destructor Documentation

vtkWidgetEventTranslator::vtkWidgetEventTranslator ( )

protected

vtkWidgetEventTranslator::~vtkWidgetEventTranslator ( )

protected

Member Function Documentation

static vtkWidgetEventTranslator* vtkWidgetEventTranslator::New ( )

static

Instantiate the object.

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

static

Standard macros.

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

virtual

Standard macros.

Reimplemented from vtkObject.

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

static

Standard macros.

virtual vtkObjectBase* vtkWidgetEventTranslator::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

Reimplemented from vtkObject.

vtkWidgetEventTranslator* vtkWidgetEventTranslator::NewInstance ( ) const

Standard macros.

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

virtual

Standard macros.

Reimplemented from vtkObject.

void vtkWidgetEventTranslator::SetTranslation	(	unsigned long	VTKEvent,
		unsigned long	widgetEvent
	)

Use these methods to create the translation from a VTK event to a widget event. Specifying vtkWidgetEvent::NoEvent or an empty string for the (toEvent) erases the mapping for the event.

void vtkWidgetEventTranslator::SetTranslation	(	const char *	VTKEvent,
		const char *	widgetEvent
	)

Use these methods to create the translation from a VTK event to a widget event. Specifying vtkWidgetEvent::NoEvent or an empty string for the (toEvent) erases the mapping for the event.

void vtkWidgetEventTranslator::SetTranslation	(	unsigned long	VTKEvent,
		int	modifier,
		char	keyCode,
		int	repeatCount,
		const char *	keySym,
		unsigned long	widgetEvent
	)

Use these methods to create the translation from a VTK event to a widget event. Specifying vtkWidgetEvent::NoEvent or an empty string for the (toEvent) erases the mapping for the event.

void vtkWidgetEventTranslator::SetTranslation	(	vtkEvent *	VTKevent,
		unsigned long	widgetEvent
	)

Use these methods to create the translation from a VTK event to a widget event. Specifying vtkWidgetEvent::NoEvent or an empty string for the (toEvent) erases the mapping for the event.

unsigned long vtkWidgetEventTranslator::GetTranslation ( unsigned long VTKEvent )

Translate a VTK event into a widget event. If no event mapping is found, then the methods return vtkWidgetEvent::NoEvent or a NULL string.

const char* vtkWidgetEventTranslator::GetTranslation ( const char * VTKEvent )

Translate a VTK event into a widget event. If no event mapping is found, then the methods return vtkWidgetEvent::NoEvent or a NULL string.

unsigned long vtkWidgetEventTranslator::GetTranslation	(	unsigned long	VTKEvent,
		int	modifier,
		char	keyCode,
		int	repeatCount,
		char *	keySym
	)

Translate a VTK event into a widget event. If no event mapping is found, then the methods return vtkWidgetEvent::NoEvent or a NULL string.

unsigned long vtkWidgetEventTranslator::GetTranslation ( vtkEvent * VTKEvent )

Translate a VTK event into a widget event. If no event mapping is found, then the methods return vtkWidgetEvent::NoEvent or a NULL string.

int vtkWidgetEventTranslator::RemoveTranslation	(	unsigned long	VTKEvent,
		int	modifier,
		char	keyCode,
		int	repeatCount,
		char *	keySym
	)

Remove translations for a binding. Returns the number of translations removed.

int vtkWidgetEventTranslator::RemoveTranslation ( vtkEvent * e )

Remove translations for a binding. Returns the number of translations removed.

int vtkWidgetEventTranslator::RemoveTranslation ( unsigned long VTKEvent )

Remove translations for a binding. Returns the number of translations removed.

int vtkWidgetEventTranslator::RemoveTranslation ( const char * VTKEvent )

Remove translations for a binding. Returns the number of translations removed.

void vtkWidgetEventTranslator::ClearEvents ( )

Clear all events from the translator (i.e., no events will be translated).

void vtkWidgetEventTranslator::AddEventsToParent	(	vtkAbstractWidget *	,
		vtkCallbackCommand *	,
		float	priority
	)

Add the events in the current translation table to the interactor.

void vtkWidgetEventTranslator::AddEventsToInteractor	(	vtkRenderWindowInteractor *	,
		vtkCallbackCommand *	,
		float	priority
	)

Add the events in the current translation table to the interactor.

Member Data Documentation

vtkEventMap* vtkWidgetEventTranslator::EventMap

protected

Definition at line 114 of file vtkWidgetEventTranslator.h.

vtkEvent* vtkWidgetEventTranslator::Event

protected

Definition at line 117 of file vtkWidgetEventTranslator.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/vtkWidgetEventTranslator.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation