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

vtkKWToolbarSet Class Reference

a "set of toolbars" widget More...

#include <vtkKWToolbarSet.h>

Inheritance diagram for vtkKWToolbarSet:

Inheritance graph
[legend]
Collaboration diagram for vtkKWToolbarSet:

Collaboration graph
[legend]
List of all members.

[NOHEADER]

enum  { ToolbarAnchorWest = 0, ToolbarAnchorEast }
virtual void SetToolbarAnchor (vtkKWToolbar *toolbar, int anchor)
virtual int GetToolbarAnchor (vtkKWToolbar *toolbar)
virtual void SetToolbarAnchorToWest (vtkKWToolbar *toolbar)
virtual void SetToolbarAnchorToEast (vtkKWToolbar *toolbar)

Public Types


Public Member Functions

 vtkTypeRevisionMacro (vtkKWToolbarSet, vtkKWCompositeWidget)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Create (vtkKWApplication *app)
virtual void SetToolbarsFlatAspect (int)
virtual void SetToolbarsWidgetsFlatAspect (int)
virtual int GetNumberOfVisibleToolbars ()
virtual void Update ()
virtual void Pack ()
virtual void UpdateEnableState ()
virtual vtkKWFrame * GetToolbarsFrame ()
virtual int AddToolbar (vtkKWToolbar *toolbar)
virtual int AddToolbar (vtkKWToolbar *toolbar, int default_visibility)
virtual int HasToolbar (vtkKWToolbar *toolbar)
virtual vtkKWToolbar * GetNthToolbar (int rank)
virtual int GetNumberOfToolbars ()
virtual int RemoveToolbar (vtkKWToolbar *toolbar)
virtual void RemoveAllToolbars ()
virtual void HideToolbar (vtkKWToolbar *toolbar)
virtual void ShowToolbar (vtkKWToolbar *toolbar)
virtual void SetToolbarVisibility (vtkKWToolbar *toolbar, int flag)
virtual int GetToolbarVisibility (vtkKWToolbar *toolbar)
virtual void ToggleToolbarVisibility (vtkKWToolbar *toolbar)
virtual void SaveToolbarVisibilityToRegistry (vtkKWToolbar *toolbar)
virtual void RestoreToolbarVisibilityFromRegistry (vtkKWToolbar *toolbar)
virtual void SaveToolbarsVisibilityToRegistry ()
virtual void RestoreToolbarsVisibilityFromRegistry ()
virtual void SynchronizeToolbarsVisibilityWithRegistryOn ()
virtual void SynchronizeToolbarsVisibilityWithRegistryOff ()
virtual int GetSynchronizeToolbarsVisibilityWithRegistry ()
virtual void SetSynchronizeToolbarsVisibilityWithRegistry (int)
virtual void PopulateToolbarsVisibilityMenu (vtkKWMenu *menu)
virtual void UpdateToolbarsVisibilityMenu (vtkKWMenu *menu)
virtual void SetToolbarVisibilityChangedCommand (vtkObject *object, const char *method)
virtual void InvokeToolbarVisibilityChangedCommand ()
virtual void SetNumberOfToolbarsChangedCommand (vtkObject *object, const char *method)
virtual void InvokeNumberOfToolbarsChangedCommand ()
virtual void SetBottomSeparatorVisibility (int)
virtual void BottomSeparatorVisibilityOn ()
virtual void BottomSeparatorVisibilityOff ()
virtual int GetBottomSeparatorVisibility ()
virtual void SetTopSeparatorVisibility (int)
virtual void TopSeparatorVisibilityOn ()
virtual void TopSeparatorVisibilityOff ()
virtual int GetTopSeparatorVisibility ()

Static Public Member Functions

vtkKWToolbarSet * New ()

Protected Member Functions

 vtkKWToolbarSet ()
 ~vtkKWToolbarSet ()
ToolbarSlot * GetToolbarSlot (vtkKWToolbar *toolbar)
virtual void PackToolbars ()
virtual void PackBottomSeparator ()
virtual void PackTopSeparator ()

Protected Attributes

