vtkKWProgressGauge.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWProgressGauge.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 __vtkKWProgressGauge_h
#define __vtkKWProgressGauge_h

#include "vtkKWCompositeWidget.h"

class vtkKWCanvas;
class vtkKWProgressGaugeInternals;

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


  virtual void SetValue(double value);
  virtual double GetValue();
  

  virtual void SetNthValue(int rank, double value);
  virtual double GetNthValue(int rank);
  

  virtual void SetWidth(int width);
  vtkGetMacro(Width, int);
  virtual void SetHeight(int height);
  vtkGetMacro(Height, int);


  vtkBooleanMacro(ExpandHeight, int);
  virtual void SetExpandHeight(int);
  vtkGetMacro(ExpandHeight, int);


  virtual void SetMinimumHeight(int height);
  vtkGetMacro(MinimumHeight, int);
  

  virtual void SetBarColor(double r, double g, double b);
  virtual void SetBarColor(double rgb[3])
    { this->SetBarColor(rgb[0], rgb[1], rgb[2]); }
  vtkGetVectorMacro(BarColor,double,3);


  enum 
  {
    GaugePositionTop = 0,
    GaugePositionBottom
  };
  //ETX
  virtual void SetPrimaryGaugePosition(int);
  vtkGetMacro(PrimaryGaugePosition, int);
  virtual void SetPrimaryGaugePositionToTop();
  virtual void SetPrimaryGaugePositionToBottom();

  virtual void ConfigureCallback();

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

  virtual void CreateWidget();

  virtual void Redraw();

  int Width;
  int Height;
  int MinimumHeight;
  double BarColor[3];
  double Value;
  int ExpandHeight;
  int PrimaryGaugePosition;

  vtkKWCanvas *Canvas;

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

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


#endif

// @endcond

---