vtkKWKeyBindingsManager.h

Go to the documentation of this file.

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

  Module:    vtkKWKeyBindingsManager.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 __vtkKWKeyBindingsManager_h
#define __vtkKWKeyBindingsManager_h

#include "vtkKWObject.h"

class vtkKWKeyBindingsManagerInternals;
class vtkKWEventMap;

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


  virtual void AddKeyBinding(
    vtkObject *target, 
    const char *binding, 
    vtkObject *callback_object = NULL, 
    const char *callback_command = NULL,
    const char *context = NULL,
    const char *description = NULL);
  virtual void SetKeyBinding(
    vtkObject *target, 
    const char *binding, 
    vtkObject *callback_object = NULL, 
    const char *callback_command = NULL,
    const char *context = NULL,
    const char *description = NULL);
  virtual void RemoveKeyBinding(
    vtkObject *target, 
    const char *binding = NULL, 
    vtkObject *callback_object = NULL, 
    const char *callback_command = NULL);
  

  virtual int GetNumberOfTargets();
  virtual vtkObject* GetNthTarget(int idx);
  virtual int GetNumberOfBindings(vtkObject *target);
  virtual const char* GetNthBinding(vtkObject *target, int idx);
  virtual int GetNumberOfCallbackObjects(
    vtkObject *target, const char *binding);
  virtual vtkObject* GetNthCallbackObject(
    vtkObject *target, const char *binding, int idx);
  virtual int GetNumberOfKeyBindings(
    vtkObject *target, const char *binding, vtkObject *callback_object);
  virtual const char* GetNthCallbackCommand(
    vtkObject *target, const char *binding,vtkObject *callback_object,int idx);
  virtual const char* GetNthContext(
    vtkObject *target, const char *binding,vtkObject *callback_object,int idx);
  virtual const char* GetNthDescription(
    vtkObject *target, const char *binding,vtkObject *callback_object,int idx);

  virtual void SetKeyBindingsFromEventMap(vtkKWEventMap *map);

  virtual const char* GetPrettyBinding(const char *binding);

  virtual const char* GetPrettyContext(const char *context);

// @endcond
// @cond section_protected
protected:
  vtkKWKeyBindingsManager();
  ~vtkKWKeyBindingsManager();

  //BTX
  // PIMPL Encapsulation for STL containers
  vtkKWKeyBindingsManagerInternals *Internals;
  //ETX


  virtual void ProcessCallbackCommandEvents(
    vtkObject *caller, unsigned long event, void *calldata);
  
// @endcond
// @cond section_private
private:
  
  vtkKWKeyBindingsManager(const vtkKWKeyBindingsManager&); // Not implemented
  void operator=(const vtkKWKeyBindingsManager&); // Not implemented
};

#endif

// @endcond

---