| | 1 | ///////////////////////////////////////////////////////////////////////////// |
| | 2 | // Name: toolbook.h |
| | 3 | // Purpose: interface of wxToolbook |
| | 4 | // Author: wxWidgets team |
| | 5 | // RCS-ID: $Id$ |
| | 6 | // Licence: wxWindows license |
| | 7 | ///////////////////////////////////////////////////////////////////////////// |
| | 8 | |
| | 9 | /** |
| | 10 | @class wxToolbook |
| | 11 | |
| | 12 | wxToolbook is a class similar to wxNotebook but which uses a wxToolBar to |
| | 13 | show the labels instead of the tabs. |
| | 14 | |
| | 15 | There is no documentation for this class yet but its usage is identical to |
| | 16 | wxNotebook (except for the features clearly related to tabs only), so please |
| | 17 | refer to that class documentation for now. You can also use the |
| | 18 | @ref page_samples_notebook to see wxToolbook in action. |
| | 19 | |
| | 20 | @beginStyleTable |
| | 21 | @style{wxTBK_BUTTONBAR} |
| | 22 | Use wxButtonToolBar-based implementation under Mac OS (ignored under |
| | 23 | other platforms). |
| | 24 | @style{wxTBK_HORZ_LAYOUT} |
| | 25 | Shows the text and the icons alongside, not vertically stacked (only |
| | 26 | implement under Windows and GTK 2 platforms as it relies on |
| | 27 | @c wxTB_HORZ_LAYOUT flag support). |
| | 28 | @endStyleTable |
| | 29 | |
| | 30 | The common wxBookCtrl styles described in the @ref overview_bookctrl are |
| | 31 | also supported. |
| | 32 | |
| | 33 | @beginEventEmissionTable{wxBookCtrlEvent} |
| | 34 | @event{EVT_TOOLBOOK_PAGE_CHANGED(id, func)} |
| | 35 | The page selection was changed. |
| | 36 | Processes a @c wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED event. |
| | 37 | @event{EVT_TOOLBOOK_PAGE_CHANGING(id, func)} |
| | 38 | The page selection is about to be changed. |
| | 39 | Processes a @c wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING event. |
| | 40 | This event can be vetoed (using wxNotifyEvent::Veto()). |
| | 41 | @endEventTable |
| | 42 | |
| | 43 | @library{wxcore} |
| | 44 | @category{bookctrl} |
| | 45 | |
| | 46 | @see @ref overview_bookctrl, wxBookCtrlBase, wxNotebook, |
| | 47 | @ref page_samples_notebook |
| | 48 | */ |
| | 49 | class wxToolbook : public wxBookCtrlBase |
| | 50 | { |
| | 51 | public: |
| | 52 | //@{ |
| | 53 | /** |
| | 54 | Constructs a choicebook control. |
| | 55 | */ |
| | 56 | wxToolbook(); |
| | 57 | wxToolbook(wxWindow* parent, wxWindowID id, |
| | 58 | const wxPoint& pos = wxDefaultPosition, |
| | 59 | const wxSize& size = wxDefaultSize, |
| | 60 | long style = 0, |
| | 61 | const wxString& name = wxEmptyStr); |
| | 62 | //@} |
| | 63 | |
| | 64 | /** |
| | 65 | Returns the wxToolBarBase associated with the control. |
| | 66 | */ |
| | 67 | wxToolBarBase* GetToolBar() const; |
| | 68 | }; |
| | 69 | |
projects / wxWidgets.git / blame_incremental