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

vtkKWFrameWithLabel Class Reference

a frame with a grooved border and a label More...

#include <vtkKWFrameWithLabel.h>

Inheritance diagram for vtkKWFrameWithLabel:

Inheritance graph
[legend]
Collaboration diagram for vtkKWFrameWithLabel:

Collaboration graph
[legend]
List of all members.

[NOHEADER]

enum  { LabelCaseUserSpecified = 0, LabelCaseUppercaseFirst, LabelCaseLowercaseFirst }
void SetDefaultLabelCase (int v)
int GetDefaultLabelCase ()
void SetDefaultLabelCaseToUserSpecified ()
void SetDefaultLabelCaseToUppercaseFirst ()
void SetDefaultLabelCaseToLowercaseFirst ()

[NOHEADER]

enum  { LabelFontWeightNormal = 0, LabelFontWeightBold }
void SetDefaultLabelFontWeight (int v)
int GetDefaultLabelFontWeight ()
void SetDefaultLabelFontWeightToNormal ()
void SetDefaultLabelFontWeightToBold ()

Public Types


Public Member Functions

 vtkTypeRevisionMacro (vtkKWFrameWithLabel, vtkKWCompositeWidget)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Create (vtkKWApplication *app)
void SetLabelText (const char *)
virtual vtkKWLabel * GetLabel ()
virtual void UpdateEnableState ()
virtual vtkKWDragAndDropTargetSet * GetDragAndDropTargetSet ()
virtual vtkKWFrame * GetFrame ()
virtual vtkKWFrame * GetLabelFrame ()
virtual void CollapseFrame ()
virtual void ExpandFrame ()
virtual int IsFrameCollapsed ()
virtual void SetAllowFrameToCollapse (int)
virtual void AllowFrameToCollapseOn ()
virtual void AllowFrameToCollapseOff ()
virtual int GetAllowFrameToCollapse ()
virtual void SetLimitedEditionModeIconVisibility (int)
virtual void LimitedEditionModeIconVisibilityOn ()
virtual void LimitedEditionModeIconVisibilityOff ()
virtual int GetLimitedEditionModeIconVisibility ()
virtual void AdjustMarginCallback ()
virtual void CollapseButtonCallback ()

Static Public Member Functions

vtkKWFrameWithLabel * New ()
int GetDefaultAllowFrameToCollapse ()
void SetDefaultAllowFrameToCollapse (int)
void DefaultAllowFrameToCollapseOn ()
void DefaultAllowFrameToCollapseOff ()

Protected Member Functions

 vtkKWFrameWithLabel ()
 ~vtkKWFrameWithLabel ()
virtual vtkKWLabel * GetLabelIcon ()

Protected Attributes

vtkKWFrame * Frame
vtkKWFrame * LabelFrame
vtkKWLabelWithLabel * Label
vtkKWFrame * Border
vtkKWFrame * Border2
vtkKWFrame * Groove
vtkKWLabel * Icon
vtkKWIcon * IconData
int AllowFrameToCollapse
int LimitedEditionModeIconVisibility

Static Protected Attributes

int DefaultAllowFrameToCollapse
int DefaultLabelFontWeight
int DefaultLabelCase

Detailed Description

a frame with a grooved border and a label

The vtkKWFrameWithLabel creates a frame with a grooved border, and a label embedded in the upper left corner of the grooved border.

Definition at line 32 of file vtkKWFrameWithLabel.h.

Member Enumeration Documentation

anonymous enum
 

Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. Defaults to LabelCaseUppercaseFirst. BTX

Enumeration values:
LabelCaseUserSpecified 
LabelCaseUppercaseFirst 
LabelCaseLowercaseFirst 

Definition at line 88 of file vtkKWFrameWithLabel.h.

anonymous enum
 

Globally enable or disable the font weight of the label. By default it is set to bold. BTX

Enumeration values:
LabelFontWeightNormal 
LabelFontWeightBold 

Definition at line 111 of file vtkKWFrameWithLabel.h.

Constructor & Destructor Documentation

vtkKWFrameWithLabel::vtkKWFrameWithLabel (   )  [protected]
 

vtkKWFrameWithLabel::~vtkKWFrameWithLabel (   )  [protected]
 

Member Function Documentation

vtkKWFrameWithLabel* vtkKWFrameWithLabel::New (   )  [static]
 

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWBoundsDisplay.

vtkKWFrameWithLabel::vtkTypeRevisionMacro (  vtkKWFrameWithLabel  ,
vtkKWCompositeWidget 
) 
 

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

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWBoundsDisplay.

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

Create the widget.

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWBoundsDisplay.

