VTK
Static Public Member Functions | Protected Member Functions | Protected Attributes
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]

List of all members.

Public Types

enum  EventModifiers {
  AnyModifier = -1, NoModifier = 0, ShiftModifier = 1, ControlModifier = 2,
  AltModifier = 4
}
- Public Types inherited from vtkObject

Public Member Functions

virtual void SetEventId (unsigned long)
virtual unsigned long GetEventId ()
virtual void SetModifier (int)
virtual int GetModifier ()
virtual void SetKeyCode (char)
virtual char GetKeyCode ()
virtual void SetRepeatCount (int)
virtual int GetRepeatCount ()
virtual void SetKeySym (const char *)
virtual char * GetKeySym ()
int operator== (vtkEvent *)
int operator== (unsigned long VTKEvent)
- 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 vtkEventNew ()
static int GetModifier (vtkRenderWindowInteractor *)
- 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

 vtkEvent ()
virtual ~vtkEvent ()
- 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

unsigned long EventId
int Modifier
char KeyCode
int RepeatCount
char * KeySym
- 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 vtkEventSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

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.

Tests:
vtkEvent (Tests)

Definition at line 32 of file vtkEvent.h.


Member Typedef Documentation

Standard macros.

Reimplemented from vtkObject.

Definition at line 40 of file vtkEvent.h.


Member Enumeration Documentation

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 48 of file vtkEvent.h.


Constructor & Destructor Documentation

vtkEvent::vtkEvent ( )
protected
virtual vtkEvent::~vtkEvent ( )
protectedvirtual

Member Function Documentation

static vtkEvent* vtkEvent::New ( )
static

The object factory constructor.

Reimplemented from vtkObject.

virtual const char* vtkEvent::GetClassName ( )
virtual

Standard macros.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkObject.

void vtkEvent::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Standard macros.

Reimplemented from vtkObject.

virtual void vtkEvent::SetEventId ( unsigned  long)
virtual

Set the modifier for the event.

virtual unsigned long vtkEvent::GetEventId ( )
virtual

Set the modifier for the event.

virtual void vtkEvent::SetModifier ( int  )
virtual

Set the modifier for the event.

virtual int vtkEvent::GetModifier ( )
virtual

Set the modifier for the event.

virtual void vtkEvent::SetKeyCode ( char  )
virtual

Set the KeyCode for the event.

virtual char vtkEvent::GetKeyCode ( )
virtual

Set the KeyCode for the event.

virtual void vtkEvent::SetRepeatCount ( int  )
virtual

Set the repease count for the event.

virtual int vtkEvent::GetRepeatCount ( )
virtual

Set the repease count for the event.

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

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

virtual char* vtkEvent::GetKeySym ( )
virtual

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

static int vtkEvent::GetModifier ( vtkRenderWindowInteractor )
static

Convenience method computes the event modifier from an interactor.

int vtkEvent::operator== ( vtkEvent )

Used to compare whether two events are equal. Takes into account the EventId as well as the various modifiers.

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

Used to compare whether two events are equal. Takes into account the EventId as well as the various modifiers.


Member Data Documentation

unsigned long vtkEvent::EventId
protected

Definition at line 104 of file vtkEvent.h.

int vtkEvent::Modifier
protected

Definition at line 105 of file vtkEvent.h.

char vtkEvent::KeyCode
protected

Definition at line 106 of file vtkEvent.h.

int vtkEvent::RepeatCount
protected

Definition at line 107 of file vtkEvent.h.

char* vtkEvent::KeySym
protected

Definition at line 108 of file vtkEvent.h.


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