include/wx/msw/notebook.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/notebook.h
   3 // Purpose:     MSW/GTK compatible notebook (a.k.a. property sheet)
   4 // Author:      Robert Roebling
   5 // Modified by: Vadim Zeitlin for Windows version
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Julian Smart and Markus Holzem
   8 // Licence:     wxWindows license
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _NOTEBOOK_H
  12 #define _NOTEBOOK_H
  13
  14 #ifdef __GNUG__
  15   #pragma interface "notebook.h"
  16 #endif
  17
  18 // ----------------------------------------------------------------------------
  19 // headers
  20 // ----------------------------------------------------------------------------
  21 #ifndef   _DYNARRAY_H
  22   #include <wx/dynarray.h>
  23 #endif  //_DYNARRAY_H
  24
  25 // ----------------------------------------------------------------------------
  26 // types
  27 // ----------------------------------------------------------------------------
  28
  29 // fwd declarations
  30 class WXDLLEXPORT wxImageList;
  31 class WXDLLEXPORT wxWindow;
  32
  33 // array of notebook pages
  34 typedef wxWindow WXDLLEXPORT wxNotebookPage;  // so far, any window can be a page
  35
  36 #undef WXDLLEXPORTLOCAL
  37 #define WXDLLEXPORTLOCAL WXDLLEXPORT
  38
  39 WX_DEFINE_ARRAY(wxNotebookPage *, wxArrayPages);
  40
  41 #undef  WXDLLEXPORTLOCAL
  42 #define WXDLLEXPORTLOCAL
  43
  44 // ----------------------------------------------------------------------------
  45 // notebook events
  46 // ----------------------------------------------------------------------------
  47 class WXDLLEXPORT wxNotebookEvent : public wxNotifyEvent
  48 {
  49 public:
  50   wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
  51                   int nSel = -1, int nOldSel = -1)
  52   : wxNotifyEvent(commandType, id)
  53   {
  54       m_nSel = nSel;
  55       m_nOldSel = nOldSel;
  56   }
  57
  58   // accessors
  59     // the currently selected page (-1 if none)
  60   int GetSelection() const { return m_nSel; }
  61   void SetSelection(int nSel) { m_nSel = nSel; }
  62     // the page that was selected before the change (-1 if none)
  63   int GetOldSelection() const { return m_nOldSel; }
  64   void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }
  65
  66 private:
  67   int m_nSel,     // currently selected page
  68       m_nOldSel;  // previously selected page
  69
  70   DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
  71 };
  72
  73 // ----------------------------------------------------------------------------
  74 // wxNotebook
  75 // ----------------------------------------------------------------------------
  76
  77 // @@@ this class should really derive from wxTabCtrl, but the interface is not
  78 //     exactly the same, so I can't do it right now and instead we reimplement
  79 //     part of wxTabCtrl here
  80 class WXDLLEXPORT wxNotebook : public wxControl
  81 {
  82 public:
  83   // ctors
  84   // -----
  85     // default for dynamic class
  86   wxNotebook();
  87     // the same arguments as for wxControl (@@@ any special styles?)
  88   wxNotebook(wxWindow *parent,
  89              wxWindowID id,
  90              const wxPoint& pos = wxDefaultPosition,
  91              const wxSize& size = wxDefaultSize,
  92              long style = 0,
  93              const wxString& name = "notebook");
  94     // Create() function
  95   bool Create(wxWindow *parent,
  96               wxWindowID id,
  97               const wxPoint& pos = wxDefaultPosition,
  98               const wxSize& size = wxDefaultSize,
  99               long style = 0,
 100               const wxString& name = "notebook");
 101     // dtor
 102   ~wxNotebook();
 103
 104   // accessors
 105   // ---------
 106     // get number of pages in the dialog
 107   int GetPageCount() const;
 108
 109     // set the currently selected page, return the index of the previously
 110     // selected one (or -1 on error)
 111     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
 112   int SetSelection(int nPage);
 113     // cycle thru the tabs
 114   void AdvanceSelection(bool bForward = TRUE);
 115     // get the currently selected page
 116   int GetSelection() const { return m_nSelection; }
 117
 118     // set/get the title of a page
 119   bool SetPageText(int nPage, const wxString& strText);
 120   wxString GetPageText(int nPage) const;
 121
 122   // image list stuff: each page may have an image associated with it. All
 123   // the images belong to an image list, so you have to
 124   // 1) create an image list
 125   // 2) associate it with the notebook
 126   // 3) set for each page it's image
 127     // associate image list with a control
 128   void SetImageList(wxImageList* imageList);
 129     // get pointer (may be NULL) to the associated image list
 130   wxImageList* GetImageList() const { return m_pImageList; }
 131
 132     // sets/returns item's image index in the current image list
 133   int  GetPageImage(int nPage) const;
 134   bool SetPageImage(int nPage, int nImage);
 135
 136     // currently it's always 1 because wxGTK doesn't support multi-row
 137     // tab controls
 138   int GetRowCount() const;
 139
 140   // control the appearance of the notebook pages
 141     // set the size (the same for all pages)
 142   void SetPageSize(const wxSize& size);
 143     // set the padding between tabs (in pixels)
 144   void SetPadding(const wxSize& padding);
 145
 146   // operations
 147   // ----------
 148     // remove one page from the notebook
 149   bool DeletePage(int nPage);
 150     // remove one page from the notebook, without deleting
 151   bool RemovePage(int nPage);
 152     // remove all pages
 153   bool DeleteAllPages();
 154     // adds a new page to the notebook (it will be deleted ny the notebook,
 155     // don't delete it yourself). If bSelect, this page becomes active.
 156   bool AddPage(wxNotebookPage *pPage,
 157                const wxString& strText,
 158                bool bSelect = FALSE,
 159                int imageId = -1);
 160     // the same as AddPage(), but adds it at the specified position
 161   bool InsertPage(int nPage,
 162                   wxNotebookPage *pPage,
 163                   const wxString& strText,
 164                   bool bSelect = FALSE,
 165                   int imageId = -1);
 166     // get the panel which represents the given page
 167   wxNotebookPage *GetPage(int nPage) { return m_aPages[nPage]; }
 168
 169     // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
 170     // style.
 171   void SetTabSize(const wxSize& sz);
 172
 173   // callbacks
 174   // ---------
 175   void OnSize(wxSizeEvent& event);
 176   void OnSelChange(wxNotebookEvent& event);
 177   void OnSetFocus(wxFocusEvent& event);
 178   void OnNavigationKey(wxNavigationKeyEvent& event);
 179   void OnEraseBackground(wxEraseEvent& event);
 180
 181   // base class virtuals
 182   // -------------------
 183   virtual void Command(wxCommandEvent& event);
 184   virtual bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam, WXLPARAM *result);
 185   virtual void SetConstraintSizes(bool recurse = TRUE);
 186   virtual bool DoPhase(int nPhase);
 187
 188 protected:
 189   // common part of all ctors
 190   void Init();
 191
 192   // helper functions
 193   void ChangePage(int nOldSel, int nSel); // change pages
 194
 195   wxImageList  *m_pImageList; // we can have an associated image list
 196   wxArrayPages  m_aPages;     // array of pages
 197
 198   int m_nSelection;           // the current selection (-1 if none)
 199
 200   DECLARE_DYNAMIC_CLASS(wxNotebook)
 201   DECLARE_EVENT_TABLE()
 202 };
 203
 204 // ----------------------------------------------------------------------------
 205 // event macros
 206 // ----------------------------------------------------------------------------
 207 typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 208
 209 #define EVT_NOTEBOOK_PAGE_CHANGED(id, fn)                                   \
 210   {                                                                         \
 211     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,                                    \
 212     id,                                                                     \
 213     -1,                                                                     \
 214     (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
 215     NULL                                                                    \
 216   },
 217
 218 #define EVT_NOTEBOOK_PAGE_CHANGING(id, fn)                                  \
 219   {                                                                         \
 220     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,                                   \
 221     id,                                                                     \
 222     -1,                                                                     \
 223     (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
 224     NULL                                                                    \
 225   },
 226
 227 #endif // _NOTEBOOK_H