interface/wx/toolbook.h

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