a superclass for creating wizards UI. More...
#include <vtkKWWizardWidget.h>
a superclass for creating wizards UI.
This class is the basis for a wizard widget/dialog. It embeds a wizard workflow (i.e. a state machine) and tie it to navigation buttons. This widget can be inserted directly inside another user interface; most of the time, however, people will use a vtkKWWizardDialog, which is just an independent toplevel embedding a vtkKWWizardWidget.
Definition at line 44 of file vtkKWWizardWidget.h.
Reimplemented from vtkKWCompositeWidget.
Definition at line 49 of file vtkKWWizardWidget.h.
| anonymous enum |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
Definition at line 185 of file vtkKWWizardWidget.h.
| vtkKWWizardWidget::vtkKWWizardWidget | ( | ) | [protected] |
| vtkKWWizardWidget::~vtkKWWizardWidget | ( | ) | [protected] |
| static vtkKWWizardWidget* vtkKWWizardWidget::New | ( | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| virtual const char* vtkKWWizardWidget::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| static int vtkKWWizardWidget::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| virtual int vtkKWWizardWidget::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| static vtkKWWizardWidget* vtkKWWizardWidget::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| void vtkKWWizardWidget::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| virtual vtkKWWizardWorkflow* vtkKWWizardWidget::GetWizardWorkflow | ( | ) | [virtual] |
Get the wizard workflow instance.
| virtual vtkKWFrame* vtkKWWizardWidget::GetClientArea | ( | ) | [virtual] |
Get the client area. This is where user content should be placed. A wizard workflow is made of steps (vtkKWWizardStep). Each step should set its vtkKWWizardStep::ShowUserInterfaceCommand callback to point to a method that will display this step's UI (or reimplement vtkKWWizardStep::ShowUserInterface). Within that method, all widgets should be children of this ClientArea.
| virtual void vtkKWWizardWidget::SetClientAreaMinimumHeight | ( | int | ) | [virtual] |
Set the minimum client area height. No effect if called before Create().
| virtual void vtkKWWizardWidget::Update | ( | ) | [virtual] |
Refresh the interface. This important method will refresh the state of the buttons, depending on the current workflow navigation stack. If the workflow's FinishStep step is defined, it will invoke its CanGoToSelf method/callback to check if it can be reached directly, and enable the Finish button accordingly. This method should be called each time modifying the UI of the current step may have an impact on navigating the workflow. For example, updating the value of a specific entry may forbid the user to move to the Finish step directly. Check the entry's API for callbacks that can be triggered with a small granularity (vtkKWEntry::Command, vtkKWEntry::SetCommandTriggerToAnyChange, vtkKWScale::Command, etc.).
| virtual void vtkKWWizardWidget::SetTitle | ( | const char * | ) | [virtual] |
Set the title text (usually a few words), located in the top area. Note that this method is called automatically by Update() to display the name of the WizardWorkflow's CurrentStep() step (see the vtkKWWizardStep::GetName() method).
| virtual char* vtkKWWizardWidget::GetTitle | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetSubTitle | ( | const char * | ) | [virtual] |
Set the subtitle text (usually a short sentence or two), located in the top area below the title. Note that this method is called automatically by Update() to display the description of the WizardWorkflow's CurrentStep() step (see the vtkKWWizardStep::GetDescription() method).
| virtual char* vtkKWWizardWidget::GetSubTitle | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::GetTitleAreaBackgroundColor | ( | double * | r, | |
| double * | g, | |||
| double * | b | |||
| ) | [virtual] |
Set/Get the background color of the title area.
| virtual double* vtkKWWizardWidget::GetTitleAreaBackgroundColor | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetTitleAreaBackgroundColor | ( | double | r, | |
| double | g, | |||
| double | b | |||
| ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetTitleAreaBackgroundColor | ( | double | rgb[3] | ) | [inline, virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
Definition at line 108 of file vtkKWWizardWidget.h.
| virtual vtkKWLabel* vtkKWWizardWidget::GetTitleIconLabel | ( | ) | [virtual] |
Get the wizard icon, located in the top area right of the title. This can be used to provide a better graphical identity to the wizard.
| virtual void vtkKWWizardWidget::SetPreText | ( | const char * | ) | [virtual] |
Set the pre-text, i.e. the contents of a convenience text section placed just above the client area.
| virtual char* vtkKWWizardWidget::GetPreText | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetPostText | ( | const char * | ) | [virtual] |
Set the post-text, i.e. the contents of a convenience text section placed just below the client area.
| virtual char* vtkKWWizardWidget::GetPostText | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetErrorText | ( | const char * | ) | [virtual] |
Set the error text, i.e. the contents of a convenience text section placed just below the client area. It is prefixed with an error icon. This is typically used by a step's vtkKWWizardStep::Validate method/callback to report an error when validating the UI failed.
| virtual char* vtkKWWizardWidget::GetErrorText | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::ClearPage | ( | ) | [virtual] |
Unpack all children in the client-area and set all pre-/post-/title label to empty strings. This is typically used by a step's vtkKWWizardStep::HideUserInterfaceCommand callback (or the vtkKWWizardStep::HideUserInterface method) to hide the step's UI or release resources that were allocated specifically for a step's UI.
| virtual void vtkKWWizardWidget::SetBackButtonVisibility | ( | int | ) | [virtual] |
Set/Get the visibility of the buttons.
| virtual int vtkKWWizardWidget::GetBackButtonVisibility | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::BackButtonVisibilityOn | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::BackButtonVisibilityOff | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetNextButtonVisibility | ( | int | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual int vtkKWWizardWidget::GetNextButtonVisibility | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::NextButtonVisibilityOn | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::NextButtonVisibilityOff | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetFinishButtonVisibility | ( | int | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual int vtkKWWizardWidget::GetFinishButtonVisibility | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::FinishButtonVisibilityOn | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::FinishButtonVisibilityOff | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetCancelButtonVisibility | ( | int | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual int vtkKWWizardWidget::GetCancelButtonVisibility | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::CancelButtonVisibilityOn | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::CancelButtonVisibilityOff | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetHelpButtonVisibility | ( | int | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual int vtkKWWizardWidget::GetHelpButtonVisibility | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::HelpButtonVisibilityOn | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::HelpButtonVisibilityOff | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetOKButtonVisibility | ( | int | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual int vtkKWWizardWidget::GetOKButtonVisibility | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::OKButtonVisibilityOn | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::OKButtonVisibilityOff | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual vtkKWPushButton* vtkKWWizardWidget::GetCancelButton | ( | ) | [virtual] |
Get and customize some UI elements.
| virtual vtkKWPushButton* vtkKWWizardWidget::GetOKButton | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual vtkKWPushButton* vtkKWWizardWidget::GetFinishButton | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual vtkKWPushButton* vtkKWWizardWidget::GetHelpButton | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual vtkKWSeparator* vtkKWWizardWidget::GetSeparatorBeforeButtons | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual vtkKWLabel* vtkKWWizardWidget::GetSubTitleLabel | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual vtkKWLabel* vtkKWWizardWidget::GetTitleLabel | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetButtonsPosition | ( | int | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual int vtkKWWizardWidget::GetButtonsPosition | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
| virtual void vtkKWWizardWidget::SetButtonsPositionToTop | ( | ) | [inline, virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
Definition at line 193 of file vtkKWWizardWidget.h.
| virtual void vtkKWWizardWidget::SetButtonsPositionToBottom | ( | ) | [inline, virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
Definition at line 195 of file vtkKWWizardWidget.h.
| virtual void vtkKWWizardWidget::AddCallbackCommandObservers | ( | ) | [virtual] |
Add all the default observers needed by that object, or remove all the observers that were added through AddCallbackCommandObserver. Subclasses can override these methods to add/remove their own default observers, but should call the superclass too.
Reimplemented from vtkKWObject.
| virtual void vtkKWWizardWidget::RemoveCallbackCommandObservers | ( | ) | [virtual] |
If supported, set the label position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. BTX
Reimplemented from vtkKWObject.
| virtual void vtkKWWizardWidget::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 void vtkKWWizardWidget::CreateWidget | ( | ) | [protected, virtual] |
Create the widget
Reimplemented from vtkKWCompositeWidget.
| virtual void vtkKWWizardWidget::PackButtons | ( | ) | [protected, virtual] |
Pack the buttons.
| virtual void vtkKWWizardWidget::ProcessCallbackCommandEvents | ( | vtkObject * | caller, | |
| unsigned long | event, | |||
| void * | calldata | |||
| ) | [protected, virtual] |
Processes the events that are passed through CallbackCommand (or others). Subclasses can oberride this method to process their own events, but should call the superclass too.
Reimplemented from vtkKWObject.
int vtkKWWizardWidget::ButtonsPosition [protected] |
Definition at line 228 of file vtkKWWizardWidget.h.
int vtkKWWizardWidget::BackButtonVisibility [protected] |
Definition at line 230 of file vtkKWWizardWidget.h.
int vtkKWWizardWidget::NextButtonVisibility [protected] |
Definition at line 231 of file vtkKWWizardWidget.h.
int vtkKWWizardWidget::FinishButtonVisibility [protected] |
Definition at line 232 of file vtkKWWizardWidget.h.
int vtkKWWizardWidget::CancelButtonVisibility [protected] |
Definition at line 233 of file vtkKWWizardWidget.h.
int vtkKWWizardWidget::HelpButtonVisibility [protected] |
Definition at line 234 of file vtkKWWizardWidget.h.
int vtkKWWizardWidget::OKButtonVisibility [protected] |
Definition at line 235 of file vtkKWWizardWidget.h.
vtkKWWizardWorkflow* vtkKWWizardWidget::WizardWorkflow [protected] |
Definition at line 237 of file vtkKWWizardWidget.h.
vtkKWFrame* vtkKWWizardWidget::TitleFrame [protected] |
Definition at line 239 of file vtkKWWizardWidget.h.
vtkKWLabel* vtkKWWizardWidget::TitleLabel [protected] |
Definition at line 240 of file vtkKWWizardWidget.h.
vtkKWLabel* vtkKWWizardWidget::SubTitleLabel [protected] |
Definition at line 241 of file vtkKWWizardWidget.h.
vtkKWLabel* vtkKWWizardWidget::TitleIconLabel [protected] |
Definition at line 242 of file vtkKWWizardWidget.h.
vtkKWSeparator* vtkKWWizardWidget::SeparatorAfterTitleArea [protected] |
Definition at line 244 of file vtkKWWizardWidget.h.
vtkKWFrame* vtkKWWizardWidget::LayoutFrame [protected] |
Definition at line 246 of file vtkKWWizardWidget.h.
vtkKWLabel* vtkKWWizardWidget::PreTextLabel [protected] |
Definition at line 247 of file vtkKWWizardWidget.h.
vtkKWFrame* vtkKWWizardWidget::ClientArea [protected] |
Definition at line 248 of file vtkKWWizardWidget.h.
vtkKWLabel* vtkKWWizardWidget::PostTextLabel [protected] |
Definition at line 249 of file vtkKWWizardWidget.h.
vtkKWLabelWithLabel* vtkKWWizardWidget::ErrorTextLabel [protected] |
Definition at line 250 of file vtkKWWizardWidget.h.
vtkKWSeparator* vtkKWWizardWidget::SeparatorBeforeButtons [protected] |
Definition at line 252 of file vtkKWWizardWidget.h.
vtkKWFrame* vtkKWWizardWidget::ButtonFrame [protected] |
Definition at line 254 of file vtkKWWizardWidget.h.
vtkKWPushButton* vtkKWWizardWidget::BackButton [protected] |
Definition at line 255 of file vtkKWWizardWidget.h.
vtkKWPushButton* vtkKWWizardWidget::NextButton [protected] |
Definition at line 256 of file vtkKWWizardWidget.h.
vtkKWPushButton* vtkKWWizardWidget::FinishButton [protected] |
Definition at line 257 of file vtkKWWizardWidget.h.
vtkKWPushButton* vtkKWWizardWidget::CancelButton [protected] |
Definition at line 258 of file vtkKWWizardWidget.h.
vtkKWPushButton* vtkKWWizardWidget::HelpButton [protected] |
Definition at line 259 of file vtkKWWizardWidget.h.
vtkKWPushButton* vtkKWWizardWidget::OKButton [protected] |
Definition at line 260 of file vtkKWWizardWidget.h.
1.6.1
