X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..e5ef1cae0f424be0bffbd651cb10052dfb208396:/interface/listbook.h diff --git a/interface/listbook.h b/interface/listbook.h index a6b21fad18..28855b7ef3 100644 --- a/interface/listbook.h +++ b/interface/listbook.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: listbook.h -// Purpose: documentation for wxListbook class +// Purpose: interface of wxListbook // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -14,6 +14,10 @@ uses a wxListCtrl to show the labels instead of the tabs. + The underlying wxListCtrl displays page labels in a one-column report view + by default. Calling wxListbook::SetImageList will implicitly switch the + control to use an icon view. + 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 @@ -21,24 +25,23 @@ action. @beginStyleTable - @style{wxLB_DEFAULT}: + @style{wxLB_DEFAULT} Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top). - @style{wxLB_TOP}: + @style{wxLB_TOP} Place labels above the page area. - @style{wxLB_LEFT}: + @style{wxLB_LEFT} Place labels on the left side. - @style{wxLB_RIGHT}: + @style{wxLB_RIGHT} Place labels on the right side. - @style{wxLB_BOTTOM}: + @style{wxLB_BOTTOM} Place labels below the page area. @endStyleTable @library{wxcore} @category{miscwnd} - @seealso - wxBookCtrl, wxNotebook, @ref overview_samplenotebook "notebook sample" + @see wxBookCtrl(), wxNotebook, @ref overview_samplenotebook "notebook sample" */ class wxListbook : public wxBookCtrl overview { @@ -55,3 +58,4 @@ public: const wxString& name = wxEmptyStr); //@} }; +