interface/choicebk.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        choicebk.h
   3 // Purpose:     documentation for wxChoicebook class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxChoicebook
  11     @wxheader{choicebk.h}
  12
  13     wxChoicebook is a class similar to wxNotebook but which
  14     uses a wxChoice to show the labels instead of the
  15     tabs.
  16
  17     There is no documentation for this class yet but its usage is
  18     identical to wxNotebook (except for the features clearly related to tabs
  19     only), so please refer to that class documentation for now. You can also
  20     use the @ref overview_samplenotebook "notebook sample" to see wxChoicebook in
  21     action.
  22
  23     wxChoicebook allows the use of wxBookCtrl::GetControlSizer, allowing a program
  24     to add other controls next to the choice control. This is particularly useful
  25     when screen space is restricted, as it often is when wxChoicebook is being
  26     employed.
  27
  28     @beginStyleTable
  29     @style{wxCHB_DEFAULT}:
  30            Choose the default location for the labels depending on the current
  31            platform (left everywhere except Mac where it is top).
  32     @style{wxCHB_TOP}:
  33            Place labels above the page area.
  34     @style{wxCHB_LEFT}:
  35            Place labels on the left side.
  36     @style{wxCHB_RIGHT}:
  37            Place labels on the right side.
  38     @style{wxCHB_BOTTOM}:
  39            Place labels below the page area.
  40     @endStyleTable
  41
  42     @library{wxcore}
  43     @category{miscwnd}
  44
  45     @seealso
  46     wxBookCtrl, wxNotebook, @ref overview_samplenotebook "notebook sample"
  47 */
  48 class wxChoicebook : public wxBookCtrl overview
  49 {
  50 public:
  51     //@{
  52     /**
  53         Constructs a choicebook control.
  54     */
  55     wxChoicebook();
  56     wxChoicebook(wxWindow* parent, wxWindowID id,
  57                  const wxPoint& pos = wxDefaultPosition,
  58                  const wxSize& size = wxDefaultSize,
  59                  long style = 0,
  60                  const wxString& name = wxEmptyStr);
  61     //@}
  62 };