include/wx/bookctrl.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/bookctrl.h
   3 // Purpose:     wxBookCtrl: 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@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BOOKCTRL_H_
  13 #define _WX_BOOKCTRL_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "bookctrl.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // headers
  21 // ----------------------------------------------------------------------------
  22
  23 #include "wx/defs.h"
  24
  25 #if wxUSE_BOOKCTRL
  26
  27 #include "wx/control.h"
  28 #include "wx/dynarray.h"
  29
  30 WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
  31
  32 class WXDLLEXPORT wxImageList;
  33
  34 // ----------------------------------------------------------------------------
  35 // wxBookCtrl
  36 // ----------------------------------------------------------------------------
  37
  38 class WXDLLEXPORT wxBookCtrl : public wxControl
  39 {
  40 public:
  41     // construction
  42     // ------------
  43
  44     wxBookCtrl()
  45     {
  46         Init();
  47     }
  48
  49     wxBookCtrl(wxWindow *parent,
  50                wxWindowID winid,
  51                const wxPoint& pos = wxDefaultPosition,
  52                const wxSize& size = wxDefaultSize,
  53                long style = 0,
  54                const wxString& name = wxEmptyString)
  55     {
  56         Init();
  57
  58         (void)Create(parent, winid, pos, size, style, name);
  59     }
  60
  61     // quasi ctor
  62     bool Create(wxWindow *parent,
  63                 wxWindowID winid,
  64                 const wxPoint& pos = wxDefaultPosition,
  65                 const wxSize& size = wxDefaultSize,
  66                 long style = 0,
  67                 const wxString& name = wxEmptyString);
  68
  69     // dtor
  70     virtual ~wxBookCtrl();
  71
  72
  73     // accessors
  74     // ---------
  75
  76     // get number of pages in the dialog
  77     virtual size_t GetPageCount() const { return m_pages.size(); }
  78
  79     // get the panel which represents the given page
  80     virtual wxWindow *GetPage(size_t n) { return m_pages[n]; }
  81
  82     // get the currently selected page or wxNOT_FOUND if none
  83     virtual int GetSelection() const = 0;
  84
  85     // set/get the title of a page
  86     virtual bool SetPageText(size_t n, const wxString& strText) = 0;
  87     virtual wxString GetPageText(size_t n) const = 0;
  88
  89
  90     // image list stuff: each page may have an image associated with it (all
  91     // images belong to the same image list)
  92     // ---------------------------------------------------------------------
  93
  94     // sets the image list to use, it is *not* deleted by the control
  95     virtual void SetImageList(wxImageList *imageList);
  96
  97     // as SetImageList() but we will delete the image list ourselves
  98     void AssignImageList(wxImageList *imageList);
  99
 100     // get pointer (may be NULL) to the associated image list
 101     wxImageList* GetImageList() const { return m_imageList; }
 102
 103     // sets/returns item's image index in the current image list
 104     virtual int GetPageImage(size_t n) const = 0;
 105     virtual bool SetPageImage(size_t n, int imageId) = 0;
 106
 107
 108     // geometry
 109     // --------
 110
 111     // resize the notebook so that all pages will have the specified size
 112     virtual void SetPageSize(const wxSize& size);
 113
 114     // calculate the size of the control from the size of its page
 115     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0;
 116
 117
 118     // operations
 119     // ----------
 120
 121     // remove one page from the control and delete it
 122     virtual bool DeletePage(size_t n);
 123
 124     // remove one page from the notebook, without deleting it
 125     virtual bool RemovePage(size_t n) { return DoRemovePage(n) != NULL; }
 126
 127     // remove all pages and delete them
 128     virtual bool DeleteAllPages() { WX_CLEAR_ARRAY(m_pages); return true; }
 129
 130     // adds a new page to the control
 131     virtual bool AddPage(wxWindow *page,
 132                          const wxString& text,
 133                          bool bSelect = false,
 134                          int imageId = -1)
 135     {
 136         return InsertPage(GetPageCount(), page, text, bSelect, imageId);
 137     }
 138
 139     // the same as AddPage(), but adds the page at the specified position
 140     virtual bool InsertPage(size_t n,
 141                             wxWindow *page,
 142                             const wxString& text,
 143                             bool bSelect = false,
 144                             int imageId = -1) = 0;
 145
 146     // set the currently selected page, return the index of the previously
 147     // selected one (or -1 on error)
 148     //
 149     // NB: this function will _not_ generate PAGE_CHANGING/ED events
 150     virtual int SetSelection(size_t n) = 0;
 151
 152
 153     // cycle thru the pages
 154     void AdvanceSelection(bool forward = true)
 155     {
 156         int nPage = GetNextPage(forward);
 157         if ( nPage != -1 )
 158         {
 159             // cast is safe because of the check above
 160             SetSelection((size_t)nPage);
 161         }
 162     }
 163
 164     virtual void ApplyParentThemeBackground(const wxColour& bg)
 165         { SetBackgroundColour(bg); }
 166
 167 protected:
 168     // remove the page and return a pointer to it
 169     virtual wxWindow *DoRemovePage(size_t page) = 0;
 170
 171     // our best size is the size which fits all our pages
 172     virtual wxSize DoGetBestSize() const;
 173
 174     // helper: get the next page wrapping if we reached the end
 175     int GetNextPage(bool forward) const;
 176
 177     // common part of all ctors
 178     void Init();
 179
 180     // Always rely on GetBestSize, which will look at all the pages
 181     virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) { }
 182
 183     // the array of all pages of this control
 184     wxArrayPages m_pages;
 185
 186     // the associated image list or NULL
 187     wxImageList *m_imageList;
 188
 189     // true if we must delete m_imageList
 190     bool m_ownsImageList;
 191
 192
 193     DECLARE_NO_COPY_CLASS(wxBookCtrl)
 194 };
 195
 196 // ----------------------------------------------------------------------------
 197 // wxBookCtrlEvent: page changing events generated by derived classes
 198 // ----------------------------------------------------------------------------
 199
 200 class WXDLLEXPORT wxBookCtrlEvent : public wxNotifyEvent
 201 {
 202 public:
 203     wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
 204                     int nSel = -1, int nOldSel = -1)
 205         : wxNotifyEvent(commandType, winid)
 206         {
 207             m_nSel = nSel;
 208             m_nOldSel = nOldSel;
 209         }
 210
 211     // accessors
 212         // the currently selected page (-1 if none)
 213     int GetSelection() const { return m_nSel; }
 214     void SetSelection(int nSel) { m_nSel = nSel; }
 215         // the page that was selected before the change (-1 if none)
 216     int GetOldSelection() const { return m_nOldSel; }
 217     void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }
 218
 219 private:
 220     int m_nSel,     // currently selected page
 221         m_nOldSel;  // previously selected page
 222 };
 223
 224 #endif // wxUSE_BOOKCTRL
 225
 226 #endif // _WX_BOOKCTRL_H_