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