include/wx/notebook.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/notebook.h
   3 // Purpose:     wxNotebook interface
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     01.02.01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1996-2000 Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_NOTEBOOK_H_BASE_
  13 #define _WX_NOTEBOOK_H_BASE_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_NOTEBOOK
  22
  23 #include "wx/bookctrl.h"
  24
  25 // ----------------------------------------------------------------------------
  26 // constants
  27 // ----------------------------------------------------------------------------
  28
  29 #if WXWIN_COMPATIBILITY_2_6
  30
  31 // wxNotebook hit results, use wxBK_HITTEST so other book controls can share them
  32 // if wxUSE_NOTEBOOK is disabled
  33 enum
  34 {
  35     wxNB_HITTEST_NOWHERE = wxBK_HITTEST_NOWHERE,
  36     wxNB_HITTEST_ONICON  = wxBK_HITTEST_ONICON,
  37     wxNB_HITTEST_ONLABEL = wxBK_HITTEST_ONLABEL,
  38     wxNB_HITTEST_ONITEM  = wxBK_HITTEST_ONITEM,
  39     wxNB_HITTEST_ONPAGE  = wxBK_HITTEST_ONPAGE
  40 };
  41
  42 #endif // WXWIN_COMPATIBILITY_2_6
  43
  44 typedef wxWindow wxNotebookPage;  // so far, any window can be a page
  45
  46 extern WXDLLEXPORT_DATA(const wxChar) wxNotebookNameStr[];
  47
  48 #if WXWIN_COMPATIBILITY_2_4
  49     #define wxNOTEBOOK_NAME wxNotebookNameStr
  50 #endif
  51
  52 // ----------------------------------------------------------------------------
  53 // wxNotebookBase: define wxNotebook interface
  54 // ----------------------------------------------------------------------------
  55
  56 class WXDLLEXPORT wxNotebookBase : public wxBookCtrlBase
  57 {
  58 public:
  59     // ctors
  60     // -----
  61
  62     wxNotebookBase() { }
  63
  64     wxNotebookBase(wxWindow *parent,
  65                    wxWindowID winid,
  66                    const wxPoint& pos = wxDefaultPosition,
  67                    const wxSize& size = wxDefaultSize,
  68                    long style = 0,
  69                    const wxString& name = wxNotebookNameStr) ;
  70
  71     // wxNotebook-specific additions to wxBookCtrlBase interface
  72     // ---------------------------------------------------------
  73
  74     // get the number of rows for a control with wxNB_MULTILINE style (not all
  75     // versions support it - they will always return 1 then)
  76     virtual int GetRowCount() const { return 1; }
  77
  78     // set the padding between tabs (in pixels)
  79     virtual void SetPadding(const wxSize& padding) = 0;
  80
  81     // set the size of the tabs for wxNB_FIXEDWIDTH controls
  82     virtual void SetTabSize(const wxSize& sz) = 0;
  83
  84
  85
  86     // implement some base class functions
  87     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
  88
  89     // On platforms that support it, get the theme page background colour, else invalid colour
  90     virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; }
  91
  92
  93     // send wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING/ED events
  94
  95     // returns false if the change to nPage is vetoed by the program
  96     bool SendPageChangingEvent(int nPage);
  97
  98     // sends the event about page change from old to new (or GetSelection() if
  99     // new is -1)
 100     void SendPageChangedEvent(int nPageOld, int nPageNew = -1);
 101
 102
 103 protected:
 104     DECLARE_NO_COPY_CLASS(wxNotebookBase)
 105 };
 106
 107 // ----------------------------------------------------------------------------
 108 // notebook event class and related stuff
 109 // ----------------------------------------------------------------------------
 110
 111 class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlBaseEvent
 112 {
 113 public:
 114     wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
 115                     int nSel = -1, int nOldSel = -1)
 116         : wxBookCtrlBaseEvent(commandType, winid, nSel, nOldSel)
 117     {
 118     }
 119
 120     wxNotebookEvent(const wxNotebookEvent& event)
 121         : wxBookCtrlBaseEvent(event)
 122     {
 123     }
 124
 125     virtual wxEvent *Clone() const { return new wxNotebookEvent(*this); }
 126
 127 private:
 128     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotebookEvent)
 129 };
 130
 131 BEGIN_DECLARE_EVENT_TYPES()
 132     DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 802)
 133     DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 803)
 134 END_DECLARE_EVENT_TYPES()
 135
 136 typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 137
 138 #define wxNotebookEventHandler(func) \
 139     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotebookEventFunction, &func)
 140
 141 #define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \
 142     wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxNotebookEventHandler(fn))
 143
 144 #define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \
 145     wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxNotebookEventHandler(fn))
 146
 147 // ----------------------------------------------------------------------------
 148 // wxNotebook class itself
 149 // ----------------------------------------------------------------------------
 150
 151 #if defined(__WXUNIVERSAL__)
 152     #include "wx/univ/notebook.h"
 153 #elif defined(__WXMSW__)
 154     #include  "wx/msw/notebook.h"
 155 #elif defined(__WXMOTIF__)
 156     #include  "wx/generic/notebook.h"
 157 #elif defined(__WXGTK20__)
 158     #include  "wx/gtk/notebook.h"
 159 #elif defined(__WXGTK__)
 160     #include  "wx/gtk1/notebook.h"
 161 #elif defined(__WXMAC__)
 162     #include  "wx/mac/notebook.h"
 163 #elif defined(__WXCOCOA__)
 164     #include  "wx/cocoa/notebook.h"
 165 #elif defined(__WXPM__)
 166     #include  "wx/os2/notebook.h"
 167 #endif
 168
 169 #endif // wxUSE_NOTEBOOK
 170
 171 #endif
 172     // _WX_NOTEBOOK_H_BASE_