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.

Public Types
typedef vtkKWCompositeWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkKWWidget *	GetWidget (const char *name)
virtual vtkKWWidget *	GetNthWidget (int rank)
virtual void	UpdateWidgets ()
virtual void	Update ()
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWToolbar *	New ()
static int	IsTypeOf (const char *type)
static vtkKWToolbar *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWToolbar ()
	~vtkKWToolbar ()
virtual void	CreateWidget ()
void	ConstrainWidgetsLayout ()
void	UpdateWidgetsLayout ()
void	UpdateWidgetsAspect ()
void	UpdateToolbarFrameAspect ()
Protected Attributes
int	Expanding
vtkKWFrame *	Frame
vtkKWFrame *	Handle
vtkKWToolbarInternals *	Internals
int	WidgetsPadX
int	WidgetsPadY
int	WidgetsFlatAdditionalPadX
int	WidgetsFlatAdditionalPadY
int	WidgetsInternalPadX
int	WidgetsInternalPadY
int	WidgetsFlatAdditionalInternalPadX
int	WidgetsFlatAdditionalInternalPadY
int	ToolbarAspect
int	WidgetsAspect
int	Resizable
vtkKWRadioButton *	DefaultOptionsWidget
char *	Name

enum	{ ToolbarAspectRelief = 0, ToolbarAspectFlat = 1, ToolbarAspectUnChanged }
enum	{ WidgetsAspectRelief = 0, WidgetsAspectFlat = 1, WidgetsAspectUnChanged }
static const char *	ToolbarAspectRegKey
static const char *	WidgetsAspectRegKey
static int	GetGlobalToolbarAspect ()
static void	SetGlobalToolbarAspect (int val)
static void	SetGlobalToolbarAspectToFlat ()
static void	SetGlobalToolbarAspectToRelief ()
static void	SetGlobalToolbarAspectToUnChanged ()
static int	GetGlobalWidgetsAspect ()
static void	SetGlobalWidgetsAspect (int val)
static void	SetGlobalWidgetsAspectToFlat ()
static void	SetGlobalWidgetsAspectToRelief ()
static void	SetGlobalWidgetsAspectToUnChanged ()
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 void	AddSeparator ()
virtual void	InsertSeparator (vtkKWWidget *location)
virtual int	HasWidget (vtkKWWidget *widget)
virtual int	GetNumberOfWidgets ()
virtual void	RemoveWidget (vtkKWWidget *widget)
virtual void	RemoveAllWidgets ()
virtual void	SetWidgetVisibility (vtkKWWidget *widget, int val)
virtual int	GetWidgetVisibility (vtkKWWidget *widget)
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 int	GetToolbarAspect ()
virtual void	SetToolbarAspect (int)
virtual void	SetToolbarAspectToFlat ()
virtual void	SetToolbarAspectToRelief ()
virtual void	SetToolbarAspectToUnChanged ()
virtual int	GetWidgetsAspect ()
virtual void	SetWidgetsAspect (int)
virtual void	SetWidgetsAspectToFlat ()
virtual void	SetWidgetsAspectToRelief ()
virtual void	SetWidgetsAspectToUnChanged ()
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	SetWidgetsFlatAdditionalPadX (int)
virtual int	GetWidgetsFlatAdditionalPadX ()
virtual void	SetWidgetsFlatAdditionalPadY (int)
virtual int	GetWidgetsFlatAdditionalPadY ()
virtual void	SetWidgetsFlatAdditionalInternalPadX (int)
virtual int	GetWidgetsFlatAdditionalInternalPadX ()
virtual void	SetWidgetsFlatAdditionalInternalPadY (int)
virtual int	GetWidgetsFlatAdditionalInternalPadY ()
virtual void	ScheduleResize ()
virtual void	Resize ()
virtual void	Bind ()
virtual void	UnBind ()

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 31 of file vtkKWToolbar.h.

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWToolbar::Superclass

Reimplemented from vtkKWCompositeWidget.

Definition at line 36 of file vtkKWToolbar.h.

Member Enumeration Documentation

anonymous enum

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

Enumerator:

ToolbarAspectRelief
ToolbarAspectFlat
ToolbarAspectUnChanged

Definition at line 128 of file vtkKWToolbar.h.

anonymous enum

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

Enumerator:

WidgetsAspectRelief
WidgetsAspectFlat
WidgetsAspectUnChanged

Definition at line 151 of file vtkKWToolbar.h.

Constructor & Destructor Documentation

vtkKWToolbar::vtkKWToolbar ( ) [protected]

vtkKWToolbar::~vtkKWToolbar ( ) [protected]

Member Function Documentation

static vtkKWToolbar* vtkKWToolbar::New ( ) [static]

Reimplemented from vtkKWCompositeWidget.

virtual const char* vtkKWToolbar::GetClassName ( ) [virtual]

Reimplemented from vtkKWCompositeWidget.

static int vtkKWToolbar::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWToolbar::IsA ( const char * type ) [virtual]

Reimplemented from vtkKWCompositeWidget.

