vtkKWWidget.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWWidget.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 __vtkKWWidget_h
#define __vtkKWWidget_h

#include "vtkKWObject.h"

class vtkKWTopLevel;
class vtkKWDragAndDropTargetSet;
class vtkKWWidgetInternals;
class vtkKWBalloonHelpManager;
class vtkKWKeyBindingsManager;
class vtkKWIcon;

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


  virtual void SetParent(vtkKWWidget *p);
  vtkGetObjectMacro(Parent, vtkKWWidget);

  virtual vtkKWApplication* GetApplication();

  virtual void Create();


  virtual const char *GetWidgetName();
  vtkSetStringMacro(WidgetName);


  static int GetUseClassNameInWidgetName();
  static void SetUseClassNameInWidgetName(int);
  static void UseClassNameInWidgetNameOn();
  static void UseClassNameInWidgetNameOff();

  virtual int IsCreated();

  virtual int IsAlive();
  
  virtual int IsMapped();
  

  virtual void Focus();
  virtual int HasFocus();


  virtual void SetEnabled(int);
  vtkBooleanMacro(Enabled, int);
  vtkGetMacro(Enabled, int);


  virtual void SetBinding(
    const char *event, vtkObject *object, const char *method);
  virtual void SetBinding(
    const char *event, const char *command);
  virtual const char* GetBinding(const char *event);
  virtual void AddBinding(
    const char *event, vtkObject *object, const char *method);
  virtual void AddBinding(
    const char *event, const char *command);
  virtual void RemoveBinding(const char *event);
  virtual void RemoveBinding(
    const char *event, vtkObject *object, const char *method);


  virtual void SetKeyBinding(
    const char *event, vtkObject *object, const char *method,
    const char *context, const char *description);
  virtual void RemoveKeyBinding(const char *event);
  virtual void RemoveKeyBinding(
    const char *event, vtkObject *object, const char *method);

  virtual vtkKWKeyBindingsManager* GetKeyBindingsManager();

  virtual void SetDropFileBinding(vtkObject *object, const char *method);

  vtkKWTopLevel* GetParentTopLevel();


  virtual int IsPacked();
  virtual int GetNumberOfPackedChildren();
  virtual void Unpack();


  virtual int IsGridded();
  virtual int GetNumberOfGriddedChildren();
  virtual void Ungrid();


  virtual int IsPlaced();
  virtual int GetNumberOfPlacedChildren();
  virtual void Unplace();


  virtual void UnpackSiblings();
  virtual void UnpackChildren();
  

  virtual void SetBalloonHelpString(const char *str);
  vtkGetStringMacro(BalloonHelpString);
  virtual void SetBalloonHelpIcon(vtkKWIcon *icon);
  vtkGetObjectMacro(BalloonHelpIcon, vtkKWIcon);


  virtual vtkKWBalloonHelpManager *GetBalloonHelpManager();
  virtual void SetBalloonHelpManager(vtkKWBalloonHelpManager *mgr);


  virtual int HasDragAndDropTargetSet();
  virtual vtkKWDragAndDropTargetSet* GetDragAndDropTargetSet();


  virtual void Grab();
  virtual void ReleaseGrab();
  virtual int IsGrabbed();

  virtual void UpdateEnableState();

  virtual void UnRegister(vtkObjectBase *o);

  virtual int  GetNetReferenceCount();


  virtual int HasChild(vtkKWWidget *w);
  virtual int GetNumberOfChildren();
  virtual vtkKWWidget* GetNthChild(int rank);
  virtual vtkKWWidget* GetChildWidgetWithName(const char *);
  virtual void RemoveAllChildren();


  enum
  {
    WidgetCreatedEvent = 30000
  };
  //ETX


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


  virtual void AddChild(vtkKWWidget *w);
  virtual void RemoveChild(vtkKWWidget *w);

  char *WidgetName;

  vtkKWWidget *Parent;


  char *BalloonHelpString;
  vtkKWIcon *BalloonHelpIcon;
  vtkKWBalloonHelpManager *BalloonHelpManager;
  virtual void AddBalloonHelpBindings();

  vtkKWWidgetInternals *Internals;

  virtual void PropagateEnableState(vtkKWWidget* widget);

  virtual void CreateWidget();


  static int CreateSpecificTkWidget(
    vtkKWWidget *obj, const char *type, const char *args = NULL);


  virtual void SetGenericBinding(
    const char *target, const char *event, 
    vtkObject *object, const char *method);
  virtual void AddGenericBinding(
    const char *target, const char *event, 
    vtkObject *object, const char *method);
  virtual void RemoveGenericBinding(
    const char *target, const char *event);
  virtual void RemoveGenericBinding(
    const char *target, const char *event, 
    vtkObject *object, const char *method);

// @endcond
// @cond section_private
private:
  
  vtkKWDragAndDropTargetSet* DragAndDropTargetSet;

  int WidgetIsCreated;
  int Enabled;

  static int UseClassNameInWidgetName;

  virtual unsigned long GetNextAvailableChildID();

  vtkKWWidget(const vtkKWWidget&); // Not implemented
  void operator=(const vtkKWWidget&); // Not implemented
};

#endif
// @endcond

---