vtkKWWindow.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWWindow.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 __vtkKWWindow_h
#define __vtkKWWindow_h

#include "vtkKWWindowBase.h"

class vtkKWFrame;
class vtkKWNotebook;
class vtkKWSplitFrame;
class vtkKWToolbar;
class vtkKWUserInterfaceManager;
class vtkKWUserInterfaceManagerNotebook;
class vtkKWUserInterfaceManagerDialog;
class vtkKWApplicationSettingsInterface;
class vtkKWUserInterfacePanel;

class KWWidgets_EXPORT vtkKWWindow : public vtkKWWindowBase
{
// @cond section_public
public:

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


  virtual vtkKWFrame* GetMainPanelFrame();
  virtual int GetMainPanelVisibility();
  virtual void SetMainPanelVisibility(int);
  vtkBooleanMacro(MainPanelVisibility, int );
  virtual vtkKWNotebook* GetMainNotebook();
  virtual int HasMainUserInterfaceManager();
  virtual vtkKWUserInterfaceManager* GetMainUserInterfaceManager();
  virtual void ShowMainUserInterface(const char *name);
  vtkGetObjectMacro(MainSplitFrame, vtkKWSplitFrame);


  virtual vtkKWFrame* GetSecondaryPanelFrame();
  virtual int GetSecondaryPanelVisibility();
  virtual void SetSecondaryPanelVisibility(int);
  vtkBooleanMacro(SecondaryPanelVisibility, int );
  virtual vtkKWNotebook* GetSecondaryNotebook();
  virtual int HasSecondaryUserInterfaceManager();
  virtual vtkKWUserInterfaceManager* GetSecondaryUserInterfaceManager();
  virtual void ShowSecondaryUserInterface(const char *name);
  vtkGetObjectMacro(SecondarySplitFrame, vtkKWSplitFrame);


  enum 
  {
    PanelLayoutSecondaryBelowView = 0,
    PanelLayoutSecondaryBelowMain,
    PanelLayoutSecondaryBelowMainAndView
  };
  //ETX
  vtkSetClampMacro(PanelLayout, int, 
                   vtkKWWindow::PanelLayoutSecondaryBelowView, 
                   vtkKWWindow::PanelLayoutSecondaryBelowMainAndView);
  vtkGetMacro(PanelLayout, int);
  virtual void SetPanelLayoutToSecondaryBelowView()
    { this->SetPanelLayout(vtkKWWindow::PanelLayoutSecondaryBelowView);};
  virtual void SetPanelLayoutToSecondaryBelowMain()
    { this->SetPanelLayout(vtkKWWindow::PanelLayoutSecondaryBelowMain);};
  virtual void SetPanelLayoutToSecondaryBelowMainAndView()
    {this->SetPanelLayout(vtkKWWindow::PanelLayoutSecondaryBelowMainAndView);};


  enum 
  {
    ViewPanelPositionLeft = 0,
    ViewPanelPositionRight
  };
  //ETX
  virtual void SetViewPanelPosition(int);
  virtual int GetViewPanelPosition();
  virtual void SetViewPanelPositionToLeft()
    { this->SetViewPanelPosition(vtkKWWindow::ViewPanelPositionLeft);};
  virtual void SetViewPanelPositionToRight()
    { this->SetViewPanelPosition(vtkKWWindow::ViewPanelPositionRight);};

  virtual vtkKWFrame* GetViewFrame();


  virtual vtkKWNotebook* GetViewNotebook();
  virtual int HasViewUserInterfaceManager();
  virtual vtkKWUserInterfaceManager* GetViewUserInterfaceManager();
  virtual void ShowViewUserInterface(const char *name);
  virtual vtkKWFrame* GetViewPanelFrame();

  virtual vtkKWToolbarSet* GetSecondaryToolbarSet();


  enum 
  {
    StatusFramePositionWindow = 0,
    StatusFramePositionMainPanel,
    StatusFramePositionSecondaryPanel,
    StatusFramePositionViewPanel,
    StatusFramePositionLeftOfDivider,
    StatusFramePositionRightOfDivider
  };
  //ETX
  vtkGetMacro(StatusFramePosition, int);
  virtual void SetStatusFramePosition(int);
  virtual void SetStatusFramePositionToWindow()
    { this->SetStatusFramePosition(
      vtkKWWindow::StatusFramePositionWindow); };
  virtual void SetStatusFramePositionToMainPanel()
    { this->SetStatusFramePosition(
      vtkKWWindow::StatusFramePositionMainPanel); };
  virtual void SetStatusFramePositionToSecondaryPanel()
    { this->SetStatusFramePosition(
      vtkKWWindow::StatusFramePositionSecondaryPanel); };
  virtual void SetStatusFramePositionToViewPanel()
    { this->SetStatusFramePosition(
      vtkKWWindow::StatusFramePositionViewPanel); };
  virtual void SetStatusFramePositionToLeftOfDivider()
    { this->SetStatusFramePosition(
      vtkKWWindow::StatusFramePositionLeftOfDivider); };
  virtual void SetStatusFramePositionToRightOfDivider()
    { this->SetStatusFramePosition(
      vtkKWWindow::StatusFramePositionRightOfDivider); };

