vtkEvent.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkEvent.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkEvent_h
#define vtkEvent_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkObject.h"
 
class vtkRenderWindowInteractor;
 
class VTKINTERACTIONWIDGETS_EXPORT vtkEvent : public vtkObject
{
public:
  static vtkEvent *New();
 
 
  vtkTypeMacro(vtkEvent,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
 
//BTX
 
  enum EventModifiers {
    AnyModifier = -1,
    NoModifier = 0,
    ShiftModifier = 1,
    ControlModifier = 2,
    AltModifier = 4
  };
//ETX
 
 
  vtkSetMacro(EventId,unsigned long);
  vtkGetMacro(EventId,unsigned long);
 
 
  vtkSetMacro(Modifier,int);
  vtkGetMacro(Modifier,int);
 
 
  vtkSetMacro(KeyCode,char);
  vtkGetMacro(KeyCode,char);
 
 
  vtkSetMacro(RepeatCount,int);
  vtkGetMacro(RepeatCount,int);
 
 
  vtkSetStringMacro(KeySym);
  vtkGetStringMacro(KeySym);
 
  static int GetModifier(vtkRenderWindowInteractor*);
 
//BTX
 
  int operator==(vtkEvent*);
  int operator==(unsigned long VTKEvent);  //event with no modifiers
//ETX
 
protected:
  vtkEvent();
  virtual ~vtkEvent();
 
  unsigned long EventId;
  int           Modifier;
  char          KeyCode;
  int           RepeatCount;
  char*         KeySym;
 
private:
  vtkEvent(const vtkEvent&);  //Not implemented
  void operator=(const vtkEvent&);  //Not implemented
 
};
 
#endif