add support for asynchronous execution in wxBase (patch 1906889)

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

diff --git a/include/wx/notebook.h b/include/wx/notebook.h
index 7f6b719f63dea7a0db2e8469909aef12af4739db..2687911ed49d3820458163dd0fd29e598cf3b3c2 100644 (file)
--- a/include/wx/notebook.h
+++ b/include/wx/notebook.h
@@ -26,22 +26,35 @@
 // constants
 // ----------------------------------------------------------------------------
 
-// wxNotebook hit results
+// wxNotebook hit results, use wxBK_HITTEST so other book controls can share them
+// if wxUSE_NOTEBOOK is disabled
 enum
 {
-    wxNB_HITTEST_NOWHERE = 1,   // not on tab
-    wxNB_HITTEST_ONICON  = 2,   // on icon
-    wxNB_HITTEST_ONLABEL = 4,   // on label
-    wxNB_HITTEST_ONITEM  = wxNB_HITTEST_ONICON | wxNB_HITTEST_ONLABEL
+    wxNB_HITTEST_NOWHERE = wxBK_HITTEST_NOWHERE,
+    wxNB_HITTEST_ONICON  = wxBK_HITTEST_ONICON,
+    wxNB_HITTEST_ONLABEL = wxBK_HITTEST_ONLABEL,
+    wxNB_HITTEST_ONITEM  = wxBK_HITTEST_ONITEM,
+    wxNB_HITTEST_ONPAGE  = wxBK_HITTEST_ONPAGE
 };
 
-typedef wxWindow wxNotebookPage;  // so far, any window can be a page
+// wxNotebook flags
 
-extern WXDLLEXPORT_DATA(const wxChar*) wxNotebookNameStr;
+// use common book wxBK_* flags for describing alignment
+#define wxNB_DEFAULT          wxBK_DEFAULT
+#define wxNB_TOP              wxBK_TOP
+#define wxNB_BOTTOM           wxBK_BOTTOM
+#define wxNB_LEFT             wxBK_LEFT
+#define wxNB_RIGHT            wxBK_RIGHT
 
-#if WXWIN_COMPATIBILITY_2_4
-    #define wxNOTEBOOK_NAME wxNotebookNameStr
-#endif
+#define wxNB_FIXEDWIDTH       0x0100
+#define wxNB_MULTILINE        0x0200
+#define wxNB_NOPAGETHEME      0x0400
+#define wxNB_FLAT             0x0800
+
+
+typedef wxWindow wxNotebookPage;  // so far, any window can be a page
+
+extern WXDLLEXPORT_DATA(const char) wxNotebookNameStr[];
 
 // ----------------------------------------------------------------------------
 // wxNotebookBase: define wxNotebook interface
@@ -75,13 +88,6 @@ public:
     // set the size of the tabs for wxNB_FIXEDWIDTH controls
     virtual void SetTabSize(const wxSize& sz) = 0;
 
-    // hit test, returns which tab is hit and, optionally, where (icon, label)
-    // (not implemented on all platforms)
-    virtual int HitTest(const wxPoint& WXUNUSED(pt),
-                        long * WXUNUSED(flags) = NULL) const
-    {
-        return wxNOT_FOUND;
-    }
 
 
     // implement some base class functions
@@ -91,12 +97,18 @@ public:
     virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; }
 
 
-    // Reserved for future use
-    virtual void ReservedNotebookFunc1() {}
-    virtual void ReservedNotebookFunc2() {}
-    virtual void ReservedNotebookFunc3() {}
-    virtual void ReservedNotebookFunc4() {}
-    virtual void ReservedNotebookFunc5() {}
+    // send wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING/ED events
+
+    // returns false if the change to nPage is vetoed by the program
+    bool SendPageChangingEvent(int nPage);
+
+    // sends the event about page change from old to new (or GetSelection() if
+    // new is -1)
+    void SendPageChangedEvent(int nPageOld, int nPageNew = -1);
+
+    // wxBookCtrlBase overrides this method to return false but we do need
+    // focus because we have tabs
+    virtual bool AcceptsFocus() const { return wxControl::AcceptsFocus(); }
 
 protected:
     DECLARE_NO_COPY_CLASS(wxNotebookBase)
@@ -126,10 +138,8 @@ private:
     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotebookEvent)
 };
 
-BEGIN_DECLARE_EVENT_TYPES()
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 802)
-    DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 803)
-END_DECLARE_EVENT_TYPES()
+extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED;
+extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING;
 
 typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 
@@ -152,8 +162,10 @@ typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
     #include  "wx/msw/notebook.h"
 #elif defined(__WXMOTIF__)
     #include  "wx/generic/notebook.h"
-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)
     #include  "wx/gtk/notebook.h"
+#elif defined(__WXGTK__)
+    #include  "wx/gtk1/notebook.h"
 #elif defined(__WXMAC__)
     #include  "wx/mac/notebook.h"
 #elif defined(__WXCOCOA__)