static vtkKWToolbar* vtkKWToolbar::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkKWCompositeWidget.

void vtkKWToolbar::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Reimplemented from vtkKWCompositeWidget.

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]

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

virtual void vtkKWToolbar::ResizableOn ( ) [virtual]

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

virtual void vtkKWToolbar::ResizableOff ( ) [virtual]

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

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 aspect of the toolbar (flat or 3D GUI style, or unchanged) The static GlobalToolbarAspect member can be set so that all toolbars are rendered using the same aspect. BTX

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]`

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

virtual void vtkKWToolbar::AddSeparator ( ) [virtual]

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

virtual void vtkKWToolbar::InsertSeparator ( vtkKWWidget * location ) [virtual]

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

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

Query widgets

virtual int vtkKWToolbar::GetNumberOfWidgets ( ) [virtual]

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

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

Remove a widget (or all) from the toolbar

virtual void vtkKWToolbar::RemoveAllWidgets ( ) [virtual]

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

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

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

virtual void vtkKWToolbar::SetWidgetVisibility	(	vtkKWWidget *	widget,
		int	val
	)			`[virtual]`

Set/Get widget visibility

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

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

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`
	)

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`
	)

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

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 int vtkKWToolbar::GetToolbarAspect ( ) [virtual]

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

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

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

virtual void vtkKWToolbar::SetToolbarAspectToFlat ( ) [virtual]

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

virtual void vtkKWToolbar::SetToolbarAspectToRelief ( ) [virtual]

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

virtual void vtkKWToolbar::SetToolbarAspectToUnChanged ( ) [virtual]

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

static int vtkKWToolbar::GetGlobalToolbarAspect ( ) [static]

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

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

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

static void vtkKWToolbar::SetGlobalToolbarAspectToFlat ( ) [static]

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

static void vtkKWToolbar::SetGlobalToolbarAspectToRelief ( ) [static]

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

static void vtkKWToolbar::SetGlobalToolbarAspectToUnChanged ( ) [static]

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

virtual int vtkKWToolbar::GetWidgetsAspect ( ) [virtual]

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

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

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

virtual void vtkKWToolbar::SetWidgetsAspectToFlat ( ) [virtual]

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

virtual void vtkKWToolbar::SetWidgetsAspectToRelief ( ) [virtual]

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

virtual void vtkKWToolbar::SetWidgetsAspectToUnChanged ( ) [virtual]

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

static int vtkKWToolbar::GetGlobalWidgetsAspect ( ) [static]

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

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

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

static void vtkKWToolbar::SetGlobalWidgetsAspectToFlat ( ) [static]

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

static void vtkKWToolbar::SetGlobalWidgetsAspectToRelief ( ) [static]

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

static void vtkKWToolbar::SetGlobalWidgetsAspectToUnChanged ( ) [static]

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

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 aspect of the toolbar (flat or 3D GUI style, or unchanged) The static GlobalToolbarAspect member can be set so that all toolbars are rendered using the same aspect. BTX

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

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

virtual int vtkKWToolbar::GetWidgetsPadY ( ) [virtual]

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

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

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

virtual int vtkKWToolbar::GetWidgetsInternalPadX ( ) [virtual]

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

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

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

virtual int vtkKWToolbar::GetWidgetsInternalPadY ( ) [virtual]

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

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

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

virtual int vtkKWToolbar::GetWidgetsFlatAdditionalPadX ( ) [virtual]

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

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

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

virtual int vtkKWToolbar::GetWidgetsFlatAdditionalPadY ( ) [virtual]

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

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

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

virtual int vtkKWToolbar::GetWidgetsFlatAdditionalInternalPadX ( ) [virtual]

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

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

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

virtual int vtkKWToolbar::GetWidgetsFlatAdditionalInternalPadY ( ) [virtual]

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

virtual void vtkKWToolbar::ScheduleResize ( ) [virtual]

Schedule the widget to resize itself, or resize it right away

virtual void vtkKWToolbar::Resize ( ) [virtual]

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

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.

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

Create the widget.

Reimplemented from vtkKWCompositeWidget.

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]

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

Member Data Documentation

const char* vtkKWToolbar::ToolbarAspectRegKey [static]

Some constants BTX

Definition at line 222 of file vtkKWToolbar.h.

const char* vtkKWToolbar::WidgetsAspectRegKey [static]

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

Definition at line 223 of file vtkKWToolbar.h.

int vtkKWToolbar::Expanding [protected]

Definition at line 236 of file vtkKWToolbar.h.

vtkKWFrame* vtkKWToolbar::Frame [protected]

Definition at line 238 of file vtkKWToolbar.h.

vtkKWFrame* vtkKWToolbar::Handle [protected]

Definition at line 239 of file vtkKWToolbar.h.

vtkKWToolbarInternals* vtkKWToolbar::Internals [protected]

PIMPL Encapsulation for STL containers

Reimplemented from vtkKWCoreWidget.

Definition at line 250 of file vtkKWToolbar.h.

int vtkKWToolbar::WidgetsPadX [protected]