]>
Commit | Line | Data |
---|---|---|
23324ae1 FM |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: listbook.h | |
e54c96f1 | 3 | // Purpose: interface of wxListbook |
23324ae1 FM |
4 | // Author: wxWidgets team |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | /** | |
10 | @class wxListbook | |
11 | @wxheader{listbook.h} | |
7c913512 | 12 | |
23324ae1 FM |
13 | wxListbook is a class similar to wxNotebook but which |
14 | uses a wxListCtrl to show the labels instead of the | |
15 | tabs. | |
7c913512 | 16 | |
c1718122 VZ |
17 | The underlying wxListCtrl displays page labels in a one-column report view |
18 | by default. Calling wxListbook::SetImageList will implicitly switch the | |
19 | control to use an icon view. | |
20 | ||
23324ae1 FM |
21 | There is no documentation for this class yet but its usage is |
22 | identical to wxNotebook (except for the features clearly related to tabs | |
23 | only), so please refer to that class documentation for now. You can also | |
24 | use the @ref overview_samplenotebook "notebook sample" to see wxListbook in | |
25 | action. | |
7c913512 | 26 | |
23324ae1 | 27 | @beginStyleTable |
8c6791e4 | 28 | @style{wxLB_DEFAULT} |
23324ae1 FM |
29 | Choose the default location for the labels depending on the current |
30 | platform (left everywhere except Mac where it is top). | |
8c6791e4 | 31 | @style{wxLB_TOP} |
23324ae1 | 32 | Place labels above the page area. |
8c6791e4 | 33 | @style{wxLB_LEFT} |
23324ae1 | 34 | Place labels on the left side. |
8c6791e4 | 35 | @style{wxLB_RIGHT} |
23324ae1 | 36 | Place labels on the right side. |
8c6791e4 | 37 | @style{wxLB_BOTTOM} |
23324ae1 FM |
38 | Place labels below the page area. |
39 | @endStyleTable | |
7c913512 | 40 | |
23324ae1 FM |
41 | @library{wxcore} |
42 | @category{miscwnd} | |
7c913512 | 43 | |
e54c96f1 | 44 | @see wxBookCtrl(), wxNotebook, @ref overview_samplenotebook "notebook sample" |
23324ae1 FM |
45 | */ |
46 | class wxListbook : public wxBookCtrl overview | |
47 | { | |
48 | public: | |
49 | //@{ | |
50 | /** | |
51 | Constructs a listbook control. | |
52 | */ | |
53 | wxListbook(); | |
7c913512 FM |
54 | wxListbook(wxWindow* parent, wxWindowID id, |
55 | const wxPoint& pos = wxDefaultPosition, | |
56 | const wxSize& size = wxDefaultSize, | |
57 | long style = 0, | |
58 | const wxString& name = wxEmptyStr); | |
23324ae1 FM |
59 | //@} |
60 | }; | |
e54c96f1 | 61 |