VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkWidgetEvent Class Reference

define widget events More...

#include <vtkWidgetEvent.h>

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

Public Types

enum  WidgetEventIds {
  NoEvent = 0, Select, EndSelect, Delete,
  Translate, EndTranslate, Scale, EndScale,
  Resize, EndResize, Rotate, EndRotate,
  Move, SizeHandles, AddPoint, AddFinalPoint,
  Completed, TimedOut, ModifyEvent, Reset,
  Up, Down, Left, Right,
  Select3D, EndSelect3D, Move3D, AddPoint3D,
  AddFinalPoint3D
}
 All the widget events are defined here. More...
 
typedef vtkObject Superclass
 Standard macros. 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...
 
vtkWidgetEventNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 vtkWidgetEventNew ()
 The object factory constructor. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWidgetEventSafeDownCast (vtkObjectBase *o)
 
static const char * GetStringFromEventId (unsigned long event)
 Convenience methods for translating between event names and event ids. More...
 
static unsigned long GetEventIdFromString (const char *event)
 
- 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
 
 vtkWidgetEvent ()
 
 ~vtkWidgetEvent () override
 
- 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

define widget events

vtkWidgetEvent defines widget events. These events are processed by subclasses of vtkInteractorObserver.

Tests:
vtkWidgetEvent (Tests)

Definition at line 32 of file vtkWidgetEvent.h.

Member Typedef Documentation

◆ Superclass

Standard macros.

Definition at line 44 of file vtkWidgetEvent.h.

Member Enumeration Documentation

◆ WidgetEventIds

All the widget events are defined here.

Enumerator
NoEvent 
Select 
EndSelect 
Delete 
Translate 
EndTranslate 
Scale 
EndScale 
Resize 
EndResize 
Rotate 
EndRotate 
Move 
SizeHandles 
AddPoint 
AddFinalPoint 
Completed 
TimedOut 
ModifyEvent 
Reset 
Up 
Down 
Left 
Right 
Select3D 
EndSelect3D 
Move3D 
AddPoint3D 
AddFinalPoint3D 

Definition at line 51 of file vtkWidgetEvent.h.

Constructor & Destructor Documentation

◆ vtkWidgetEvent()

vtkWidgetEvent::vtkWidgetEvent ( )
inlineprotected

Definition at line 92 of file vtkWidgetEvent.h.

◆ ~vtkWidgetEvent()

vtkWidgetEvent::~vtkWidgetEvent ( )
inlineoverrideprotected

Definition at line 93 of file vtkWidgetEvent.h.

Member Function Documentation

◆ New()

static vtkWidgetEvent* vtkWidgetEvent::New ( )
static

The object factory constructor.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkWidgetEvent::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 vtkWidgetEvent* vtkWidgetEvent::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWidgetEvent::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkWidgetEvent* vtkWidgetEvent::NewInstance ( ) const

◆ PrintSelf()

void vtkWidgetEvent::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.

◆ GetStringFromEventId()

static const char* vtkWidgetEvent::GetStringFromEventId ( unsigned long  event)
static

Convenience methods for translating between event names and event ids.

◆ GetEventIdFromString()

static unsigned long vtkWidgetEvent::GetEventIdFromString ( const char *  event)
static

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