interface/wx/toolbook.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        toolbook.h
   3 // Purpose:     interface of wxToolbook
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 #define wxTBK_BUTTONBAR            0x0100
  10 #define wxTBK_HORZ_LAYOUT          0x8000
  11
  12 wxEventType wxEVT_TOOLBOOK_PAGE_CHANGED;
  13 wxEventType wxEVT_TOOLBOOK_PAGE_CHANGING;
  14
  15
  16 /**
  17     @class wxToolbook
  18
  19     wxToolbook is a class similar to wxNotebook but which uses a wxToolBar to
  20     show the labels instead of the tabs.
  21
  22     There is no documentation for this class yet but its usage is identical to
  23     wxNotebook (except for the features clearly related to tabs only), so please
  24     refer to that class documentation for now. You can also use the
  25     @ref page_samples_notebook to see wxToolbook in action.
  26
  27     @beginStyleTable
  28     @style{wxTBK_BUTTONBAR}
  29         Use wxButtonToolBar-based implementation under Mac OS (ignored under
  30         other platforms).
  31     @style{wxTBK_HORZ_LAYOUT}
  32         Shows the text and the icons alongside, not vertically stacked (only
  33         implement under Windows and GTK 2 platforms as it relies on
  34         @c wxTB_HORZ_LAYOUT flag support).
  35     @endStyleTable
  36
  37     The common wxBookCtrl styles described in the @ref overview_bookctrl are
  38     also supported.
  39
  40     @beginEventEmissionTable{wxBookCtrlEvent}
  41     @event{EVT_TOOLBOOK_PAGE_CHANGED(id, func)}
  42         The page selection was changed.
  43         Processes a @c wxEVT_TOOLBOOK_PAGE_CHANGED event.
  44     @event{EVT_TOOLBOOK_PAGE_CHANGING(id, func)}
  45         The page selection is about to be changed.
  46         Processes a @c wxEVT_TOOLBOOK_PAGE_CHANGING event.
  47         This event can be vetoed (using wxNotifyEvent::Veto()).
  48     @endEventTable
  49
  50     @library{wxcore}
  51     @category{bookctrl}
  52
  53     @see @ref overview_bookctrl, wxBookCtrlBase, wxNotebook,
  54          @ref page_samples_notebook
  55 */
  56 class wxToolbook : public wxBookCtrlBase
  57 {
  58 public:
  59     //@{
  60     /**
  61         Constructs a choicebook control.
  62     */
  63     wxToolbook();
  64     wxToolbook(wxWindow* parent, wxWindowID id,
  65                  const wxPoint& pos = wxDefaultPosition,
  66                  const wxSize& size = wxDefaultSize,
  67                  long style = 0,
  68                  const wxString& name = wxEmptyString);
  69     //@}
  70
  71     /**
  72        Create the tool book control that has already been constructed with
  73        the default constructor.
  74     */
  75     bool Create(wxWindow *parent,
  76                 wxWindowID id,
  77                 const wxPoint& pos = wxDefaultPosition,
  78                 const wxSize& size = wxDefaultSize,
  79                 long style = 0,
  80                 const wxString& name = wxEmptyString);
  81
  82     /**
  83         Returns the wxToolBarBase associated with the control.
  84     */
  85     wxToolBarBase* GetToolBar() const;
  86 };
  87