vtkKWWizardStep.h

Go to the documentation of this file.

/*=========================================================================

  Module:    $RCSfile: vtkKWWizardStep.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkKWWizardStep_h
#define __vtkKWWizardStep_h

#include "vtkKWObject.h"

class vtkKWStateMachineState;
class vtkKWStateMachineInput;
class vtkKWStateMachineTransition;

//BTX
class KWWidgets_EXPORT vtkKWWizardStepCleanup
{
// @cond section_public
public:
  vtkKWWizardStepCleanup() {};
  ~vtkKWWizardStepCleanup();
};
//ETX

class KWWidgets_EXPORT vtkKWWizardStep : public vtkKWObject
{
// @endcond
// @cond section_public
public:
  static vtkKWWizardStep* New();
  vtkTypeRevisionMacro(vtkKWWizardStep, vtkKWObject);
  void PrintSelf(ostream& os, vtkIndent indent);


  vtkGetMacro(Id, vtkIdType);


  vtkGetStringMacro(Name);
  vtkSetStringMacro(Name);


  vtkGetStringMacro(Description);
  vtkSetStringMacro(Description);


  virtual void ShowUserInterface();
  virtual void SetShowUserInterfaceCommand(
    vtkObject *object, const char *method);
  virtual void InvokeShowUserInterfaceCommand();
  virtual int HasShowUserInterfaceCommand();


  enum
  {
    ShowUserInterfaceEvent = 10000,
    HideUserInterfaceEvent,
    ValidateEvent
  };
  //ETX



  virtual void HideUserInterface();
  virtual void SetHideUserInterfaceCommand(
    vtkObject *object, const char *method);
  virtual void InvokeHideUserInterfaceCommand();
  virtual int HasHideUserInterfaceCommand();


  virtual void Validate();
  virtual void SetValidateCommand(vtkObject *object, const char *method);
  virtual void InvokeValidateCommand();
  virtual int HasValidateCommand();


  virtual int CanGoToSelf();
  virtual void SetCanGoToSelfCommand(vtkObject *object, const char *method);
  virtual int InvokeCanGoToSelfCommand();
  virtual int HasCanGoToSelfCommand();

  virtual vtkKWStateMachineState* GetInteractionState();

  virtual vtkKWStateMachineState* GetValidationState();

  virtual vtkKWStateMachineTransition* GetValidationTransition();

  static vtkKWStateMachineInput* GetValidationInput();

  static vtkKWStateMachineInput* GetValidationSucceededInput();

  static vtkKWStateMachineInput* GetValidationFailedInput();

  virtual vtkKWStateMachineTransition* GetValidationFailedTransition();

  virtual vtkKWStateMachineInput* GetGoToSelfInput();

  virtual vtkKWStateMachineInput* GetGoBackToSelfInput();

  virtual void RemoveCallbackCommandObservers();

// @endcond
// @cond section_protected
protected:
  vtkKWWizardStep();
  ~vtkKWWizardStep();

  vtkIdType Id;
  char *Name;
  char *Description;

  char *ShowUserInterfaceCommand;
  char *HideUserInterfaceCommand;
  char *ValidateCommand;
  char *CanGoToSelfCommand;


  virtual void ProcessCallbackCommandEvents(
    vtkObject *caller, unsigned long event, void *calldata);
  
// @endcond
// @cond section_private
private:

  vtkKWStateMachineState *InteractionState;
  vtkKWStateMachineState *ValidationState;

  vtkKWStateMachineTransition *ValidationTransition;
  vtkKWStateMachineTransition *ValidationFailedTransition;

  vtkKWStateMachineInput *GoToSelfInput;
  vtkKWStateMachineInput *GoBackToSelfInput;

  static vtkIdType IdCounter;

  static vtkKWStateMachineInput *ValidationInput;
  static vtkKWStateMachineInput *ValidationSucceededInput;
  static vtkKWStateMachineInput *ValidationFailedInput;

  //BTX
  // Used to delete our singletons.
  static vtkKWWizardStepCleanup Cleanup;
  friend class vtkKWWizardStepCleanup;
  //ETX

  static void SetValidationInput(vtkKWStateMachineInput*);
  static void SetValidationSucceededInput(vtkKWStateMachineInput*);
  static void SetValidationFailedInput(vtkKWStateMachineInput*);

  vtkKWWizardStep(const vtkKWWizardStep&); // Not implemented
  void operator=(const vtkKWWizardStep&); // Not implemented
};

#endif
// @endcond

---