  virtual void Render();


  virtual vtkKWUserInterfaceManager* GetApplicationSettingsUserInterfaceManager();
  virtual void ShowApplicationSettingsUserInterface(const char *name);
  virtual vtkKWApplicationSettingsInterface *GetApplicationSettingsInterface();

  virtual void Update();


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

  virtual void UpdateToolbarState();

  virtual void PrepareForDelete();


  virtual void MainPanelVisibilityCallback();
  virtual void SecondaryPanelVisibilityCallback();
  virtual void PrintSettingsCallback();
  virtual void ToolbarVisibilityChangedCallback(vtkKWToolbar*);
  virtual void NumberOfToolbarsChangedCallback();


  vtkGetStringMacro(MainPanelSizeRegKey);
  vtkGetStringMacro(MainPanelVisibilityRegKey);
  vtkGetStringMacro(MainPanelVisibilityKeyAccelerator);
  vtkGetStringMacro(HideMainPanelMenuLabel);
  vtkGetStringMacro(ShowMainPanelMenuLabel);
  vtkGetStringMacro(SecondaryPanelSizeRegKey);
  vtkGetStringMacro(SecondaryPanelVisibilityRegKey);
  vtkGetStringMacro(SecondaryPanelVisibilityKeyAccelerator);
  vtkGetStringMacro(HideSecondaryPanelMenuLabel);
  vtkGetStringMacro(ShowSecondaryPanelMenuLabel);
  vtkGetStringMacro(DefaultViewPanelName);
  vtkGetStringMacro(TclInteractorMenuLabel);
  vtkGetStringMacro(ViewPanelPositionRegKey);
  vtkGetStringMacro(LogDialogMenuLabel);


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

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

  virtual void CreateWidget();


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


  virtual void ShowMainUserInterface(vtkKWUserInterfacePanel *panel);
  virtual void ShowSecondaryUserInterface(vtkKWUserInterfacePanel *panel);
  virtual void ShowViewUserInterface(vtkKWUserInterfacePanel *panel);
  virtual void ShowApplicationSettingsUserInterface(vtkKWUserInterfacePanel *panel);

  virtual void Pack();

  int PanelLayout;

  vtkKWSplitFrame *MainSplitFrame;

  vtkKWSplitFrame *SecondarySplitFrame;

  vtkKWApplicationSettingsInterface *ApplicationSettingsInterface;

  int             StatusFramePosition;


  vtkSetStringMacro(MainPanelSizeRegKey);
  vtkSetStringMacro(MainPanelVisibilityRegKey);
  vtkSetStringMacro(MainPanelVisibilityKeyAccelerator);
  vtkSetStringMacro(HideMainPanelMenuLabel);
  vtkSetStringMacro(ShowMainPanelMenuLabel);
  vtkSetStringMacro(SecondaryPanelSizeRegKey);
  vtkSetStringMacro(SecondaryPanelVisibilityRegKey);
  vtkSetStringMacro(SecondaryPanelVisibilityKeyAccelerator);
  vtkSetStringMacro(HideSecondaryPanelMenuLabel);
  vtkSetStringMacro(ShowSecondaryPanelMenuLabel);
  vtkSetStringMacro(DefaultViewPanelName);
  vtkSetStringMacro(TclInteractorMenuLabel);
  vtkSetStringMacro(ViewPanelPositionRegKey);
  vtkSetStringMacro(LogDialogMenuLabel);


  virtual void ProcessCallbackCommandEvents(
    vtkObject *caller, unsigned long event, void *calldata);


  virtual void PopulateWindowMenu();
  virtual void PopulateViewMenu();
  
// @endcond
// @cond section_private
private:

  vtkKWNotebook   *MainNotebook;
  vtkKWNotebook   *SecondaryNotebook;
  vtkKWNotebook   *ViewNotebook;

  vtkKWToolbarSet *SecondaryToolbarSet;

  vtkKWUserInterfaceManagerNotebook *MainUserInterfaceManager;
  vtkKWUserInterfaceManagerNotebook *SecondaryUserInterfaceManager;
  vtkKWUserInterfaceManagerNotebook *ViewUserInterfaceManager;

  vtkKWUserInterfaceManagerDialog *ApplicationSettingsUserInterfaceManager;

  vtkKWWindow(const vtkKWWindow&); // Not implemented
  void operator=(const vtkKWWindow&); // Not implemented


  char *MainPanelSizeRegKey;
  char *MainPanelVisibilityRegKey;
  char *MainPanelVisibilityKeyAccelerator;
  char *HideMainPanelMenuLabel;
  char *ShowMainPanelMenuLabel;
  char *SecondaryPanelSizeRegKey;
  char *SecondaryPanelVisibilityRegKey;
  char *SecondaryPanelVisibilityKeyAccelerator;
  char *HideSecondaryPanelMenuLabel;
  char *ShowSecondaryPanelMenuLabel;
  char *DefaultViewPanelName;
  char *TclInteractorMenuLabel;
  char *ViewPanelPositionRegKey;
  char *LogDialogMenuLabel;
};

#endif

// @endcond

---