Commited FRM's stockitem patch (empty stock items).

[wxWidgets.git] / include / wx / bookctrl.h

diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h
index d5e1af0316890947c8a28b5747b04c6f473d0c95..6d3c80b67017f7dd82685e58efad8b73184fadd3 100644 (file)
--- a/include/wx/bookctrl.h
+++ b/include/wx/bookctrl.h
@@ -27,6 +27,20 @@ WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
 
 class WXDLLEXPORT wxImageList;
 
 
 class WXDLLEXPORT wxImageList;
 

+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// wxBookCtrl hit results
+enum
+{
+    wxBK_HITTEST_NOWHERE = 1,   // not on tab
+    wxBK_HITTEST_ONICON  = 2,   // on icon
+    wxBK_HITTEST_ONLABEL = 4,   // on label
+    wxBK_HITTEST_ONITEM  = wxBK_HITTEST_ONICON | wxBK_HITTEST_ONLABEL,
+    wxBK_HITTEST_ONPAGE  = 8    // not on tab control, but over the selected page
+};
+

 // ----------------------------------------------------------------------------
 // wxBookCtrlBase
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxBookCtrlBase
 // ----------------------------------------------------------------------------


@@ -119,22 +133,23 @@ public:
     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0;
 
     // get/set size of area between book control area and page area
     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;
-    }
+    unsigned int GetInternalBorder() const { return m_internalBorder; }
+    void SetInternalBorder(unsigned int border) { m_internalBorder = border; }
+
+    // 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 wxCHB_TOP or wxCHB_BOTTOM style
+    // 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; }
 
     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
     // ----------
 
     // operations
     // ----------
 


@@ -191,6 +206,17 @@ public:
         }
     }
 
         }
     }
 

+    // hit test: returns which page is hit and, optionally, where (icon, label)
+    virtual int HitTest(const wxPoint& WXUNUSED(pt),
+                        long * WXUNUSED(flags) = NULL) const
+    {
+        return wxNOT_FOUND;
+    }
+
+
+    // we do have multiple pages
+    virtual bool HasMultiplePages() const { return true; }
+

 protected:
     // Should we accept NULL page pointers in Add/InsertPage()?
     //
 protected:
     // Should we accept NULL page pointers in Add/InsertPage()?
     //


@@ -214,6 +240,12 @@ protected:
     // Lay out controls
     void DoSize();
 
     // Lay out controls
     void DoSize();
 

+#if wxUSE_HELP
+    // Show the help for the corresponding page
+    void OnHelp(wxHelpEvent& event);
+#endif // wxUSE_HELP
+
+

     // the array of all pages of this control
     wxArrayPages m_pages;
 
     // the array of all pages of this control
     wxArrayPages m_pages;
 


@@ -236,13 +268,19 @@ protected:
     // Whether to shrink to fit current page
     bool m_fitToCurrentPage;
 
     // 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
 private:
 
     // common part of all ctors
     void Init();
 
     // internal border

-    size_t m_internalBorder;
+    unsigned int m_internalBorder;

 
     DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
     DECLARE_NO_COPY_CLASS(wxBookCtrlBase)
 
     DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
     DECLARE_NO_COPY_CLASS(wxBookCtrlBase)