Fix html documentation warnings.

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

diff --git a/interface/wx/toolbook.h b/interface/wx/toolbook.h
index 78d3667d4cf1235065564bfb2fb519703dd7cded..2672e2baff3ed313d3047e2cbdd1991f31be437d 100644 (file)
--- a/interface/wx/toolbook.h
+++ b/interface/wx/toolbook.h
@@ -2,10 +2,16 @@
 // Name:        toolbook.h
 // Purpose:     interface of wxToolbook
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+#define wxTBK_BUTTONBAR            0x0100
+#define wxTBK_HORZ_LAYOUT          0x8000
+
+wxEventType wxEVT_TOOLBOOK_PAGE_CHANGED;
+wxEventType wxEVT_TOOLBOOK_PAGE_CHANGING;
+
+
 /**
     @class wxToolbook
 
@@ -23,15 +29,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_TOOLBOOK_PAGE_CHANGED event.
+    @event{EVT_TOOLBOOK_PAGE_CHANGING(id, func)}
+        The page selection is about to be changed.
+        Processes a @c wxEVT_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
@@ -39,6 +55,32 @@
 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 = wxEmptyString);
+    //@}
+
+    /**
+       Create the tool book control that has already been constructed with
+       the default constructor.
+    */
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxString& name = wxEmptyString);
 
+    /**
+        Returns the wxToolBarBase associated with the control.
+    */
+    wxToolBarBase* GetToolBar() const;
 };