Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkKWWidgetSet Class Reference

an abstract set of vtkKWWidget More...

#include <vtkKWWidgetSet.h>

Inheritance diagram for vtkKWWidgetSet:

Inheritance graph
[legend]
Collaboration diagram for vtkKWWidgetSet:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkKWWidgetSet, vtkKWCompositeWidget)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Create (vtkKWApplication *app)
virtual int GetNumberOfWidgets ()
virtual int GetNthWidgetId (int rank)
virtual int HasWidget (int id)
virtual void DeleteAllWidgets ()
virtual void UpdateEnableState ()
virtual void HideWidget (int id)
virtual void ShowWidget (int id)
virtual int GetWidgetVisibility (int id)
virtual void SetWidgetVisibility (int id, int flag)
virtual int GetNumberOfVisibleWidgets ()
virtual void SetPackHorizontally (int)
virtual void PackHorizontallyOn ()
virtual void PackHorizontallyOff ()
virtual int GetPackHorizontally ()
virtual void SetMaximumNumberOfWidgetsInPackingDirection (int)
virtual int GetMaximumNumberOfWidgetsInPackingDirection ()
virtual void SetWidgetsPadX (int)
virtual int GetWidgetsPadX ()
virtual void SetWidgetsPadY (int)
virtual int GetWidgetsPadY ()
virtual void SetWidgetsInternalPadX (int)
virtual int GetWidgetsInternalPadX ()
virtual void SetWidgetsInternalPadY (int)
virtual int GetWidgetsInternalPadY ()
virtual void SetExpandWidgets (int)
virtual void ExpandWidgetsOn ()
virtual void ExpandWidgetsOff ()
virtual int GetExpandWidgets ()

Protected Member Functions

 vtkKWWidgetSet ()
 ~vtkKWWidgetSet ()
virtual vtkKWWidget * AllocateAndCreateWidget ()=0
virtual vtkKWWidget * GetWidgetInternal (int id)
virtual vtkKWWidget * AddWidgetInternal (int id)
virtual void Pack ()

Protected Attributes

int PackHorizontally
int MaximumNumberOfWidgetsInPackingDirection
int WidgetsPadX
int WidgetsPadY
int WidgetsInternalPadX
int WidgetsInternalPadY
int ExpandWidgets
vtkKWWidgetSetInternals * Internals

Detailed Description

an abstract set of vtkKWWidget

