VTK  9.0.20200928
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkEvent Class Reference

a complete specification of a VTK event including all modifiers More...

#include <vtkEvent.h>

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

Public Types

enum  EventModifiers {
  AnyModifier = -1, NoModifier = 0, ShiftModifier = 1, ControlModifier = 2,
  AltModifier = 4
}
 Ways to specify modifiers to VTK events. 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...
 
vtkEventNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetEventId (unsigned long)
 Set the modifier for the event. More...
 
virtual unsigned long GetEventId ()
 
virtual void SetModifier (int)
 Set the modifier for the event. More...
 
virtual int GetModifier ()
 
virtual void SetKeyCode (char)
 Set the KeyCode for the event. More...
 
virtual char GetKeyCode ()
 
virtual void SetRepeatCount (int)
 Set the repease count for the event. More...
 
virtual int GetRepeatCount ()
 
virtual void SetKeySym (const char *)
 Set the complex key symbol (compound key strokes) for the event. More...
 
virtual char * GetKeySym ()
 
bool operator== (vtkEvent *)
 Used to compare whether two events are equal. More...
 
bool operator== (unsigned long VTKEvent)
 
- 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 vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkEventNew ()
 The object factory constructor. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkEventSafeDownCast (vtkObjectBase *o)
 
static int GetModifier (vtkRenderWindowInteractor *)
 Convenience method computes the event modifier from an interactor. More...
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

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

Protected Attributes

unsigned long EventId
 
int Modifier
 
char KeyCode
 
int RepeatCount
 
char * KeySym
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

a complete specification of a VTK event including all modifiers

vtkEvent is a class that fully describes a VTK event. It is used by the widgets to help specify the mapping between VTK events and widget events.

Definition at line 31 of file vtkEvent.h.

Member Typedef Documentation

◆ Superclass

Standard macros.

Definition at line 43 of file vtkEvent.h.

Member Enumeration Documentation

◆ EventModifiers

Ways to specify modifiers to VTK events.

These can be logical OR'd to produce combinations of modifiers.

Enumerator
AnyModifier 
NoModifier 
ShiftModifier 
ControlModifier 
AltModifier 

Definition at line 51 of file vtkEvent.h.

Constructor & Destructor Documentation

◆ vtkEvent()

vtkEvent::vtkEvent ( )
protected

◆ ~vtkEvent()

vtkEvent::~vtkEvent ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkEvent* vtkEvent::New ( )
static

The object factory constructor.

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkEvent::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkEvent* vtkEvent::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetEventId()

virtual void vtkEvent::SetEventId ( unsigned long  )
virtual

Set the modifier for the event.

◆ GetEventId()

virtual unsigned long vtkEvent::GetEventId ( )
virtual

◆ SetModifier()

virtual void vtkEvent::SetModifier ( int  )
virtual

Set the modifier for the event.

◆ GetModifier() [1/2]

virtual int vtkEvent::GetModifier ( )
virtual

◆ SetKeyCode()

virtual void vtkEvent::SetKeyCode ( char  )
virtual

Set the KeyCode for the event.

◆ GetKeyCode()

virtual char vtkEvent::GetKeyCode ( )
virtual

◆ SetRepeatCount()

virtual void vtkEvent::SetRepeatCount ( int  )
virtual

Set the repease count for the event.

◆ GetRepeatCount()

virtual int vtkEvent::GetRepeatCount ( )
virtual

◆ SetKeySym()

virtual void vtkEvent::SetKeySym ( const char *  )
virtual

Set the complex key symbol (compound key strokes) for the event.

◆ GetKeySym()

virtual char* vtkEvent::GetKeySym ( )
virtual

◆ GetModifier() [2/2]

static int vtkEvent::GetModifier ( vtkRenderWindowInteractor )
static

Convenience method computes the event modifier from an interactor.

◆ operator==() [1/2]

bool vtkEvent::operator== ( vtkEvent )

Used to compare whether two events are equal.

Takes into account the EventId as well as the various modifiers.

◆ operator==() [2/2]

bool vtkEvent::operator== ( unsigned long  VTKEvent)

Member Data Documentation

◆ EventId

unsigned long vtkEvent::EventId
protected

Definition at line 116 of file vtkEvent.h.

◆ Modifier

int vtkEvent::Modifier
protected

Definition at line 117 of file vtkEvent.h.

◆ KeyCode

char vtkEvent::KeyCode
protected

Definition at line 118 of file vtkEvent.h.

◆ RepeatCount

int vtkEvent::RepeatCount
protected

Definition at line 119 of file vtkEvent.h.

◆ KeySym

char* vtkEvent::KeySym
protected

Definition at line 120 of file vtkEvent.h.


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