vtkKWToolbar Class Reference

a frame that holds tool buttons More...

#include <vtkKWToolbar.h>

Inheritance diagram for vtkKWToolbar:

[legend]Collaboration diagram for vtkKWToolbar:

[legend]List of all members.

[NOHEADER]
virtual void	SetFlatAspect (int)
virtual void	FlatAspectOn ()
virtual void	FlatAspectOff ()
virtual int	GetFlatAspect ()
int	GetGlobalFlatAspect ()
void	SetGlobalFlatAspect (int val)
void	GlobalFlatAspectOn ()
void	GlobalFlatAspectOff ()
[NOHEADER]
virtual void	SetWidgetsFlatAspect (int)
virtual void	WidgetsFlatAspectOn ()
virtual void	WidgetsFlatAspectOff ()
virtual int	GetWidgetsFlatAspect ()
int	GetGlobalWidgetsFlatAspect ()
void	SetGlobalWidgetsFlatAspect (int val)
void	GlobalWidgetsFlatAspectOn ()
void	GlobalWidgetsFlatAspectOff ()
Public Member Functions
	vtkTypeRevisionMacro (vtkKWToolbar, vtkKWCompositeWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual vtkKWWidget *	GetWidget (const char *name)
virtual vtkKWWidget *	GetNthWidget (int rank)
virtual void	UpdateWidgets ()
virtual void	Update ()
virtual void	UpdateEnableState ()
virtual vtkKWFrame *	GetFrame ()
virtual void	SetResizable (int)
virtual int	GetResizable ()
virtual void	ResizableOn ()
virtual void	ResizableOff ()
virtual char *	GetName ()
virtual void	SetName (const char *)
virtual void	AddWidget (vtkKWWidget *widget)
virtual void	InsertWidget (vtkKWWidget *location, vtkKWWidget *widget)
virtual int	HasWidget (vtkKWWidget *widget)
virtual int	GetNumberOfWidgets ()
virtual void	RemoveWidget (vtkKWWidget *widget)
virtual void	RemoveAllWidgets ()
vtkKWWidget *	AddRadioButtonImage (int value, const char *image_name, const char *select_image_name, const char *variable_name, vtkObject *object, const char *method, const char *help=0)
vtkKWWidget *	AddCheckButtonImage (const char *image_name, const char *select_image_name, const char *variable_name, vtkObject *object, const char *method, const char *help=0)
virtual void	SetWidgetsPadX (int)
virtual int	GetWidgetsPadX ()
virtual void	SetWidgetsPadY (int)
virtual int	GetWidgetsPadY ()
virtual void	SetWidgetsFlatAdditionalPadX (int)
virtual int	GetWidgetsFlatAdditionalPadX ()
virtual void	SetWidgetsFlatAdditionalPadY (int)
virtual int	GetWidgetsFlatAdditionalPadY ()
virtual void	ScheduleResize ()
virtual void	Resize ()
Static Public Member Functions
vtkKWToolbar *	New ()
Static Public Attributes
const char *	FlatAspectRegKey
const char *	WidgetsFlatAspectRegKey
Protected Member Functions
	vtkKWToolbar ()
	~vtkKWToolbar ()
void	ConstrainWidgetsLayout ()
void	UpdateWidgetsLayout ()
void	UpdateWidgetsAspect ()
void	UpdateToolbarFrameAspect ()
virtual void	Bind ()
virtual void	UnBind ()
Protected Attributes
int	Expanding
vtkKWFrame *	Frame
vtkKWFrame *	Handle
vtkKWToolbarInternals *	Internals
int	WidgetsPadX
int	WidgetsPadY
int	WidgetsFlatAdditionalPadX
int	WidgetsFlatAdditionalPadY
int	FlatAspect
int	WidgetsFlatAspect
int	Resizable
vtkKWRadioButton *	DefaultOptionsWidget
char *	Name

---

Detailed Description

a frame that holds tool buttons

Simply a frame to hold a bunch of tools. It uses bindings to control the height of the frame. In the future we could use the object to move toolbars groups around.

Definition at line 32 of file vtkKWToolbar.h.

---

Constructor & Destructor Documentation

vtkKWToolbar::vtkKWToolbar (   )  [protected]

vtkKWToolbar::~vtkKWToolbar (   )  [protected]

---

Member Function Documentation

vtkKWToolbar* vtkKWToolbar::New (   )  [static]

Reimplemented from vtkKWCompositeWidget. Reimplemented in vtkPVVCRControl.

vtkKWToolbar::vtkTypeRevisionMacro (  vtkKWToolbar  , vtkKWCompositeWidget  )

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

Reimplemented from vtkKWCompositeWidget. Reimplemented in vtkPVVCRControl.

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

Create the widget. Reimplemented from vtkKWCompositeWidget. Reimplemented in vtkPVVCRControl.

virtual vtkKWFrame* vtkKWToolbar::GetFrame (   )  [virtual]

Returns the main frame of the toolbar. This should be used as the parent of all the widgets in the toolbar.

virtual void vtkKWToolbar::SetResizable (  int   )  [virtual]

Determines whether the toolbar is resizable.

virtual int vtkKWToolbar::GetResizable (   )  [virtual]

Determines whether the toolbar is resizable.

virtual void vtkKWToolbar::ResizableOn (   )  [virtual]

Determines whether the toolbar is resizable.

virtual void vtkKWToolbar::ResizableOff (   )  [virtual]

Determines whether the toolbar is resizable.

virtual char* vtkKWToolbar::GetName (   )  [virtual]

Set/Get the name of the toolbar. This is optional but certainly useful if this toolbar is meant to be added to a vtkKWToolbarSet

virtual void vtkKWToolbar::SetName (  const char *   )  [virtual]

Set/Get the name of the toolbar. This is optional but certainly useful if this toolbar is meant to be added to a vtkKWToolbarSet

virtual void vtkKWToolbar::AddWidget (  vtkKWWidget *  widget  )  [virtual]

Add a widget to the toolbar, insert a widget before 'location' (or at beginning of list if 'location' is not found)

virtual void vtkKWToolbar::InsertWidget (  vtkKWWidget *  location, vtkKWWidget *  widget )  [virtual]

Add a widget to the toolbar, insert a widget before 'location' (or at beginning of list if 'location' is not found)

virtual int vtkKWToolbar::HasWidget (  vtkKWWidget *  widget  )  [virtual]

Query widgets

virtual int vtkKWToolbar::GetNumberOfWidgets (   )  [virtual]

Query widgets

virtual void vtkKWToolbar::RemoveWidget (  vtkKWWidget *  widget  )  [virtual]

Remove a widget (or all) from the toolbar

virtual void vtkKWToolbar::RemoveAllWidgets (   )  [virtual]

Remove a widget (or all) from the toolbar

virtual vtkKWWidget* vtkKWToolbar::GetWidget (  const char *  name  )  [virtual]

Convenience method to retrieve a widget given its name. The name is looked up in common Tk options like -label, -text, -image, -selectimage

virtual vtkKWWidget* vtkKWToolbar::GetNthWidget (  int  rank  )  [virtual]

Retrieve the nth- widget

vtkKWWidget* vtkKWToolbar::AddRadioButtonImage (  int  value, const char *  image_name, const char *  select_image_name, const char *  variable_name, vtkObject *  object, const char *  method, const char *  help = 0 )

Convenience method to create and add a specific type of widget Note: for radiobutton, the variable_name should be the same for each radiobutton in the set of radiobuttons. for checkbutton, this is only optional (can be NULL)

vtkKWWidget* vtkKWToolbar::AddCheckButtonImage (  const char *  image_name, const char *  select_image_name, const char *  variable_name, vtkObject *  object, const char *  method, const char *  help = 0 )

Convenience method to create and add a specific type of widget Note: for radiobutton, the variable_name should be the same for each radiobutton in the set of radiobuttons. for checkbutton, this is only optional (can be NULL)

virtual void vtkKWToolbar::UpdateWidgets (   )  [virtual]

Update/refresh the widgets layout/aspect

virtual void vtkKWToolbar::Update (   )  [virtual]

Update/refresh the toolbar layout/aspect (does not include the widgets)

virtual void vtkKWToolbar::SetFlatAspect (  int   )  [virtual]

Set/Get the flat aspect of the toolbar (flat or 3D GUI style) The static GlobalFlatAspect member can be set so that all toolbars are rendered using the same aspect.

virtual void vtkKWToolbar::FlatAspectOn (   )  [virtual]

Set/Get the flat aspect of the toolbar (flat or 3D GUI style) The static GlobalFlatAspect member can be set so that all toolbars are rendered using the same aspect.

virtual void vtkKWToolbar::FlatAspectOff (   )  [virtual]

Set/Get the flat aspect of the toolbar (flat or 3D GUI style) The static GlobalFlatAspect member can be set so that all toolbars are rendered using the same aspect.

virtual int vtkKWToolbar::GetFlatAspect (   )  [virtual]

Set/Get the flat aspect of the toolbar (flat or 3D GUI style) The static GlobalFlatAspect member can be set so that all toolbars are rendered using the same aspect.

int vtkKWToolbar::GetGlobalFlatAspect (   )  [static]

Set/Get the flat aspect of the toolbar (flat or 3D GUI style) The static GlobalFlatAspect member can be set so that all toolbars are rendered using the same aspect.

void vtkKWToolbar::SetGlobalFlatAspect (  int  val  )  [static]

Set/Get the flat aspect of the toolbar (flat or 3D GUI style) The static GlobalFlatAspect member can be set so that all toolbars are rendered using the same aspect. Referenced by GlobalFlatAspectOff(), and GlobalFlatAspectOn().

void vtkKWToolbar::GlobalFlatAspectOn (   )  [inline, static]

Set/Get the flat aspect of the toolbar (flat or 3D GUI style) The static GlobalFlatAspect member can be set so that all toolbars are rendered using the same aspect. Definition at line 125 of file vtkKWToolbar.h. References SetGlobalFlatAspect().

void vtkKWToolbar::GlobalFlatAspectOff (   )  [inline, static]

Set/Get the flat aspect of the toolbar (flat or 3D GUI style) The static GlobalFlatAspect member can be set so that all toolbars are rendered using the same aspect. Definition at line 127 of file vtkKWToolbar.h. References SetGlobalFlatAspect().

virtual void vtkKWToolbar::SetWidgetsFlatAspect (  int   )  [virtual]

Set/Get the flat aspect of the widgets (flat or 3D GUI style) The static GlobalWidgetsFlatAspect member can be set so that all widgets are rendered using the same aspect.

virtual void vtkKWToolbar::WidgetsFlatAspectOn (   )  [virtual]

Set/Get the flat aspect of the widgets (flat or 3D GUI style) The static GlobalWidgetsFlatAspect member can be set so that all widgets are rendered using the same aspect.

virtual void vtkKWToolbar::WidgetsFlatAspectOff (   )  [virtual]

Set/Get the flat aspect of the widgets (flat or 3D GUI style) The static GlobalWidgetsFlatAspect member can be set so that all widgets are rendered using the same aspect.

virtual int vtkKWToolbar::GetWidgetsFlatAspect (   )  [virtual]

Set/Get the flat aspect of the widgets (flat or 3D GUI style) The static GlobalWidgetsFlatAspect member can be set so that all widgets are rendered using the same aspect.

int vtkKWToolbar::GetGlobalWidgetsFlatAspect (   )  [static]

Set/Get the flat aspect of the widgets (flat or 3D GUI style) The static GlobalWidgetsFlatAspect member can be set so that all widgets are rendered using the same aspect.

void vtkKWToolbar::SetGlobalWidgetsFlatAspect (  int  val  )  [static]

Set/Get the flat aspect of the widgets (flat or 3D GUI style) The static GlobalWidgetsFlatAspect member can be set so that all widgets are rendered using the same aspect. Referenced by GlobalWidgetsFlatAspectOff(), and GlobalWidgetsFlatAspectOn().

void vtkKWToolbar::GlobalWidgetsFlatAspectOn (   )  [inline, static]

Set/Get the flat aspect of the widgets (flat or 3D GUI style) The static GlobalWidgetsFlatAspect member can be set so that all widgets are rendered using the same aspect. Definition at line 140 of file vtkKWToolbar.h. References SetGlobalWidgetsFlatAspect().

void vtkKWToolbar::GlobalWidgetsFlatAspectOff (   )  [inline, static]

Set/Get the flat aspect of the widgets (flat or 3D GUI style) The static GlobalWidgetsFlatAspect member can be set so that all widgets are rendered using the same aspect. Definition at line 142 of file vtkKWToolbar.h. References SetGlobalWidgetsFlatAspect().

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

Set/Get the padding that will be applied around each widget. (default to 0 on Windows, 1 otherwise).

virtual int vtkKWToolbar::GetWidgetsPadX (   )  [virtual]

Set/Get the padding that will be applied around each widget. (default to 0 on Windows, 1 otherwise).

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

Set/Get the padding that will be applied around each widget. (default to 0 on Windows, 1 otherwise).

virtual int vtkKWToolbar::GetWidgetsPadY (   )  [virtual]

Set/Get the padding that will be applied around each widget. (default to 0 on Windows, 1 otherwise).

virtual void vtkKWToolbar::SetWidgetsFlatAdditionalPadX (  int   )  [virtual]

Set/Get the additional internal padding that will be applied around each widget when WidgetsFlatAspect is On (default to 1).

virtual int vtkKWToolbar::GetWidgetsFlatAdditionalPadX (   )  [virtual]

Set/Get the additional internal padding that will be applied around each widget when WidgetsFlatAspect is On (default to 1).

virtual void vtkKWToolbar::SetWidgetsFlatAdditionalPadY (  int   )  [virtual]

Set/Get the additional internal padding that will be applied around each widget when WidgetsFlatAspect is On (default to 1).

virtual int vtkKWToolbar::GetWidgetsFlatAdditionalPadY (   )  [virtual]

Set/Get the additional internal padding that will be applied around each widget when WidgetsFlatAspect is On (default to 1).

virtual void vtkKWToolbar::ScheduleResize (   )  [virtual]

Callbacks to ensure all widgets are visible (only if the were added with AddWidget)

virtual void vtkKWToolbar::Resize (   )  [virtual]

Callbacks to ensure all widgets are visible (only if the were added with AddWidget)

virtual void vtkKWToolbar::UpdateEnableState (   )  [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (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. Reimplemented in vtkPVVCRControl.

void vtkKWToolbar::ConstrainWidgetsLayout (   )  [protected]

void vtkKWToolbar::UpdateWidgetsLayout (   )  [protected]

void vtkKWToolbar::UpdateWidgetsAspect (   )  [protected]

void vtkKWToolbar::UpdateToolbarFrameAspect (   )  [protected]

virtual void vtkKWToolbar::Bind (   )  [protected, virtual]

Bind/Unbind events.

virtual void vtkKWToolbar::UnBind (   )  [protected, virtual]

Bind/Unbind events.

---

Member Data Documentation

const char* vtkKWToolbar::FlatAspectRegKey [static]

Some constants BTX Definition at line 181 of file vtkKWToolbar.h.

const char* vtkKWToolbar::WidgetsFlatAspectRegKey [static]

Some constants BTX Definition at line 182 of file vtkKWToolbar.h.

int vtkKWToolbar::Expanding [protected]

Definition at line 190 of file vtkKWToolbar.h.

vtkKWFrame* vtkKWToolbar::Frame [protected]

Definition at line 192 of file vtkKWToolbar.h.

vtkKWFrame* vtkKWToolbar::Handle [protected]

Definition at line 193 of file vtkKWToolbar.h.

vtkKWToolbarInternals* vtkKWToolbar::Internals [protected]

PIMPL Encapsulation for STL containers Reimplemented from vtkKWWidget. Definition at line 204 of file vtkKWToolbar.h.

int vtkKWToolbar::WidgetsPadX [protected]

Definition at line 208 of file vtkKWToolbar.h.

int vtkKWToolbar::WidgetsPadY [protected]

Definition at line 209 of file vtkKWToolbar.h.

int vtkKWToolbar::WidgetsFlatAdditionalPadX [protected]

Definition at line 210 of file vtkKWToolbar.h.

int vtkKWToolbar::WidgetsFlatAdditionalPadY [protected]

Definition at line 211 of file vtkKWToolbar.h.

int vtkKWToolbar::FlatAspect [protected]

Definition at line 213 of file vtkKWToolbar.h.

int vtkKWToolbar::WidgetsFlatAspect [protected]

Definition at line 214 of file vtkKWToolbar.h.

int vtkKWToolbar::Resizable [protected]

Definition at line 215 of file vtkKWToolbar.h.

vtkKWRadioButton* vtkKWToolbar::DefaultOptionsWidget [protected]

Definition at line 217 of file vtkKWToolbar.h.

char* vtkKWToolbar::Name [protected]

Definition at line 219 of file vtkKWToolbar.h.

---

The documentation for this class was generated from the following file:

• GUI/Widgets/vtkKWToolbar.h

---