vtkWidgetEventTranslator.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkWidgetEventTranslator.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 vtkWidgetEventTranslator_h
#define vtkWidgetEventTranslator_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkObject.h"
 
// Support PIMPL encapsulation of internal STL map
class vtkEventMap;
class vtkRenderWindowInteractor;
class vtkCallbackCommand;
class vtkEvent;
class vtkAbstractWidget;
class vtkEventData;
 
// This is a lightweight class that should be used internally by the widgets
class VTKINTERACTIONWIDGETS_EXPORT vtkWidgetEventTranslator : public vtkObject
{
public:
  static vtkWidgetEventTranslator* New();
 
 
  vtkTypeMacro(vtkWidgetEventTranslator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetTranslation(unsigned long VTKEvent, unsigned long widgetEvent);
  void SetTranslation(const char* VTKEvent, const char* widgetEvent);
  void SetTranslation(unsigned long VTKEvent, int modifier, char keyCode, int repeatCount,
    const char* keySym, unsigned long widgetEvent);
  void SetTranslation(vtkEvent* VTKevent, unsigned long widgetEvent);
  void SetTranslation(unsigned long VTKEvent, vtkEventData* edata, unsigned long widgetEvent);
 
 
  unsigned long GetTranslation(unsigned long VTKEvent);
  const char* GetTranslation(const char* VTKEvent);
  unsigned long GetTranslation(
    unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char* keySym);
  unsigned long GetTranslation(unsigned long VTKEvent, vtkEventData* edata);
  unsigned long GetTranslation(vtkEvent* VTKEvent);
 
 
  int RemoveTranslation(
    unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char* keySym);
  int RemoveTranslation(vtkEvent* e);
  int RemoveTranslation(vtkEventData* e);
  int RemoveTranslation(unsigned long VTKEvent);
  int RemoveTranslation(const char* VTKEvent);
 
  void ClearEvents();
 
 
  void AddEventsToParent(vtkAbstractWidget*, vtkCallbackCommand*, float priority);
  void AddEventsToInteractor(vtkRenderWindowInteractor*, vtkCallbackCommand*, float priority);
 
protected:
  // Constructors/destructors made public for widgets to use
  vtkWidgetEventTranslator();
  ~vtkWidgetEventTranslator() override;
 
  // Map VTK events to widget events
  vtkEventMap* EventMap;
 
  // Used for performance reasons to avoid object construction/deletion
  vtkEvent* Event;
 
private:
  vtkWidgetEventTranslator(const vtkWidgetEventTranslator&) = delete;
  void operator=(const vtkWidgetEventTranslator&) = delete;
};
 
#endif /* vtkWidgetEventTranslator_h */