Escape underscores

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

diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h
index 653a186aaacf6bc962e92522c6cea67235e3682d..50b6dcdf13fda9bc67442df7b8de0777e1273687 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;
 
+// ----------------------------------------------------------------------------
+// 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
 // ----------------------------------------------------------------------------
@@ -119,20 +133,14 @@ public:
     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;
-    }
+    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
@@ -198,6 +206,13 @@ 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;
+    }
+
 protected:
     // Should we accept NULL page pointers in Add/InsertPage()?
     //
@@ -221,6 +236,12 @@ protected:
     // 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;