include/wx/listbook.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/listbook.h
   3 // Purpose:     wxListbook: wxListCtrl and wxNotebook combination
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     19.08.03
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_LISTBOOK_H_
  13 #define _WX_LISTBOOK_H_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_LISTBOOK
  18
  19 #include "wx/bookctrl.h"
  20
  21 class WXDLLEXPORT wxListView;
  22 class WXDLLEXPORT wxListEvent;
  23
  24 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED;
  25 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING;
  26
  27 // ----------------------------------------------------------------------------
  28 // wxListbook
  29 // ----------------------------------------------------------------------------
  30
  31 class WXDLLEXPORT wxListbook : public wxBookCtrlBase
  32 {
  33 public:
  34     wxListbook()
  35     {
  36         Init();
  37     }
  38
  39     wxListbook(wxWindow *parent,
  40                wxWindowID id,
  41                const wxPoint& pos = wxDefaultPosition,
  42                const wxSize& size = wxDefaultSize,
  43                long style = 0,
  44                const wxString& name = wxEmptyString)
  45     {
  46         Init();
  47
  48         (void)Create(parent, id, pos, size, style, name);
  49     }
  50
  51     // quasi ctor
  52     bool Create(wxWindow *parent,
  53                 wxWindowID id,
  54                 const wxPoint& pos = wxDefaultPosition,
  55                 const wxSize& size = wxDefaultSize,
  56                 long style = 0,
  57                 const wxString& name = wxEmptyString);
  58
  59
  60     virtual int GetSelection() const;
  61     virtual bool SetPageText(size_t n, const wxString& strText);
  62     virtual wxString GetPageText(size_t n) const;
  63     virtual int GetPageImage(size_t n) const;
  64     virtual bool SetPageImage(size_t n, int imageId);
  65     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
  66     virtual bool InsertPage(size_t n,
  67                             wxWindow *page,
  68                             const wxString& text,
  69                             bool bSelect = false,
  70                             int imageId = -1);
  71     virtual int SetSelection(size_t n) { return DoSetSelection(n, SetSelection_SendEvent); }
  72     virtual int ChangeSelection(size_t n) { return DoSetSelection(n); }
  73     virtual void SetImageList(wxImageList *imageList);
  74
  75     virtual bool DeleteAllPages();
  76
  77     wxListView* GetListView() const { return (wxListView*)m_bookctrl; }
  78
  79 protected:
  80     virtual wxWindow *DoRemovePage(size_t page);
  81
  82     // get the size which the list control should have
  83     virtual wxSize GetControllerSize() const;
  84
  85     // return the page corresponding to the tab at the specified position
  86     virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
  87
  88     int DoSetSelection(size_t nPage, int flags = 0);
  89
  90     void UpdateSelectedPage(size_t newsel);
  91
  92     void MakeChangedEvent(wxBookCtrlBaseEvent &event)
  93     {
  94         event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED);
  95     }
  96
  97     // event handlers
  98     void OnListSelected(wxListEvent& event);
  99     void OnSize(wxSizeEvent& event);
 100
 101     // the currently selected page or wxNOT_FOUND if none
 102     int m_selection;
 103
 104 private:
 105     // common part of all constructors
 106     void Init();
 107
 108     DECLARE_EVENT_TABLE()
 109     DECLARE_DYNAMIC_CLASS_NO_COPY(wxListbook)
 110 };
 111
 112 // ----------------------------------------------------------------------------
 113 // listbook event class and related stuff
 114 // ----------------------------------------------------------------------------
 115
 116 class WXDLLEXPORT wxListbookEvent : public wxBookCtrlBaseEvent
 117 {
 118 public:
 119     wxListbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
 120                     int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND)
 121         : wxBookCtrlBaseEvent(commandType, id, nSel, nOldSel)
 122     {
 123     }
 124
 125     wxListbookEvent(const wxListbookEvent& event)
 126         : wxBookCtrlBaseEvent(event)
 127     {
 128     }
 129
 130     virtual wxEvent *Clone() const { return new wxListbookEvent(*this); }
 131
 132 private:
 133     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxListbookEvent)
 134 };
 135
 136 typedef void (wxEvtHandler::*wxListbookEventFunction)(wxListbookEvent&);
 137
 138 #define wxListbookEventHandler(func) \
 139     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxListbookEventFunction, &func)
 140
 141 #define EVT_LISTBOOK_PAGE_CHANGED(winid, fn) \
 142     wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, winid, wxListbookEventHandler(fn))
 143
 144 #define EVT_LISTBOOK_PAGE_CHANGING(winid, fn) \
 145     wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, winid, wxListbookEventHandler(fn))
 146
 147 #endif // wxUSE_LISTBOOK
 148
 149 #endif // _WX_LISTBOOK_H_