KWWidgets
debian/tmp/usr/include/KWWidgets/vtkKWFrame.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Module: $RCSfile: vtkKWFrame.h,v $
4 
5  Copyright (c) Kitware, Inc.
6  All rights reserved.
7  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
8 
9  This software is distributed WITHOUT ANY WARRANTY; without even
10  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
11  PURPOSE. See the above copyright notice for more information.
12 
13 =========================================================================*/
14 // .NAME vtkKWFrame - a simple frame
15 // .SECTION Description
16 // The core frame
17 
18 
19 #ifndef __vtkKWFrame_h
20 #define __vtkKWFrame_h
21 
22 #include "vtkKWCoreWidget.h"
23 
25 {
26 public:
27  static vtkKWFrame* New();
28  vtkTypeRevisionMacro(vtkKWFrame,vtkKWCoreWidget);
29  void PrintSelf(ostream& os, vtkIndent indent);
30 
31  // Description:
32  // Set/Get the background color of the widget.
33  virtual void GetBackgroundColor(double *r, double *g, double *b);
34  virtual double* GetBackgroundColor();
35  virtual void SetBackgroundColor(double r, double g, double b);
36  virtual void SetBackgroundColor(double rgb[3])
37  { this->SetBackgroundColor(rgb[0], rgb[1], rgb[2]); };
38 
39  // Description:
40  // Set/Get the highlight thickness, a non-negative value indicating the
41  // width of the highlight rectangle to draw around the outside of the
42  // widget when it has the input focus.
43  virtual void SetHighlightThickness(int);
44  virtual int GetHighlightThickness();
45 
46  // Description:
47  // Set/Get the border width, a non-negative value indicating the width of
48  // the 3-D border to draw around the outside of the widget (if such a border
49  // is being drawn; the Relief option typically determines this).
50  virtual void SetBorderWidth(int);
51  virtual int GetBorderWidth();
52 
53  // Description:
54  // Set/Get the 3-D effect desired for the widget.
55  // The value indicates how the interior of the widget should appear
56  // relative to its exterior.
57  // Valid constants can be found in vtkKWOptions::ReliefType.
58  virtual void SetRelief(int);
59  virtual int GetRelief();
60  virtual void SetReliefToRaised();
61  virtual void SetReliefToSunken();
62  virtual void SetReliefToFlat();
63  virtual void SetReliefToRidge();
64  virtual void SetReliefToSolid();
65  virtual void SetReliefToGroove();
66 
67  // Description:
68  // Set/Get the padding that will be applied around each widget (in pixels).
69  // Specifies a non-negative value indicating how much extra space to request
70  // for the widget in the X and Y-direction. When computing how large a
71  // window it needs, the widget will add this amount to the width it would
72  // normally need (as determined by the width of the things displayed
73  // in the widget); if the geometry manager can satisfy this request, the
74  // widget will end up with extra internal space around what it displays
75  // inside.
76  virtual void SetPadX(int);
77  virtual int GetPadX();
78  virtual void SetPadY(int);
79  virtual int GetPadY();
80 
81  // Description:
82  // Request the width/height of a frame.
83  // If width or height is less than or equal to zero then the frame will
84  // not request any site at all, and we obey both the geometry of its
85  // children and the space provided by its parent.
86  // Supported only starting Tcl/Tk 8.3
87  virtual void SetWidth(int);
88  virtual int GetWidth();
89  virtual void SetHeight(int);
90  virtual int GetHeight();
91 
92 protected:
93  vtkKWFrame() {};
95 
96  // Description:
97  // Create the widget.
98  virtual void CreateWidget();
99 
100 private:
101  vtkKWFrame(const vtkKWFrame&); // Not implemented
102  void operator=(const vtkKWFrame&); // Not implemented
103 };
104 
105 
106 #endif
107 
108 
109