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 wxCommandEvent
  48 {
  49 public:
  50   wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
  51                   int nSel = -1, int nOldSel = -1)
  52     : wxCommandEvent(commandType, id) { m_nSel = nSel; m_nOldSel = nOldSel; }
  53
  54   // accessors
  55     // the currently selected page (-1 if none)
  56   int GetSelection() const { return m_nSel; }
  57   void SetSelection(int nSel) { m_nSel = nSel; }
  58     // the page that was selected before the change (-1 if none)
  59   int GetOldSelection() const { return m_nOldSel; }
  60   void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }
  61
  62 private:
  63   int m_nSel,     // currently selected page
  64       m_nOldSel;  // previously selected page
  65
  66   DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
  67 };
  68
  69 // ----------------------------------------------------------------------------
  70 // wxNotebook
  71 // ----------------------------------------------------------------------------
  72
  73 // @@@ this class should really derive from wxTabCtrl, but the interface is not
  74 //     exactly the same, so I can't do it right now and instead we reimplement
  75 //     part of wxTabCtrl here
  76 class WXDLLEXPORT wxNotebook : public wxControl
  77 {
  78 public:
  79   // ctors
  80   // -----
  81     // default for dynamic class
  82   wxNotebook();
  83     // the same arguments as for wxControl (@@@ any special styles?)
  84   wxNotebook(wxWindow *parent,
  85              wxWindowID id,
  86              const wxPoint& pos = wxDefaultPosition,
  87              const wxSize& size = wxDefaultSize,
  88              long style = 0,
  89              const wxString& name = "notebook");
  90     // Create() function
  91   bool Create(wxWindow *parent,
  92               wxWindowID id,
  93               const wxPoint& pos = wxDefaultPosition,
  94               const wxSize& size = wxDefaultSize,
  95               long style = 0,
  96               const wxString& name = "notebook");
  97     // dtor
  98   ~wxNotebook();
  99
 100   // accessors
 101   // ---------
 102     // get number of pages in the dialog
 103   int GetPageCount() const;
 104
 105     // set the currently selected page, return the index of the previously
 106     // selected one (or -1 on error)
 107     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
 108   int SetSelection(int nPage);
 109     // cycle thru the tabs
 110   void AdvanceSelection(bool bForward = TRUE);
 111     // get the currently selected page
 112   int GetSelection() const { return m_nSelection; }
 113
 114     // set/get the title of a page
 115   bool SetPageText(int nPage, const wxString& strText);
 116   wxString GetPageText(int nPage) const;
 117
 118   // image list stuff: each page may have an image associated with it. All
 119   // the images belong to an image list, so you have to
 120   // 1) create an image list
 121   // 2) associate it with the notebook
 122   // 3) set for each page it's image
 123     // associate image list with a control
 124   void SetImageList(wxImageList* imageList);
 125     // get pointer (may be NULL) to the associated image list
 126   wxImageList* GetImageList() const { return m_pImageList; }
 127
 128     // sets/returns item's image index in the current image list
 129   int  GetPageImage(int nPage) const;
 130   bool SetPageImage(int nPage, int nImage);
 131
 132     // currently it's always 1 because wxGTK doesn't support multi-row
 133     // tab controls
 134   int GetRowCount() const;
 135
 136   // control the appearance of the notebook pages
 137     // set the size (the same for all pages)
 138   void SetPageSize(const wxSize& size);
 139     // set the padding between tabs (in pixels)
 140   void SetPadding(const wxSize& padding);
 141
 142   // operations
 143   // ----------
 144     // remove one page from the notebook
 145   bool DeletePage(int nPage);
 146     // remove all pages
 147   bool DeleteAllPages();
 148     // adds a new page to the notebook (it will be deleted ny the notebook,
 149     // don't delete it yourself). If bSelect, this page becomes active.
 150   bool AddPage(wxNotebookPage *pPage,
 151                const wxString& strText,
 152                bool bSelect = FALSE,
 153                int imageId = -1);
 154     // the same as AddPage(), but adds it at the specified position
 155   bool InsertPage(int nPage,
 156                   wxNotebookPage *pPage,
 157                   const wxString& strText,
 158                   bool bSelect = FALSE,
 159                   int imageId = -1);
 160     // get the panel which represents the given page
 161   wxNotebookPage *GetPage(int nPage) { return m_aPages[nPage]; }
 162
 163   // callbacks
 164   // ---------
 165   void OnSize(wxSizeEvent& event);
 166   void OnSelChange(wxNotebookEvent& event);
 167   void OnSetFocus(wxFocusEvent& event);
 168   void OnNavigationKey(wxNavigationKeyEvent& event);
 169   void OnEraseBackground(wxEraseEvent& event);
 170
 171   // base class virtuals
 172   // -------------------
 173   virtual void Command(wxCommandEvent& event);
 174   virtual bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam);
 175   virtual void SetConstraintSizes(bool recurse = TRUE);
 176   virtual bool DoPhase(int nPhase);
 177
 178 protected:
 179   // common part of all ctors
 180   void Init();
 181
 182   // helper functions
 183   void ChangePage(int nOldSel, int nSel); // change pages
 184
 185   wxImageList  *m_pImageList; // we can have an associated image list
 186   wxArrayPages  m_aPages;     // array of pages
 187
 188   int m_nSelection;           // the current selection (-1 if none)
 189
 190   DECLARE_DYNAMIC_CLASS(wxNotebook)
 191   DECLARE_EVENT_TABLE()
 192 };
 193
 194 // ----------------------------------------------------------------------------
 195 // event macros
 196 // ----------------------------------------------------------------------------
 197 typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 198
 199 #define EVT_NOTEBOOK_PAGE_CHANGED(id, fn)                                   \
 200   {                                                                         \
 201     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,                                    \
 202     id,                                                                     \
 203     -1,                                                                     \
 204     (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
 205     NULL                                                                    \
 206   },
 207
 208 #define EVT_NOTEBOOK_PAGE_CHANGING(id, fn)                                  \
 209   {                                                                         \
 210     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \                                 \
 211     id,                                                                     \
 212     -1,                                                                     \
 213     (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
 214     NULL                                                                    \
 215   },
 216
 217 #endif // _NOTEBOOK_H