]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/bookctrl.h
simplify the client data/non standard images handling code by unconditionally using...
[wxWidgets.git] / include / wx / bookctrl.h
index e1605aef7310da1e771aee91a47eb2e16c0d2d2b..02ad3f6f5e385ba79c0caa5ce38c4b01d3f76fde 100644 (file)
 #ifndef _WX_BOOKCTRL_H_
 #define _WX_BOOKCTRL_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "bookctrl.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
@@ -77,14 +73,14 @@ public:
     virtual size_t GetPageCount() const { return m_pages.size(); }
 
     // get the panel which represents the given page
-    virtual wxWindow *GetPage(size_t n) { return m_pages[n]; }
+    wxWindow *GetPage(size_t n) { return m_pages[n]; }
+    wxWindow *GetPage(size_t n) const { return m_pages[n]; }
 
     // get the current page or NULL if none
     wxWindow *GetCurrentPage() const
     {
-        int n = GetSelection();
-        return n == wxNOT_FOUND ? NULL
-                                : wx_const_cast(wxBookCtrlBase *, this)->GetPage(n);
+        const int n = GetSelection();
+        return n == wxNOT_FOUND ? NULL : GetPage(n);
     }
 
     // get the currently selected page or wxNOT_FOUND if none
@@ -122,6 +118,29 @@ public:
     // calculate the size of the control from the size of its page
     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0;
 
+    // get/set size of area between book control area and page area
+    inline unsigned int GetInternalBorder() const
+    {
+        return m_internalBorder;
+    }
+    void SetInternalBorder(unsigned int internalBorder)
+    {
+        m_internalBorder = internalBorder;
+    }
+
+    // Sets/gets the margin around the controller
+    void SetControlMargin(int margin) { m_controlMargin = margin; }
+    int GetControlMargin() const { return m_controlMargin; }
+
+    // returns true if we have wxBK_TOP or wxBK_BOTTOM style
+    bool IsVertical() const { return HasFlag(wxBK_BOTTOM | wxBK_TOP); }
+
+    // set/get option to shrink to fit current page
+    void SetFitToCurrentPage(bool fit) { m_fitToCurrentPage = fit; }
+    bool GetFitToCurrentPage() const { return m_fitToCurrentPage; }
+
+    // returns the sizer containing the control, if any
+    wxSizer* GetControlSizer() const { return m_controlSizer; }
 
     // operations
     // ----------
@@ -179,12 +198,14 @@ public:
         }
     }
 
-    // override some base class virtuals
-    virtual void ApplyParentThemeBackground(const wxColour& bg)
-        { SetBackgroundColour(bg); }
-    virtual bool ProvidesBackground() const { return true; }
-
 protected:
+    // Should we accept NULL page pointers in Add/InsertPage()?
+    //
+    // Default is no but derived classes may override it if they can treat NULL
+    // pages in some sensible way (e.g. wxTreebook overrides this to allow
+    // having nodes without any associated page)
+    virtual bool AllowNullPage() const { return false; }
+
     // remove the page and return a pointer to it
     virtual wxWindow *DoRemovePage(size_t page) = 0;
 
@@ -194,12 +215,12 @@ protected:
     // helper: get the next page wrapping if we reached the end
     int GetNextPage(bool forward) const;
 
-    // common part of all ctors
-    void Init();
-
     // Always rely on GetBestSize, which will look at all the pages
     virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) { }
 
+    // Lay out controls
+    void DoSize();
+
     // the array of all pages of this control
     wxArrayPages m_pages;
 
@@ -209,8 +230,36 @@ protected:
     // true if we must delete m_imageList
     bool m_ownsImageList;
 
