KWWidgets
debian/tmp/usr/include/KWWidgets/vtkKWMatrixWidgetWithLabel.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Module: $RCSfile: vtkKWWidgetWithLabelSubclass.h.in,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 vtkKWMatrixWidgetWithLabel - a vtkKWMatrixWidget associated to a vtkKWLabel
15 // .SECTION Description
16 // This class creates a composite widget associating a vtkKWMatrixWidget to a
17 // vtkKWLabel.
18 // As a subclass of vtkKWWidgetWithLabel, it inherits a label and methods to
19 // set its position and visibility. Note that the default label position
20 // implemented in this class is on the left of the vtkKWMatrixWidget, but
21 // specific positions listed in vtkKWWidgetWithLabel are supported as well.
22 // @ingroup kwwidgets_autogenerated_widget_with_label_group
23 // .SECTION Note
24 // This class and the corresponding code were
25 // \subpage kwwidgets_autogenerated_page "generated automatically" by
26 // instantiating the <tt>Templates/vtkKWWidgetWithLabelSubclass.h.in</tt>
27 // and <tt>Templates/vtkKWWidgetWithLabelSubclass.cxx.in</tt> files for
28 // the type vtkKWMatrixWidget. Classes related to the same template can be found
29 // in the \ref kwwidgets_autogenerated_widget_with_label_group section.
30 // .SECTION See Also
31 // vtkKWWidgetWithLabel vtkKWMatrixWidget
32 
33 #ifndef __vtkKWMatrixWidgetWithLabel_h
34 #define __vtkKWMatrixWidgetWithLabel_h
35 
36 #include "vtkKWWidgetWithLabel.h"
37 
38 class vtkKWMatrixWidget;
39 
41 {
42 public:
45  void PrintSelf(ostream& os, vtkIndent indent);
46 
47  // Description:
48  // Get the vtkKWMatrixWidget that is being labeled
49  virtual vtkKWMatrixWidget* GetWidget();
50 
51  // Description:
52  // Set the layout to allow the widget that is labeled to expand
53  // horizontally automatically
54  virtual void SetExpandWidget(int);
55  vtkBooleanMacro(ExpandWidget, int);
56  vtkGetMacro(ExpandWidget, int);
57 
58  // Description:
59  // Set the string that enables balloon help for this widget.
60  // Override to pass down to children.
61  virtual void SetBalloonHelpString(const char *str);
62 
63  // Description:
64  // Update the "enable" state of the object and its internal parts.
65  // Depending on different Ivars (this->Enabled, the application's
66  // Limited Edition Mode, etc.), the "enable" state of the object is updated
67  // and propagated to its internal parts/subwidgets. This will, for example,
68  // enable/disable parts of the widget UI, enable/disable the visibility
69  // of 3D widgets, etc.
70  virtual void UpdateEnableState();
71 
72 protected:
75 
76  // Description:
77  // Create the widget
78  virtual void CreateWidget();
79 
80  // Description:
81  // Expand the widget that is being labeled
82  int ExpandWidget;
83 
84  // Description:
85  // Pack or repack the widget. To be implemented by subclasses.
86  virtual void Pack();
87 
88  // Description:
89  // Internal widget
90  vtkKWMatrixWidget *Widget;
91 
92 private:
93 
94  vtkKWMatrixWidgetWithLabel(const vtkKWMatrixWidgetWithLabel&); // Not implemented
95  void operator=(const vtkKWMatrixWidgetWithLabel&); // Not implemented
96 };
97 
98 #endif