vtkKWToolbar.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWToolbar.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 __vtkKWToolbar_h
#define __vtkKWToolbar_h

#include "vtkKWCompositeWidget.h"

class vtkKWFrame;
class vtkKWRadioButton;
class vtkKWToolbarInternals;

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


  vtkGetObjectMacro(Frame, vtkKWFrame);


  virtual void SetResizable(int);
  vtkGetMacro(Resizable, int);
  vtkBooleanMacro(Resizable, int);


  vtkGetStringMacro(Name);
  vtkSetStringMacro(Name);


  virtual void AddWidget(vtkKWWidget* widget);
  virtual void InsertWidget(vtkKWWidget* location, vtkKWWidget* widget);


  virtual void AddSeparator();
  virtual void InsertSeparator(vtkKWWidget* location);


  virtual int HasWidget(vtkKWWidget* widget);
  virtual int GetNumberOfWidgets();


  virtual void RemoveWidget(vtkKWWidget* widget);
  virtual void RemoveAllWidgets();

  virtual vtkKWWidget* GetWidget(const char *name);

  virtual vtkKWWidget* GetNthWidget(int rank);


  virtual void SetWidgetVisibility(vtkKWWidget *widget, int val);
  virtual int GetWidgetVisibility(vtkKWWidget *widget);


  vtkKWWidget* AddRadioButtonImage(int value, 
                                   const char *image_name, 
                                   const char *select_image_name, 
                                   const char *variable_name,
                                   vtkObject *object, 
                                   const char *method, 
                                   const char *help = 0);
  vtkKWWidget* AddCheckButtonImage(const char *image_name, 
                                   const char *select_image_name, 
                                   const char *variable_name,
                                   vtkObject *object, 
                                   const char *method, 
                                   const char *help = 0);
  
  virtual void UpdateWidgets();

  virtual void Update();


  enum 
  {
    ToolbarAspectRelief = 0,
    ToolbarAspectFlat = 1,
    ToolbarAspectUnChanged
  };
  //ETX
  vtkGetMacro(ToolbarAspect, int);
  virtual void SetToolbarAspect(int);
  virtual void SetToolbarAspectToFlat();
  virtual void SetToolbarAspectToRelief();
  virtual void SetToolbarAspectToUnChanged();
  static int GetGlobalToolbarAspect();
  static void SetGlobalToolbarAspect(int val);
  static void SetGlobalToolbarAspectToFlat();
  static void SetGlobalToolbarAspectToRelief();
  static void SetGlobalToolbarAspectToUnChanged();


  enum 
  {
    WidgetsAspectRelief = 0,
    WidgetsAspectFlat = 1,
    WidgetsAspectUnChanged
  };
  //ETX
  vtkGetMacro(WidgetsAspect, int);
  virtual void SetWidgetsAspect(int);
  virtual void SetWidgetsAspectToFlat();
  virtual void SetWidgetsAspectToRelief();
  virtual void SetWidgetsAspectToUnChanged();
  static int GetGlobalWidgetsAspect();
  static void SetGlobalWidgetsAspect(int val);
  static void SetGlobalWidgetsAspectToFlat();
  static void SetGlobalWidgetsAspectToRelief();
  static void SetGlobalWidgetsAspectToUnChanged();


  virtual void SetWidgetsPadX(int);
  vtkGetMacro(WidgetsPadX, int);
  virtual void SetWidgetsPadY(int);
  vtkGetMacro(WidgetsPadY, int);


  virtual void SetWidgetsInternalPadX(int);
  vtkGetMacro(WidgetsInternalPadX, int);
  virtual void SetWidgetsInternalPadY(int);
  vtkGetMacro(WidgetsInternalPadY, int);


  virtual void SetWidgetsFlatAdditionalPadX(int);
  vtkGetMacro(WidgetsFlatAdditionalPadX, int);
  virtual void SetWidgetsFlatAdditionalPadY(int);
  vtkGetMacro(WidgetsFlatAdditionalPadY, int);


  virtual void SetWidgetsFlatAdditionalInternalPadX(int);
  vtkGetMacro(WidgetsFlatAdditionalInternalPadX, int);
  virtual void SetWidgetsFlatAdditionalInternalPadY(int);
  vtkGetMacro(WidgetsFlatAdditionalInternalPadY, int);


  virtual void ScheduleResize();
  virtual void Resize();

  virtual void UpdateEnableState();


  static const char *ToolbarAspectRegKey;
  static const char *WidgetsAspectRegKey;
  //ETX

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

  virtual void CreateWidget();

  int Expanding;

  vtkKWFrame *Frame;
  vtkKWFrame *Handle;

  void ConstrainWidgetsLayout();
  void UpdateWidgetsLayout();
  void UpdateWidgetsAspect();
  void UpdateToolbarFrameAspect();
  
  //BTX

  // PIMPL Encapsulation for STL containers

  vtkKWToolbarInternals *Internals;

  //ETX

  int WidgetsPadX;
  int WidgetsPadY;
  int WidgetsFlatAdditionalPadX;
  int WidgetsFlatAdditionalPadY;

  int WidgetsInternalPadX;
  int WidgetsInternalPadY;
  int WidgetsFlatAdditionalInternalPadX;
  int WidgetsFlatAdditionalInternalPadY;

  int ToolbarAspect;
  int WidgetsAspect;
  int Resizable;

  vtkKWRadioButton *DefaultOptionsWidget;

  char *Name;


  virtual void Bind();
  virtual void UnBind();

// @endcond
// @cond section_private
private:
  vtkKWToolbar(const vtkKWToolbar&); // Not implemented
  void operator=(const vtkKWToolbar&); // Not implemented
};


#endif



// @endcond

---