a complete specification of a VTK event including all modifiers More...
#include <vtkEvent.h>
Public Types | |
| enum | EventModifiers { AnyModifier = -1, NoModifier = 0, ShiftModifier = 1, ControlModifier = 2, AltModifier = 4 } |
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) |
Static Public Member Functions | |
| static vtkEvent * | New () |
| static int | GetModifier (vtkRenderWindowInteractor *) |
Protected Member Functions | |
| vtkEvent () | |
| virtual | ~vtkEvent () |
Protected Attributes | |
| unsigned long | EventId |
| int | Modifier |
| char | KeyCode |
| int | RepeatCount |
| char * | KeySym |
| typedef vtkObject | Superclass |
| static int | IsTypeOf (const char *type) |
| static vtkEvent * | SafeDownCast (vtkObjectBase *o) |
| virtual int | IsA (const char *type) |
| vtkEvent * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual vtkObjectBase * | NewInstanceInternal () const |
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 33 of file vtkEvent.h.
Member Typedef Documentation
| typedef vtkObject vtkEvent::Superclass |
Member Enumeration Documentation
Ways to specify modifiers to VTK events. These can be logical OR'd to produce combinations of modifiers.
Definition at line 49 of file vtkEvent.h.
Constructor & Destructor Documentation
| vtkEvent::vtkEvent | ( | ) | [protected] |
| virtual vtkEvent::~vtkEvent | ( | ) | [protected, virtual] |
Member Function Documentation
| static vtkEvent* vtkEvent::New | ( | ) | [static] |
The object factory constructor.
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 | ( | vtkObjectBase * | o | ) | [static] |
Standard macros.
Reimplemented from vtkObject.
| virtual vtkObjectBase* vtkEvent::NewInstanceInternal | ( | ) | const [protected, virtual] |
Standard macros.
Reimplemented from vtkObject.
| vtkEvent* vtkEvent::NewInstance | ( | ) | const |
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.
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 105 of file vtkEvent.h.
int vtkEvent::Modifier [protected] |
Definition at line 106 of file vtkEvent.h.
char vtkEvent::KeyCode [protected] |
Definition at line 107 of file vtkEvent.h.
int vtkEvent::RepeatCount [protected] |
Definition at line 108 of file vtkEvent.h.
char* vtkEvent::KeySym [protected] |
Definition at line 109 of file vtkEvent.h.
The documentation for this class was generated from the following file:
- dox/Interaction/Widgets/vtkEvent.h
