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
  30 enum
  31 {
  32     wxNB_HITTEST_NOWHERE = 1,   // not on tab
  33     wxNB_HITTEST_ONICON  = 2,   // on icon
  34     wxNB_HITTEST_ONLABEL = 4,   // on label
  35     wxNB_HITTEST_ONITEM  = wxNB_HITTEST_ONICON | wxNB_HITTEST_ONLABEL
  36 };
  37
  38 typedef wxWindow wxNotebookPage;  // so far, any window can be a page
  39
  40 extern WXDLLEXPORT_DATA(const wxChar*) wxNotebookNameStr;
  41
  42 #if WXWIN_COMPATIBILITY_2_4
  43     #define wxNOTEBOOK_NAME wxNotebookNameStr
  44 #endif
  45
  46 // ----------------------------------------------------------------------------
  47 // wxNotebookBase: define wxNotebook interface
  48 // ----------------------------------------------------------------------------
  49
  50 class WXDLLEXPORT wxNotebookBase : public wxBookCtrlBase
  51 {
  52 public:
  53     // ctors
  54     // -----
  55
  56     wxNotebookBase() { }
  57
  58     wxNotebookBase(wxWindow *parent,
  59                    wxWindowID winid,
  60                    const wxPoint& pos = wxDefaultPosition,
  61                    const wxSize& size = wxDefaultSize,
  62                    long style = 0,
  63                    const wxString& name = wxNotebookNameStr) ;
  64
  65     // wxNotebook-specific additions to wxBookCtrlBase interface
  66     // ---------------------------------------------------------
  67
  68     // get the number of rows for a control with wxNB_MULTILINE style (not all
  69     // versions support it - they will always return 1 then)
  70     virtual int GetRowCount() const { return 1; }
  71
  72     // set the padding between tabs (in pixels)
  73     virtual void SetPadding(const wxSize& padding) = 0;
  74
  75     // set the size of the tabs for wxNB_FIXEDWIDTH controls
  76     virtual void SetTabSize(const wxSize& sz) = 0;
  77
  78     // hit test, returns which tab is hit and, optionally, where (icon, label)
  79     // (not implemented on all platforms)
  80     virtual int HitTest(const wxPoint& WXUNUSED(pt),
  81                         long * WXUNUSED(flags) = NULL) const
  82     {
  83         return wxNOT_FOUND;
  84     }
  85
  86
  87     // implement some base class functions
  88     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
  89
  90     // On platforms that support it, get the theme page background colour, else invalid colour
  91     virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; }
  92
  93
  94     // Reserved for future use
  95     virtual void ReservedNotebookFunc1() {}
  96     virtual void ReservedNotebookFunc2() {}
  97     virtual void ReservedNotebookFunc3() {}
  98     virtual void ReservedNotebookFunc4() {}
  99     virtual void ReservedNotebookFunc5() {}
 100
 101 protected:
 102     DECLARE_NO_COPY_CLASS(wxNotebookBase)
 103 };
 104
 105 // ----------------------------------------------------------------------------
 106 // notebook event class and related stuff
 107 // ----------------------------------------------------------------------------
 108
 109 class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlBaseEvent
 110 {
 111 public:
 112     wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
 113                     int nSel = -1, int nOldSel = -1)
 114         : wxBookCtrlBaseEvent(commandType, winid, nSel, nOldSel)
 115     {
 116     }
 117
 118     wxNotebookEvent(const wxNotebookEvent& event)
 119         : wxBookCtrlBaseEvent(event)
 120     {
 121     }
 122
 123     virtual wxEvent *Clone() const { return new wxNotebookEvent(*this); }
 124
 125 private:
 126     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotebookEvent)
 127 };
 128
 129 BEGIN_DECLARE_EVENT_TYPES()
 130     DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 802)
 131     DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 803)
 132 END_DECLARE_EVENT_TYPES()
 133
 134 typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 135
 136 #define wxNotebookEventHandler(func) \
 137     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotebookEventFunction, &func)
 138
 139 #define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \
 140     wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxNotebookEventHandler(fn))
 141
 142 #define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \
 143     wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxNotebookEventHandler(fn))
 144
 145 // ----------------------------------------------------------------------------
 146 // wxNotebook class itself
 147 // ----------------------------------------------------------------------------
 148
 149 #if defined(__WXUNIVERSAL__)
 150     #include "wx/univ/notebook.h"
 151 #elif defined(__WXMSW__)
 152     #include  "wx/msw/notebook.h"
 153 #elif defined(__WXMOTIF__)
 154     #include  "wx/generic/notebook.h"
 155 #elif defined(__WXGTK__)
 156     #include  "wx/gtk/notebook.h"
 157 #elif defined(__WXMAC__)
 158     #include  "wx/mac/notebook.h"
 159 #elif defined(__WXCOCOA__)
 160     #include  "wx/cocoa/notebook.h"
 161 #elif defined(__WXPM__)
 162     #include  "wx/os2/notebook.h"
 163 #endif
 164
 165 #endif // wxUSE_NOTEBOOK
 166
 167 #endif
 168     // _WX_NOTEBOOK_H_BASE_