Better document wxAutomationObject::GetDispatchPtr() return value.

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

diff --git a/interface/wx/toolbook.h b/interface/wx/toolbook.h
index 358adbd2120f074a2f73c535c68f7ea4bb4e147d..26281e31735495bd2de01d7af1419539750f941e 100644 (file)
--- a/interface/wx/toolbook.h
+++ b/interface/wx/toolbook.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxToolbook
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxToolbook
-    @wxheader{toolbook.h}
 
     wxToolbook is a class similar to wxNotebook but which uses a wxToolBar to
     show the labels instead of the tabs.
@@ -24,15 +23,25 @@
         other platforms).
     @style{wxTBK_HORZ_LAYOUT}
         Shows the text and the icons alongside, not vertically stacked (only
-        implement under Windows and GTK 2 platforms as it relies on @c
-        wxTB_HORZ_LAYOUT flag support).
+        implement under Windows and GTK 2 platforms as it relies on
+        @c wxTB_HORZ_LAYOUT flag support).
     @endStyleTable
 
     The common wxBookCtrl styles described in the @ref overview_bookctrl are
     also supported.
 
+    @beginEventEmissionTable{wxBookCtrlEvent}
+    @event{EVT_TOOLBOOK_PAGE_CHANGED(id, func)}
+        The page selection was changed.
+        Processes a @c wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED event.
+    @event{EVT_TOOLBOOK_PAGE_CHANGING(id, func)}
+        The page selection is about to be changed.
+        Processes a @c wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING event.
+        This event can be vetoed (using wxNotifyEvent::Veto()).
+    @endEventTable
+
     @library{wxcore}
-    @category{miscwnd}
+    @category{bookctrl}
 
     @see @ref overview_bookctrl, wxBookCtrlBase, wxNotebook,
          @ref page_samples_notebook
@@ -40,6 +49,21 @@
 class wxToolbook : public wxBookCtrlBase
 {
 public:
+    //@{
+    /**
+        Constructs a choicebook control.
+    */
+    wxToolbook();
+    wxToolbook(wxWindow* parent, wxWindowID id,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 long style = 0,
+                 const wxString& name = wxEmptyStr);
+    //@}
 
+    /**
+        Returns the wxToolBarBase associated with the control.
+    */
+    wxToolBarBase* GetToolBar() const;
 };