include/wx/generic/notebook.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        notebook.h
   3 // Purpose:     wxNotebook class (a.k.a. property sheet, tabbed dialog)
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_NOTEBOOK_H_
  12 #define _WX_NOTEBOOK_H_
  13
  14 // ----------------------------------------------------------------------------
  15 // headers
  16 // ----------------------------------------------------------------------------
  17 #include "wx/event.h"
  18 #include "wx/control.h"
  19
  20 // ----------------------------------------------------------------------------
  21 // types
  22 // ----------------------------------------------------------------------------
  23
  24 // fwd declarations
  25 class WXDLLIMPEXP_FWD_CORE wxImageList;
  26 class WXDLLIMPEXP_FWD_CORE wxWindow;
  27 class WXDLLIMPEXP_FWD_CORE wxTabView;
  28
  29 // ----------------------------------------------------------------------------
  30 // wxNotebook
  31 // ----------------------------------------------------------------------------
  32
  33 class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
  34 {
  35 public:
  36   // ctors
  37   // -----
  38     // default for dynamic class
  39   wxNotebook();
  40     // the same arguments as for wxControl (@@@ any special styles?)
  41   wxNotebook(wxWindow *parent,
  42              wxWindowID id,
  43              const wxPoint& pos = wxDefaultPosition,
  44              const wxSize& size = wxDefaultSize,
  45              long style = 0,
  46              const wxString& name = wxNotebookNameStr);
  47     // Create() function
  48   bool Create(wxWindow *parent,
  49               wxWindowID id,
  50               const wxPoint& pos = wxDefaultPosition,
  51               const wxSize& size = wxDefaultSize,
  52               long style = 0,
  53               const wxString& name = wxNotebookNameStr);
  54     // dtor
  55   virtual ~wxNotebook();
  56
  57   // accessors
  58   // ---------
  59   // Find the position of the wxNotebookPage, wxNOT_FOUND if not found.
  60   int FindPagePosition(wxNotebookPage* page) const;
  61
  62     // set the currently selected page, return the index of the previously
  63     // selected one (or wxNOT_FOUND on error)
  64     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
  65   int SetSelection(size_t nPage);
  66     // cycle thru the tabs
  67   //  void AdvanceSelection(bool bForward = true);
  68
  69     // changes selected page without sending events
  70   int ChangeSelection(size_t nPage);
  71
  72     // set/get the title of a page
  73   bool SetPageText(size_t nPage, const wxString& strText);
  74   wxString GetPageText(size_t nPage) const;
  75
  76   // get the number of rows for a control with wxNB_MULTILINE style (not all
  77   // versions support it - they will always return 1 then)
  78   virtual int GetRowCount() const ;
  79
  80     // sets/returns item's image index in the current image list
  81   int  GetPageImage(size_t nPage) const;
  82   bool SetPageImage(size_t nPage, int nImage);
  83
  84   // control the appearance of the notebook pages
  85     // set the size (the same for all pages)
  86   void SetPageSize(const wxSize& size);
  87     // set the padding between tabs (in pixels)
  88   void SetPadding(const wxSize& padding);
  89
  90     // Sets the size of the tabs (assumes all tabs are the same size)
  91   void SetTabSize(const wxSize& sz);
  92
  93   // operations
  94   // ----------
  95     // remove one page from the notebook, and delete the page.
  96   bool DeletePage(size_t nPage);
  97   bool DeletePage(wxNotebookPage* page);
  98     // remove one page from the notebook, without deleting the page.
  99   bool RemovePage(size_t nPage);
 100   bool RemovePage(wxNotebookPage* page);
 101   virtual wxWindow* DoRemovePage(size_t nPage);
 102
 103     // remove all pages
 104   bool DeleteAllPages();
 105     // the same as AddPage(), but adds it at the specified position
 106   bool InsertPage(size_t nPage,
 107                   wxNotebookPage *pPage,
 108                   const wxString& strText,
 109                   bool bSelect = false,
 110                   int imageId = -1);
 111
 112   // callbacks
 113   // ---------
 114   void OnSize(wxSizeEvent& event);
 115   void OnInternalIdle();
 116   void OnSelChange(wxBookCtrlEvent& event);
 117   void OnSetFocus(wxFocusEvent& event);
 118   void OnNavigationKey(wxNavigationKeyEvent& event);
 119
 120   // base class virtuals
 121   // -------------------
 122   virtual void Command(wxCommandEvent& event);
 123   virtual void SetConstraintSizes(bool recurse = true);
 124   virtual bool DoPhase(int nPhase);
 125
 126   virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
 127
 128   // Implementation
 129
 130   // wxNotebook on Motif uses a generic wxTabView to implement itself.
 131   wxTabView *GetTabView() const { return m_tabView; }
 132   void SetTabView(wxTabView *v) { m_tabView = v; }
 133
 134   void OnMouseEvent(wxMouseEvent& event);
 135   void OnPaint(wxPaintEvent& event);
 136
 137   virtual wxRect GetAvailableClientSize();
 138
 139   // Implementation: calculate the layout of the view rect
 140   // and resize the children if required
 141   bool RefreshLayout(bool force = true);
 142
 143 protected:
 144   // common part of all ctors
 145   void Init();
 146
 147   // helper functions
 148   void ChangePage(int nOldSel, int nSel); // change pages
 149
 150   wxTabView*   m_tabView;
 151
 152   DECLARE_DYNAMIC_CLASS(wxNotebook)
 153   DECLARE_EVENT_TABLE()
 154 };
 155
 156 #endif // _WX_NOTEBOOK_H_