VTK
Public Types | 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 vtkObject Superclass
 Standard macros. More...
 
typedef void(* CallbackType) (vtkAbstractWidget *)
 Convenient typedef for working with callbacks. More...
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkWidgetCallbackMapperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetEventTranslator (vtkWidgetEventTranslator *t)
 Specify the vtkWidgetEventTranslator to coordinate with. More...
 
virtual vtkWidgetEventTranslatorGetEventTranslator ()
 
void 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. More...
 
void SetCallbackMethod (unsigned long VTKEvent, int modifiers, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f)
 
void SetCallbackMethod (unsigned long VTKEvent, vtkEventData *ed, unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f)
 
void InvokeCallback (unsigned long widgetEvent)
 This method invokes the callback given a widget event. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkWidgetCallbackMapperNew ()
 Instantiate the class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWidgetCallbackMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWidgetCallbackMapper ()
 
 ~vtkWidgetCallbackMapper () override
 
void SetCallbackMethod (unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f)
 This method is used to assign a callback (implemented as a static class method) to a particular widget event. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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

vtkWidgetEventTranslatorEventTranslator
 
vtkCallbackMap * CallbackMap
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Member Typedef Documentation

◆ Superclass

Standard macros.

Definition at line 53 of file vtkWidgetCallbackMapper.h.

◆ CallbackType

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

Convenient typedef for working with callbacks.

Definition at line 68 of file vtkWidgetCallbackMapper.h.

Constructor & Destructor Documentation

◆ vtkWidgetCallbackMapper()

vtkWidgetCallbackMapper::vtkWidgetCallbackMapper ( )
protected

◆ ~vtkWidgetCallbackMapper()

vtkWidgetCallbackMapper::~vtkWidgetCallbackMapper ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkWidgetCallbackMapper* vtkWidgetCallbackMapper::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkWidgetCallbackMapper::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWidgetCallbackMapper::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkWidgetCallbackMapper* vtkWidgetCallbackMapper::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetEventTranslator()

void vtkWidgetCallbackMapper::SetEventTranslator ( vtkWidgetEventTranslator t)

Specify the vtkWidgetEventTranslator to coordinate with.

◆ GetEventTranslator()

virtual vtkWidgetEventTranslator* vtkWidgetCallbackMapper::GetEventTranslator ( )
virtual

◆ SetCallbackMethod() [1/4]

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.

◆ SetCallbackMethod() [2/4]

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

◆ SetCallbackMethod() [3/4]

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

◆ InvokeCallback()

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.

◆ SetCallbackMethod() [4/4]

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

◆ EventTranslator

vtkWidgetEventTranslator* vtkWidgetCallbackMapper::EventTranslator
protected

Definition at line 102 of file vtkWidgetCallbackMapper.h.

◆ CallbackMap

vtkCallbackMap* vtkWidgetCallbackMapper::CallbackMap
protected

Definition at line 105 of file vtkWidgetCallbackMapper.h.


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