Don't mention non-existent setup.exe in wxMSW installation notes.

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

diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h
index e864221cada8e43c77a907133a274a93b207db6f..66704cb9a1df0cda14bb4c24e4de12c07c8acc3f 100644 (file)
--- a/include/wx/bookctrl.h
+++ b/include/wx/bookctrl.h
@@ -26,7 +26,7 @@
 WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
 
 class WXDLLIMPEXP_FWD_CORE wxImageList;
-class WXDLLIMPEXP_FWD_CORE wxBookCtrlBaseEvent;
+class WXDLLIMPEXP_FWD_CORE wxBookCtrlEvent;
 
 // ----------------------------------------------------------------------------
 // constants
@@ -137,8 +137,14 @@ public:
     // resize the notebook so that all pages will have the specified size
     virtual void SetPageSize(const wxSize& size);
 
+    // return the size of the area needed to accommodate the controller
+    wxSize GetControllerSize() const;
+
     // calculate the size of the control from the size of its page
-    virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0;
+    //
+    // by default this simply returns size enough to fit both the page and the
+    // controller
+    virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
 
     // get/set size of area between book control area and page area
     unsigned int GetInternalBorder() const { return m_internalBorder; }
@@ -260,12 +266,12 @@ protected:
         { wxFAIL_MSG(wxT("Override this function!")); }
 
     // create a new "page changing" event
-    virtual wxBookCtrlBaseEvent* CreatePageChangingEvent() const
+    virtual wxBookCtrlEvent* CreatePageChangingEvent() const
         { wxFAIL_MSG(wxT("Override this function!")); return NULL; }
 
     // modify the event created by CreatePageChangingEvent() to "page changed"
     // event, usually by just calling SetEventType() on it
-    virtual void MakeChangedEvent(wxBookCtrlBaseEvent& WXUNUSED(event))
+    virtual void MakeChangedEvent(wxBookCtrlEvent& WXUNUSED(event))
         { wxFAIL_MSG(wxT("Override this function!")); }
 
 
@@ -286,7 +292,7 @@ protected:
     int GetNextPage(bool forward) const;
 
     // Lay out controls
-    void DoSize();
+    virtual void DoSize();
 
     // This method also invalidates the size of the controller and should be
     // called instead of just InvalidateBestSize() whenever pages are added or
@@ -309,10 +315,9 @@ protected:
     bool m_ownsImageList;
 
     // get the page area
-    wxRect GetPageRect() const;
+    virtual 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)
@@ -336,18 +341,18 @@ private:
     unsigned int m_internalBorder;
 
     DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
-    DECLARE_NO_COPY_CLASS(wxBookCtrlBase)
+    wxDECLARE_NO_COPY_CLASS(wxBookCtrlBase);
     DECLARE_EVENT_TABLE()
 };
 
 // ----------------------------------------------------------------------------
-// wxBookCtrlBaseEvent: page changing events generated by derived classes
+// wxBookCtrlEvent: page changing events generated by book classes
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_CORE wxBookCtrlBaseEvent : public wxNotifyEvent
+class WXDLLIMPEXP_CORE wxBookCtrlEvent : public wxNotifyEvent
 {
 public:
-    wxBookCtrlBaseEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
+    wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
                         int nSel = -1, int nOldSel = -1)
         : wxNotifyEvent(commandType, winid)
     {
@@ -355,13 +360,15 @@ public:
         m_nOldSel = nOldSel;
     }
 
-    wxBookCtrlBaseEvent(const wxBookCtrlBaseEvent& event)
+    wxBookCtrlEvent(const wxBookCtrlEvent& event)
         : wxNotifyEvent(event)
     {
         m_nSel = event.m_nSel;
         m_nOldSel = event.m_nOldSel;
     }
 
+    virtual wxEvent *Clone() const { return new wxBookCtrlEvent(*this); }
+
     // accessors
         // the currently selected page (-1 if none)
     int GetSelection() const { return m_nSel; }
@@ -373,29 +380,35 @@ public:
 private:
     int m_nSel,     // currently selected page
         m_nOldSel;  // previously selected page
+
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxBookCtrlEvent)
 };
 
+typedef void (wxEvtHandler::*wxBookCtrlEventFunction)(wxBookCtrlEvent&);
+
+#define wxBookCtrlEventHandler(func) \
+    wxEVENT_HANDLER_CAST(wxBookCtrlEventFunction, func)
+
+// obsolete name, defined for compatibility only
+#define wxBookCtrlBaseEvent wxBookCtrlEvent
+
 // 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)
-    #define wxBookctrlEventHandler(func)           wxNotebookEventHandler(func)
 #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)
-    #define wxBookctrlEventHandler(func)           wxChoicebookEventHandler(func)
 #endif
 
 #if WXWIN_COMPATIBILITY_2_6