interface/wx/choicebk.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        choicebk.h
   3 // Purpose:     interface of wxChoicebook
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxChoicebook
  11
  12     wxChoicebook is a class similar to wxNotebook, but uses a wxChoice control
  13     to show the labels instead of the tabs.
  14
  15     For usage documentation of this class, please refer to the base abstract class
  16     wxBookCtrl. You can also use the @ref page_samples_notebook to see wxChoicebook in
  17     action.
  18
  19     wxChoicebook allows the use of wxBookCtrlBase::GetControlSizer(), allowing
  20     a program to add other controls next to the choice control. This is
  21     particularly useful when screen space is restricted, as it often is when
  22     wxChoicebook is being employed.
  23
  24     @beginStyleTable
  25     @style{wxCHB_DEFAULT}
  26            Choose the default location for the labels depending on the current
  27            platform (left everywhere except Mac where it is top).
  28     @style{wxCHB_TOP}
  29            Place labels above the page area.
  30     @style{wxCHB_LEFT}
  31            Place labels on the left side.
  32     @style{wxCHB_RIGHT}
  33            Place labels on the right side.
  34     @style{wxCHB_BOTTOM}
  35            Place labels below the page area.
  36     @endStyleTable
  37
  38     @beginEventTable{wxBookCtrlEvent}
  39     @event{EVT_CHOICEBOOK_PAGE_CHANGED(id, func)}
  40         The page selection was changed.
  41         Processes a @c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED event.
  42     @event{EVT_CHOICEBOOK_PAGE_CHANGING(id, func)}
  43         The page selection is about to be changed.
  44         Processes a @c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING event.
  45         This event can be vetoed (using wxNotifyEvent::Veto()).
  46     @endEventTable
  47
  48     @library{wxcore}
  49     @category{miscwnd}
  50     @appearance{choicebook.png}
  51
  52     @see @ref overview_bookctrl, wxNotebook, @ref page_samples_notebook
  53 */
  54 class wxChoicebook : public wxBookCtrlBase
  55 {
  56 public:
  57     //@{
  58     /**
  59         Constructs a choicebook control.
  60     */
  61     wxChoicebook();
  62     wxChoicebook(wxWindow* parent, wxWindowID id,
  63                  const wxPoint& pos = wxDefaultPosition,
  64                  const wxSize& size = wxDefaultSize,
  65                  long style = 0,
  66                  const wxString& name = wxEmptyStr);
  67     //@}
  68
  69     /**
  70         Returns the wxChoice associated with the control.
  71     */
  72     wxChoice * GetChoiceCtrl() const;
  73 };
  74