vtkWidgetEventTranslator Class Reference

#include <vtkWidgetEventTranslator.h>

Inheritance diagram for vtkWidgetEventTranslator:

Inheritance graph
[legend]
Collaboration diagram for vtkWidgetEventTranslator:

Collaboration graph
[legend]

List of all members.


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 49 of file vtkWidgetEventTranslator.h.

typedef vtkObject Superclass
static int IsTypeOf (const char *type)
static vtkWidgetEventTranslatorSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

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)
void AddEventsToParent (vtkAbstractWidget *, vtkCallbackCommand *, float priority)
void AddEventsToInteractor (vtkRenderWindowInteractor *, vtkCallbackCommand *, float priority)

Static Public Member Functions

static vtkWidgetEventTranslatorNew ()

Protected Member Functions

 vtkWidgetEventTranslator ()
 ~vtkWidgetEventTranslator ()

Protected Attributes

vtkEventMap * EventMap
vtkEventEvent

Member Typedef Documentation

Standard macros.

Reimplemented from vtkObject.

Definition at line 57 of file vtkWidgetEventTranslator.h.


Constructor & Destructor Documentation

vtkWidgetEventTranslator::vtkWidgetEventTranslator (  )  [protected]

vtkWidgetEventTranslator::~vtkWidgetEventTranslator (  )  [protected]


Member Function Documentation

static vtkWidgetEventTranslator* vtkWidgetEventTranslator::New (  )  [static]

Instantiate the object.

Reimplemented from vtkObject.

virtual const char* vtkWidgetEventTranslator::GetClassName (  )  [virtual]

Standard macros.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkObject.

static vtkWidgetEventTranslator* vtkWidgetEventTranslator::SafeDownCast ( vtkObject o  )  [static]

Standard macros.

Reimplemented from vtkObject.

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.

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 112 of file vtkWidgetEventTranslator.h.

Definition at line 115 of file vtkWidgetEventTranslator.h.


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

Generated on Wed Aug 24 12:19:50 2011 for VTK by  doxygen 1.5.6