include/wx/gtk/notebook.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        notebook.h
   3 // Purpose:     wxNotebook class
   4 // Author:      Robert Roebling
   5 // Modified by:
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Julian Smart and Robert Roebling
   8 // Licence:     wxWindows license
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef __GTKNOTEBOOKH__
  12 #define __GTKNOTEBOOKH__
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include "wx/defs.h"
  19 #include "wx/object.h"
  20 #include "wx/string.h"
  21 #include "wx/control.h"
  22
  23 //-----------------------------------------------------------------------------
  24 // classes
  25 //-----------------------------------------------------------------------------
  26
  27 class wxImageList;
  28 class wxNotebook;
  29 class wxNotebookPage;
  30
  31 // ----------------------------------------------------------------------------
  32 // notebook events
  33 // ----------------------------------------------------------------------------
  34
  35 class wxNotebookEvent : public wxNotifyEvent
  36 {
  37 public:
  38   wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
  39                   int nSel = -1, int nOldSel = -1)
  40   : wxNotifyEvent(commandType, id)
  41   {
  42       m_bAllow = TRUE;
  43       m_nSel = nSel;
  44       m_nOldSel = nOldSel;
  45   }
  46
  47   // accessors
  48   int GetSelection() const { return m_nSel; }
  49   int GetOldSelection() const { return m_nOldSel; }
  50
  51   // for wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING event this method may be called
  52   // to disallow the page change
  53   void Veto() { m_bAllow = FALSE; }
  54
  55   // implementation: for wxNotebook usage only
  56   bool Allowed() const { return m_bAllow; }
  57
  58 private:
  59   bool m_bAllow;
  60
  61   int m_nSel,     // currently selected page
  62       m_nOldSel;  // previously selected page
  63
  64   DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
  65 };
  66
  67 //-----------------------------------------------------------------------------
  68 // wxNotebook
  69 //-----------------------------------------------------------------------------
  70
  71 class wxNotebook : public wxControl
  72 {
  73 public:
  74   // ctors
  75   // -----
  76     // default for dynamic class
  77   wxNotebook();
  78     // the same arguments as for wxControl (@@@ any special styles?)
  79   wxNotebook(wxWindow *parent,
  80              wxWindowID id,
  81              const wxPoint& pos = wxDefaultPosition,
  82              const wxSize& size = wxDefaultSize,
  83              long style = 0,
  84              const wxString& name = "notebook");
  85     // Create() function
  86   bool Create(wxWindow *parent,
  87               wxWindowID id,
  88               const wxPoint& pos = wxDefaultPosition,
  89               const wxSize& size = wxDefaultSize,
  90               long style = 0,
  91               const wxString& name = "notebook");
  92     // dtor
  93   ~wxNotebook();
  94
  95   // accessors
  96   // ---------
  97     // get number of pages in the dialog
  98   int GetPageCount() const;
  99
 100     // set the currently selected page, return the index of the previously
 101     // selected one (or -1 on error)
 102     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
 103   int SetSelection(int nPage);
 104     // cycle thru the tabs
 105   void AdvanceSelection(bool bForward = TRUE);
 106     // get the currently selected page
 107   int GetSelection() const;
 108
 109     // set/get the title of a page
 110   bool SetPageText(int nPage, const wxString& strText);
 111   wxString GetPageText(int nPage) const;
 112
 113   // image list stuff: each page may have an image associated with it. All
 114   // the images belong to an image list, so you have to
 115   // 1) create an image list
 116   // 2) associate it with the notebook
 117   // 3) set for each page it's image
 118     // associate image list with a control
 119   void SetImageList(wxImageList* imageList);
 120     // get pointer (may be NULL) to the associated image list
 121   wxImageList *GetImageList() const { return m_imageList; }
 122
 123     // sets/returns item's image index in the current image list
 124   int  GetPageImage(int nPage) const;
 125   bool SetPageImage(int nPage, int nImage);
 126
 127     // currently it's always 1 because wxGTK doesn't support multi-row
 128     // tab controls
 129   int GetRowCount() const;
 130
 131   // control the appearance of the notebook pages
 132     // set the size (the same for all pages)
 133   void SetPageSize(const wxSize& size);
 134     // set the padding between tabs (in pixels)
 135   void SetPadding(const wxSize& padding);
 136     // sets the size of the tabs (assumes all tabs are the same size)
 137   void SetTabSize(const wxSize& sz);
 138
 139   // operations
 140   // ----------
 141     // remove one page from the notebook but do not destroy it
 142   bool RemovePage(int nPage);
 143     // remove one page from the notebook
 144   bool DeletePage(int nPage);
 145     // remove all pages
 146   bool DeleteAllPages();
 147     // adds a new page to the notebook (it will be deleted ny the notebook,
 148     // don't delete it yourself). If bSelect, this page becomes active.
 149   bool AddPage(wxWindow *pPage,
 150                const wxString& strText,
 151                bool select = FALSE,
 152                int imageId = -1);
 153     // TODO VZ: I don't know how to implement InsertPage()
 154
 155     // get the panel which represents the given page
 156   wxWindow *GetPage(int nPage) const;
 157
 158   void OnNavigationKey(wxNavigationKeyEvent& event);
 159
 160   // implementation
 161
 162   void SetConstraintSizes(bool recurse);
 163   bool DoPhase(int phase);
 164   void ApplyWidgetStyle();
 165
 166   // report if window belongs to notebook
 167   bool IsOwnGtkWindow( GdkWindow *window );
 168
 169   // common part of all ctors
 170   void Init();
 171
 172   // helper function
 173   wxNotebookPage* GetNotebookPage(int page) const;
 174
 175   wxImageList*    m_imageList;
 176   wxList          m_pages;
 177   size_t            m_idHandler; // the change page handler id
 178
 179   DECLARE_DYNAMIC_CLASS(wxNotebook)
 180   DECLARE_EVENT_TABLE()
 181 };
 182
 183 // ----------------------------------------------------------------------------
 184 // event macros
 185 // ----------------------------------------------------------------------------
 186 typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 187
 188 #define EVT_NOTEBOOK_PAGE_CHANGED(id, fn)                                   \
 189   {                                                                         \
 190     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,                                    \
 191     id,                                                                     \
 192     -1,                                                                     \
 193     (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
 194     NULL                                                                    \
 195   },
 196
 197 #define EVT_NOTEBOOK_PAGE_CHANGING(id, fn)                                  \
 198   {                                                                         \
 199     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,                                   \
 200     id,                                                                     \
 201     -1,                                                                     \
 202     (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
 203     NULL                                                                    \
 204   },
 205
 206 #endif
 207     // __GTKNOTEBOOKH__