include/wx/bookctrl.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/bookctrl.h
   3 // Purpose:     wxBookCtrlBase: common base class for wxList/Tree/Notebook
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     19.08.03
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BOOKCTRL_H_
  13 #define _WX_BOOKCTRL_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_BOOKCTRL
  22
  23 #include "wx/control.h"
  24 #include "wx/dynarray.h"
  25
  26 WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
  27
  28 class WXDLLEXPORT wxImageList;
  29
  30 // ----------------------------------------------------------------------------
  31 // wxBookCtrlBase
  32 // ----------------------------------------------------------------------------
  33
  34 class WXDLLEXPORT wxBookCtrlBase : public wxControl
  35 {
  36 public:
  37     // construction
  38     // ------------
  39
  40     wxBookCtrlBase()
  41     {
  42         Init();
  43     }
  44
  45     wxBookCtrlBase(wxWindow *parent,
  46                    wxWindowID winid,
  47                    const wxPoint& pos = wxDefaultPosition,
  48                    const wxSize& size = wxDefaultSize,
  49                    long style = 0,
  50                    const wxString& name = wxEmptyString)
  51     {
  52         Init();
  53
  54         (void)Create(parent, winid, pos, size, style, name);
  55     }
  56
  57     // quasi ctor
  58     bool Create(wxWindow *parent,
  59                 wxWindowID winid,
  60                 const wxPoint& pos = wxDefaultPosition,
  61                 const wxSize& size = wxDefaultSize,
  62                 long style = 0,
  63                 const wxString& name = wxEmptyString);
  64
  65     // dtor
  66     virtual ~wxBookCtrlBase();
  67
  68
  69     // accessors
  70     // ---------
  71
  72     // get number of pages in the dialog
  73     virtual size_t GetPageCount() const { return m_pages.size(); }
  74
  75     // get the panel which represents the given page
  76     wxWindow *GetPage(size_t n) { return m_pages[n]; }
  77     wxWindow *GetPage(size_t n) const { return m_pages[n]; }
  78
  79     // get the current page or NULL if none
  80     wxWindow *GetCurrentPage() const
  81     {
  82         const int n = GetSelection();
  83         return n == wxNOT_FOUND ? NULL : GetPage(n);
  84     }
  85
  86     // get the currently selected page or wxNOT_FOUND if none
  87     virtual int GetSelection() const = 0;
  88
  89     // set/get the title of a page
  90     virtual bool SetPageText(size_t n, const wxString& strText) = 0;
  91     virtual wxString GetPageText(size_t n) const = 0;
  92
  93
  94     // image list stuff: each page may have an image associated with it (all
  95     // images belong to the same image list)
  96     // ---------------------------------------------------------------------
  97
  98     // sets the image list to use, it is *not* deleted by the control
  99     virtual void SetImageList(wxImageList *imageList);
 100
 101     // as SetImageList() but we will delete the image list ourselves
 102     void AssignImageList(wxImageList *imageList);
 103
 104     // get pointer (may be NULL) to the associated image list
 105     wxImageList* GetImageList() const { return m_imageList; }
 106
 107     // sets/returns item's image index in the current image list
 108     virtual int GetPageImage(size_t n) const = 0;
 109     virtual bool SetPageImage(size_t n, int imageId) = 0;
 110
 111
 112     // geometry
 113     // --------
 114
 115     // resize the notebook so that all pages will have the specified size
 116     virtual void SetPageSize(const wxSize& size);
 117
 118     // calculate the size of the control from the size of its page
 119     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0;
 120
 121     // get/set size of area between book control area and page area
 122     inline unsigned int GetInternalBorder() const
 123     {
 124         return m_internalBorder;
 125     }
 126     void SetInternalBorder(unsigned int internalBorder)
 127     {
 128         m_internalBorder = internalBorder;
 129     }
 130
 131     // returns true if we have wxCHB_TOP or wxCHB_BOTTOM style
 132     bool IsVertical() const { return HasFlag(wxBK_BOTTOM | wxBK_TOP); }
 133
 134     // operations
 135     // ----------
 136
 137     // remove one page from the control and delete it
 138     virtual bool DeletePage(size_t n);
 139
 140     // remove one page from the notebook, without deleting it
 141     virtual bool RemovePage(size_t n)
 142     {
 143         InvalidateBestSize();
 144         return DoRemovePage(n) != NULL;
 145     }
 146
 147     // remove all pages and delete them
 148     virtual bool DeleteAllPages()
 149     {
 150         InvalidateBestSize();
 151         WX_CLEAR_ARRAY(m_pages);
 152         return true;
 153     }
 154
 155     // adds a new page to the control
 156     virtual bool AddPage(wxWindow *page,
 157                          const wxString& text,
 158                          bool bSelect = false,
 159                          int imageId = -1)
 160     {
 161         InvalidateBestSize();
 162         return InsertPage(GetPageCount(), page, text, bSelect, imageId);
 163     }
 164
 165     // the same as AddPage(), but adds the page at the specified position
 166     virtual bool InsertPage(size_t n,
 167                             wxWindow *page,
 168                             const wxString& text,
 169                             bool bSelect = false,
 170                             int imageId = -1) = 0;
 171
 172     // set the currently selected page, return the index of the previously
 173     // selected one (or -1 on error)
 174     //
 175     // NB: this function will generate PAGE_CHANGING/ED events
 176     virtual int SetSelection(size_t n) = 0;
 177
 178
 179     // cycle thru the pages
 180     void AdvanceSelection(bool forward = true)
 181     {
 182         int nPage = GetNextPage(forward);
 183         if ( nPage != -1 )
 184         {
 185             // cast is safe because of the check above
 186             SetSelection((size_t)nPage);
 187         }
 188     }
 189
 190 protected:
 191     // Should we accept NULL page pointers in Add/InsertPage()?
 192     //
 193     // Default is no but derived classes may override it if they can treat NULL
 194     // pages in some sensible way (e.g. wxTreebook overrides this to allow
 195     // having nodes without any associated page)
 196     virtual bool AllowNullPage() const { return false; }
 197
 198     // remove the page and return a pointer to it
 199     virtual wxWindow *DoRemovePage(size_t page) = 0;
 200
 201     // our best size is the size which fits all our pages
 202     virtual wxSize DoGetBestSize() const;
 203
 204     // helper: get the next page wrapping if we reached the end
 205     int GetNextPage(bool forward) const;
 206
 207     // Always rely on GetBestSize, which will look at all the pages
 208     virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) { }
 209
 210     // Lay out controls
 211     void DoSize();
 212
 213     // the array of all pages of this control
 214     wxArrayPages m_pages;
 215
 216     // the associated image list or NULL
 217     wxImageList *m_imageList;
 218
 219     // true if we must delete m_imageList
 220     bool m_ownsImageList;
 221
 222     // get the page area
 223     wxRect GetPageRect() const;
 224
 225     // event handlers
 226     virtual wxSize GetControllerSize() const;
 227     void OnSize(wxSizeEvent& event);
 228
 229     // controller buddy if available, NULL otherwise (usually for native book controls like wxNotebook)
 230     wxControl *m_bookctrl;
 231
 232 private:
 233
 234     // common part of all ctors
 235     void Init();
 236
 237     // internal border
 238     unsigned int m_internalBorder;
 239
 240     DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
 241     DECLARE_NO_COPY_CLASS(wxBookCtrlBase)
 242     DECLARE_EVENT_TABLE()
 243 };
 244
 245 // ----------------------------------------------------------------------------
 246 // wxBookCtrlBaseEvent: page changing events generated by derived classes
 247 // ----------------------------------------------------------------------------
 248
 249 class WXDLLEXPORT wxBookCtrlBaseEvent : public wxNotifyEvent
 250 {
 251 public:
 252     wxBookCtrlBaseEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
 253                         int nSel = -1, int nOldSel = -1)
 254         : wxNotifyEvent(commandType, winid)
 255     {
 256         m_nSel = nSel;
 257         m_nOldSel = nOldSel;
 258     }
 259
 260     wxBookCtrlBaseEvent(const wxBookCtrlBaseEvent& event)
 261         : wxNotifyEvent(event)
 262     {
 263         m_nSel = event.m_nSel;
 264         m_nOldSel = event.m_nOldSel;
 265     }
 266
 267     // accessors
 268         // the currently selected page (-1 if none)
 269     int GetSelection() const { return m_nSel; }
 270     void SetSelection(int nSel) { m_nSel = nSel; }
 271         // the page that was selected before the change (-1 if none)
 272     int GetOldSelection() const { return m_nOldSel; }
 273     void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }
 274
 275 private:
 276     int m_nSel,     // currently selected page
 277         m_nOldSel;  // previously selected page
 278 };
 279
 280 // make a default book control for given platform
 281 #if wxUSE_NOTEBOOK
 282     // dedicated to majority of desktops
 283     #include "wx/notebook.h"
 284     #define wxBookCtrl                             wxNotebook
 285     #define wxBookCtrlEvent                        wxNotebookEvent
 286     #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
 287     #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
 288     #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn)      EVT_NOTEBOOK_PAGE_CHANGED(id, fn)
 289     #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn)     EVT_NOTEBOOK_PAGE_CHANGING(id, fn)
 290 #else
 291     // dedicated to Smartphones
 292     #include "wx/choicebk.h"
 293     #define wxBookCtrl                             wxChoicebook
 294     #define wxBookCtrlEvent                        wxChoicebookEvent
 295     #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED
 296     #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING
 297     #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn)      EVT_CHOICEBOOK_PAGE_CHANGED(id, fn)
 298     #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn)     EVT_CHOICEBOOK_PAGE_CHANGING(id, fn)
 299 #endif
 300
 301 #if WXWIN_COMPATIBILITY_2_6
 302     #define wxBC_TOP                               wxBK_TOP
 303     #define wxBC_BOTTOM                            wxBK_BOTTOM
 304     #define wxBC_LEFT                              wxBK_LEFT
 305     #define wxBC_RIGHT                             wxBK_RIGHT
 306     #define wxBC_DEFAULT                           wxBK_DEFAULT
 307 #endif
 308
 309 #endif // wxUSE_BOOKCTRL
 310
 311 #endif // _WX_BOOKCTRL_H_