VTK
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWidgetCallbackMapper Class Reference

map widget events into callbacks More...

#include <vtkWidgetCallbackMapper.h>

Inheritance diagram for vtkWidgetCallbackMapper:
[legend]
Collaboration diagram for vtkWidgetCallbackMapper:
[legend]

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 vtkWidgetEventTranslatorGetEventTranslator ()
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
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkWidgetCallbackMapperNew ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkWidgetEventTranslatorEventTranslator
vtkCallbackMap * CallbackMap
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
typedef vtkObject Superclass
static int IsTypeOf (const char *type)
static vtkWidgetCallbackMapperSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

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 39 of file vtkWidgetCallbackMapper.h.

Member Typedef Documentation

Standard macros.

Definition at line 47 of file vtkWidgetCallbackMapper.h.

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

Convenient typedef for working with callbacks.

Definition at line 60 of file vtkWidgetCallbackMapper.h.

Constructor & Destructor Documentation

vtkWidgetCallbackMapper::vtkWidgetCallbackMapper ( )
protected
vtkWidgetCallbackMapper::~vtkWidgetCallbackMapper ( )
protected

Member Function Documentation

static vtkWidgetCallbackMapper* vtkWidgetCallbackMapper::New ( )
static

Instantiate the class.

Reimplemented from vtkObject.

virtual const char* vtkWidgetCallbackMapper::GetClassName ( )
virtual

Standard macros.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkObject.

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 92 of file vtkWidgetCallbackMapper.h.

vtkCallbackMap* vtkWidgetCallbackMapper::CallbackMap
protected

Definition at line 95 of file vtkWidgetCallbackMapper.h.


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