vtkKWSeparator * TopSeparator
vtkKWFrame * ToolbarsFrame
vtkKWSeparator * BottomSeparator
int BottomSeparatorVisibility
int TopSeparatorVisibility
int SynchronizeToolbarsVisibilityWithRegistry
char * ToolbarVisibilityChangedCommand
char * NumberOfToolbarsChangedCommand
vtkKWToolbarSetInternals * Internals

Friends

class vtkKWToolbarSetInternals

Detailed Description

a "set of toolbars" widget

A simple widget representing a set of toolbars..

Definition at line 32 of file vtkKWToolbarSet.h.

Member Enumeration Documentation

anonymous enum
 

Set a toolbar's anchor. By default, toolbars are packed from left to right in the order they were added to the toolbar set, i.e. each toolbar is "anchored" to the west side of the set. One can change this anchor on a per-toolbar basis. This means that all toolbars anchored to the west side will be grouped together on that side, and all toolbars anchored to the east side will be grouped on the opposite side. Note though that anchoring acts like a "mirror": packing starts from the anchor side, progressing towards the middle of the toolbar set (i.e., toolbars anchored west are packed left to right, toolbars anchored east are packed right to left, following the order they were inserted in the set). BTX

Enumeration values:
ToolbarAnchorWest 
ToolbarAnchorEast 

Definition at line 101 of file vtkKWToolbarSet.h.

Constructor & Destructor Documentation

vtkKWToolbarSet::vtkKWToolbarSet (   )  [protected]
 

vtkKWToolbarSet::~vtkKWToolbarSet (   )  [protected]
 

Member Function Documentation

vtkKWToolbarSet* vtkKWToolbarSet::New (   )  [static]
 

Reimplemented from vtkKWCompositeWidget.

vtkKWToolbarSet::vtkTypeRevisionMacro (  vtkKWToolbarSet  ,
vtkKWCompositeWidget 
) 
 

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

Reimplemented from vtkKWCompositeWidget.

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

Create the widget.

Reimplemented from vtkKWCompositeWidget.

virtual vtkKWFrame* vtkKWToolbarSet::GetToolbarsFrame (   )  [virtual]
 

Get the frame that can be used as a parent to a toolbar

virtual int vtkKWToolbarSet::AddToolbar (  vtkKWToolbar *  toolbar  )  [inline, virtual]
 

Add a toolbar to the set. The default_visibility parameter sets the visibility of the toolbar in the set once it is added (so that it can be added hidden for example, before its visibility setting is retrieved from the registry). Return 1 on success, 0 otherwise.

Definition at line 52 of file vtkKWToolbarSet.h.

virtual int vtkKWToolbarSet::AddToolbar (  vtkKWToolbar *  toolbar,
int  default_visibility
)  [virtual]
 

Add a toolbar to the set. The default_visibility parameter sets the visibility of the toolbar in the set once it is added (so that it can be added hidden for example, before its visibility setting is retrieved from the registry). Return 1 on success, 0 otherwise.

virtual int vtkKWToolbarSet::HasToolbar (  vtkKWToolbar *  toolbar  )  [virtual]
 

Add a toolbar to the set. The default_visibility parameter sets the visibility of the toolbar in the set once it is added (so that it can be added hidden for example, before its visibility setting is retrieved from the registry). Return 1 on success, 0 otherwise.

virtual vtkKWToolbar* vtkKWToolbarSet::GetNthToolbar (  int  rank  )  [virtual]
 

Get the n-th toolbar, and the number of toolbars.

virtual int vtkKWToolbarSet::GetNumberOfToolbars (   )  [virtual]
 

Get the n-th toolbar, and the number of toolbars.

virtual int vtkKWToolbarSet::RemoveToolbar (  vtkKWToolbar *  toolbar  )  [virtual]
 

Remove a toolbar (or all) from the set. Return 1 on success, 0 otherwise.

virtual void vtkKWToolbarSet::RemoveAllToolbars (   )  [virtual]
 

Remove a toolbar (or all) from the set. Return 1 on success, 0 otherwise.

virtual void vtkKWToolbarSet::SetToolbarsFlatAspect (  int   )  [virtual]
 

