vtkKWNotebook.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWNotebook.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 __vtkKWNotebook_h
#define __vtkKWNotebook_h

#include "vtkKWCompositeWidget.h"

class vtkKWFrame;
class vtkKWIcon;
class vtkKWLabel;
class vtkKWSmallCounterLabel;
class vtkKWMenu;
class vtkKWNotebookInternals;
class vtkKWBalloonHelpManager;

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

  int AddPage(const char *title, const char* balloon, vtkKWIcon *icon,int tag);
  int AddPage(const char *title, const char* balloon, vtkKWIcon *icon);
  int AddPage(const char *title, const char* balloon);
  int AddPage(const char *title);


  int HasPage(int id);
  int HasPage(const char *title, int tag);
  int GetPageId(const char *title, int tag);


  const char* GetPageTitle(int id);
  virtual void SetPageTitle(int id, const char *title);


  const char* GetPageBalloonHelpString(int id);
  virtual void SetPageBalloonHelpString(int id, const char *str);


  vtkKWIcon* GetPageIcon(int id);
  virtual void SetPageIcon(int id, vtkKWIcon *icon);
  virtual void SetPageIconToPredefinedIcon(int id, int icon_index);


  int GetPageSmallCounterValue(int id);
  virtual void SetPageSmallCounterValue(int id, int v);


  unsigned int GetNumberOfPages();
  unsigned int GetNumberOfPagesMatchingTag(int tag);
  

  void SetPageTag(int id, int tag);
  void SetPageTag(const char *title, int tag);
  int GetPageTag(int id);
  int GetPageTag(const char *title);


  void RaisePage(int id);
  void RaisePage(const char *title);
  void RaisePage(const char *title, int tag);
  int GetRaisedPageId();
  void RaiseFirstPageMatchingTag(int tag);
  

  vtkKWFrame *GetFrame(int id);
  vtkKWFrame *GetFrame(const char *title);
  vtkKWFrame *GetFrame(const char *title, int tag);
  int GetPageIdFromFrameWidgetName(const char *frame_wname);


  int RemovePage(int id);
  int RemovePage(const char *title);

  void RemovePagesMatchingTag(int tag);
  

  void ShowPage(int id);
  void ShowPage(const char *title);
  void ShowPage(const char *title, int tag);
  void HidePage(int id);
  void HidePage(const char *title);
  void HidePage(const char *title, int tag);
  void SetPageVisibility(int id, int flag);
  void SetPageVisibility(const char *title, int flag);
  void SetPageVisibility(const char *title, int tag, int flag);
  int  GetPageVisibility(int id);
  int  GetPageVisibility(const char *title);
  int  GetPageVisibility(const char *title, int tag);
  void TogglePageVisibility(int id);
  void TogglePageVisibility(const char *title);
  void TogglePageVisibility(const char *title, int tag);
  int  CanBeHidden(int id);
  int  CanBeHidden(const char *title);
  int  CanBeHidden(const char *title, int tag);
  void HideAllPages();


  void SetPageEnabled(int id, int flag);
  void SetPageEnabled(const char *title, int flag);
  void SetPageEnabled(const char *title, int tag, int fkag);
  

  unsigned int GetNumberOfVisiblePages();
  unsigned int GetNumberOfVisiblePagesMatchingTag(int tag);

  int GetVisiblePageId(int idx);
  

  void HidePagesMatchingTag(int tag);
  void ShowPagesMatchingTag(int tag);
  void ShowPagesMatchingTagReverse(int tag);
  void HidePagesNotMatchingTag(int tag);
  void ShowPagesNotMatchingTag(int tag);


  virtual void SetShowAllPagesWithSameTag(int);
  vtkGetMacro(ShowAllPagesWithSameTag, int);
  vtkBooleanMacro(ShowAllPagesWithSameTag, int);
  

  virtual void SetShowOnlyPagesWithSameTag(int);
  vtkGetMacro(ShowOnlyPagesWithSameTag, int);
  vtkBooleanMacro(ShowOnlyPagesWithSameTag, int);
  

  virtual void SetShowOnlyMostRecentPages(int);
  vtkGetMacro(ShowOnlyMostRecentPages, int);
  vtkBooleanMacro(ShowOnlyMostRecentPages, int);
  vtkSetMacro(NumberOfMostRecentPages, int);
  vtkGetMacro(NumberOfMostRecentPages, int);

  int GetMostRecentPageId(int idx);


  void PinPage(int id);
  void PinPage(const char *title);
  void PinPage(const char *title, int tag);
  void UnpinPage(int id);
  void UnpinPage(const char *title);
  void UnpinPage(const char *title, int tag);
  void TogglePagePinned(int id);
  void TogglePagePinned(const char *title);
  void TogglePagePinned(const char *title, int tag);
  int  GetPagePinned(int id);
  int  GetPagePinned(const char *title);
  int  GetPagePinned(const char *title, int tag);
  

  void PinPagesMatchingTag(int tag);
  void UnpinPagesMatchingTag(int tag);


  virtual void SetPagesCanBePinned(int);
  vtkGetMacro(PagesCanBePinned, int);
  vtkBooleanMacro(PagesCanBePinned, int);

  unsigned int GetNumberOfPinnedPages();

  int GetPinnedPageId(int idx);
  

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

  virtual void SetMinimumWidth(int);
  vtkGetMacro(MinimumWidth,int);
  virtual void SetMinimumHeight(int);
  vtkGetMacro(MinimumHeight,int);


  virtual void SetAlwaysShowTabs(int);
  vtkGetMacro(AlwaysShowTabs, int);
  vtkBooleanMacro(AlwaysShowTabs, int);
  

  virtual void SetShowIcons(int);
  vtkGetMacro(ShowIcons, int);
  vtkBooleanMacro(ShowIcons, int);
  

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

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


  vtkGetVector3Macro(PageTabColor,double);
  virtual void SetPageTabColor(double r, double g, double b);
  virtual void SetPageTabColor(double rgb[3]) 
    { this->SetPageTabColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(SelectedPageTabColor,double);
  virtual void SetSelectedPageTabColor(double r, double g, double b);
  virtual void SetSelectedPageTabColor(double rgb[3]) 
    { this->SetSelectedPageTabColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(PinnedPageTabOutlineColor,double);
  virtual void SetPinnedPageTabOutlineColor(double r, double g, double b);
  virtual void SetPinnedPageTabOutlineColor(double rgb[3]) 
    { this->SetPinnedPageTabOutlineColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(PageTabTextColor,double);
  virtual void SetPageTabTextColor(double r, double g, double b);
  virtual void SetPageTabTextColor(double rgb[3]) 
    { this->SetPageTabTextColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(SelectedPageTabTextColor,double);
  virtual void SetSelectedPageTabTextColor(double r, double g, double b);
  virtual void SetSelectedPageTabTextColor(double rgb[3]) 
    { this->SetSelectedPageTabTextColor(rgb[0], rgb[1], rgb[2]); };


  vtkGetMacro(SelectedPageTabPadding, int);
  virtual void SetSelectedPageTabPadding(int arg);

  virtual int GetPageIdContainingCoordinatesInTab(int x, int y);

  virtual void UpdateEnableState();


  virtual void ScheduleResize();
  virtual void Resize();

  virtual void PageTabContextMenuCallback(int id, int x, int y);
  virtual void RaiseCallback(int id);
  virtual void TogglePagePinnedCallback(int id);
  virtual void TogglePageVisibilityCallback(int id);

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

  virtual void CreateWidget();

  int MinimumWidth;
  int MinimumHeight;
  int AlwaysShowTabs;
  int ShowIcons;
  int ShowAllPagesWithSameTag;
  int ShowOnlyPagesWithSameTag;
  int ShowOnlyMostRecentPages;
  int NumberOfMostRecentPages;
  int PagesCanBePinned;
  int EnablePageTabContextMenu;
  int UseFrameWithScrollbars;

  double PageTabColor[3];
  double SelectedPageTabColor[3];
  double PageTabTextColor[3];
  double SelectedPageTabTextColor[3];
  double PinnedPageTabOutlineColor[3];
  int SelectedPageTabPadding;

  vtkKWFrame *TabsFrame;
  vtkKWFrame *Body;
  vtkKWFrame *Mask;
  vtkKWMenu   *TabPopupMenu;

  //BTX

  // A notebook page

  class Page
  {
  public:
    Page();
    void Delete();
    void UpdateEnableState();
    void Bind();
    void UnBind();

    int             Id;
    int             Visibility;
    int             Pinned;
    int             Tag;
    int             Enabled;
    char            *Title;
    vtkKWCoreWidget *Frame;
    vtkKWFrame      *TabFrame;
    vtkKWLabel      *Label;
    vtkKWLabel      *ImageLabel;
    vtkKWIcon       *Icon;
    vtkKWSmallCounterLabel *SmallCounterLabel;
  };

  // PIMPL Encapsulation for STL containers

  vtkKWNotebookInternals *Internals;
  friend class vtkKWNotebookInternals;

  // Return a pointer to a page.
  // If a page title is provided instead of a page id, the first page matching
  // that title is considered. In the same way, if a tag is provided with the 
  // title, the page which title *and* tag match is considered.

  Page* GetPage(int id);
  Page* GetPage(const char *title);
  Page* GetPage(const char *title, int tag);

  // Get the first visible page
  // Get the first page matching a tag
  // Get the first packed page not matching a tag

  Page* GetFirstVisiblePage();
  Page* GetFirstPageMatchingTag(int tag);
  Page* GetFirstPackedPageNotMatchingTag(int tag);
  
  // Raise, Lower, Remove, Show, Hide, Pin, Unpin, Tag a specific page

  void SetPageTag(Page*, int tag);
  void RaisePage(Page*);
  void ShowPageTab(Page*);
  void ShowPageTabAsLow(Page*);
  void LowerPage(Page*);
  int  RemovePage(Page*);
  void ShowPage(Page*);
  void HidePage(Page*);
  void PinPage(Page*);
  void UnpinPage(Page*);
  void TogglePagePinned(Page*);
  int  GetPageVisibility(Page*);
  void TogglePageVisibility(Page*);
  int  CanBeHidden(Page*);
  int  GetPageTag(Page*);
  int  GetPagePinned(Page*);
  const char* GetPageTitle(Page*);
  const char* GetPageBalloonHelpString(Page*);
  vtkKWIcon* GetPageIcon(Page*);
  void SetPageEnabled(Page*, int flag);
  void BuildPage(Page*,const char *title,const char* balloon,vtkKWIcon *icon);

  int AddToMostRecentPages(Page*);
  int RemoveFromMostRecentPages(Page*);
  int PutOnTopOfMostRecentPages(Page*);

  // Update the tab frame color of a page

  virtual void UpdatePageTabAspect(Page*);
  virtual void UpdateAllPagesTabAspect();

  //ETX

  int IdCounter;
  int CurrentId;
  int Expanding;

  // Returns true if some tabs are visible.

  int AreTabsVisible();

  // Update the position of the body and mask elements

  void UpdateBodyPosition();
  void UpdateMaskPosition();

  // Constrain the visible pages depending on:
  // ShowAllPagesWithSameTag,
  // ShowOnlyPagesWithSameTag, 
  // ShowOnlyMostRecentPages

  void ConstrainVisiblePages();

  // Send event

  void SendEventForPage(unsigned long event, int id);


  virtual void Bind();
  virtual void UnBind();

  vtkKWBalloonHelpManager *TabBalloonHelpManager;

// @endcond
// @cond section_private
private:
  vtkKWNotebook(const vtkKWNotebook&); // Not implemented
  void operator=(const vtkKWNotebook&); // Not implemented
};

#endif

// @endcond

---