+    // get the page area
+    wxRect GetPageRect() const;
+
+    // event handlers
+    virtual wxSize GetControllerSize() const;
+    void OnSize(wxSizeEvent& event);
+
+    // controller buddy if available, NULL otherwise (usually for native book controls like wxNotebook)
+    wxControl *m_bookctrl;
+
+    // Whether to shrink to fit current page
+    bool m_fitToCurrentPage;
+
+    // the sizer containing the choice control
+    wxSizer*    m_controlSizer;
+
+    // the margin around the choice control
+    int         m_controlMargin;
+
+private:
+
+    // common part of all ctors
+    void Init();
 
+    // internal border
+    unsigned int m_internalBorder;
+
+    DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
     DECLARE_NO_COPY_CLASS(wxBookCtrlBase)
+    DECLARE_EVENT_TABLE()
 };
 
 // ----------------------------------------------------------------------------
@@ -223,10 +272,17 @@ public:
     wxBookCtrlBaseEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
                         int nSel = -1, int nOldSel = -1)
         : wxNotifyEvent(commandType, winid)
-        {
-            m_nSel = nSel;
-            m_nOldSel = nOldSel;
-        }
+    {
+        m_nSel = nSel;
+        m_nOldSel = nOldSel;
+    }
+
+    wxBookCtrlBaseEvent(const wxBookCtrlBaseEvent& event)
+        : wxNotifyEvent(event)
+    {
+        m_nSel = event.m_nSel;
+        m_nOldSel = event.m_nOldSel;
+    }
 
     // accessors
         // the currently selected page (-1 if none)
@@ -242,20 +298,8 @@ private:
 };
 
 // make a default book control for given platform
-#if defined(__WXMSW__) && defined(__SMARTPHONE__)
-    #include "wx/choicebk.h"
-    #define wxBookCtrl                             wxChoicebook
-    #define wxBookCtrlEvent                        wxChoicebookEvent
-    #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED
-    #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING
-    #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn)      EVT_CHOICEBOOK_PAGE_CHANGED(id, fn)
-    #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn)     EVT_CHOICEBOOK_PAGE_CHANGING(id, fn)
-    #define wxBC_TOP                               wxCHB_TOP
-    #define wxBC_BOTTOM                            wxCHB_BOTTOM
-    #define wxBC_LEFT                              wxCHB_LEFT
-    #define wxBC_RIGHT                             wxCHB_RIGHT
-    #define wxBC_DEFAULT                           wxCHB_DEFAULT
-#else
+#if wxUSE_NOTEBOOK
+    // dedicated to majority of desktops
     #include "wx/notebook.h"
     #define wxBookCtrl                             wxNotebook
     #define wxBookCtrlEvent                        wxNotebookEvent
@@ -263,11 +307,23 @@ private:
     #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
     #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn)      EVT_NOTEBOOK_PAGE_CHANGED(id, fn)
     #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn)     EVT_NOTEBOOK_PAGE_CHANGING(id, fn)
-    #define wxBC_TOP                               wxNB_TOP
-    #define wxBC_BOTTOM                            wxNB_BOTTOM
-    #define wxBC_LEFT                              wxNB_LEFT
-    #define wxBC_RIGHT                             wxNB_RIGHT
-    #define wxBC_DEFAULT                           wxNB_DEFAULT
+#else
+    // dedicated to Smartphones
+    #include "wx/choicebk.h"
+    #define wxBookCtrl                             wxChoicebook
+    #define wxBookCtrlEvent                        wxChoicebookEvent
+    #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED
+    #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING
+    #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn)      EVT_CHOICEBOOK_PAGE_CHANGED(id, fn)
+    #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn)     EVT_CHOICEBOOK_PAGE_CHANGING(id, fn)
+#endif
+
+#if WXWIN_COMPATIBILITY_2_6
+    #define wxBC_TOP                               wxBK_TOP
+    #define wxBC_BOTTOM                            wxBK_BOTTOM
+    #define wxBC_LEFT                              wxBK_LEFT
+    #define wxBC_RIGHT                             wxBK_RIGHT
+    #define wxBC_DEFAULT                           wxBK_DEFAULT
 #endif
 
 #endif // wxUSE_BOOKCTRL