Set/Get the flat aspect of the toolbars

virtual void vtkKWToolbarSet::SetToolbarsWidgetsFlatAspect (  int   )  [virtual]
 

Set/Get the flat aspect of the widgets (flat or 3D GUI style)

virtual void vtkKWToolbarSet::HideToolbar (  vtkKWToolbar *  toolbar  )  [virtual]
 

Convenience method to set the visibility of a toolbar

virtual void vtkKWToolbarSet::ShowToolbar (  vtkKWToolbar *  toolbar  )  [virtual]
 

Convenience method to set the visibility of a toolbar

virtual void vtkKWToolbarSet::SetToolbarVisibility (  vtkKWToolbar *  toolbar,
int  flag
)  [virtual]
 

Convenience method to set the visibility of a toolbar

virtual int vtkKWToolbarSet::GetToolbarVisibility (  vtkKWToolbar *  toolbar  )  [virtual]
 

Convenience method to set the visibility of a toolbar

virtual void vtkKWToolbarSet::ToggleToolbarVisibility (  vtkKWToolbar *  toolbar  )  [virtual]
 

Convenience method to set the visibility of a toolbar

virtual int vtkKWToolbarSet::GetNumberOfVisibleToolbars (   )  [virtual]
 

Return the number of visible toolbars

virtual void vtkKWToolbarSet::SetToolbarAnchor (  vtkKWToolbar *  toolbar,
int  anchor
)  [virtual]
 

Set a toolbar's anchor. By default, toolbars are packed from left to right in the order they were added to the toolbar set, i.e. each toolbar is "anchored" to the west side of the set. One can change this anchor on a per-toolbar basis. This means that all toolbars anchored to the west side will be grouped together on that side, and all toolbars anchored to the east side will be grouped on the opposite side. Note though that anchoring acts like a "mirror": packing starts from the anchor side, progressing towards the middle of the toolbar set (i.e., toolbars anchored west are packed left to right, toolbars anchored east are packed right to left, following the order they were inserted in the set). BTX

virtual int vtkKWToolbarSet::GetToolbarAnchor (  vtkKWToolbar *  toolbar  )  [virtual]
 

Set a toolbar's anchor. By default, toolbars are packed from left to right in the order they were added to the toolbar set, i.e. each toolbar is "anchored" to the west side of the set. One can change this anchor on a per-toolbar basis. This means that all toolbars anchored to the west side will be grouped together on that side, and all toolbars anchored to the east side will be grouped on the opposite side. Note though that anchoring acts like a "mirror": packing starts from the anchor side, progressing towards the middle of the toolbar set (i.e., toolbars anchored west are packed left to right, toolbars anchored east are packed right to left, following the order they were inserted in the set). BTX

virtual void vtkKWToolbarSet::SetToolbarAnchorToWest (  vtkKWToolbar *  toolbar  )  [inline, virtual]
 

Set a toolbar's anchor. By default, toolbars are packed from left to right in the order they were added to the toolbar set, i.e. each toolbar is "anchored" to the west side of the set. One can change this anchor on a per-toolbar basis. This means that all toolbars anchored to the west side will be grouped together on that side, and all toolbars anchored to the east side will be grouped on the opposite side. Note though that anchoring acts like a "mirror": packing starts from the anchor side, progressing towards the middle of the toolbar set (i.e., toolbars anchored west are packed left to right, toolbars anchored east are packed right to left, following the order they were inserted in the set). BTX

Definition at line 109 of file vtkKWToolbarSet.h.

References ToolbarAnchorWest.

virtual void vtkKWToolbarSet::SetToolbarAnchorToEast (  vtkKWToolbar *  toolbar  )  [inline, virtual]
 

Set a toolbar's anchor. By default, toolbars are packed from left to right in the order they were added to the toolbar set, i.e. each toolbar is "anchored" to the west side of the set. One can change this anchor on a per-toolbar basis. This means that all toolbars anchored to the west side will be grouped together on that side, and all toolbars anchored to the east side will be grouped on the opposite side. Note though that anchoring acts like a "mirror": packing starts from the anchor side, progressing towards the middle of the toolbar set (i.e., toolbars anchored west are packed left to right, toolbars anchored east are packed right to left, following the order they were inserted in the set). BTX