void vtkKWFrameWithLabel::SetLabelText (  const char *   ) 
 

Set the label for the frame.

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

Get the internal frame.

virtual vtkKWFrame* vtkKWFrameWithLabel::GetLabelFrame (   )  [virtual]
 

Get the internal frame containing the label.

virtual vtkKWLabel* vtkKWFrameWithLabel::GetLabel (   )  [virtual]
 

Get the label (frame title).

virtual void vtkKWFrameWithLabel::CollapseFrame (   )  [virtual]
 

Collapse/expand the frame.

virtual void vtkKWFrameWithLabel::ExpandFrame (   )  [virtual]
 

Collapse/expand the frame.

virtual int vtkKWFrameWithLabel::IsFrameCollapsed (   )  [virtual]
 

Collapse/expand the frame.

virtual void vtkKWFrameWithLabel::SetAllowFrameToCollapse (  int   )  [virtual]
 

Set/Get if the frame can be collapsed, i.e. display a button that will let the user collapse the frame. On by default.

virtual void vtkKWFrameWithLabel::AllowFrameToCollapseOn (   )  [virtual]
 

Set/Get if the frame can be collapsed, i.e. display a button that will let the user collapse the frame. On by default.

virtual void vtkKWFrameWithLabel::AllowFrameToCollapseOff (   )  [virtual]
 

Set/Get if the frame can be collapsed, i.e. display a button that will let the user collapse the frame. On by default.

virtual int vtkKWFrameWithLabel::GetAllowFrameToCollapse (   )  [virtual]
 

Set/Get if the frame can be collapsed, i.e. display a button that will let the user collapse the frame. On by default.

int vtkKWFrameWithLabel::GetDefaultAllowFrameToCollapse (   )  [static]
 

Globally set/get if the frame can be collapsed. By default it is globally enabled.

void vtkKWFrameWithLabel::SetDefaultAllowFrameToCollapse (  int   )  [static]
 

Globally set/get if the frame can be collapsed. By default it is globally enabled.

Referenced by DefaultAllowFrameToCollapseOff(), and DefaultAllowFrameToCollapseOn().

void vtkKWFrameWithLabel::DefaultAllowFrameToCollapseOn (   )  [inline, static]
 

Globally set/get if the frame can be collapsed. By default it is globally enabled.

Definition at line 78 of file vtkKWFrameWithLabel.h.

References SetDefaultAllowFrameToCollapse().

void vtkKWFrameWithLabel::DefaultAllowFrameToCollapseOff (   )  [inline, static]
 

Globally set/get if the frame can be collapsed. By default it is globally enabled.

Definition at line 80 of file vtkKWFrameWithLabel.h.

References SetDefaultAllowFrameToCollapse().

void vtkKWFrameWithLabel::SetDefaultLabelCase (  int  v  )  [static]
 

Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. Defaults to LabelCaseUppercaseFirst. BTX

Referenced by SetDefaultLabelCaseToLowercaseFirst(), SetDefaultLabelCaseToUppercaseFirst(), and SetDefaultLabelCaseToUserSpecified().

int vtkKWFrameWithLabel::GetDefaultLabelCase (   )  [static]
 

Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. Defaults to LabelCaseUppercaseFirst. BTX

void vtkKWFrameWithLabel::SetDefaultLabelCaseToUserSpecified (   )  [inline, static]
 

Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. Defaults to LabelCaseUppercaseFirst. BTX

Definition at line 97 of file vtkKWFrameWithLabel.h.

References LabelCaseUserSpecified, and SetDefaultLabelCase().

void vtkKWFrameWithLabel::SetDefaultLabelCaseToUppercaseFirst (   )  [inline, static]
 

Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. Defaults to LabelCaseUppercaseFirst. BTX

Definition at line 100 of file vtkKWFrameWithLabel.h.

References LabelCaseUppercaseFirst, and SetDefaultLabelCase().

void vtkKWFrameWithLabel::SetDefaultLabelCaseToLowercaseFirst (   )  [inline, static]
 

Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. Defaults to LabelCaseUppercaseFirst. BTX

Definition at line 103 of file vtkKWFrameWithLabel.h.

References LabelCaseLowercaseFirst, and SetDefaultLabelCase().

void vtkKWFrameWithLabel::SetDefaultLabelFontWeight (  int  v  )  [static]
 

Globally enable or disable the font weight of the label. By default it is set to bold. BTX

Referenced by SetDefaultLabelFontWeightToBold(), and SetDefaultLabelFontWeightToNormal().

int vtkKWFrameWithLabel::GetDefaultLabelFontWeight (   )  [static]
 

