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 class WXDLLEXPORT wxBookCtrlBaseEvent;
  30
  31 // ----------------------------------------------------------------------------
  32 // constants
  33 // ----------------------------------------------------------------------------
  34
  35 // wxBookCtrl hit results
  36 enum
  37 {
  38     wxBK_HITTEST_NOWHERE = 1,   // not on tab
  39     wxBK_HITTEST_ONICON  = 2,   // on icon
  40     wxBK_HITTEST_ONLABEL = 4,   // on label
  41     wxBK_HITTEST_ONITEM  = wxBK_HITTEST_ONICON | wxBK_HITTEST_ONLABEL,
  42     wxBK_HITTEST_ONPAGE  = 8    // not on tab control, but over the selected page
  43 };
  44
  45 // wxBookCtrl flags (common for wxNotebook, wxListbook, wxChoicebook, wxTreebook)
  46 #define wxBK_DEFAULT          0x0000
  47 #define wxBK_TOP              0x0010
  48 #define wxBK_BOTTOM           0x0020
  49 #define wxBK_LEFT             0x0040
  50 #define wxBK_RIGHT            0x0080
  51 #define wxBK_ALIGN_MASK       (wxBK_TOP | wxBK_BOTTOM | wxBK_LEFT | wxBK_RIGHT)
  52
  53 // ----------------------------------------------------------------------------
  54 // wxBookCtrlBase
  55 // ----------------------------------------------------------------------------
  56
  57 class WXDLLEXPORT wxBookCtrlBase : public wxControl
  58 {
  59 public:
  60     // construction
  61     // ------------
  62
  63     wxBookCtrlBase()
  64     {
  65         Init();
  66     }
  67
  68     wxBookCtrlBase(wxWindow *parent,
  69                    wxWindowID winid,
  70                    const wxPoint& pos = wxDefaultPosition,
  71                    const wxSize& size = wxDefaultSize,
  72                    long style = 0,
  73                    const wxString& name = wxEmptyString)
  74     {
  75         Init();
  76
  77         (void)Create(parent, winid, pos, size, style, name);
  78     }
  79
  80     // quasi ctor
  81     bool Create(wxWindow *parent,
  82                 wxWindowID winid,
  83                 const wxPoint& pos = wxDefaultPosition,
  84                 const wxSize& size = wxDefaultSize,
  85                 long style = 0,
  86                 const wxString& name = wxEmptyString);
  87
  88     // dtor
  89     virtual ~wxBookCtrlBase();
  90
  91
  92     // accessors
  93     // ---------
  94
  95     // get number of pages in the dialog
  96     virtual size_t GetPageCount() const { return m_pages.size(); }
  97
  98     // get the panel which represents the given page
  99     wxWindow *GetPage(size_t n) { return m_pages[n]; }
 100     wxWindow *GetPage(size_t n) const { return m_pages[n]; }
 101
 102     // get the current page or NULL if none
 103     wxWindow *GetCurrentPage() const
 104     {
 105         const int n = GetSelection();
 106         return n == wxNOT_FOUND ? NULL : GetPage(n);
 107     }
 108
 109     // get the currently selected page or wxNOT_FOUND if none
 110     virtual int GetSelection() const = 0;
 111
 112     // set/get the title of a page
 113     virtual bool SetPageText(size_t n, const wxString& strText) = 0;
 114     virtual wxString GetPageText(size_t n) const = 0;
 115
 116
 117     // image list stuff: each page may have an image associated with it (all
 118     // images belong to the same image list)
 119     // ---------------------------------------------------------------------
 120
 121     // sets the image list to use, it is *not* deleted by the control
 122     virtual void SetImageList(wxImageList *imageList);
 123
 124     // as SetImageList() but we will delete the image list ourselves
 125     void AssignImageList(wxImageList *imageList);
 126
 127     // get pointer (may be NULL) to the associated image list
 128     wxImageList* GetImageList() const { return m_imageList; }
 129
 130     // sets/returns item's image index in the current image list
 131     virtual int GetPageImage(size_t n) const = 0;
 132     virtual bool SetPageImage(size_t n, int imageId) = 0;
 133
 134
 135     // geometry
 136     // --------
 137
 138     // resize the notebook so that all pages will have the specified size
 139     virtual void SetPageSize(const wxSize& size);
 140
 141     // calculate the size of the control from the size of its page
 142     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0;
 143
 144     // get/set size of area between book control area and page area
 145     unsigned int GetInternalBorder() const { return m_internalBorder; }
 146     void SetInternalBorder(unsigned int border) { m_internalBorder = border; }
 147
 148     // Sets/gets the margin around the controller
 149     void SetControlMargin(int margin) { m_controlMargin = margin; }
 150     int GetControlMargin() const { return m_controlMargin; }
 151
 152     // returns true if we have wxBK_TOP or wxBK_BOTTOM style
 153     bool IsVertical() const { return HasFlag(wxBK_BOTTOM | wxBK_TOP); }
 154
 155     // set/get option to shrink to fit current page
 156     void SetFitToCurrentPage(bool fit) { m_fitToCurrentPage = fit; }
 157     bool GetFitToCurrentPage() const { return m_fitToCurrentPage; }
 158
 159     // returns the sizer containing the control, if any
 160     wxSizer* GetControlSizer() const { return m_controlSizer; }
 161
 162
 163     // operations
 164     // ----------
 165
 166     // remove one page from the control and delete it
 167     virtual bool DeletePage(size_t n);
 168
 169     // remove one page from the notebook, without deleting it
 170     virtual bool RemovePage(size_t n)
 171     {
 172         DoInvalidateBestSize();
 173         return DoRemovePage(n) != NULL;
 174     }
 175
 176     // remove all pages and delete them
 177     virtual bool DeleteAllPages()
 178     {
 179         DoInvalidateBestSize();
 180         WX_CLEAR_ARRAY(m_pages);
 181         return true;
 182     }
 183
 184     // adds a new page to the control
 185     virtual bool AddPage(wxWindow *page,
 186                          const wxString& text,
 187                          bool bSelect = false,
 188                          int imageId = -1)
 189     {
 190         DoInvalidateBestSize();
 191         return InsertPage(GetPageCount(), page, text, bSelect, imageId);
 192     }
 193
 194     // the same as AddPage(), but adds the page at the specified position
 195     virtual bool InsertPage(size_t n,
 196                             wxWindow *page,
 197                             const wxString& text,
 198                             bool bSelect = false,
 199                             int imageId = -1) = 0;
 200
 201     // set the currently selected page, return the index of the previously
 202     // selected one (or -1 on error)
 203     //
 204     // NB: this function will generate PAGE_CHANGING/ED events
 205     virtual int SetSelection(size_t n) = 0;
 206
 207     // acts as SetSelection but does not generate events
 208     virtual int ChangeSelection(size_t n) = 0;
 209
 210
 211     // cycle thru the pages
 212     void AdvanceSelection(bool forward = true)
 213     {
 214         int nPage = GetNextPage(forward);
 215         if ( nPage != -1 )
 216         {
 217             // cast is safe because of the check above
 218             SetSelection((size_t)nPage);
 219         }
 220     }
 221
 222     // hit test: returns which page is hit and, optionally, where (icon, label)
 223     virtual int HitTest(const wxPoint& WXUNUSED(pt),
 224                         long * WXUNUSED(flags) = NULL) const
 225     {
 226         return wxNOT_FOUND;
 227     }
 228
 229
 230     // we do have multiple pages
 231     virtual bool HasMultiplePages() const { return true; }
 232
 233     // we don't want focus for ourselves
 234     virtual bool AcceptsFocus() const { return false; }
 235
 236 protected:
 237     // flags for DoSetSelection()
 238     enum
 239     {
 240         SetSelection_SendEvent = 1
 241     };
 242
 243     // set the selection to the given page, sending the events (which can
 244     // possibly prevent the page change from taking place) if SendEvent flag is
 245     // included
 246     virtual int DoSetSelection(size_t nPage, int flags = 0);
 247
 248     // if the derived class uses DoSetSelection() for implementing
 249     // [Set|Change]Selection, it must override UpdateSelectedPage(),
 250     // CreatePageChangingEvent() and MakeChangedEvent(), but as it might not
 251     // use it, these functions are not pure virtual
 252
 253     // called to notify the control about a new current page
 254     virtual void UpdateSelectedPage(size_t WXUNUSED(newsel))
 255         { wxFAIL_MSG(wxT("Override this function!")); }
 256
 257     // create a new "page changing" event
 258     virtual wxBookCtrlBaseEvent* CreatePageChangingEvent() const
 259         { wxFAIL_MSG(wxT("Override this function!")); return NULL; }
 260
 261     // modify the event created by CreatePageChangingEvent() to "page changed"
 262     // event, usually by just calling SetEventType() on it
 263     virtual void MakeChangedEvent(wxBookCtrlBaseEvent& WXUNUSED(event))
 264         { wxFAIL_MSG(wxT("Override this function!")); }
 265
 266
 267     // Should we accept NULL page pointers in Add/InsertPage()?
 268     //
 269     // Default is no but derived classes may override it if they can treat NULL
 270     // pages in some sensible way (e.g. wxTreebook overrides this to allow
 271     // having nodes without any associated page)
 272     virtual bool AllowNullPage() const { return false; }
 273
 274     // remove the page and return a pointer to it
 275     virtual wxWindow *DoRemovePage(size_t page) = 0;
 276
 277     // our best size is the size which fits all our pages
 278     virtual wxSize DoGetBestSize() const;
 279
 280     // helper: get the next page wrapping if we reached the end
 281     int GetNextPage(bool forward) const;
 282
 283     // Lay out controls
 284     void DoSize();
 285
 286     // This method also invalidates the size of the controller and should be
 287     // called instead of just InvalidateBestSize() whenever pages are added or
 288     // removed as this also affects the controller
 289     void DoInvalidateBestSize();
 290
 291 #if wxUSE_HELP
 292     // Show the help for the corresponding page
 293     void OnHelp(wxHelpEvent& event);
 294 #endif // wxUSE_HELP
 295
 296
 297     // the array of all pages of this control
 298     wxArrayPages m_pages;
 299
 300     // the associated image list or NULL
 301     wxImageList *m_imageList;
 302
 303     // true if we must delete m_imageList
 304     bool m_ownsImageList;
 305
 306     // get the page area
 307     wxRect GetPageRect() const;
 308
 309     // event handlers
 310     virtual wxSize GetControllerSize() const;
 311     void OnSize(wxSizeEvent& event);
 312
 313     // controller buddy if available, NULL otherwise (usually for native book controls like wxNotebook)
 314     wxControl *m_bookctrl;
 315
 316     // Whether to shrink to fit current page
 317     bool m_fitToCurrentPage;
 318
 319     // the sizer containing the choice control
 320     wxSizer *m_controlSizer;
 321
 322     // the margin around the choice control
 323     int m_controlMargin;
 324
 325 private:
 326
 327     // common part of all ctors
 328     void Init();
 329
 330     // internal border
 331     unsigned int m_internalBorder;
 332
 333     DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
 334     DECLARE_NO_COPY_CLASS(wxBookCtrlBase)
 335     DECLARE_EVENT_TABLE()
 336 };
 337
 338 // ----------------------------------------------------------------------------
 339 // wxBookCtrlBaseEvent: page changing events generated by derived classes
 340 // ----------------------------------------------------------------------------
 341
 342 class WXDLLEXPORT wxBookCtrlBaseEvent : public wxNotifyEvent
 343 {
 344 public:
 345     wxBookCtrlBaseEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
 346                         int nSel = -1, int nOldSel = -1)
 347         : wxNotifyEvent(commandType, winid)
 348     {
 349         m_nSel = nSel;
 350         m_nOldSel = nOldSel;
 351     }
 352
 353     wxBookCtrlBaseEvent(const wxBookCtrlBaseEvent& event)
 354         : wxNotifyEvent(event)
 355     {
 356         m_nSel = event.m_nSel;
 357         m_nOldSel = event.m_nOldSel;
 358     }
 359
 360     // accessors
 361         // the currently selected page (-1 if none)
 362     int GetSelection() const { return m_nSel; }
 363     void SetSelection(int nSel) { m_nSel = nSel; }
 364         // the page that was selected before the change (-1 if none)
 365     int GetOldSelection() const { return m_nOldSel; }
 366     void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }
 367
 368 private:
 369     int m_nSel,     // currently selected page
 370         m_nOldSel;  // previously selected page
 371 };
 372
 373 // make a default book control for given platform
 374 #if wxUSE_NOTEBOOK
 375     // dedicated to majority of desktops
 376     #include "wx/notebook.h"
 377     #define wxBookCtrl                             wxNotebook
 378     #define wxBookCtrlEvent                        wxNotebookEvent
 379     #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
 380     #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
 381     #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn)      EVT_NOTEBOOK_PAGE_CHANGED(id, fn)
 382     #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn)     EVT_NOTEBOOK_PAGE_CHANGING(id, fn)
 383     #define wxBookctrlEventHandler(func)           wxNotebookEventHandler(func)
 384 #else
 385     // dedicated to Smartphones
 386     #include "wx/choicebk.h"
 387     #define wxBookCtrl                             wxChoicebook
 388     #define wxBookCtrlEvent                        wxChoicebookEvent
 389     #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED
 390     #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING
 391     #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn)      EVT_CHOICEBOOK_PAGE_CHANGED(id, fn)
 392     #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn)     EVT_CHOICEBOOK_PAGE_CHANGING(id, fn)
 393     #define wxBookctrlEventHandler(func)           wxChoicebookEventHandler(func)
 394 #endif
 395
 396 #if WXWIN_COMPATIBILITY_2_6
 397     #define wxBC_TOP                               wxBK_TOP
 398     #define wxBC_BOTTOM                            wxBK_BOTTOM
 399     #define wxBC_LEFT                              wxBK_LEFT
 400     #define wxBC_RIGHT                             wxBK_RIGHT
 401     #define wxBC_DEFAULT                           wxBK_DEFAULT
 402 #endif
 403
 404 #endif // wxUSE_BOOKCTRL
 405
 406 #endif // _WX_BOOKCTRL_H_