vtkKWWidgetWithScrollbars Class Reference

an abstract class for composite widgets associated to two vtkKWScrollbar's More...

#include <vtkKWWidgetWithScrollbars.h>

Inheritance diagram for vtkKWWidgetWithScrollbars:

[legend]

Collaboration diagram for vtkKWWidgetWithScrollbars:

[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 void	UpdateEnableState ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkKWWidgetWithScrollbars *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWWidgetWithScrollbars ()
	~vtkKWWidgetWithScrollbars ()
virtual void	CreateWidget ()

int	VerticalScrollbarVisibility
int	HorizontalScrollbarVisibility
vtkKWScrollbar *	VerticalScrollbar
vtkKWScrollbar *	HorizontalScrollbar
virtual void	SetVerticalScrollbarVisibility (int val)
virtual int	GetVerticalScrollbarVisibility ()
virtual void	VerticalScrollbarVisibilityOn ()
virtual void	VerticalScrollbarVisibilityOff ()
virtual void	SetHorizontalScrollbarVisibility (int val)
virtual int	GetHorizontalScrollbarVisibility ()
virtual void	HorizontalScrollbarVisibilityOn ()
virtual void	HorizontalScrollbarVisibilityOff ()
virtual vtkKWScrollbar *	GetVerticalScrollbar ()
virtual vtkKWScrollbar *	GetHorizontalScrollbar ()
virtual void	CreateHorizontalScrollbar ()
virtual void	CreateVerticalScrollbar ()
virtual void	AssociateHorizontalScrollbarToWidget (vtkKWCoreWidget *widget)
virtual void	AssociateVerticalScrollbarToWidget (vtkKWCoreWidget *widget)
virtual void	Pack ()=0
virtual void	PackScrollbarsWithWidget (vtkKWWidget *widget)

Detailed Description

an abstract class for composite widgets associated to two vtkKWScrollbar's

This provide a boilerplate for a composite widget associated to a horizontal and vertical scrollbars.

Be aware that most subclasses of vtkKWWidgetWithScrollbars are generated automatically out of the vtkKWWidgetWithScrollbarsSubclass template located in the Templates directory. Therefore, even though the source code for those vtkKWWidgetWithScrollbars subclasses does not exist in the KWWidgets repository, they are still generated automatically and documented in the API online; check the vtkKWWidgetWithScrollbars API online for its subclasses, as well as the KWWidgets Auto-Generated Classes page. Classes related to the same template can be found in the KWWidgets Auto-Generated Classes: Widget With Scrollbars section.

See also:: vtkKWCanvasWithScrollbars vtkKWListBoxWithScrollbars vtkKWMultiColumnListWithScrollbars vtkKWTextWithScrollbars vtkKWTreeWithScrollbars

Definition at line 41 of file vtkKWWidgetWithScrollbars.h.

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWWidgetWithScrollbars::Superclass

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

Definition at line 45 of file vtkKWWidgetWithScrollbars.h.

Constructor & Destructor Documentation

vtkKWWidgetWithScrollbars::vtkKWWidgetWithScrollbars ( ) [protected]

vtkKWWidgetWithScrollbars::~vtkKWWidgetWithScrollbars ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

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

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

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

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

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

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

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

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

virtual void vtkKWWidgetWithScrollbars::SetVerticalScrollbarVisibility ( int val ) [virtual]

Set/Get the vertical scrollbar visibility (default to On).

virtual int vtkKWWidgetWithScrollbars::GetVerticalScrollbarVisibility ( ) [virtual]

Scrollbar visibility flags

virtual void vtkKWWidgetWithScrollbars::VerticalScrollbarVisibilityOn ( ) [virtual]

Scrollbar visibility flags

virtual void vtkKWWidgetWithScrollbars::VerticalScrollbarVisibilityOff ( ) [virtual]

Scrollbar visibility flags

virtual void vtkKWWidgetWithScrollbars::SetHorizontalScrollbarVisibility ( int val ) [virtual]

Set/Get the horizontal scrollbar visibility (default to On).

virtual int vtkKWWidgetWithScrollbars::GetHorizontalScrollbarVisibility ( ) [virtual]

Scrollbar visibility flags

virtual void vtkKWWidgetWithScrollbars::HorizontalScrollbarVisibilityOn ( ) [virtual]

Scrollbar visibility flags

virtual void vtkKWWidgetWithScrollbars::HorizontalScrollbarVisibilityOff ( ) [virtual]

Scrollbar visibility flags

virtual vtkKWScrollbar* vtkKWWidgetWithScrollbars::GetVerticalScrollbar ( ) [virtual]

Access the internal scrollbars.

virtual vtkKWScrollbar* vtkKWWidgetWithScrollbars::GetHorizontalScrollbar ( ) [virtual]

Scrollbar visibility flags

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

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

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

Create the widget.

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

virtual void vtkKWWidgetWithScrollbars::CreateHorizontalScrollbar ( ) [protected, virtual]

Create scrollbars and associate the scrollbars to a widget by setting up the callbacks between both instances. The associated *has* to be made for this class to work, but since we do not know the internal widget at that point, it is up to the subclass to reimplement both Create*Scrollbar() methods and have them simply call the super and the Associate*Scrollbar() methods with the internal argument as parameter.

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

virtual void vtkKWWidgetWithScrollbars::CreateVerticalScrollbar ( ) [protected, virtual]

Scrollbar visibility flags

Reimplemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

virtual void vtkKWWidgetWithScrollbars::AssociateHorizontalScrollbarToWidget ( vtkKWCoreWidget * widget ) [protected, virtual]

Scrollbar visibility flags

virtual void vtkKWWidgetWithScrollbars::AssociateVerticalScrollbarToWidget ( vtkKWCoreWidget * widget ) [protected, virtual]

Scrollbar visibility flags

virtual void vtkKWWidgetWithScrollbars::Pack ( ) [protected, pure virtual]

Pack or repack the widget. This should be implemented by subclasses, but a convenience function PackScrollbarsWithWidget() can be called from the subclass just as easily.

Implemented in vtkKWTreeWithScrollbars, vtkKWCanvasWithScrollbars, vtkKWListBoxWithScrollbars, vtkKWMultiColumnListWithScrollbars, and vtkKWTextWithScrollbars.

virtual void vtkKWWidgetWithScrollbars::PackScrollbarsWithWidget ( vtkKWWidget * widget ) [protected, virtual]

Scrollbar visibility flags