KWWidgets
DEB_build_shared/AutoGeneratedClasses/vtkKWScaleWithEntrySet.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Module: $RCSfile: vtkKWWidgetSetSubclass.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 vtkKWScaleWithEntrySet - a concrete set of vtkKWScaleWithEntry
15 // .SECTION Description
16 // A composite widget to conveniently store, allocate, create and pack a
17 // set of vtkKWScaleWithEntry.
18 // Each vtkKWScaleWithEntry is created, removed or queried based
19 // on a unique ID provided by the user (ids are *not* handled by the class
20 // since it is likely that they will be defined as enum's or #define by
21 // the user for easier retrieval).
22 // As a subclass of vtkKWWidgetSet, it inherits methods to set the widgets
23 // visibility individually, set the layout parameters, and query each widget.
24 // Widgets are packed (gridded) in the order they were added.
25 // @ingroup kwwidgets_autogenerated_widget_set_group
26 // .SECTION Note
27 // This class and the corresponding code were
28 // \subpage kwwidgets_autogenerated_page "generated automatically" by
29 // instantiating the <tt>Templates/vtkKWWidgetSetSubclass.h.in</tt>
30 // and <tt>Templates/vtkKWWidgetSetSubclass.cxx.in</tt> files for
31 // the type vtkKWScaleWithEntry. Classes related to the same template can be found
32 // in the \ref kwwidgets_autogenerated_widget_set_group section.
33 // .SECTION See Also
34 // vtkKWWidgetSet vtkKWScaleWithEntry
35 
36 #ifndef __vtkKWScaleWithEntrySet_h
37 #define __vtkKWScaleWithEntrySet_h
38 
39 #include "vtkKWWidgetSet.h"
40 
42 
44 {
45 public:
46  static vtkKWScaleWithEntrySet* New();
47  vtkTypeRevisionMacro(vtkKWScaleWithEntrySet,vtkKWWidgetSet);
48  void PrintSelf(ostream& os, vtkIndent indent);
49 
50  // Description:
51  // Add a vtkKWScaleWithEntry to the end of the set.
52  // The id has to be unique among the set.
53  // Return a pointer to the vtkKWScaleWithEntry, or NULL on error.
54  virtual vtkKWScaleWithEntry* AddWidget(int id);
55 
56  // Description:
57  // Insert a vtkKWScaleWithEntry at a specific position in the set.
58  // The id has to be unique among the set.
59  // Return a pointer to the vtkKWScaleWithEntry, or NULL on error.
60  virtual vtkKWScaleWithEntry* InsertWidget(int id, int pos);
61 
62  // Description:
63  // Get a vtkKWScaleWithEntry from the set, given its unique id.
64  // Return a pointer to the vtkKWScaleWithEntry, or NULL on error.
65  virtual vtkKWScaleWithEntry* GetWidget(int id);
66 
67 protected:
70 
71  // Helper methods
72 
74 
75 private:
76  vtkKWScaleWithEntrySet(const vtkKWScaleWithEntrySet&); // Not implemented
77  void operator=(const vtkKWScaleWithEntrySet&); // Not implemented
78 };
79 
80 #endif