vtkKWSplitFrame Class Reference

A Frame that contains two adjustable sub frames. More...

#include <vtkKWSplitFrame.h>

Inheritance diagram for vtkKWSplitFrame:

[legend]Collaboration diagram for vtkKWSplitFrame:


[NOHEADER]
enum	{ OrientationHorizontal = 0, OrientationVertical }
virtual void	SetOrientation (int)
virtual int	GetOrientation ()
virtual void	SetOrientationToHorizontal ()
virtual void	SetOrientationToVertical ()
[NOHEADER]
enum	{ FrameLayoutDefault = 0, FrameLayoutSwapped }
virtual void	SetFrameLayout (int)
virtual int	GetFrameLayout ()
virtual void	SetFrameLayoutToDefault ()
virtual void	SetFrameLayoutToSwapped ()
[NOHEADER]
enum	{ ExpandableFrame1 = 0, ExpandableFrame2, ExpandableFrameBoth }
virtual void	SetExpandableFrame (int)
virtual int	GetExpandableFrame ()
virtual void	SetExpandableFrameToFrame1 ()
virtual void	SetExpandableFrameToFrame2 ()
virtual void	SetExpandableFrameToBothFrames ()
Public Types
Public Member Functions
	vtkTypeRevisionMacro (vtkKWSplitFrame, vtkKWCompositeWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
vtkKWFrame *	GetFrame1 ()
vtkKWFrame *	GetFrame2 ()
virtual void	UpdateEnableState ()

virtual int	GetFrame1MinimumSize ()
virtual void	SetFrame1MinimumSize (int minSize)
virtual int	GetFrame1Size ()
virtual void	SetFrame1Size (int size)
virtual int	GetFrame1Visibility ()
virtual void	SetFrame1Visibility (int flag)
virtual void	Frame1VisibilityOn ()
virtual void	Frame1VisibilityOff ()

virtual int	GetFrame2MinimumSize ()
virtual void	SetFrame2MinimumSize (int minSize)
virtual int	GetFrame2Size ()
virtual void	SetFrame2Size (int size)
virtual int	GetFrame2Visibility ()
virtual void	SetFrame2Visibility (int flag)
virtual void	Frame2VisibilityOn ()
virtual void	Frame2VisibilityOff ()

virtual void	SetSeparatorSize (int size)
virtual int	GetSeparatorSize ()

virtual void	SetSeparatorMargin (int size)
virtual int	GetSeparatorMargin ()

virtual void	SetSeparatorVisibility (int flag)
virtual int	GetSeparatorVisibility ()
virtual void	SeparatorVisibilityOn ()
virtual void	SeparatorVisibilityOff ()

virtual void	DragCallback ()
virtual void	ConfigureCallback ()
Static Public Member Functions
vtkKWSplitFrame *	New ()
Protected Member Functions
	vtkKWSplitFrame ()
	~vtkKWSplitFrame ()
virtual int	GetTotalSeparatorSize ()
virtual void	Pack ()
virtual void	AddBindings ()
virtual void	RemoveBindings ()
virtual void	AddSeparatorBindings ()
virtual void	RemoveSeparatorBindings ()
virtual void	ReConfigure ()
virtual int	GetInternalMarginHorizontal ()
virtual int	GetInternalMarginVertical ()
virtual void	ConfigureSeparatorCursor ()
Protected Attributes
vtkKWFrame *	Frame1
vtkKWFrame *	Separator
vtkKWFrame *	Frame2
int	Size
int	Frame1Size
int	Frame2Size
int	SeparatorSize
int	SeparatorMargin
int	SeparatorVisibility
int	Frame1Visibility
int	Frame2Visibility
int	Frame1MinimumSize
int	Frame2MinimumSize
int	Orientation
int	FrameLayout
int	ExpandableFrame

Detailed Description

A Frame that contains two adjustable sub frames.

The split frame allows the use to select the size of the two frames. It uses a separator that can be dragged interactively.

Definition at line 28 of file vtkKWSplitFrame.h.

Member Enumeration Documentation

anonymous enum

Set/Get the orientation of the split frame. If horizontal, Frame1 is on the left of the separator, Frame2 on the right. If Vertical, Frame1 is below the separator, Frame2 is on top. Both Frame1 and Frame2 position can be swapped using the SetFrameLayout method. BTX
Enumeration values:

OrientationHorizontal

OrientationVertical

Definition at line 55 of file vtkKWSplitFrame.h.

anonymous enum

Set/Get the the frame layout. If set to Default, depending on the orientation, Frame1 is on the left (respectively bottom) of the separator, Frame2 on the right (top). If set to Swapped, Frame1 and Frame2 position are exchanged. BTX
Enumeration values:

FrameLayoutDefault

FrameLayoutSwapped

Definition at line 74 of file vtkKWSplitFrame.h.

anonymous enum

Set/Get which frame is automatically expanded when the whole widget is resized. By default, Frame2 (i.e. right or top frame) BTX
Enumeration values:

ExpandableFrame1

ExpandableFrame2

ExpandableFrameBoth

Definition at line 91 of file vtkKWSplitFrame.h.

Constructor & Destructor Documentation

vtkKWSplitFrame::vtkKWSplitFrame ( ) [protected]

vtkKWSplitFrame::~vtkKWSplitFrame ( ) [protected]

Member Function Documentation

vtkKWSplitFrame* vtkKWSplitFrame::New ( ) [static]

Reimplemented from vtkKWCompositeWidget.

vtkKWSplitFrame::vtkTypeRevisionMacro ( vtkKWSplitFrame ,

vtkKWCompositeWidget

)

void vtkKWSplitFrame::PrintSelf ( ostream & os,

vtkIndent indent

)

Reimplemented from vtkKWCompositeWidget.

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

Create the widget.
Reimplemented from vtkKWCompositeWidget.

vtkKWFrame* vtkKWSplitFrame::GetFrame1 ( ) [inline]

Get Frame1. In horizontal orientation, this is the one on the left of the separator. In vertical orientation, the one at the bottom. Both Frame1 and Frame2 position can be swapped using the SetFrameLayout method.
Definition at line 42 of file vtkKWSplitFrame.h.

vtkKWFrame* vtkKWSplitFrame::GetFrame2 ( ) [inline]

Get Frame2. In horizontal orientation, this is the one on the right of the separator. In vertical orientation, the one at the top. Both Frame1 and Frame2 position can be swapped using the SetFrameLayout method.
Definition at line 48 of file vtkKWSplitFrame.h.

virtual void vtkKWSplitFrame::SetOrientation ( int ) [virtual]

Set/Get the orientation of the split frame. If horizontal, Frame1 is on the left of the separator, Frame2 on the right. If Vertical, Frame1 is below the separator, Frame2 is on top. Both Frame1 and Frame2 position can be swapped using the SetFrameLayout method. BTX

virtual int vtkKWSplitFrame::GetOrientation ( ) [virtual]

Set/Get the orientation of the split frame. If horizontal, Frame1 is on the left of the separator, Frame2 on the right. If Vertical, Frame1 is below the separator, Frame2 is on top. Both Frame1 and Frame2 position can be swapped using the SetFrameLayout method. BTX

virtual void vtkKWSplitFrame::SetOrientationToHorizontal ( ) [inline, virtual]

Set/Get the orientation of the split frame. If horizontal, Frame1 is on the left of the separator, Frame2 on the right. If Vertical, Frame1 is below the separator, Frame2 is on top. Both Frame1 and Frame2 position can be swapped using the SetFrameLayout method. BTX
Definition at line 63 of file vtkKWSplitFrame.h.
References OrientationHorizontal.

virtual void vtkKWSplitFrame::SetOrientationToVertical ( ) [inline, virtual]

Set/Get the orientation of the split frame. If horizontal, Frame1 is on the left of the separator, Frame2 on the right. If Vertical, Frame1 is below the separator, Frame2 is on top. Both Frame1 and Frame2 position can be swapped using the SetFrameLayout method. BTX
Definition at line 65 of file vtkKWSplitFrame.h.
References OrientationVertical.

virtual void vtkKWSplitFrame::SetFrameLayout ( int ) [virtual]

Set/Get the the frame layout. If set to Default, depending on the orientation, Frame1 is on the left (respectively bottom) of the separator, Frame2 on the right (top). If set to Swapped, Frame1 and Frame2 position are exchanged. BTX

virtual int vtkKWSplitFrame::GetFrameLayout ( ) [virtual]

Set/Get the the frame layout. If set to Default, depending on the orientation, Frame1 is on the left (respectively bottom) of the separator, Frame2 on the right (top). If set to Swapped, Frame1 and Frame2 position are exchanged. BTX

virtual void vtkKWSplitFrame::SetFrameLayoutToDefault ( ) [inline, virtual]

Set/Get the the frame layout. If set to Default, depending on the orientation, Frame1 is on the left (respectively bottom) of the separator, Frame2 on the right (top). If set to Swapped, Frame1 and Frame2 position are exchanged. BTX
Definition at line 82 of file vtkKWSplitFrame.h.
References FrameLayoutDefault.

virtual void vtkKWSplitFrame::SetFrameLayoutToSwapped ( ) [inline, virtual]

Set/Get the the frame layout. If set to Default, depending on the orientation, Frame1 is on the left (respectively bottom) of the separator, Frame2 on the right (top). If set to Swapped, Frame1 and Frame2 position are exchanged. BTX
Definition at line 84 of file vtkKWSplitFrame.h.
References FrameLayoutSwapped.

virtual void vtkKWSplitFrame::SetExpandableFrame ( int ) [virtual]

Set/Get which frame is automatically expanded when the whole widget is resized. By default, Frame2 (i.e. right or top frame) BTX

virtual int vtkKWSplitFrame::GetExpandableFrame ( ) [virtual]

Set/Get which frame is automatically expanded when the whole widget is resized. By default, Frame2 (i.e. right or top frame) BTX

virtual void vtkKWSplitFrame::SetExpandableFrameToFrame1 ( ) [inline, virtual]

Set/Get which frame is automatically expanded when the whole widget is resized. By default, Frame2 (i.e. right or top frame) BTX
Definition at line 102 of file vtkKWSplitFrame.h.
References ExpandableFrame1.

virtual void vtkKWSplitFrame::SetExpandableFrameToFrame2 ( ) [inline, virtual]

Set/Get which frame is automatically expanded when the whole widget is resized. By default, Frame2 (i.e. right or top frame) BTX
Definition at line 104 of file vtkKWSplitFrame.h.
References ExpandableFrame2.

virtual void vtkKWSplitFrame::SetExpandableFrameToBothFrames ( ) [inline, virtual]

Set/Get which frame is automatically expanded when the whole widget is resized. By default, Frame2 (i.e. right or top frame) BTX
Definition at line 106 of file vtkKWSplitFrame.h.
References ExpandableFrameBoth.

virtual int vtkKWSplitFrame::GetFrame1MinimumSize ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame1.

virtual void vtkKWSplitFrame::SetFrame1MinimumSize ( int minSize ) [virtual]

Set/Get The minimum size, size and visibility of Frame1.

virtual int vtkKWSplitFrame::GetFrame1Size ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame1.

virtual void vtkKWSplitFrame::SetFrame1Size ( int size ) [virtual]

Set/Get The minimum size, size and visibility of Frame1.

virtual int vtkKWSplitFrame::GetFrame1Visibility ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame1.

virtual void vtkKWSplitFrame::SetFrame1Visibility ( int flag ) [virtual]

Set/Get The minimum size, size and visibility of Frame1.

virtual void vtkKWSplitFrame::Frame1VisibilityOn ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame1.

virtual void vtkKWSplitFrame::Frame1VisibilityOff ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame1.

virtual int vtkKWSplitFrame::GetFrame2MinimumSize ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame2.

virtual void vtkKWSplitFrame::SetFrame2MinimumSize ( int minSize ) [virtual]

Set/Get The minimum size, size and visibility of Frame2.

virtual int vtkKWSplitFrame::GetFrame2Size ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame2.

virtual void vtkKWSplitFrame::SetFrame2Size ( int size ) [virtual]

Set/Get The minimum size, size and visibility of Frame2.

virtual int vtkKWSplitFrame::GetFrame2Visibility ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame2.

virtual void vtkKWSplitFrame::SetFrame2Visibility ( int flag ) [virtual]

Set/Get The minimum size, size and visibility of Frame2.

virtual void vtkKWSplitFrame::Frame2VisibilityOn ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame2.

virtual void vtkKWSplitFrame::Frame2VisibilityOff ( ) [virtual]

Set/Get The minimum size, size and visibility of Frame2.

virtual void vtkKWSplitFrame::SetSeparatorSize ( int size ) [virtual]

Set/Get the separator narrow dimension. If the size is 0, then the two frames cannot be adjusted by the user.

virtual int vtkKWSplitFrame::GetSeparatorSize ( ) [virtual]

Set/Get the separator narrow dimension. If the size is 0, then the two frames cannot be adjusted by the user.

virtual void vtkKWSplitFrame::SetSeparatorMargin ( int size ) [virtual]

Set/Get the separator narrow margin, i.e. the empty space around the separator itself.

virtual int vtkKWSplitFrame::GetSeparatorMargin ( ) [virtual]

Set/Get the separator narrow margin, i.e. the empty space around the separator itself.

virtual void vtkKWSplitFrame::SetSeparatorVisibility ( int flag ) [virtual]

Set/Get the visibility of the separator.

virtual int vtkKWSplitFrame::GetSeparatorVisibility ( ) [virtual]

Set/Get the visibility of the separator.

virtual void vtkKWSplitFrame::SeparatorVisibilityOn ( ) [virtual]

Set/Get the visibility of the separator.

virtual void vtkKWSplitFrame::SeparatorVisibilityOff ( ) [virtual]

Set/Get the visibility of the separator.

virtual void vtkKWSplitFrame::DragCallback ( ) [virtual]

Callbacks used internally to adjust the size,

virtual void vtkKWSplitFrame::ConfigureCallback ( ) [virtual]

Callbacks used internally to adjust the size,

virtual void vtkKWSplitFrame::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 int vtkKWSplitFrame::GetTotalSeparatorSize ( ) [protected, virtual]

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

virtual void vtkKWSplitFrame::AddBindings ( ) [protected, virtual]

virtual void vtkKWSplitFrame::RemoveBindings ( ) [protected, virtual]

virtual void vtkKWSplitFrame::AddSeparatorBindings ( ) [protected, virtual]

virtual void vtkKWSplitFrame::RemoveSeparatorBindings ( ) [protected, virtual]

virtual void vtkKWSplitFrame::ReConfigure ( ) [protected, virtual]

virtual int vtkKWSplitFrame::GetInternalMarginHorizontal ( ) [protected, virtual]

virtual int vtkKWSplitFrame::GetInternalMarginVertical ( ) [protected, virtual]

virtual void vtkKWSplitFrame::ConfigureSeparatorCursor ( ) [protected, virtual]

Member Data Documentation

vtkKWFrame* vtkKWSplitFrame::Frame1 [protected]

Definition at line 173 of file vtkKWSplitFrame.h.

vtkKWFrame* vtkKWSplitFrame::Separator [protected]

Definition at line 174 of file vtkKWSplitFrame.h.

vtkKWFrame* vtkKWSplitFrame::Frame2 [protected]

Definition at line 175 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::Size [protected]

Definition at line 177 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::Frame1Size [protected]

Definition at line 178 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::Frame2Size [protected]

Definition at line 179 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::SeparatorSize [protected]

Definition at line 181 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::SeparatorMargin [protected]

Definition at line 182 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::SeparatorVisibility [protected]

Definition at line 183 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::Frame1Visibility [protected]

Definition at line 185 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::Frame2Visibility [protected]

Definition at line 186 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::Frame1MinimumSize [protected]

Definition at line 188 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::Frame2MinimumSize [protected]

Definition at line 189 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::Orientation [protected]

Definition at line 191 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::FrameLayout [protected]

Definition at line 192 of file vtkKWSplitFrame.h.

int vtkKWSplitFrame::ExpandableFrame [protected]

Definition at line 193 of file vtkKWSplitFrame.h.

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

GUI/Widgets/vtkKWSplitFrame.h

Generated on Tue May 30 12:44:57 2006 for ParaView by

1.3.5

vtkKWSplitFrame Class Reference

[NOHEADER]

[NOHEADER]

[NOHEADER]

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation