]> git.saurik.com Git - wxWidgets.git/blame - interface/wx/listbook.h
Add length parameter to AddTextRaw and AppendTextRaw. Closes #1358
[wxWidgets.git] / interface / wx / listbook.h
CommitLineData
23324ae1
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: listbook.h
e54c96f1 3// Purpose: interface of wxListbook
23324ae1
FM
4// Author: wxWidgets team
5// RCS-ID: $Id$
526954c5 6// Licence: wxWindows licence
23324ae1
FM
7/////////////////////////////////////////////////////////////////////////////
8
9/**
10 @class wxListbook
7c913512 11
340e9651
FM
12 wxListbook is a class similar to wxNotebook but which uses a wxListCtrl
13 to show the labels instead of the tabs.
7c913512 14
c1718122 15 The underlying wxListCtrl displays page labels in a one-column report view
340e9651 16 by default. Calling wxBookCtrl::SetImageList will implicitly switch the
c1718122
VZ
17 control to use an icon view.
18
340e9651
FM
19 For usage documentation of this class, please refer to the base abstract class
20 wxBookCtrl. You can also use the @ref page_samples_notebook to see wxListbook in
23324ae1 21 action.
7c913512 22
23324ae1 23 @beginStyleTable
8c6791e4 24 @style{wxLB_DEFAULT}
23324ae1
FM
25 Choose the default location for the labels depending on the current
26 platform (left everywhere except Mac where it is top).
8c6791e4 27 @style{wxLB_TOP}
23324ae1 28 Place labels above the page area.
8c6791e4 29 @style{wxLB_LEFT}
23324ae1 30 Place labels on the left side.
8c6791e4 31 @style{wxLB_RIGHT}
23324ae1 32 Place labels on the right side.
8c6791e4 33 @style{wxLB_BOTTOM}
23324ae1
FM
34 Place labels below the page area.
35 @endStyleTable
7c913512 36
3051a44a 37 @beginEventEmissionTable{wxBookCtrlEvent}
340e9651
FM
38 @event{EVT_LISTBOOK_PAGE_CHANGED(id, func)}
39 The page selection was changed.
40 Processes a @c wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED event.
41 @event{EVT_LISTBOOK_PAGE_CHANGING(id, func)}
42 The page selection is about to be changed.
43 Processes a @c wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING event.
44 This event can be vetoed.
45 @endEventTable
46
23324ae1 47 @library{wxcore}
3c99e2fd 48 @category{bookctrl}
7c14fc8c 49 @appearance{listbook.png}
7c913512 50
7c14fc8c 51 @see wxBookCtrl, wxNotebook, @ref page_samples_notebook
23324ae1 52*/
340e9651 53class wxListbook : public wxBookCtrlBase
23324ae1
FM
54{
55public:
23324ae1 56 /**
340e9651 57 Default ctor.
23324ae1
FM
58 */
59 wxListbook();
340e9651
FM
60
61 /**
62 Constructs a listbook control.
63 */
7c913512
FM
64 wxListbook(wxWindow* parent, wxWindowID id,
65 const wxPoint& pos = wxDefaultPosition,
66 const wxSize& size = wxDefaultSize,
67 long style = 0,
0a98423e 68 const wxString& name = wxEmptyString);
340e9651
FM
69
70 /**
71 Returns the wxListView associated with the control.
72 */
73 wxListView* GetListView() const;
23324ae1 74};
e54c96f1 75