]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/bookctrl.h
define __WXFUNCTION__ instead of redefining the (semi-)standard __FUNCTION__ which...
[wxWidgets.git] / include / wx / bookctrl.h
index 49952ecb2c07c1e7ebdf82bbfe0edb21462eadc8..d5e1af0316890947c8a28b5747b04c6f473d0c95 100644 (file)
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        wx/bookctrl.h
-// Purpose:     wxBookCtrl: common base class for wxList/Tree/Notebook
+// Purpose:     wxBookCtrlBase: common base class for wxList/Tree/Notebook
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     19.08.03
 #ifndef _WX_BOOKCTRL_H_
 #define _WX_BOOKCTRL_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "bookctrl.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
@@ -32,26 +28,26 @@ WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
 class WXDLLEXPORT wxImageList;
 
 // ----------------------------------------------------------------------------
-// wxBookCtrl
+// wxBookCtrlBase
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxBookCtrl : public wxControl
+class WXDLLEXPORT wxBookCtrlBase : public wxControl
 {
 public:
     // construction
     // ------------
 
-    wxBookCtrl()
+    wxBookCtrlBase()
     {
         Init();
     }
 
-    wxBookCtrl(wxWindow *parent,
-               wxWindowID winid,
-               const wxPoint& pos = wxDefaultPosition,
-               const wxSize& size = wxDefaultSize,
-               long style = 0,
-               const wxString& name = wxEmptyString)
+    wxBookCtrlBase(wxWindow *parent,
+                   wxWindowID winid,
+                   const wxPoint& pos = wxDefaultPosition,
+                   const wxSize& size = wxDefaultSize,
+                   long style = 0,
+                   const wxString& name = wxEmptyString)
     {
         Init();
 
@@ -67,7 +63,7 @@ public:
                 const wxString& name = wxEmptyString);
 
     // dtor
-    virtual ~wxBookCtrl();
+    virtual ~wxBookCtrlBase();
 
 
     // accessors
@@ -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(wxBookCtrl *, 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,22 @@ 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 size_t GetInternalBorder() const
+    {
+        return m_internalBorder;
+    }
+    void SetInternalBorder(size_t internalBorder)
+    {
+        m_internalBorder = internalBorder;
+    }
+
+    // returns true if we have wxCHB_TOP or wxCHB_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; }
 
     // operations
     // ----------
@@ -179,10 +191,14 @@ public:
         }
     }
 
-    virtual void ApplyParentThemeBackground(const wxColour& bg)
-        { SetBackgroundColour(bg); }
-
 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;
 
@@ -192,12 +208,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;
 
@@ -207,24 +223,53 @@ 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;
 
-    DECLARE_NO_COPY_CLASS(wxBookCtrl)
+private:
+
+    // common part of all ctors
+    void Init();
+
+    // internal border
+    size_t m_internalBorder;
+
+    DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
+    DECLARE_NO_COPY_CLASS(wxBookCtrlBase)
+    DECLARE_EVENT_TABLE()
 };
 
 // ----------------------------------------------------------------------------
-// wxBookCtrlEvent: page changing events generated by derived classes
+// wxBookCtrlBaseEvent: page changing events generated by derived classes
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxBookCtrlEvent : public wxNotifyEvent
+class WXDLLEXPORT wxBookCtrlBaseEvent : public wxNotifyEvent
 {
 public:
-    wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
-                    int nSel = -1, int nOldSel = -1)
+    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)
@@ -239,6 +284,35 @@ private:
         m_nOldSel;  // previously selected page
 };
 
+// make a default book control for given platform
+#if wxUSE_NOTEBOOK
+    // dedicated to majority of desktops
+    #include "wx/notebook.h"
+    #define wxBookCtrl                             wxNotebook
+    #define wxBookCtrlEvent                        wxNotebookEvent
+    #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
+    #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)
+#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
 
 #endif // _WX_BOOKCTRL_H_