a frame with a grooved border and a label More...
#include <vtkKWFrameWithLabel.h>
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 31 of file vtkKWFrameWithLabel.h.
Reimplemented from vtkKWCompositeWidget.
Definition at line 36 of file vtkKWFrameWithLabel.h.
| anonymous enum |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Definition at line 93 of file vtkKWFrameWithLabel.h.
| anonymous enum |
Globally enable or disable the font weight of the label. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. By default it is set to bold. BTX
Definition at line 120 of file vtkKWFrameWithLabel.h.
| vtkKWFrameWithLabel::vtkKWFrameWithLabel | ( | ) | [protected] |
| vtkKWFrameWithLabel::~vtkKWFrameWithLabel | ( | ) | [protected] |
| static vtkKWFrameWithLabel* vtkKWFrameWithLabel::New | ( | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| virtual const char* vtkKWFrameWithLabel::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| static int vtkKWFrameWithLabel::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| virtual int vtkKWFrameWithLabel::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| static vtkKWFrameWithLabel* vtkKWFrameWithLabel::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| void vtkKWFrameWithLabel::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| 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] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual int vtkKWFrameWithLabel::IsFrameCollapsed | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| 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] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual void vtkKWFrameWithLabel::AllowFrameToCollapseOff | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual int vtkKWFrameWithLabel::GetAllowFrameToCollapse | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| static int vtkKWFrameWithLabel::GetDefaultAllowFrameToCollapse | ( | ) | [static] |
Globally Set/Get if the frame can be collapsed. NOTE: this is a static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. By default it is globally enabled.
| static void vtkKWFrameWithLabel::SetDefaultAllowFrameToCollapse | ( | int | ) | [static] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| static void vtkKWFrameWithLabel::DefaultAllowFrameToCollapseOn | ( | ) | [inline, static] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Definition at line 79 of file vtkKWFrameWithLabel.h.
| static void vtkKWFrameWithLabel::DefaultAllowFrameToCollapseOff | ( | ) | [inline, static] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Definition at line 81 of file vtkKWFrameWithLabel.h.
| static 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. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| static int vtkKWFrameWithLabel::GetDefaultLabelCase | ( | ) | [static] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| static 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. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Definition at line 102 of file vtkKWFrameWithLabel.h.
| static 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. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Definition at line 105 of file vtkKWFrameWithLabel.h.
| static 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. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Definition at line 108 of file vtkKWFrameWithLabel.h.
| static void vtkKWFrameWithLabel::SetDefaultLabelFontWeight | ( | int | v | ) | [static] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| static int vtkKWFrameWithLabel::GetDefaultLabelFontWeight | ( | ) | [static] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| static void vtkKWFrameWithLabel::SetDefaultLabelFontWeightToNormal | ( | ) | [inline, static] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Definition at line 128 of file vtkKWFrameWithLabel.h.
| static void vtkKWFrameWithLabel::SetDefaultLabelFontWeightToBold | ( | ) | [inline, static] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Definition at line 131 of file vtkKWFrameWithLabel.h.
| 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] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual void vtkKWFrameWithLabel::LimitedEditionModeIconVisibilityOff | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual int vtkKWFrameWithLabel::GetLimitedEditionModeIconVisibility | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual void vtkKWFrameWithLabel::SetChangePackingOnCollapse | ( | int | ) | [virtual] |
Set/Get if the packing options should be changed automatically when the frame is collapsed/uncollapsed. This if OFF by default. WARNING: turning this option will modify the -expand attribute in the packing options automatically. Packing is usually the responsibility of the user, and no widget instance would usually change its own packing option automatically, since this could be considered pulling the rug out from under the user's feet. However, in some very specific case (say, when packing a vtkKWMultiColumnList), you would want the widget packed inside the frame with label to expand automatically. This can not be done without allowing the vtkKWFrameWithLabel instance to expand automatically as well, which is not compatible with the "collapsed" more. To work around this, the -expand flag of the vtkKWFrameWithLabel has to be changed automatically back and forth each time the frame is collapsed/uncollapsed. Turning this variable ON will take care of it.
| virtual void vtkKWFrameWithLabel::ChangePackingOnCollapseOn | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual void vtkKWFrameWithLabel::ChangePackingOnCollapseOff | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual int vtkKWFrameWithLabel::GetChangePackingOnCollapse | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| 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.
| 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::SetWidth | ( | int | ) | [virtual] |
Override parent's SetWidth/SetHeight to propagate to internal frames. A frame's size can be set explicitly, until something else is packed inside.
Reimplemented from vtkKWFrame.
| virtual int vtkKWFrameWithLabel::GetWidth | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Reimplemented from vtkKWFrame.
| virtual void vtkKWFrameWithLabel::SetHeight | ( | int | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Reimplemented from vtkKWFrame.
| virtual int vtkKWFrameWithLabel::GetHeight | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
Reimplemented from vtkKWFrame.
| virtual vtkKWFrame* vtkKWFrameWithLabel::GetCollapsibleFrame | ( | ) | [virtual] |
Get the internal frame responsible for drawing the collapsible border.
| virtual void vtkKWFrameWithLabel::AdjustMarginCallback | ( | ) | [virtual] |
Callbacks. Internal, do not use.
| virtual void vtkKWFrameWithLabel::CollapseButtonCallback | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual void vtkKWFrameWithLabel::LabelDoubleClickCallback | ( | ) | [virtual] |
Globally override the case of the label to ensure GUI consistency. This will change the label when SetLabelText() is called. NOTE: this is a *static* method that defines the behaviour for *all* instances of this class to be created afterwards. This is typically called in your application class or your main executable, before creating any UI; this will ensure all instances have a consistent look. Defaults to LabelCaseUppercaseFirst. BTX
| virtual void vtkKWFrameWithLabel::CreateWidget | ( | ) | [protected, virtual] |
Create the widget.
Reimplemented from vtkKWCompositeWidget.
| virtual vtkKWLabel* vtkKWFrameWithLabel::GetLabelIcon | ( | ) | [protected, virtual] |
vtkKWFrame* vtkKWFrameWithLabel::Frame [protected] |
Definition at line 209 of file vtkKWFrameWithLabel.h.
vtkKWFrame* vtkKWFrameWithLabel::LabelFrame [protected] |
Definition at line 210 of file vtkKWFrameWithLabel.h.
vtkKWLabelWithLabel* vtkKWFrameWithLabel::Label [protected] |
Definition at line 211 of file vtkKWFrameWithLabel.h.
vtkKWFrame* vtkKWFrameWithLabel::ExternalMarginFrame [protected] |
Definition at line 212 of file vtkKWFrameWithLabel.h.
vtkKWFrame* vtkKWFrameWithLabel::InternalMarginFrame [protected] |
Definition at line 213 of file vtkKWFrameWithLabel.h.
vtkKWFrame* vtkKWFrameWithLabel::CollapsibleFrame [protected] |
Definition at line 214 of file vtkKWFrameWithLabel.h.
vtkKWLabel* vtkKWFrameWithLabel::Icon [protected] |
Definition at line 215 of file vtkKWFrameWithLabel.h.
vtkKWIcon* vtkKWFrameWithLabel::IconData [protected] |
Definition at line 216 of file vtkKWFrameWithLabel.h.
int vtkKWFrameWithLabel::AllowFrameToCollapse [protected] |
Definition at line 218 of file vtkKWFrameWithLabel.h.
int vtkKWFrameWithLabel::ChangePackingOnCollapse [protected] |
Definition at line 219 of file vtkKWFrameWithLabel.h.
int vtkKWFrameWithLabel::LimitedEditionModeIconVisibility [protected] |
Definition at line 220 of file vtkKWFrameWithLabel.h.
int vtkKWFrameWithLabel::DefaultAllowFrameToCollapse [static, protected] |
Definition at line 222 of file vtkKWFrameWithLabel.h.
int vtkKWFrameWithLabel::DefaultLabelFontWeight [static, protected] |
Definition at line 223 of file vtkKWFrameWithLabel.h.
int vtkKWFrameWithLabel::DefaultLabelCase [static, protected] |
Definition at line 224 of file vtkKWFrameWithLabel.h.
1.6.1
