Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/toolbook.h b/include/wx/toolbook.h
index a45d87815ddea54673db4862042b53e70f35eb6a..ab3e71abe1bdf56c2764935e1c4d5d9e72e09e5d 100644 (file)
--- a/include/wx/toolbook.h
+++ b/include/wx/toolbook.h
@@ -17,12 +17,13 @@
 #if wxUSE_TOOLBOOK
 
 #include "wx/bookctrl.h"
 #if wxUSE_TOOLBOOK
 
 #include "wx/bookctrl.h"

+#include "wx/containr.h"

 
 class WXDLLIMPEXP_FWD_CORE wxToolBarBase;
 class WXDLLIMPEXP_FWD_CORE wxCommandEvent;
 
 
 class WXDLLIMPEXP_FWD_CORE wxToolBarBase;
 class WXDLLIMPEXP_FWD_CORE wxCommandEvent;
 

-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED;
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING;
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_TOOLBOOK_PAGE_CHANGED,  wxBookCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_TOOLBOOK_PAGE_CHANGING, wxBookCtrlEvent );

 
 
 // Use wxButtonToolBar
 
 
 // Use wxButtonToolBar


@@ -40,7 +41,7 @@ extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING;
 // wxToolbook
 // ----------------------------------------------------------------------------
 
 // wxToolbook
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxToolbook : public wxBookCtrlBase
+class WXDLLIMPEXP_CORE wxToolbook : public wxNavigationEnabled<wxBookCtrlBase>

 {
 public:
     wxToolbook()
 {
 public:
     wxToolbook()


@@ -70,17 +71,15 @@ public:
 
 
     // implement base class virtuals
 
 
     // implement base class virtuals

-    virtual int GetSelection() const;

     virtual bool SetPageText(size_t n, const wxString& strText);
     virtual wxString GetPageText(size_t n) const;
     virtual int GetPageImage(size_t n) const;
     virtual bool SetPageImage(size_t n, int imageId);
     virtual bool SetPageText(size_t n, const wxString& strText);
     virtual wxString GetPageText(size_t n) const;
     virtual int GetPageImage(size_t n) const;
     virtual bool SetPageImage(size_t n, int imageId);

-    virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;

     virtual bool InsertPage(size_t n,
                             wxWindow *page,
                             const wxString& text,
                             bool bSelect = false,
     virtual bool InsertPage(size_t n,
                             wxWindow *page,
                             const wxString& text,
                             bool bSelect = false,

-                            int imageId = -1);
+                            int imageId = NO_IMAGE);

     virtual int SetSelection(size_t n) { return DoSetSelection(n, SetSelection_SendEvent); }
     virtual int ChangeSelection(size_t n) { return DoSetSelection(n); }
     virtual void SetImageList(wxImageList *imageList);
     virtual int SetSelection(size_t n) { return DoSetSelection(n, SetSelection_SendEvent); }
     virtual int ChangeSelection(size_t n) { return DoSetSelection(n); }
     virtual void SetImageList(wxImageList *imageList);


@@ -101,9 +100,6 @@ public:
 protected:
     virtual wxWindow *DoRemovePage(size_t page);
 
 protected:
     virtual wxWindow *DoRemovePage(size_t page);
 

-    // get the size which the list control should have
-    virtual wxSize GetControllerSize() const;
-

     // event handlers
     void OnToolSelected(wxCommandEvent& event);
     void OnSize(wxSizeEvent& event);
     // event handlers
     void OnToolSelected(wxCommandEvent& event);
     void OnSize(wxSizeEvent& event);


@@ -111,11 +107,8 @@ protected:
 
     void UpdateSelectedPage(size_t newsel);
 
 
     void UpdateSelectedPage(size_t newsel);
 

-    wxBookCtrlBaseEvent* CreatePageChangingEvent() const;
-    void MakeChangedEvent(wxBookCtrlBaseEvent &event);
-
-    // the currently selected page or wxNOT_FOUND if none
-    int m_selection;
+    wxBookCtrlEvent* CreatePageChangingEvent() const;
+    void MakeChangedEvent(wxBookCtrlEvent &event);

 
     // whether the toolbar needs to be realized
     bool m_needsRealizing;
 
     // whether the toolbar needs to be realized
     bool m_needsRealizing;


@@ -135,36 +128,21 @@ private:
 // listbook event class and related stuff
 // ----------------------------------------------------------------------------
 
 // listbook event class and related stuff
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxToolbookEvent : public wxBookCtrlBaseEvent
-{
-public:
-    wxToolbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
-                    int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND)
-        : wxBookCtrlBaseEvent(commandType, id, nSel, nOldSel)
-    {
-    }
+// wxToolbookEvent is obsolete and defined for compatibility only
+#define wxToolbookEvent wxBookCtrlEvent
+typedef wxBookCtrlEventFunction wxToolbookEventFunction;
+#define wxToolbookEventHandler(func) wxBookCtrlEventHandler(func)

 
 

-    wxToolbookEvent(const wxToolbookEvent& event)
-        : wxBookCtrlBaseEvent(event)
-    {
-    }
-
-    virtual wxEvent *Clone() const { return new wxToolbookEvent(*this); }
-
-private:
-    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxToolbookEvent)
-};
-
-typedef void (wxEvtHandler::*wxToolbookEventFunction)(wxToolbookEvent&);
-
-#define wxToolbookEventHandler(func) \
-    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxToolbookEventFunction, &func)

 
 #define EVT_TOOLBOOK_PAGE_CHANGED(winid, fn) \
 
 #define EVT_TOOLBOOK_PAGE_CHANGED(winid, fn) \

-    wx__DECLARE_EVT1(wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED, winid, wxToolbookEventHandler(fn))
+    wx__DECLARE_EVT1(wxEVT_TOOLBOOK_PAGE_CHANGED, winid, wxBookCtrlEventHandler(fn))

 
 #define EVT_TOOLBOOK_PAGE_CHANGING(winid, fn) \
 
 #define EVT_TOOLBOOK_PAGE_CHANGING(winid, fn) \

-    wx__DECLARE_EVT1(wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING, winid, wxToolbookEventHandler(fn))
+    wx__DECLARE_EVT1(wxEVT_TOOLBOOK_PAGE_CHANGING, winid, wxBookCtrlEventHandler(fn))
+
+// old wxEVT_COMMAND_* constants
+#define wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED    wxEVT_TOOLBOOK_PAGE_CHANGED
+#define wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING   wxEVT_TOOLBOOK_PAGE_CHANGING

 
 #endif // wxUSE_TOOLBOOK
 
 
 #endif // wxUSE_TOOLBOOK