a wizard step. More...
#include <vtkKWWizardStep.h>
a wizard step.
This class is the basis for a wizard step. A wizard step is a placeholder for various states, transitions and inputs that are used in a typical wizard workflow. Such steps can be added to instances of the vtkKWWizardWorkflow class (subclass of vtkKWStateMachine). A wizard workflow can be manipulated from a user interface through either the vtkKWWizardWidget or vtkKWWizardDialog classes.
Definition at line 52 of file vtkKWWizardStep.h.
Reimplemented from vtkKWObject.
Definition at line 58 of file vtkKWWizardStep.h.
| anonymous enum |
Events. BTX
Definition at line 99 of file vtkKWWizardStep.h.
| vtkKWWizardStep::vtkKWWizardStep | ( | ) | [protected] |
| vtkKWWizardStep::~vtkKWWizardStep | ( | ) | [protected] |
| static vtkKWWizardStep* vtkKWWizardStep::New | ( | ) | [static] |
Reimplemented from vtkKWObject.
| virtual const char* vtkKWWizardStep::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkKWObject.
| static int vtkKWWizardStep::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkKWObject.
| virtual int vtkKWWizardStep::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkKWObject.
| static vtkKWWizardStep* vtkKWWizardStep::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkKWObject.
| void vtkKWWizardStep::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Reimplemented from vtkKWObject.
| virtual vtkIdType vtkKWWizardStep::GetId | ( | ) | [virtual] |
Get id.
| virtual char* vtkKWWizardStep::GetName | ( | ) | [virtual] |
Set/Get simple name.
| virtual void vtkKWWizardStep::SetName | ( | const char * | ) | [virtual] |
Events. BTX
| virtual char* vtkKWWizardStep::GetDescription | ( | ) | [virtual] |
Set/Get short description.
| virtual void vtkKWWizardStep::SetDescription | ( | const char * | ) | [virtual] |
Events. BTX
| virtual void vtkKWWizardStep::ShowUserInterface | ( | ) | [virtual] |
Show the user interface associated to that step. Wizard developpers can either reimplement the ShowUserInterface method in a vtkKWWizardStep subclass (*do* call the superclass' ShowUserInterface first), or create a vtkKWWizardStep instance and set the ShowUserInterfaceCommand to point to a callback of their choice. Either ways, these methods will be invoked automatically when the state machine enters the step's InteractionState state. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.
| virtual void vtkKWWizardStep::SetShowUserInterfaceCommand | ( | vtkObject * | object, | |
| const char * | method | |||
| ) | [virtual] |
Events. BTX
| virtual void vtkKWWizardStep::InvokeShowUserInterfaceCommand | ( | ) | [virtual] |
Events. BTX
| virtual int vtkKWWizardStep::HasShowUserInterfaceCommand | ( | ) | [virtual] |
Events. BTX
| virtual void vtkKWWizardStep::HideUserInterface | ( | ) | [virtual] |
Hide the user interface associated to that step. Wizard developpers can either reimplement the HideUserInterface method in a vtkKWWizardStep subclass (*do* call the superclass' HideUserInterface first), or create a vtkKWWizardStep instance and set the HideUserInterfaceCommand to point to a callback of their choice. Either ways, these methods will be invoked automatically by transitions that move the state machine from one step to another step, such as the ones created by the vtkKWWizardWorkflow::AddNextStep(), vtkKWWizardWorkflow::CreateNextTransition() or vtkKWWizardWorkflow::CreateBackTransition() methods. While this method/callback can be used to release resources that were allocated specifically for a step's UI, calling the vtkKWWizardWidget::ClearPage() method will do the trick most of the time when the wizard workflow is working in conjunction with a vtkKWWizardWidget. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.
| virtual void vtkKWWizardStep::SetHideUserInterfaceCommand | ( | vtkObject * | object, | |
| const char * | method | |||
| ) | [virtual] |
Events. BTX
| virtual void vtkKWWizardStep::InvokeHideUserInterfaceCommand | ( | ) | [virtual] |
Events. BTX
| virtual int vtkKWWizardStep::HasHideUserInterfaceCommand | ( | ) | [virtual] |
Events. BTX
| virtual void vtkKWWizardStep::Validate | ( | ) | [virtual] |
Validate the user interface associated to that step. Wizard developpers can either reimplement the Validate method in a vtkKWWizardStep subclass (*do* call the superclass' Validate first), or create a vtkKWWizardStep instance and set the ValidateCommand to point to a callback of their choice. Either ways, these important methods are called when the ValidationTransition transition is triggered by the ValidationInput input, effectively moving the state machine from the InteractionState state to the ValidationState state. It is the responsibility of this method/callback to push inputs that will move the state machine to the next step (using the ValidationSucceededInput input for example), or back to the InteractionState on error (using the ValidationFailedInput input and the ValidationFailedTransition transition). User-defined inputs can be pushed as well if the step has potentially multiple "valid" next steps. Pushing the ValidationSucceededInput input will trigger transitions such as the one created by the vtkKWWizardWorkflow::AddNextStep() or vtkKWWizardWorkflow::CreateNextTransition() methods. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.
| virtual void vtkKWWizardStep::SetValidateCommand | ( | vtkObject * | object, | |
| const char * | method | |||
| ) | [virtual] |
Events. BTX
| virtual void vtkKWWizardStep::InvokeValidateCommand | ( | ) | [virtual] |
Events. BTX
| virtual int vtkKWWizardStep::HasValidateCommand | ( | ) | [virtual] |
Events. BTX
| virtual int vtkKWWizardStep::CanGoToSelf | ( | ) | [virtual] |
Check if one can go directly to this step, given the model associated to the wizard workflow. Wizard developpers can either reimplement the CanGoToSelf method in a vtkKWWizardStep subclass (*do* check if the CanGoToSelfCommand is set though, and invoke it in priority), or create a vtkKWWizardStep instance and set the CanGoToSelfCommand to point to a callback of their choice. Either ways, these methods can be used when there is a need to know if one can go directly to this step, effectively bypassing all others steps: this should be used very* carefully, and is provided to implement features such as the "Finish" button in a wizard widget. This method/command should return 1 if the step can be reached, 0 otherwise. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.
| virtual void vtkKWWizardStep::SetCanGoToSelfCommand | ( | vtkObject * | object, | |
| const char * | method | |||
| ) | [virtual] |
Events. BTX
| virtual int vtkKWWizardStep::InvokeCanGoToSelfCommand | ( | ) | [virtual] |
Events. BTX
| virtual int vtkKWWizardStep::HasCanGoToSelfCommand | ( | ) | [virtual] |
Events. BTX
| virtual vtkKWStateMachineState* vtkKWWizardStep::GetInteractionState | ( | ) | [virtual] |
Get the step's interaction state. This state is used to display the user interface pertaining to this step, then wait for more user inputs. Note that this class listens to the InteractionState's vtkKWStateMachineState::EnterEvent event; as this event is triggered, the ShowUserInterface() method is automatically called (hence the InvokeShowUserInterfaceCommand() as well). Access to this state is given for advanced customization. In the vast majority of wizards, it should be ignored; the ShowUserInterface method or callback is however the key component to define for this state to work as expected.
| virtual vtkKWStateMachineState* vtkKWWizardStep::GetValidationState | ( | ) | [virtual] |
Get the step's validation state. This state is used to validate the user interface pertaining to this step (as displayed by the InteractionState state), then branch to the next step's InteractionState state on success, or back to the current step's InteractionState state on error. The state acts as a hub: the validation itself is performed by the ValidateCommand callback (or Validate method for the corresponding step) attached to the ValidationTransition transition that sits between the InteractionState state and the ValidationState state. Access to this state is given for advanced customization. In the vast majority of wizards, it should be ignored; the ValidateCommand (or the Validate method) is however the key component to define for this state to work as expected.
| virtual vtkKWStateMachineTransition* vtkKWWizardStep::GetValidationTransition | ( | ) | [virtual] |
Get the step's validation transition. This transition is used to validate the user interface pertaining to this step (as displayed by the InteractionState state), then branch to the next step's InteractionState state on success, or back to the current step's InteractionState state on error. More specifically: - its originating state is the InteractionState state, - its destination state is the ValidationState state, - it is triggered by the ValidationInput input. Note that this class listens to the ValidationTransition's vtkKWStateMachineTransition::EndEvent event; as this even is triggered, the Validate() method is automatically called (hence the InvokeValidateCommand() method as well). Wizard developpers reimplement the Validate method or can set ValidateCommand to point to a method of their choice to validate the step's UI; it will be invoked automatically when the state machine triggers the ValidationTransition transition. The wizard workflow (or wizard widget) will typically push a ValidationInput input on the queue to request a step to be validated and move to the next step. If the state machine is at an InteractionState state, the corresponding step's ValidationTransition transition will be triggered, the state machine will move to the ValidationState state and validation will occur through the ValidateCommand callback or Validate method. This method/callback will push inputs that in turn will move the state machine to the next step (using the ValidationSucceededInput input for example), or back to the InteractionState on error (using the ValidationFailedInput input and the ValidationFailedTransition transition). Access to this transition is given for advanced customization. In the vast majority of wizards, it should be ignored; the ValidateCommand (or Validate method) is however the key component to define for this transition to work as expected, since it is where the ValidationSucceededInput, ValidationFailedInput and user-defined inputs should be pushed.
| static vtkKWStateMachineInput* vtkKWWizardStep::GetValidationInput | ( | ) | [static] |
Get the step's validation input. This singleton input is used to trigger the ValidationTransition transition and move the state machine from the InteractionState state to the ValidationState state. Access to this input is given for advanced customization. In the vast majority of wizards, it should be ignored; the wizard workflow (or wizard widget) will typically push a ValidationInput input on the queue to request a step to be validated and move to the next step. If the state machine is at an InteractionState state, the corresponding step's ValidationTransition transition will be triggered, the state machine will move to the ValidationState state and validation will occur through the ValidateCommand callback (or Validate method).
| static vtkKWStateMachineInput* vtkKWWizardStep::GetValidationSucceededInput | ( | ) | [static] |
Get the step's validation successful input. This singleton input is used in the ValidateCommand callback and in conjunction with the workflow class (vtkKWWizardWorkflow) to trigger a transition from the step's ValidationState state to the next step's InteractionState state. It is, as far as the workflow is concerned, the input that moves the state machine from one step to the other. The corresponding transition can be created automatically by the vtkKWWizardWorkflow::AddNextStep() or vtkKWWizardWorkflow::CreateNextTransition() methods. The ValidateCommand callback (or Validate method) is the key component where this input is used.
| static vtkKWStateMachineInput* vtkKWWizardStep::GetValidationFailedInput | ( | ) | [static] |
Get the step's validation failed input. This singleton input is used in the ValidateCommand callback (or Validate method) and in conjunction with the workflow class (vtkKWWizardWorkflow) to trigger the ValidationFailedTransition transition from the step's ValidationState state back to the step's InteractionState state. The ValidateCommand callback (or Validate method) is the key component where this input is used.
| virtual vtkKWStateMachineTransition* vtkKWWizardStep::GetValidationFailedTransition | ( | ) | [virtual] |
Get the step's validation failed transition. This transition is used to bring the state machine from the ValidationState state back to the InteractionState state, when validation of the user interface pertaining to this step failed (as displayed by the InteractionState state). More specifically: - its originating state is the ValidationState state, - its destination state is the InteractionState state, - it is triggered by the ValidationFailedInput input. Important: it is up to the wizard developpers to push the ValidationFailedInput input on the state machine queue *from* the ValidateCommand callback (or Validate method) for the state machine to trigger that transition and go back to the InteractionState state. Access to this transition is given for advanced customization. In the vast majority of wizards, it should be ignored; the ValidateCommand callback (or Validate method) is the key component to define for this transition to work as expected, since it is where the ValidationFailedInput input should be pushed.
| virtual vtkKWStateMachineInput* vtkKWWizardStep::GetGoToSelfInput | ( | ) | [virtual] |
Get the step's go to self input. This input is used to trigger transition that are meant to move the state machine directly to this step, effectively bypassing all others steps: this should be used very carefully, and is provided only to implement features such as the "Finish" button in a wizard widget. Access to this input is given for advanced customization. In the vast majority of wizards, it should be ignored; it is used by the vtkKWWizardWorkflow::CreateGoToTransition() method to implement transitions to specific steps directly (the "Finish" step, for example).
| virtual vtkKWStateMachineInput* vtkKWWizardStep::GetGoBackToSelfInput | ( | ) | [virtual] |
Get the step's go back to self input. This input is used to trigger transitions that are meant to move the state machine back to the previous step (if any): this should be used very carefully, and is provided only to implement features such as the "Back" or "Finish" button in a wizard widget. Access to this input is given for advanced customization. In the vast majority of wizards, it should be ignored; it is used by the vtkKWWizardWorkflow::CreateBackTransition() method to implement transitions back to specific steps directly.
| virtual void vtkKWWizardStep::RemoveCallbackCommandObservers | ( | ) | [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 vtkKWWizardStep::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.
friend class vtkKWWizardStepCleanup [friend] |
Definition at line 373 of file vtkKWWizardStep.h.
vtkIdType vtkKWWizardStep::Id [protected] |
Definition at line 334 of file vtkKWWizardStep.h.
char* vtkKWWizardStep::Name [protected] |
Definition at line 335 of file vtkKWWizardStep.h.
char* vtkKWWizardStep::Description [protected] |
Definition at line 336 of file vtkKWWizardStep.h.
char* vtkKWWizardStep::ShowUserInterfaceCommand [protected] |
Definition at line 338 of file vtkKWWizardStep.h.
char* vtkKWWizardStep::HideUserInterfaceCommand [protected] |
Definition at line 339 of file vtkKWWizardStep.h.
char* vtkKWWizardStep::ValidateCommand [protected] |
Definition at line 340 of file vtkKWWizardStep.h.
char* vtkKWWizardStep::CanGoToSelfCommand [protected] |
Definition at line 341 of file vtkKWWizardStep.h.
1.6.1
