wxWidgets/interface/wx/choicebk.h
Vadim Zeitlin 3f66f6a5b3 Remove all lines containing cvs/svn "$Id$" keyword.
This keyword is not expanded by Git which means it's not replaced with the
correct revision value in the releases made using git-based scripts and it's
confusing to have lines with unexpanded "$Id$" in the released files. As
expanding them with Git is not that simple (it could be done with git archive
and export-subst attribute) and there are not many benefits in having them in
the first place, just remove all these lines.

If nothing else, this will make an eventual transition to Git simpler.

Closes #14487.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-07-26 16:02:46 +00:00

98 lines
3.2 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: choicebk.h
// Purpose: interface of wxChoicebook
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// wxChoicebook flags
#define wxCHB_DEFAULT wxBK_DEFAULT
#define wxCHB_TOP wxBK_TOP
#define wxCHB_BOTTOM wxBK_BOTTOM
#define wxCHB_LEFT wxBK_LEFT
#define wxCHB_RIGHT wxBK_RIGHT
#define wxCHB_ALIGN_MASK wxBK_ALIGN_MASK
wxEventType wxEVT_CHOICEBOOK_PAGE_CHANGED;
wxEventType wxEVT_CHOICEBOOK_PAGE_CHANGING;
/**
@class wxChoicebook
wxChoicebook is a class similar to wxNotebook, but uses a wxChoice control
to show the labels instead of the tabs.
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 wxChoicebook in
action.
wxChoicebook allows the use of wxBookCtrlBase::GetControlSizer(), allowing
a program to add other controls next to the choice control. This is
particularly useful when screen space is restricted, as it often is when
wxChoicebook is being employed.
@beginStyleTable
@style{wxCHB_DEFAULT}
Choose the default location for the labels depending on the current
platform (left everywhere except Mac where it is top).
@style{wxCHB_TOP}
Place labels above the page area.
@style{wxCHB_LEFT}
Place labels on the left side.
@style{wxCHB_RIGHT}
Place labels on the right side.
@style{wxCHB_BOTTOM}
Place labels below the page area.
@endStyleTable
@beginEventEmissionTable{wxBookCtrlEvent}
@event{EVT_CHOICEBOOK_PAGE_CHANGED(id, func)}
The page selection was changed.
Processes a @c wxEVT_CHOICEBOOK_PAGE_CHANGED event.
@event{EVT_CHOICEBOOK_PAGE_CHANGING(id, func)}
The page selection is about to be changed.
Processes a @c wxEVT_CHOICEBOOK_PAGE_CHANGING event.
This event can be vetoed (using wxNotifyEvent::Veto()).
@endEventTable
@library{wxcore}
@category{bookctrl}
@appearance{choicebook}
@see @ref overview_bookctrl, wxNotebook, @ref page_samples_notebook
*/
class wxChoicebook : public wxBookCtrlBase
{
public:
//@{
/**
Constructs a choicebook control.
*/
wxChoicebook();
wxChoicebook(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxEmptyString);
//@}
/**
Create the choicebook 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 wxChoice associated with the control.
*/
wxChoice * GetChoiceCtrl() const;
};