revised the documentation of the book controls; moved common API to wxBookCtrlBase

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56268 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-13 10:27:19 +00:00
parent e8a8aa37ea
commit 340e9651e1
6 changed files with 455 additions and 315 deletions

View File

@@ -23,13 +23,23 @@
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).
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.
@beginEventTable{wxBookCtrlEvent}
@event{EVT_TOOLBOOK_PAGE_CHANGED(id, func)}
The page selection was changed.
Processes a @c wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED event.
@event{EVT_TOOLBOOK_PAGE_CHANGING(id, func)}
The page selection is about to be changed.
Processes a @c wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING event.
This event can be vetoed (using wxNotifyEvent::Veto()).
@endEventTable
@library{wxcore}
@category{miscwnd}
@@ -39,6 +49,21 @@
class wxToolbook : public wxBookCtrlBase
{
public:
//@{
/**
Constructs a choicebook control.
*/
wxToolbook();
wxToolbook(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxEmptyStr);
//@}
/**
Returns the wxToolBarBase associated with the control.
*/
wxToolBarBase* GetToolBar() const;
};