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