other misc fixes

[wxWidgets.git] / interface / choicebk.h

diff --git a/interface/choicebk.h b/interface/choicebk.h
index 0979d89a915d4e62126f1ccd2932a6f08b6c5eda..879e4e024d9c62e7c07f4072c6b7f6f2182750a1 100644 (file)
--- a/interface/choicebk.h
+++ b/interface/choicebk.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        choicebk.h
-// Purpose:     documentation for wxChoicebook class
+// Purpose:     interface of wxChoicebook
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,43 +9,53 @@
 /**
     @class wxChoicebook
     @wxheader{choicebk.h}
-    
-    wxChoicebook is a class similar to wxNotebook but which
-    uses a wxChoice to show the labels instead of the
-    tabs.
-    
-    There is no documentation for this class yet but its usage is
-    identical to wxNotebook (except for the features clearly related to tabs
-    only), so please refer to that class documentation for now. You can also
-    use the @ref overview_samplenotebook "notebook sample" to see wxChoicebook in
-    action.
-    
-    wxChoicebook allows the use of wxBookCtrl::GetControlSizer, allowing a program
-    to add other controls next to the choice control. This is particularly useful
-    when screen space is restricted, as it often is when wxChoicebook is being
-    employed.
-    
+
+    wxChoicebook is a class similar to wxNotebook, but uses a wxChoice control
+    to show the labels instead of the tabs.
+
+    There is no documentation for this class yet but its usage is identical to
+    wxNotebook (except for the features clearly related to tabs only), so
+    please refer to that class documentation for now. You can also use the
+    @ref page_samples_notebook to see wxChoicebook in action.
+
+    wxChoicebook allows the use of wxBookCtrlBase::GetControlSizer(), allowing
+    a program to add other controls next to the choice control. This is
+    particularly useful when screen space is restricted, as it often is when
+    wxChoicebook is being employed.
+
     @beginStyleTable
-    @style{wxCHB_DEFAULT}:
+    @style{wxCHB_DEFAULT}
            Choose the default location for the labels depending on the current
            platform (left everywhere except Mac where it is top).
-    @style{wxCHB_TOP}:
+    @style{wxCHB_TOP}
            Place labels above the page area.
-    @style{wxCHB_LEFT}:
+    @style{wxCHB_LEFT}
            Place labels on the left side.
-    @style{wxCHB_RIGHT}:
+    @style{wxCHB_RIGHT}
            Place labels on the right side.
-    @style{wxCHB_BOTTOM}:
+    @style{wxCHB_BOTTOM}
            Place labels below the page area.
     @endStyleTable
-    
+
+    @beginEventTable{wxChoicebookEvent}
+    @event{EVT_CHOICEBOOK_PAGE_CHANGED(id, func)}
+           The page selection was changed. Processes a
+           wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED event.
+    @event{EVT_CHOICEBOOK_PAGE_CHANGING(id, func)}
+           The page selection is about to be changed. Processes a
+           wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING event. This event can be
+           vetoed (using wxNotifyEvent::Veto()).
+    @endEventTable
+
     @library{wxcore}
     @category{miscwnd}
-    
-    @seealso
-    wxBookCtrl, wxNotebook, @ref overview_samplenotebook "notebook sample"
+
+    @see @ref overview_bookctrl, wxNotebook, @ref page_samples_notebook
+
+    @todo Write up wxBookCtrlBase documentation, where most of this class'
+          functionality comes from.
 */
-class wxChoicebook : public wxBookCtrl overview
+class wxChoicebook : public wxBookCtrlBase
 {
 public:
     //@{
@@ -53,10 +63,16 @@ public:
         Constructs a choicebook control.
     */
     wxChoicebook();
-        wxChoicebook(wxWindow* parent, wxWindowID id,
-                     const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& size = wxDefaultSize,
-                     long style = 0,
-                     const wxString& name = wxEmptyStr);
+    wxChoicebook(wxWindow* parent, wxWindowID id,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 long style = 0,
+                 const wxString& name = wxEmptyStr);
     //@}
+
+    /**
+        Returns the wxChoice associated with the control.
+    */
+    wxChoice * GetChoiceCtrl() const;
 };
+