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