Definition at line 111 of file vtkKWToolbarSet.h.

References ToolbarAnchorEast.

virtual void vtkKWToolbarSet::SaveToolbarVisibilityToRegistry (  vtkKWToolbar *  toolbar  )  [virtual]
 

Save/Restore the visibility flag of one/all toolbars to/from the registry Note that the name of each toolbar to save/restore should have been set for this method to work (see vtkKWToolbar).

virtual void vtkKWToolbarSet::RestoreToolbarVisibilityFromRegistry (  vtkKWToolbar *  toolbar  )  [virtual]
 

Save/Restore the visibility flag of one/all toolbars to/from the registry Note that the name of each toolbar to save/restore should have been set for this method to work (see vtkKWToolbar).

virtual void vtkKWToolbarSet::SaveToolbarsVisibilityToRegistry (   )  [virtual]
 

Save/Restore the visibility flag of one/all toolbars to/from the registry Note that the name of each toolbar to save/restore should have been set for this method to work (see vtkKWToolbar).

virtual void vtkKWToolbarSet::RestoreToolbarsVisibilityFromRegistry (   )  [virtual]
 

Save/Restore the visibility flag of one/all toolbars to/from the registry Note that the name of each toolbar to save/restore should have been set for this method to work (see vtkKWToolbar).

virtual void vtkKWToolbarSet::SynchronizeToolbarsVisibilityWithRegistryOn (   )  [virtual]
 

Set/Get if the visibility flag of the toolbars should be saved or restored to the registry automatically. It is restored when the toolbar is added, and saved when the visibility flag is changed.

virtual void vtkKWToolbarSet::SynchronizeToolbarsVisibilityWithRegistryOff (   )  [virtual]
 

Set/Get if the visibility flag of the toolbars should be saved or restored to the registry automatically. It is restored when the toolbar is added, and saved when the visibility flag is changed.

virtual int vtkKWToolbarSet::GetSynchronizeToolbarsVisibilityWithRegistry (   )  [virtual]
 

Set/Get if the visibility flag of the toolbars should be saved or restored to the registry automatically. It is restored when the toolbar is added, and saved when the visibility flag is changed.

virtual void vtkKWToolbarSet::SetSynchronizeToolbarsVisibilityWithRegistry (  int   )  [virtual]
 

Set/Get if the visibility flag of the toolbars should be saved or restored to the registry automatically. It is restored when the toolbar is added, and saved when the visibility flag is changed.

virtual void vtkKWToolbarSet::PopulateToolbarsVisibilityMenu (  vtkKWMenu *  menu  )  [virtual]
 

Convenience method to create and update a menu that can be used to control the visibility of all toolbars. The Populate...() method will repopulate the menu (note that it does *not* remove all entries, so that this menu can be used for several toolbar sets). The Update...() method will update the state of the entries according to the toolbarsvisibility (the first one will call the second one automatically).

virtual void vtkKWToolbarSet::UpdateToolbarsVisibilityMenu (  vtkKWMenu *  menu  )  [virtual]
 

Convenience method to create and update a menu that can be used to control the visibility of all toolbars. The Populate...() method will repopulate the menu (note that it does *not* remove all entries, so that this menu can be used for several toolbar sets). The Update...() method will update the state of the entries according to the toolbarsvisibility (the first one will call the second one automatically).

virtual void vtkKWToolbarSet::SetToolbarVisibilityChangedCommand (  vtkObject *  object,
const char *  method
)  [virtual]
 

Set/Get the command/callback that will be called when the visibility of a toolbar is changed.

virtual void vtkKWToolbarSet::InvokeToolbarVisibilityChangedCommand (   )  [virtual]
 

Set/Get the command/callback that will be called when the visibility of a toolbar is changed.

virtual void vtkKWToolbarSet::SetNumberOfToolbarsChangedCommand (  vtkObject *  object,
const char *  method
)  [virtual]
 

