interface/wx/listbook.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        listbook.h
   3 // Purpose:     interface of wxListbook
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxListbook
  11
  12     wxListbook is a class similar to wxNotebook but which uses a wxListCtrl
  13     to show the labels instead of the tabs.
  14
  15     The underlying wxListCtrl displays page labels in a one-column report view
  16     by default. Calling wxBookCtrl::SetImageList will implicitly switch the
  17     control to use an icon view.
  18
  19     For usage documentation of this class, please refer to the base abstract class
  20     wxBookCtrl. You can also use the @ref page_samples_notebook to see wxListbook in
  21     action.
  22
  23     @beginStyleTable
  24     @style{wxLB_DEFAULT}
  25            Choose the default location for the labels depending on the current
  26            platform (left everywhere except Mac where it is top).
  27     @style{wxLB_TOP}
  28            Place labels above the page area.
  29     @style{wxLB_LEFT}
  30            Place labels on the left side.
  31     @style{wxLB_RIGHT}
  32            Place labels on the right side.
  33     @style{wxLB_BOTTOM}
  34            Place labels below the page area.
  35     @endStyleTable
  36
  37     @beginEventEmissionTable{wxBookCtrlEvent}
  38     @event{EVT_LISTBOOK_PAGE_CHANGED(id, func)}
  39         The page selection was changed.
  40         Processes a @c wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED event.
  41     @event{EVT_LISTBOOK_PAGE_CHANGING(id, func)}
  42         The page selection is about to be changed.
  43         Processes a @c wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING event.
  44         This event can be vetoed.
  45     @endEventTable
  46
  47     @library{wxcore}
  48     @category{miscwnd}
  49     @appearance{listbook.png}
  50
  51     @see wxBookCtrl, wxNotebook, @ref page_samples_notebook
  52 */
  53 class wxListbook : public wxBookCtrlBase
  54 {
  55 public:
  56     /**
  57         Default ctor.
  58     */
  59     wxListbook();
  60
  61     /**
  62         Constructs a listbook control.
  63     */
  64     wxListbook(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         Returns the wxListView associated with the control.
  72     */
  73     wxListView* GetListView() const;
  74 };
  75