include/wx/choicebk.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/choicebk.h
   3 // Purpose:     wxChoicebook: wxChoice and wxNotebook combination
   4 // Author:      Vadim Zeitlin
   5 // Modified by: Wlodzimierz ABX Skiba from wx/listbook.h
   6 // Created:     15.09.04
   7 // Copyright:   (c) Vadim Zeitlin, Wlodzimierz Skiba
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_CHOICEBOOK_H_
  12 #define _WX_CHOICEBOOK_H_
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_CHOICEBOOK
  17
  18 #include "wx/bookctrl.h"
  19 #include "wx/choice.h"
  20 #include "wx/containr.h"
  21
  22 class WXDLLIMPEXP_FWD_CORE wxChoice;
  23
  24 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_CHOICEBOOK_PAGE_CHANGED,  wxBookCtrlEvent );
  25 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_CHOICEBOOK_PAGE_CHANGING, wxBookCtrlEvent );
  26
  27 // wxChoicebook flags
  28 #define wxCHB_DEFAULT          wxBK_DEFAULT
  29 #define wxCHB_TOP              wxBK_TOP
  30 #define wxCHB_BOTTOM           wxBK_BOTTOM
  31 #define wxCHB_LEFT             wxBK_LEFT
  32 #define wxCHB_RIGHT            wxBK_RIGHT
  33 #define wxCHB_ALIGN_MASK       wxBK_ALIGN_MASK
  34
  35 // ----------------------------------------------------------------------------
  36 // wxChoicebook
  37 // ----------------------------------------------------------------------------
  38
  39 class WXDLLIMPEXP_CORE wxChoicebook : public wxNavigationEnabled<wxBookCtrlBase>
  40 {
  41 public:
  42     wxChoicebook() { }
  43
  44     wxChoicebook(wxWindow *parent,
  45                  wxWindowID id,
  46                  const wxPoint& pos = wxDefaultPosition,
  47                  const wxSize& size = wxDefaultSize,
  48                  long style = 0,
  49                  const wxString& name = wxEmptyString)
  50     {
  51         (void)Create(parent, id, pos, size, style, name);
  52     }
  53
  54     // quasi ctor
  55     bool Create(wxWindow *parent,
  56                 wxWindowID id,
  57                 const wxPoint& pos = wxDefaultPosition,
  58                 const wxSize& size = wxDefaultSize,
  59                 long style = 0,
  60                 const wxString& name = wxEmptyString);
  61
  62
  63     virtual bool SetPageText(size_t n, const wxString& strText);
  64     virtual wxString GetPageText(size_t n) const;
  65     virtual int GetPageImage(size_t n) const;
  66     virtual bool SetPageImage(size_t n, int imageId);
  67     virtual bool InsertPage(size_t n,
  68                             wxWindow *page,
  69                             const wxString& text,
  70                             bool bSelect = false,
  71                             int imageId = NO_IMAGE);
  72     virtual int SetSelection(size_t n)
  73         { return DoSetSelection(n, SetSelection_SendEvent); }
  74     virtual int ChangeSelection(size_t n) { return DoSetSelection(n); }
  75     virtual void SetImageList(wxImageList *imageList);
  76
  77     virtual bool DeleteAllPages();
  78
  79     // returns the choice control
  80     wxChoice* GetChoiceCtrl() const { return (wxChoice*)m_bookctrl; }
  81
  82     // Override this to return true because the part of parent window
  83     // background between our controlling wxChoice and the page area should
  84     // show through.
  85     virtual bool HasTransparentBackground() { return true; }
  86
  87 protected:
  88     virtual void DoSetWindowVariant(wxWindowVariant variant);
  89
  90     virtual wxWindow *DoRemovePage(size_t page);
  91
  92     void UpdateSelectedPage(size_t newsel)
  93     {
  94         m_selection = static_cast<int>(newsel);
  95         GetChoiceCtrl()->Select(m_selection);
  96     }
  97
  98     wxBookCtrlEvent* CreatePageChangingEvent() const;
  99     void MakeChangedEvent(wxBookCtrlEvent &event);
 100
 101     // event handlers
 102     void OnChoiceSelected(wxCommandEvent& event);
 103
 104 private:
 105     DECLARE_EVENT_TABLE()
 106     DECLARE_DYNAMIC_CLASS_NO_COPY(wxChoicebook)
 107 };
 108
 109 // ----------------------------------------------------------------------------
 110 // choicebook event class and related stuff
 111 // ----------------------------------------------------------------------------
 112
 113 // wxChoicebookEvent is obsolete and defined for compatibility only
 114 #define wxChoicebookEvent wxBookCtrlEvent
 115 typedef wxBookCtrlEventFunction wxChoicebookEventFunction;
 116 #define wxChoicebookEventHandler(func) wxBookCtrlEventHandler(func)
 117
 118 #define EVT_CHOICEBOOK_PAGE_CHANGED(winid, fn) \
 119     wx__DECLARE_EVT1(wxEVT_CHOICEBOOK_PAGE_CHANGED, winid, wxBookCtrlEventHandler(fn))
 120
 121 #define EVT_CHOICEBOOK_PAGE_CHANGING(winid, fn) \
 122     wx__DECLARE_EVT1(wxEVT_CHOICEBOOK_PAGE_CHANGING, winid, wxBookCtrlEventHandler(fn))
 123
 124 // old wxEVT_COMMAND_* constants
 125 #define wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED    wxEVT_CHOICEBOOK_PAGE_CHANGED
 126 #define wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING   wxEVT_CHOICEBOOK_PAGE_CHANGING
 127
 128 #endif // wxUSE_CHOICEBOOK
 129
 130 #endif // _WX_CHOICEBOOK_H_