Set/Get the command/callback that will be called when the number of toolbar has changed (added or removed).

virtual void vtkKWToolbarSet::InvokeNumberOfToolbarsChangedCommand (   )  [virtual]
 

Set/Get the command/callback that will be called when the number of toolbar has changed (added or removed).

virtual void vtkKWToolbarSet::SetBottomSeparatorVisibility (  int   )  [virtual]
 

Set/Get the visibility of the separator at the bottom of the set

virtual void vtkKWToolbarSet::BottomSeparatorVisibilityOn (   )  [virtual]
 

Set/Get the visibility of the separator at the bottom of the set

virtual void vtkKWToolbarSet::BottomSeparatorVisibilityOff (   )  [virtual]
 

Set/Get the visibility of the separator at the bottom of the set

virtual int vtkKWToolbarSet::GetBottomSeparatorVisibility (   )  [virtual]
 

Set/Get the visibility of the separator at the bottom of the set

virtual void vtkKWToolbarSet::SetTopSeparatorVisibility (  int   )  [virtual]
 

Set/Get the visibility of the separator at the top of the set

virtual void vtkKWToolbarSet::TopSeparatorVisibilityOn (   )  [virtual]
 

Set/Get the visibility of the separator at the top of the set

virtual void vtkKWToolbarSet::TopSeparatorVisibilityOff (   )  [virtual]
 

Set/Get the visibility of the separator at the top of the set

virtual int vtkKWToolbarSet::GetTopSeparatorVisibility (   )  [virtual]
 

Set/Get the visibility of the separator at the top of the set

virtual void vtkKWToolbarSet::Update (   )  [virtual]
 

Update the toolbar set (update the enabled state of all toolbars, call PackToolbars(), etc.).

virtual void vtkKWToolbarSet::Pack (   )  [virtual]
 

(Re)Pack the toolbars, if needed (if the widget is created, and the toolbar is created, AddToolbar will pack the toolbar automatically).

virtual void vtkKWToolbarSet::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.

ToolbarSlot* vtkKWToolbarSet::GetToolbarSlot (  vtkKWToolbar *  toolbar  )  [protected]
 

virtual void vtkKWToolbarSet::PackToolbars (   )  [protected, virtual]
 

virtual void vtkKWToolbarSet::PackBottomSeparator (   )  [protected, virtual]
 

virtual void vtkKWToolbarSet::PackTopSeparator (   )  [protected, virtual]
 

Friends And Related Function Documentation

friend class vtkKWToolbarSetInternals [friend]
 

Definition at line 223 of file vtkKWToolbarSet.h.

Member Data Documentation

vtkKWSeparator* vtkKWToolbarSet::TopSeparator [protected]
 

Definition at line 196 of file vtkKWToolbarSet.h.

vtkKWFrame* vtkKWToolbarSet::ToolbarsFrame [protected]
 

Definition at line 197 of file vtkKWToolbarSet.h.

vtkKWSeparator* vtkKWToolbarSet::BottomSeparator [protected]
 

Definition at line 198 of file vtkKWToolbarSet.h.

int vtkKWToolbarSet::BottomSeparatorVisibility [protected]
 

Definition at line 200 of file vtkKWToolbarSet.h.

int vtkKWToolbarSet::TopSeparatorVisibility [protected]
 

Definition at line 201 of file vtkKWToolbarSet.h.

int vtkKWToolbarSet::SynchronizeToolbarsVisibilityWithRegistry [protected]
 

Definition at line 202 of file vtkKWToolbarSet.h.

char* vtkKWToolbarSet::ToolbarVisibilityChangedCommand [protected]
 

Definition at line 204 of file vtkKWToolbarSet.h.

char* vtkKWToolbarSet::NumberOfToolbarsChangedCommand [protected]
 

Definition at line 205 of file vtkKWToolbarSet.h.

vtkKWToolbarSetInternals* vtkKWToolbarSet::Internals [protected]
 

PIMPL Encapsulation for STL containers

Reimplemented from vtkKWWidget.

Definition at line 222 of file vtkKWToolbarSet.h.

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