vtkKWCanvas.h

Go to the documentation of this file.

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

Copyright (c) 1998-2003 Kitware Inc. 469 Clifton Corporate Parkway,
Clifton Park, NY, 12065, USA.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

 * Neither the name of Kitware nor the names of any contributors may be used
   to endorse or promote products derived from this software without specific
   prior written permission.

 * Modified source versions must be plainly marked as such, and must not be
   misrepresented as being the original software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/
#ifndef __vtkKWCanvas_h
#define __vtkKWCanvas_h

#include "vtkKWCoreWidget.h"

class vtkColorTransferFunction;

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


  virtual void SetWidth(int);
  virtual int GetWidth();
  virtual void SetHeight(int);
  virtual int GetHeight();


  virtual int AddHorizontalGradient(vtkColorTransferFunction *ctf, 
                                    int x1, int y1, int x2, int y2, 
                                    const char *tag);
  virtual int AddHorizontalRGBGradient(double r1, double g1, double b1, 
                                       double r2, double g2, double b2, 
                                       int x1, int y1, int x2, int y2, 
                                       const char *tag);
  virtual int AddVerticalGradient(vtkColorTransferFunction *ctf, 
                                  int x1, int y1, int x2, int y2, 
                                  const char *tag);
  virtual int AddVerticalRGBGradient(double r1, double g1, double b1, 
                                     double r2, double g2, double b2, 
                                     int x1, int y1, int x2, int y2, 
                                     const char *tag);

  virtual int HasTag(const char *tag);

  virtual void DeleteTag(const char *tag);


  virtual void GetBackgroundColor(double *r, double *g, double *b);
  virtual double* GetBackgroundColor();
  virtual void SetBackgroundColor(double r, double g, double b);
  virtual void SetBackgroundColor(double rgb[3])
    { this->SetBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  

  virtual void SetHighlightThickness(int);
  virtual int GetHighlightThickness();
  

  virtual void SetBorderWidth(int);
  virtual int GetBorderWidth();
  

  virtual void SetRelief(int);
  virtual int GetRelief();
  virtual void SetReliefToRaised();
  virtual void SetReliefToSunken();
  virtual void SetReliefToFlat();
  virtual void SetReliefToRidge();
  virtual void SetReliefToSolid();
  virtual void SetReliefToGroove();


  virtual void SetCanvasBinding(
    const char *tag, const char *event, vtkObject *object, const char *method);
  virtual void SetCanvasBinding(
    const char *tag, const char *event, const char *command);
  virtual const char* GetCanvasBinding(const char *tag, const char *event);
  virtual void AddCanvasBinding(
    const char *tag, const char *event, vtkObject *object, const char *method);
  virtual void AddCanvasBinding(
    const char *tag, const char *event, const char *command);
  virtual void RemoveCanvasBinding(const char *tag, const char *event);
  virtual void RemoveCanvasBinding(
    const char *tag, const char *event, vtkObject *object, const char *method);

  virtual void UpdateEnableState();

// @endcond
// @cond section_protected
protected:
  vtkKWCanvas() {};
  ~vtkKWCanvas() {};

  virtual void CreateWidget();


  virtual int AddGradient(vtkColorTransferFunction *ctf, 
                          int x1, int y1, int x2, int y2, 
                          const char *tag,
                          int horizontal);

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


#endif



// @endcond

---