map widget events into callbacks More...
#include <vtkWidgetCallbackMapper.h>
Public Types | |
| typedef void(* | CallbackType )(vtkAbstractWidget *) |
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) |
Static Public Member Functions | |
| static vtkWidgetCallbackMapper * | New () |
Protected Member Functions | |
| vtkWidgetCallbackMapper () | |
| ~vtkWidgetCallbackMapper () | |
| void | SetCallbackMethod (unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f) |
Protected Attributes | |
| vtkWidgetEventTranslator * | EventTranslator |
| vtkCallbackMap * | CallbackMap |
| 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
Standard macros.
Reimplemented from vtkObject.
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.
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 | ( | vtkObjectBase * | o | ) | [static] |
Standard macros.
Reimplemented from vtkObject.
| virtual vtkObjectBase* vtkWidgetCallbackMapper::NewInstanceInternal | ( | ) | const [protected, virtual] |
Standard macros.
Reimplemented from vtkObject.
Standard macros.
Reimplemented from vtkObject.
| void vtkWidgetCallbackMapper::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Standard macros.
Reimplemented from vtkObject.
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
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:
- dox/Interaction/Widgets/vtkWidgetCallbackMapper.h