Globally enable or disable the font weight of the label. By default it is set to bold. BTX

void vtkKWFrameWithLabel::SetDefaultLabelFontWeightToNormal (   )  [inline, static]
 

Globally enable or disable the font weight of the label. By default it is set to bold. BTX

Definition at line 119 of file vtkKWFrameWithLabel.h.

References LabelFontWeightNormal, and SetDefaultLabelFontWeight().

void vtkKWFrameWithLabel::SetDefaultLabelFontWeightToBold (   )  [inline, static]
 

Globally enable or disable the font weight of the label. By default it is set to bold. BTX

Definition at line 122 of file vtkKWFrameWithLabel.h.

References LabelFontWeightBold, and SetDefaultLabelFontWeight().

virtual void vtkKWFrameWithLabel::SetLimitedEditionModeIconVisibility (  int   )  [virtual]
 

Set/Get the visibility of a special icon (lock) when the application is in Limited Edition Mode and the label frame is disabled.

virtual void vtkKWFrameWithLabel::LimitedEditionModeIconVisibilityOn (   )  [virtual]
 

Set/Get the visibility of a special icon (lock) when the application is in Limited Edition Mode and the label frame is disabled.

virtual void vtkKWFrameWithLabel::LimitedEditionModeIconVisibilityOff (   )  [virtual]
 

Set/Get the visibility of a special icon (lock) when the application is in Limited Edition Mode and the label frame is disabled.

virtual int vtkKWFrameWithLabel::GetLimitedEditionModeIconVisibility (   )  [virtual]
 

Set/Get the visibility of a special icon (lock) when the application is in Limited Edition Mode and the label frame is disabled.

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

virtual vtkKWDragAndDropTargetSet* vtkKWFrameWithLabel::GetDragAndDropTargetSet (   )  [virtual]
 

Get the drag and drop framework. Override the superclass to allow the frame to be dragged using the label.

Reimplemented from vtkKWWidget.

virtual void vtkKWFrameWithLabel::AdjustMarginCallback (   )  [virtual]
 

Callback Ask the frame to readjust its tops margin according to the content of the LabelFrame. This method if bound to a "Configure" event, so the widget should adjust itself automatically most of the time.

virtual void vtkKWFrameWithLabel::CollapseButtonCallback (   )  [virtual]
 

Callback Ask the frame to readjust its tops margin according to the content of the LabelFrame. This method if bound to a "Configure" event, so the widget should adjust itself automatically most of the time.

virtual vtkKWLabel* vtkKWFrameWithLabel::GetLabelIcon (   )  [protected, virtual]
 

Member Data Documentation

vtkKWFrame* vtkKWFrameWithLabel::Frame [protected]
 

Definition at line 161 of file vtkKWFrameWithLabel.h.

vtkKWFrame* vtkKWFrameWithLabel::LabelFrame [protected]
 

Definition at line 162 of file vtkKWFrameWithLabel.h.

vtkKWLabelWithLabel* vtkKWFrameWithLabel::Label [protected]
 

Definition at line 163 of file vtkKWFrameWithLabel.h.

vtkKWFrame* vtkKWFrameWithLabel::Border [protected]
 

Definition at line 164 of file vtkKWFrameWithLabel.h.

vtkKWFrame* vtkKWFrameWithLabel::Border2 [protected]
 

Definition at line 165 of file vtkKWFrameWithLabel.h.

vtkKWFrame* vtkKWFrameWithLabel::Groove [protected]
 

Definition at line 166 of file vtkKWFrameWithLabel.h.

vtkKWLabel* vtkKWFrameWithLabel::Icon [protected]
 

Definition at line 167 of file vtkKWFrameWithLabel.h.

vtkKWIcon* vtkKWFrameWithLabel::IconData [protected]
 

Definition at line 168 of file vtkKWFrameWithLabel.h.

int vtkKWFrameWithLabel::AllowFrameToCollapse [protected]
 

Definition at line 170 of file vtkKWFrameWithLabel.h.

int vtkKWFrameWithLabel::LimitedEditionModeIconVisibility [protected]
 

Definition at line 171 of file vtkKWFrameWithLabel.h.

int vtkKWFrameWithLabel::DefaultAllowFrameToCollapse [static, protected]
 

Definition at line 173 of file vtkKWFrameWithLabel.h.

int vtkKWFrameWithLabel::DefaultLabelFontWeight [static, protected]
 

Definition at line 174 of file vtkKWFrameWithLabel.h.

int vtkKWFrameWithLabel::DefaultLabelCase [static, protected]
 

Definition at line 175 of file vtkKWFrameWithLabel.h.

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