vtkKWUserInterfacePanel.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWUserInterfacePanel.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 __vtkKWUserInterfacePanel_h
#define __vtkKWUserInterfacePanel_h

#include "vtkKWObject.h"

class vtkKWIcon;
class vtkKWUserInterfaceManager;
class vtkKWWidget;

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


  virtual void SetUserInterfaceManager(vtkKWUserInterfaceManager*);
  vtkGetObjectMacro(UserInterfaceManager, vtkKWUserInterfaceManager);


  vtkGetStringMacro(Name);
  vtkSetStringMacro(Name);


  virtual void Create();
  virtual int IsCreated();


  virtual void SetEnabled(int);
  vtkBooleanMacro(Enabled, int);
  vtkGetMacro(Enabled, int);


  virtual int AddPage(const char *title, 
                      const char *balloon = 0, 
                      vtkKWIcon *icon = 0);
  virtual int RemovePage(const char *title);


  virtual void SetPageTitle(int id, const char *title);
  virtual void SetPageBalloonHelpString(int id, const char *str);
  virtual void SetPageIcon(int id, vtkKWIcon *icon);
  virtual void SetPageIconToPredefinedIcon(int id, int icon_index);


  virtual vtkKWWidget *GetPageWidget(int id);
  virtual vtkKWWidget *GetPageWidget(const char *title);

  virtual vtkKWWidget *GetPagesParentWidget();


  virtual void RaisePage(int id);
  virtual void RaisePage(const char *title);


  virtual int Show();
  virtual int Raise();
  virtual int IsVisible();

  virtual void Update();

  virtual void UpdateEnableState() {};

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

  vtkKWUserInterfaceManager *UserInterfaceManager;

  char *Name;

// @endcond
// @cond section_private
private:

  int Enabled;
  int PanelIsCreated;

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

#endif

// @endcond

---