GUI/Widgets/vtkKWWindowBase.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWWindowBase.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 __vtkKWWindowBase_h
#define __vtkKWWindowBase_h

#include "vtkKWTopLevel.h"

class vtkKWApplication;
class vtkKWFrame;
class vtkKWLabel;
class vtkKWMenu;
class vtkKWMostRecentFilesManager;
class vtkKWProgressGauge;
class vtkKWSeparator;
class vtkKWTclInteractor;
class vtkKWToolbar;
class vtkKWToolbarSet;

class KWWIDGETS_EXPORT vtkKWWindowBase : public vtkKWTopLevel
{
public:

  static vtkKWWindowBase* New();
  vtkTypeRevisionMacro(vtkKWWindowBase,vtkKWTopLevel);
  void PrintSelf(ostream& os, vtkIndent indent);

  virtual void Create(vtkKWApplication *app);

  virtual int Close();


  vtkSetMacro(PromptBeforeClose, int);
  vtkGetMacro(PromptBeforeClose, int);
  vtkBooleanMacro(PromptBeforeClose, int);


  virtual void LoadScript();
  virtual void LoadScript(const char *filename);


  vtkSetStringMacro(ScriptExtension);
  vtkGetStringMacro(ScriptExtension);


  vtkSetStringMacro(ScriptType);
  vtkGetStringMacro(ScriptType);


  virtual void SetStatusText(const char *);
  virtual const char *GetStatusText();
  

  virtual void WarningMessage(const char* message);
  virtual void ErrorMessage(const char* message);


  enum 
  {
    ErrorIconNone = 0,
    ErrorIconBlack,
    ErrorIconRed
  };
  //ETX
  virtual void SetErrorIcon(int);
  virtual void SetErrorIconToNone()
    { this->SetErrorIcon(vtkKWWindowBase::ErrorIconNone); };
  virtual void SetErrorIconToBlack()
    { this->SetErrorIcon(vtkKWWindowBase::ErrorIconBlack); };
  virtual void SetErrorIconToRed()
    { this->SetErrorIcon(vtkKWWindowBase::ErrorIconRed); };

  virtual vtkKWFrame* GetViewFrame();


  vtkGetObjectMacro(MainToolbarSet, vtkKWToolbarSet);


  vtkGetObjectMacro(StatusFrame, vtkKWFrame);


  virtual void SetStatusFrameVisibility(int flag);
  vtkGetMacro(StatusFrameVisibility, int);
  vtkBooleanMacro(StatusFrameVisibility, int);  


  vtkGetObjectMacro(ProgressGauge, vtkKWProgressGauge);


  enum 
  {
    ProgressGaugePositionStatusFrame = 0,
    ProgressGaugePositionToolbar
  };
  //ETX
  virtual void SetProgressGaugePosition(int);
  virtual void SetProgressGaugePositionToStatusFrame()
    { this->SetProgressGaugePosition(
      vtkKWWindowBase::ProgressGaugePositionStatusFrame); };
  virtual void SetProgressGaugePositionToToolbar()
    { this->SetProgressGaugePosition(
      vtkKWWindowBase::ProgressGaugePositionToolbar); };


  vtkGetObjectMacro(TrayFrame, vtkKWFrame);


  enum 
  {
    TrayFramePositionStatusFrame = 0,
    TrayFramePositionToolbar
  };
  //ETX
  vtkGetMacro(TrayFramePosition, int);
  virtual void SetTrayFramePosition(int);
  virtual void SetTrayFramePositionToStatusFrame()
    { this->SetTrayFramePosition(
      vtkKWWindowBase::TrayFramePositionStatusFrame); };
  virtual void SetTrayFramePositionToToolbar()
    { this->SetTrayFramePosition(
      vtkKWWindowBase::TrayFramePositionToolbar); };


  vtkKWMenu *GetFileMenu();
  vtkKWMenu *GetEditMenu();
  vtkKWMenu *GetViewMenu();
  vtkKWMenu *GetWindowMenu();
  vtkKWMenu *GetHelpMenu();
  vtkKWMenu *GetToolbarsVisibilityMenu();
  

  virtual int GetFileMenuInsertPosition();
  virtual int GetHelpMenuInsertPosition();
  virtual int GetViewMenuInsertPosition();

  vtkSetClampMacro(SupportHelp, int, 0, 1);
  vtkGetMacro(SupportHelp, int);
  vtkBooleanMacro(SupportHelp, int);


  virtual void AddRecentFile(
    const char *filename, vtkObject *target, const char *command);
  

  vtkSetClampMacro(SupportPrint, int, 0, 1);
  vtkGetMacro(SupportPrint, int);
  vtkBooleanMacro(SupportPrint, int);

  virtual char* GetTitle();


  virtual vtkKWTclInteractor* GetTclInteractor();
  virtual void DisplayTclInteractor();
  
  virtual void Update();

  virtual void UpdateToolbarState();


  virtual void UpdateEnableState();
  virtual void UpdateMenuState();

  virtual void PrepareForDelete();


  virtual void ErrorIconCallback();
  virtual void PrintSettingsCallback() {};
  virtual void ToolbarVisibilityChangedCallback();
  virtual void NumberOfToolbarsChangedCallback();


  static const char *PrintOptionsMenuLabel;
  static const char *FileMenuLabel;
  static const char *FileCloseMenuLabel;
  static const char *FileExitMenuLabel;
  static const char *OpenRecentFileMenuLabel;
  static const char *EditMenuLabel;
  static const char *ViewMenuLabel;
  static const char *WindowMenuLabel;
  static const char *HelpMenuLabel;
  static const char *HelpTopicsMenuLabel;
  static const char *HelpCheckForUpdatesMenuLabel;
  static const char *ToolbarsVisibilityMenuLabel;
  static const char *WindowGeometryRegKey;
  static const char *DefaultGeometry;
  //ETX

protected:
  vtkKWWindowBase();
  ~vtkKWWindowBase();

  virtual void InsertRecentFilesMenu(int pos, vtkObject *target);

  virtual int DisplayCloseDialog();


  virtual void UpdateStatusImage();
  virtual vtkKWLabel *GetStatusImage();

  vtkKWMostRecentFilesManager *MostRecentFilesManager;


  virtual void SaveWindowGeometryToRegistry();
  virtual void RestoreWindowGeometryFromRegistry();

  virtual void Pack();

  vtkKWSeparator *MenuBarSeparator;
  vtkKWFrame *MainFrame;

  vtkKWSeparator *StatusFrameSeparator;
  vtkKWFrame *StatusFrame;
  vtkKWLabel *StatusImage;
  vtkKWLabel *StatusLabel;

  vtkKWProgressGauge *ProgressGauge;
  int                ProgressGaugePosition;

  vtkKWFrame      *TrayFrame;
  vtkKWLabel      *TrayImageError;
  int             TrayFramePosition;

  vtkKWToolbarSet *MainToolbarSet;
  vtkKWToolbar    *StatusToolbar;

  char *ScriptExtension;
  char *ScriptType;
  int  SupportHelp;
  int  SupportPrint;
  int  PromptBeforeClose;
  int  StatusFrameVisibility;

  // Allocated and created when queried

  vtkKWMenu *FileMenu;
  vtkKWMenu *EditMenu;
  vtkKWMenu *ViewMenu;
  vtkKWMenu *WindowMenu;
  vtkKWMenu *HelpMenu;
  vtkKWMenu *ToolbarsVisibilityMenu;

  vtkKWTclInteractor *TclInteractor;

private:

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

#endif

---