KWWidgets
debian/tmp/usr/include/KWWidgets/vtkKWOptions.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Module: $RCSfile: vtkKWOptions.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 vtkKWOptions - set of common options.
15 // .SECTION Description
16 // This class also provides some conversion betweek vtkKWWidget constants
17 // and the corresponding Tk options.
18 
19 #ifndef __vtkKWOptions_h
20 #define __vtkKWOptions_h
21 
22 #include "vtkObject.h"
23 #include "vtkKWWidgets.h" // Needed for export symbols directives
24 
25 class KWWidgets_EXPORT vtkKWOptions : public vtkObject
26 {
27 public:
28  static vtkKWOptions* New();
29  vtkTypeRevisionMacro(vtkKWOptions,vtkObject);
30  void PrintSelf(ostream& os, vtkIndent indent);
31 
32  // Description:
33  // Specifies how the information in a widget (e.g. text or a bitmap) is to
34  // be displayed in the widget.
35  //BTX
37  {
38  AnchorNorth = 0,
47  AnchorUnknown
48  };
49  //ETX
50 
51  // Description:
52  // Specifies the 3-D effect desired for the widget. The value indicates how
53  // the interior of the widget should appear relative to its exterior.
54  //BTX
56  {
57  ReliefRaised = 0,
63  ReliefUnknown
64  };
65  //ETX
66 
67  // Description:
68  // When there are multiple lines of text displayed in a widget,
69  // determines how the lines line up with each other.
70  //BTX
72  {
73  JustificationLeft = 0,
76  JustificationUnknown
77  };
78  //ETX
79 
80  // Description:
81  // Specifies one of several styles for manipulating the selection.
82  //BTX
84  {
85  SelectionModeSingle = 0,
89  SelectionModeUnknown
90  };
91  //ETX
92 
93  // Description:
94  // For widgets that can lay themselves out with either a horizontal or
95  // vertical orientation, such as scales or scrollbars, specifies which
96  // orientation should be used.
97  //BTX
99  {
100  OrientationHorizontal = 0,
102  OrientationUnknown
103  };
104  //ETX
105 
106  // Description:
107  // Specifies the state of a widget.
108  //BTX
110  {
111  StateDisabled = 0,
112  StateNormal = 1,
113  StateActive = 2,
114  StateReadOnly = 3,
115  StateUnknown
116  };
117  //ETX
118 
119  // Description:
120  // Specifies if the widget should display text and bitmaps/images at the
121  // same time, and if so, where the bitmap/image should be placed relative
122  // to the text.
123  //BTX
125  {
126  CompoundModeNone = 0,
132  CompoundModeUnknown
133  };
134  //ETX
135 
136  // Description:
137  // Return the Tcl value for a given encoding constant
138  // Check vtkSystemIncludes for a list of valid encodings.
139  static const char* GetCharacterEncodingAsTclOptionValue(int);
140 
141  // Description:
142  // Return the Tk value for a given anchor constant, and vice-versa
143  static const char* GetAnchorAsTkOptionValue(int);
144  static int GetAnchorFromTkOptionValue(const char *);
145 
146  // Description:
147  // Return the Tk value for a given relief constant, and vice-versa
148  static const char* GetReliefAsTkOptionValue(int);
149  static int GetReliefFromTkOptionValue(const char *);
150 
151  // Description:
152  // Return the Tk value for a given justification constant, and vice-versa.
153  static const char* GetJustificationAsTkOptionValue(int);
154  static int GetJustificationFromTkOptionValue(const char *);
155 
156  // Description:
157  // Return the Tk value for a given selection mode constant, and vice-versa.
158  static const char* GetSelectionModeAsTkOptionValue(int);
159  static int GetSelectionModeFromTkOptionValue(const char *);
160 
161  // Description:
162  // Return the Tk value for a given orientation constant, and vice-versa.
163  static const char* GetOrientationAsTkOptionValue(int);
164  static int GetOrientationFromTkOptionValue(const char *);
165 
166  // Description:
167  // Return the Tk value for a given state constant, and vice-versa.
168  static const char* GetStateAsTkOptionValue(int);
169  static int GetStateFromTkOptionValue(const char *);
170 
171  // Description:
172  // Return the Tk value for a given compound constant, and vice-versa.
173  static const char* GetCompoundModeAsTkOptionValue(int);
174  static int GetCompoundModeFromTkOptionValue(const char *);
175 
176 protected:
179 
180 private:
181 
182  vtkKWOptions(const vtkKWOptions&); // Not implemented
183  void operator=(const vtkKWOptions&); // Not implemented
184 };
185 
186 #endif