]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/notebook.h
fix unused parameter warning in wxSetEnv() in release build
[wxWidgets.git] / include / wx / notebook.h
index 7d1f7cc5fc52b192e6ef193e60cc82c3cb3eb267..f94e51622737c6e7cced934fb2ae1e115579a552 100644 (file)
@@ -5,17 +5,13 @@
 // Modified by:
 // Created:     01.02.01
 // RCS-ID:      $Id$
-// Copyright:   (c) 1996-2000 wxWindows team
+// Copyright:   (c) 1996-2000 Vadim Zeitlin
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_NOTEBOOK_H_BASE_
 #define _WX_NOTEBOOK_H_BASE_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "notebookbase.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // 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
 };
 
+// wxNotebook flags
+
+// 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
+
+#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
 
-#define wxNOTEBOOK_NAME _T("notebook")
+extern WXDLLEXPORT_DATA(const wxChar) wxNotebookNameStr[];
 
 // ----------------------------------------------------------------------------
 // wxNotebookBase: define wxNotebook interface
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxNotebookBase : public wxBookCtrl
+class WXDLLEXPORT wxNotebookBase : public wxBookCtrlBase
 {
 public:
     // ctors
@@ -56,18 +69,14 @@ public:
     wxNotebookBase() { }
 
     wxNotebookBase(wxWindow *parent,
-                   wxWindowID id,
+                   wxWindowID winid,
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    long style = 0,
-                   const wxString& name = wxNOTEBOOK_NAME)
-        : wxBookCtrl(parent, id, pos, size, style, name)
-    {
-    }
-
+                   const wxString& name = wxNotebookNameStr) ;
 
-    // wxNotebook-specific additions to wxBookCtrl interface
-    // -----------------------------------------------------
+    // wxNotebook-specific additions to wxBookCtrlBase interface
+    // ---------------------------------------------------------
 
     // get the number of rows for a control with wxNB_MULTILINE style (not all
     // versions support it - they will always return 1 then)
@@ -79,18 +88,28 @@ 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
     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
 
+    // On platforms that support it, get the theme page background colour, else invalid colour
+    virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; }
+
+
+    // 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)
 };
@@ -99,17 +118,24 @@ protected:
 // notebook event class and related stuff
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlEvent
+class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlBaseEvent
 {
 public:
-    wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
+    wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
                     int nSel = -1, int nOldSel = -1)
-        : wxBookCtrlEvent(commandType, id, nSel, nOldSel)
+        : wxBookCtrlBaseEvent(commandType, winid, nSel, nOldSel)
+    {
+    }
+
+    wxNotebookEvent(const wxNotebookEvent& event)
+        : wxBookCtrlBaseEvent(event)
     {
     }
 
+    virtual wxEvent *Clone() const { return new wxNotebookEvent(*this); }
+
 private:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebookEvent)
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotebookEvent)
 };
 
 BEGIN_DECLARE_EVENT_TYPES()
@@ -119,23 +145,14 @@ END_DECLARE_EVENT_TYPES()
 
 typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 
-#define EVT_NOTEBOOK_PAGE_CHANGED(id, fn)                                   \
-  DECLARE_EVENT_TABLE_ENTRY(                                                \
-    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,                                    \
-    id,                                                                     \
-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
-    NULL                                                                    \
-  ),
-
-#define EVT_NOTEBOOK_PAGE_CHANGING(id, fn)                                  \
-  DECLARE_EVENT_TABLE_ENTRY(                                                \
-    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,                                   \
-    id,                                                                     \
-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
-    NULL                                                                    \
-  ),
+#define wxNotebookEventHandler(func) \
+    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotebookEventFunction, &func)
+
+#define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \
+    wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxNotebookEventHandler(fn))
+
+#define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \
+    wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxNotebookEventHandler(fn))
 
 // ----------------------------------------------------------------------------
 // wxNotebook class itself
@@ -147,12 +164,14 @@ 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__)
-    #include  "wx/generic/notebook.h"
+    #include  "wx/cocoa/notebook.h"
 #elif defined(__WXPM__)
     #include  "wx/os2/notebook.h"
 #endif