]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/toolbook.h
mention the problem with writing enums to wxConfig (see #8656)
[wxWidgets.git] / interface / toolbook.h
index 331bdece6cb0ee5e85a6e9bea367b734f36c6269..358adbd2120f074a2f73c535c68f7ea4bb4e147d 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        toolbook.h
-// Purpose:     documentation for wxToolbook class
+// Purpose:     interface of wxToolbook
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,35 +9,37 @@
 /**
     @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.
-    
-    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 wxToolbook in
-    action.
-    
+
+    wxToolbook is a class similar to wxNotebook but which uses a wxToolBar 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 wxToolbook in action.
+
     @beginStyleTable
-    @style{wxTBK_BUTTONBAR}:
-           Use wxButtonToolBar-based implementation under Mac OS (ignored
-           under 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
-           wxTB_HORZ_LAYOUT flag support).
+    @style{wxTBK_BUTTONBAR}
+        Use wxButtonToolBar-based implementation under Mac OS (ignored under
+        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).
     @endStyleTable
-    
+
+    The common wxBookCtrl styles described in the @ref overview_bookctrl are
+    also supported.
+
     @library{wxcore}
-    @category{FIXME}
-    
-    @seealso
-    wxBookCtrl, wxNotebook, @ref overview_samplenotebook "notebook sample"
+    @category{miscwnd}
+
+    @see @ref overview_bookctrl, wxBookCtrlBase, wxNotebook,
+         @ref page_samples_notebook
 */
-class wxToolbook : public wxBookCtrl overview
+class wxToolbook : public wxBookCtrlBase
 {
 public:
-    
+
 };
+