vtkKWEventMap.h

Go to the documentation of this file.

/*=========================================================================

  Module:    $RCSfile: vtkKWEventMap.h,v $

  Copyright (c) Kitware, Inc.
  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 __vtkKWEventMap_h
#define __vtkKWEventMap_h

#include "vtkObject.h"
#include "vtkKWWidgets.h" // Needed for export symbols directives

class KWWidgets_EXPORT vtkKWEventMap : public vtkObject
{
// @cond section_public
public:
  static vtkKWEventMap *New();
  vtkTypeRevisionMacro(vtkKWEventMap, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  // In the following code:
  // button:   0 = Left, 1 = Middle, 2 = Right
  // modifier: 0 = button only, 1 = button + shift, 2 = button + control

  //BTX
  enum 
  {
    LeftButton   = 0,
    MiddleButton = 1,
    RightButton  = 2
  };
  
  enum 
  {
    NoModifier      = 0,
    ShiftModifier   = 1,
    ControlModifier = 2,
    ControlShiftModifier = 3
  };
  //ETX


  //BTX
  // @cond nested_class
  class MouseEvent
  {
  public:
    int Button;
    int Modifier;
    char *Action;
    char *Context;
    char *Description;
  };
  // @endcond
  
  // @cond nested_class
  class KeyEvent
  {
  public:
    char Key;
    int Modifier;
    char *Action;
    char *Context;
    char *Description;
  };
  // @endcond
  
  // @cond nested_class
  class KeySymEvent
  {
  public:
    char *KeySym;
    int Modifier;
    char *Action;
    char *Context;
    char *Description;
  };
  // @endcond
  //ETX

  // ---------------------------------------------------------


  void AddMouseEvent(vtkKWEventMap::MouseEvent *me);
  //ETX
  void AddMouseEvent(int button, int modifier, const char *action); 
  void AddMouseEvent(int button, int modifier, const char *action, 
                     const char *context, const char *description);


  void SetMouseEvent(vtkKWEventMap::MouseEvent *me);
  //ETX
  void SetMouseEvent(int button, int modifier, const char *action);
  void SetMouseEvent(int button, int modifier, const char *action,
                     const char *context, const char *description);


  vtkKWEventMap::MouseEvent* GetMouseEvent(int index);
  //ETX
  

  void RemoveMouseEvent(vtkKWEventMap::MouseEvent *me);
  //ETX
  void RemoveMouseEvent(int button, int modifier, const char *action = NULL);
  void RemoveAllMouseEvents();

  const char* FindMouseAction(int button, int modifier);
  

  vtkGetMacro(NumberOfMouseEvents, int);
  
  // ---------------------------------------------------------


  void AddKeyEvent(vtkKWEventMap::KeyEvent *me);
  //ETX
  void AddKeyEvent(char key, int modifier, const char *action);
  void AddKeyEvent(char key, int modifier, const char *action,
                   const char *context, const char *description);
  

  void SetKeyEvent(char key, int modifier, const char *action);
  void SetKeyEvent(char key, int modifier, const char *action,
                   const char *context, const char *description);
  

  vtkKWEventMap::KeyEvent* GetKeyEvent(int index);
  //ETX
  

  void RemoveKeyEvent(char key, int modifier, const char *action = NULL);
  void RemoveAllKeyEvents();
  
  const char* FindKeyAction(char key, int modifier);
  

  vtkGetMacro(NumberOfKeyEvents, int);
  
  // ---------------------------------------------------------


  void AddKeySymEvent(vtkKWEventMap::KeySymEvent *me);
  //ETX
  void AddKeySymEvent(const char *keySym, int modifier, const char *action);
  void AddKeySymEvent(const char *keySym, int modifier, const char *action,
                      const char *context, const char *description);
  

  void SetKeySymEvent(const char *keySym, int modifier, const char *action);
  void SetKeySymEvent(const char *keySym, int modifier, const char *action,
                      const char *context, const char *description);
  

  vtkKWEventMap::KeySymEvent* GetKeySymEvent(int index);
  //ETX
  

  void RemoveKeySymEvent(const char *keySym, int modifier, const char *action = NULL);
  void RemoveAllKeySymEvents();
  
  const char* FindKeySymAction(const char *keySym, int modifier);
  

  vtkGetMacro(NumberOfKeySymEvents, int);

  void ShallowCopy(vtkKWEventMap *tprop);
  
// @endcond
// @cond section_protected
protected:
  vtkKWEventMap();
  ~vtkKWEventMap();
  
  MouseEvent *MouseEvents;
  KeyEvent *KeyEvents;
  KeySymEvent *KeySymEvents;

  int NumberOfMouseEvents;
  int NumberOfKeyEvents;
  int NumberOfKeySymEvents;
  
// @endcond
// @cond section_private
private:
  vtkKWEventMap(const vtkKWEventMap&);  // Not implemented
  void operator=(const vtkKWEventMap&);  // Not implemented
};

#endif

// @endcond

---