vtkKWWizardWidget.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWWizardWidget.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 __vtkKWWizardWidget_h
#define __vtkKWWizardWidget_h

#include "vtkKWCompositeWidget.h"

class vtkKWPushButton;
class vtkKWLabel;
class vtkKWLabelWithLabel;
class vtkKWFrame;
class vtkKWSeparator;
class vtkKWWizardWorkflow;

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


  vtkGetObjectMacro(WizardWorkflow, vtkKWWizardWorkflow);


  vtkGetObjectMacro(ClientArea, vtkKWFrame);

  virtual void SetClientAreaMinimumHeight(int);

  virtual void Update();


  virtual void SetTitle(const char *);
  virtual char* GetTitle();


  virtual void SetSubTitle(const char *);
  virtual char* GetSubTitle();


  virtual void GetTitleAreaBackgroundColor(double *r, double *g, double *b);
  virtual double* GetTitleAreaBackgroundColor();
  virtual void SetTitleAreaBackgroundColor(double r, double g, double b);
  virtual void SetTitleAreaBackgroundColor(double rgb[3])
    { this->SetTitleAreaBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  

  vtkGetObjectMacro(TitleIconLabel, vtkKWLabel);


  virtual void SetPreText(const char *);
  virtual char* GetPreText();


  virtual void SetPostText(const char *);
  virtual char* GetPostText();


  virtual void SetErrorText(const char *);
  virtual char* GetErrorText();

  virtual void ClearPage();
  

  virtual void SetBackButtonVisibility(int);
  vtkGetMacro(BackButtonVisibility,int);
  vtkBooleanMacro(BackButtonVisibility,int);
  virtual void SetNextButtonVisibility(int);
  vtkGetMacro(NextButtonVisibility,int);
  vtkBooleanMacro(NextButtonVisibility,int);
  virtual void SetFinishButtonVisibility(int);
  vtkGetMacro(FinishButtonVisibility,int);
  vtkBooleanMacro(FinishButtonVisibility,int);
  virtual void SetCancelButtonVisibility(int);
  vtkGetMacro(CancelButtonVisibility,int);
  vtkBooleanMacro(CancelButtonVisibility,int);
  virtual void SetHelpButtonVisibility(int);
  vtkGetMacro(HelpButtonVisibility,int);
  vtkBooleanMacro(HelpButtonVisibility,int);
  virtual void SetOKButtonVisibility(int);
  vtkGetMacro(OKButtonVisibility,int);
  vtkBooleanMacro(OKButtonVisibility,int);


  vtkGetObjectMacro(CancelButton, vtkKWPushButton);
  vtkGetObjectMacro(OKButton, vtkKWPushButton);
  vtkGetObjectMacro(FinishButton, vtkKWPushButton);
  vtkGetObjectMacro(HelpButton, vtkKWPushButton);
  vtkGetObjectMacro(SeparatorBeforeButtons, vtkKWSeparator);
  vtkGetObjectMacro(SubTitleLabel, vtkKWLabel);
  vtkGetObjectMacro(TitleLabel, vtkKWLabel);


  enum
  {
    ButtonsPositionTop = 0,
    ButtonsPositionBottom
  };
  //ETX
  virtual void SetButtonsPosition(int);
  vtkGetMacro(ButtonsPosition, int);
  virtual void SetButtonsPositionToTop()
    { this->SetButtonsPosition(vtkKWWizardWidget::ButtonsPositionTop); };
  virtual void SetButtonsPositionToBottom()
    { this->SetButtonsPosition(vtkKWWizardWidget::ButtonsPositionBottom); };
  

  virtual void AddCallbackCommandObservers();
  virtual void RemoveCallbackCommandObservers();

  virtual void UpdateEnableState();

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

  virtual void CreateWidget();

  virtual void PackButtons();

  int ButtonsPosition;

  int BackButtonVisibility;
  int NextButtonVisibility;
  int FinishButtonVisibility;
  int CancelButtonVisibility;
  int HelpButtonVisibility;
  int OKButtonVisibility;

  vtkKWWizardWorkflow *WizardWorkflow;

  vtkKWFrame          *TitleFrame;
  vtkKWLabel          *TitleLabel;
  vtkKWLabel          *SubTitleLabel;
  vtkKWLabel          *TitleIconLabel;
  
  vtkKWSeparator      *SeparatorAfterTitleArea;

  vtkKWFrame          *LayoutFrame;
  vtkKWLabel          *PreTextLabel;
  vtkKWFrame          *ClientArea;
  vtkKWLabel          *PostTextLabel;
  vtkKWLabelWithLabel *ErrorTextLabel;

  vtkKWSeparator      *SeparatorBeforeButtons;

  vtkKWFrame          *ButtonFrame;
  vtkKWPushButton     *BackButton;
  vtkKWPushButton     *NextButton;
  vtkKWPushButton     *FinishButton;
  vtkKWPushButton     *CancelButton;
  vtkKWPushButton     *HelpButton;
  vtkKWPushButton     *OKButton;


  virtual void ProcessCallbackCommandEvents(
    vtkObject *caller, unsigned long event, void *calldata);
  
// @endcond
// @cond section_private
private:
  vtkKWWizardWidget(const vtkKWWizardWidget&); // Not implemented
  void operator=(const vtkKWWizardWidget&); // Not Implemented
};

#endif
// @endcond

---