A composite widget to conveniently store a set of vtkKWWidget. Each vtkKWWidget is created, removed or queried based on a unique ID provided by the user (ids are *not* handled by the class since it is likely that they will be defined as enum's or #define by the user for easier retrieval). Widgets are packed (gridded) in the order they were added. Subclasses need to implement AllocateAndCreateWidget

Definition at line 35 of file vtkKWWidgetSet.h.

Constructor & Destructor Documentation

vtkKWWidgetSet::vtkKWWidgetSet (   )  [protected]
 

vtkKWWidgetSet::~vtkKWWidgetSet (   )  [protected]
 

Member Function Documentation

vtkKWWidgetSet::vtkTypeRevisionMacro (  vtkKWWidgetSet  ,
vtkKWCompositeWidget 
) 
 

void vtkKWWidgetSet::PrintSelf (  ostream &  os,
vtkIndent  indent
) 
 

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWRadioButtonSet, vtkKWCheckButtonSet, vtkKWComboBoxSet, vtkKWEntrySet, vtkKWLabelSet, vtkKWLabelWithLabelSet, vtkKWPushButtonSet, vtkKWScaleSet, and vtkKWScaleWithEntrySet.

virtual void vtkKWWidgetSet::Create (  vtkKWApplication *  app  )  [virtual]
 

Create the widget.

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWWidgetSet::GetNumberOfWidgets (   )  [virtual]
 

Get the number of vtkKWWidget in the set.

virtual int vtkKWWidgetSet::GetNthWidgetId (  int  rank  )  [virtual]
 

Retrieve the id of the n-th vtkKWWidget (-1 if not found)

virtual int vtkKWWidgetSet::HasWidget (  int  id  )  [virtual]
 

Check if a vtkKWWidget is in the set, given its unique id. Return 1 if exists, 0 otherwise.

virtual void vtkKWWidgetSet::HideWidget (  int  id  )  [virtual]
 

Hide/show a vtkKWWidget, given its unique id. Get the number of visible vtkKWWidget in the set.

virtual void vtkKWWidgetSet::ShowWidget (  int  id  )  [virtual]
 

Hide/show a vtkKWWidget, given its unique id. Get the number of visible vtkKWWidget in the set.

virtual int vtkKWWidgetSet::GetWidgetVisibility (  int  id  )  [virtual]
 

Hide/show a vtkKWWidget, given its unique id. Get the number of visible vtkKWWidget in the set.

virtual void vtkKWWidgetSet::SetWidgetVisibility (  int  id,
int  flag
)  [virtual]
 

Hide/show a vtkKWWidget, given its unique id. Get the number of visible vtkKWWidget in the set.

virtual int vtkKWWidgetSet::GetNumberOfVisibleWidgets (   )  [virtual]
 

Hide/show a vtkKWWidget, given its unique id. Get the number of visible vtkKWWidget in the set.

virtual void vtkKWWidgetSet::DeleteAllWidgets (   )  [virtual]
 

Delete all vtkKWWidget widgets

virtual void vtkKWWidgetSet::SetPackHorizontally (  int   )  [virtual]
 

Set the packing direction to be horizontal (default is vertical).

virtual void vtkKWWidgetSet::PackHorizontallyOn (   )  [virtual]
 

Set the packing direction to be horizontal (default is vertical).

virtual void vtkKWWidgetSet::PackHorizontallyOff (   )  [virtual]
 

Set the packing direction to be horizontal (default is vertical).

virtual int vtkKWWidgetSet::GetPackHorizontally (   )  [virtual]
 

Set the packing direction to be horizontal (default is vertical).

virtual void vtkKWWidgetSet::SetMaximumNumberOfWidgetsInPackingDirection (  int   )  [virtual]
 

Set the maximum number of widgets that will be packed in the packing direction (i.e. horizontally or vertically). For example, if set to 3 and the packing direction is horizontal, the layout ends up as 3 columns of widgets. The default is 0, i.e. all widgets are packed along the same direction.

virtual int vtkKWWidgetSet::GetMaximumNumberOfWidgetsInPackingDirection (   )  [virtual]
 

Set the maximum number of widgets that will be packed in the packing direction (i.e. horizontally or vertically). For example, if set to 3 and the packing direction is horizontal, the layout ends up as 3 columns of widgets. The default is 0, i.e. all widgets are packed along the same direction.

virtual void vtkKWWidgetSet::SetWidgetsPadX (  int   )  [virtual]
 

Set/Get the padding that will be applied around each widget. (default to 0).

virtual int vtkKWWidgetSet::GetWidgetsPadX (   )  [virtual]
 

Set/Get the padding that will be applied around each widget. (default to 0).

virtual void vtkKWWidgetSet::SetWidgetsPadY (  int   )  [virtual]
 

Set/Get the padding that will be applied around each widget. (default to 0).

virtual int vtkKWWidgetSet::GetWidgetsPadY (   )  [virtual]
 

Set/Get the padding that will be applied around each widget. (default to 0).

virtual void vtkKWWidgetSet::SetWidgetsInternalPadX (  int   )  [virtual]
 

Set/Get the internal padding that will be left around each widget. This space is added inside the widget border. (default to 0).

virtual int vtkKWWidgetSet::GetWidgetsInternalPadX (   )  [virtual]
 

Set/Get the internal padding that will be left around each widget. This space is added inside the widget border. (default to 0).

virtual void vtkKWWidgetSet::SetWidgetsInternalPadY (  int   )  [virtual]
 

Set/Get the internal padding that will be left around each widget. This space is added inside the widget border. (default to 0).

virtual int vtkKWWidgetSet::GetWidgetsInternalPadY (   )  [virtual]
 

Set/Get the internal padding that will be left around each widget. This space is added inside the widget border. (default to 0).

virtual void vtkKWWidgetSet::SetExpandWidgets (  int   )  [virtual]
 

Set the layout to allow the widgets to expand automatically

virtual void vtkKWWidgetSet::ExpandWidgetsOn (   )  [virtual]
 

Set the layout to allow the widgets to expand automatically

virtual void vtkKWWidgetSet::ExpandWidgetsOff (   )  [virtual]
 

Set the layout to allow the widgets to expand automatically

virtual int vtkKWWidgetSet::GetExpandWidgets (   )  [virtual]
 

Set the layout to allow the widgets to expand automatically

virtual void vtkKWWidgetSet::UpdateEnableState (   )  [virtual]
 

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc.

Reimplemented from vtkKWWidget.

virtual vtkKWWidget* vtkKWWidgetSet::AllocateAndCreateWidget (   )  [protected, pure virtual]
 

To be implemented by superclasses. Allocate and create a widget of the right type. Return a pointer to the superclass though.

Implemented in vtkKWRadioButtonSet, vtkKWCheckButtonSet, vtkKWComboBoxSet, vtkKWEntrySet, vtkKWLabelSet, vtkKWLabelWithLabelSet, vtkKWPushButtonSet, vtkKWScaleSet, and vtkKWScaleWithEntrySet.

virtual vtkKWWidget* vtkKWWidgetSet::GetWidgetInternal (  int  id  )  [protected, virtual]
 

virtual vtkKWWidget* vtkKWWidgetSet::AddWidgetInternal (  int  id  )  [protected, virtual]
 

Reimplemented in vtkKWRadioButtonSet.

virtual void vtkKWWidgetSet::Pack (   )  [protected, virtual]
 

Pack the widgets

Member Data Documentation

int vtkKWWidgetSet::PackHorizontally [protected]
 

Definition at line 121 of file vtkKWWidgetSet.h.

int vtkKWWidgetSet::MaximumNumberOfWidgetsInPackingDirection [protected]
 

Definition at line 122 of file vtkKWWidgetSet.h.

int vtkKWWidgetSet::WidgetsPadX [protected]
 

Definition at line 123 of file vtkKWWidgetSet.h.

int vtkKWWidgetSet::WidgetsPadY [protected]
 

Definition at line 124 of file vtkKWWidgetSet.h.

int vtkKWWidgetSet::WidgetsInternalPadX [protected]
 

Definition at line 125 of file vtkKWWidgetSet.h.

int vtkKWWidgetSet::WidgetsInternalPadY [protected]
 

Definition at line 126 of file vtkKWWidgetSet.h.

int vtkKWWidgetSet::ExpandWidgets [protected]
 

Definition at line 127 of file vtkKWWidgetSet.h.

vtkKWWidgetSetInternals* vtkKWWidgetSet::Internals [protected]
 

PIMPL Encapsulation for STL containers

Reimplemented from vtkKWWidget.

Definition at line 137 of file vtkKWWidgetSet.h.

The documentation for this class was generated from the following file:
Generated on Tue May 30 12:47:34 2006 for ParaView by doxygen 1.3.5