wxWidgets/interface/wx/listbook.h
Vadim Zeitlin ce7fe42e84 Provide shorter synonyms for wxEVT_XXX constants.
Use the same short names as are used by the event table macros for the event
type constants themselves. This makes them much more comfortable to use, e.g.
Bind(wxEVT_BUTTON) compared to Bind(wxEVT_COMMAND_BUTTON_CLICKED).

The old long names are still kept for backwards compatibility and shouldn't be
removed as it doesn't really cost anything to continue providing them, but all
new event types should only use the short versions.

Closes #10661.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73850 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-04-25 10:11:03 +00:00

98 lines
3.0 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: listbook.h
// Purpose: interface of wxListbook
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// wxListbook flags
#define wxLB_DEFAULT wxBK_DEFAULT
#define wxLB_TOP wxBK_TOP
#define wxLB_BOTTOM wxBK_BOTTOM
#define wxLB_LEFT wxBK_LEFT
#define wxLB_RIGHT wxBK_RIGHT
#define wxLB_ALIGN_MASK wxBK_ALIGN_MASK
wxEventType wxEVT_LISTBOOK_PAGE_CHANGED;
wxEventType wxEVT_LISTBOOK_PAGE_CHANGING;
/**
@class wxListbook
wxListbook is a class similar to wxNotebook but which 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 wxBookCtrl::SetImageList will implicitly switch the
control to use an icon view.
For usage documentation of this class, please refer to the base abstract class
wxBookCtrl. You can also use the @ref page_samples_notebook to see wxListbook in
action.
@beginStyleTable
@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}
Place labels above the page area.
@style{wxLB_LEFT}
Place labels on the left side.
@style{wxLB_RIGHT}
Place labels on the right side.
@style{wxLB_BOTTOM}
Place labels below the page area.
@endStyleTable
@beginEventEmissionTable{wxBookCtrlEvent}
@event{EVT_LISTBOOK_PAGE_CHANGED(id, func)}
The page selection was changed.
Processes a @c wxEVT_LISTBOOK_PAGE_CHANGED event.
@event{EVT_LISTBOOK_PAGE_CHANGING(id, func)}
The page selection is about to be changed.
Processes a @c wxEVT_LISTBOOK_PAGE_CHANGING event.
This event can be vetoed.
@endEventTable
@library{wxcore}
@category{bookctrl}
@appearance{listbook}
@see wxBookCtrl, wxNotebook, @ref page_samples_notebook
*/
class wxListbook : public wxBookCtrlBase
{
public:
/**
Default ctor.
*/
wxListbook();
/**
Constructs a listbook control.
*/
wxListbook(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxEmptyString);
/**
Create the list book control that has already been constructed with
the default constructor.
*/
bool Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxEmptyString);
/**
Returns the wxListView associated with the control.
*/
wxListView* GetListView() const;
};