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 wxWindows team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_NOTEBOOK_H_BASE_
  13 #define _WX_NOTEBOOK_H_BASE_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "notebookbase.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // headers
  21 // ----------------------------------------------------------------------------
  22
  23 #include "wx/defs.h"
  24
  25 #if wxUSE_NOTEBOOK
  26
  27 #include "wx/bookctrl.h"
  28
  29 // ----------------------------------------------------------------------------
  30 // constants
  31 // ----------------------------------------------------------------------------
  32
  33 // wxNotebook hit results
  34 enum
  35 {
  36     wxNB_HITTEST_NOWHERE = 1,   // not on tab
  37     wxNB_HITTEST_ONICON  = 2,   // on icon
  38     wxNB_HITTEST_ONLABEL = 4,   // on label
  39     wxNB_HITTEST_ONITEM  = wxNB_HITTEST_ONICON | wxNB_HITTEST_ONLABEL
  40 };
  41
  42 typedef wxWindow wxNotebookPage;  // so far, any window can be a page
  43
  44 #define wxNOTEBOOK_NAME _T("notebook")
  45
  46 // ----------------------------------------------------------------------------
  47 // wxNotebookBase: define wxNotebook interface
  48 // ----------------------------------------------------------------------------
  49
  50 class WXDLLEXPORT wxNotebookBase : public wxBookCtrl
  51 {
  52 public:
  53     // ctors
  54     // -----
  55
  56     wxNotebookBase() { }
  57
  58     wxNotebookBase(wxWindow *parent,
  59                    wxWindowID id,
  60                    const wxPoint& pos = wxDefaultPosition,
  61                    const wxSize& size = wxDefaultSize,
  62                    long style = 0,
  63                    const wxString& name = wxNOTEBOOK_NAME)
  64         : wxBookCtrl(parent, id, pos, size, style, name)
  65     {
  66     }
  67
  68
  69     // wxNotebook-specific additions to wxBookCtrl interface
  70     // -----------------------------------------------------
  71
  72     // get the number of rows for a control with wxNB_MULTILINE style (not all
  73     // versions support it - they will always return 1 then)
  74     virtual int GetRowCount() const { return 1; }
  75
  76     // set the padding between tabs (in pixels)
  77     virtual void SetPadding(const wxSize& padding) = 0;
  78
  79     // set the size of the tabs for wxNB_FIXEDWIDTH controls
  80     virtual void SetTabSize(const wxSize& sz) = 0;
  81
  82     // hit test, returns which tab is hit and, optionally, where (icon, label)
  83     // (not implemented on all platforms)
  84     virtual int HitTest(const wxPoint& WXUNUSED(pt),
  85                         long * WXUNUSED(flags) = NULL) const
  86     {
  87         return wxNOT_FOUND;
  88     }
  89
  90
  91     // implement some base class functions
  92     virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
  93
  94 protected:
  95     DECLARE_NO_COPY_CLASS(wxNotebookBase)
  96 };
  97
  98 // ----------------------------------------------------------------------------
  99 // notebook event class and related stuff
 100 // ----------------------------------------------------------------------------
 101
 102 class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlEvent
 103 {
 104 public:
 105     wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
 106                     int nSel = -1, int nOldSel = -1)
 107         : wxBookCtrlEvent(commandType, id, nSel, nOldSel)
 108     {
 109     }
 110
 111 private:
 112     DECLARE_DYNAMIC_CLASS_NO_COPY(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 EVT_NOTEBOOK_PAGE_CHANGED(id, fn)                                   \
 123   DECLARE_EVENT_TABLE_ENTRY(                                                \
 124     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,                                    \
 125     id,                                                                     \
 126     -1,                                                                     \
 127     (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
 128     NULL                                                                    \
 129   ),
 130
 131 #define EVT_NOTEBOOK_PAGE_CHANGING(id, fn)                                  \
 132   DECLARE_EVENT_TABLE_ENTRY(                                                \
 133     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,                                   \
 134     id,                                                                     \
 135     -1,                                                                     \
 136     (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
 137     NULL                                                                    \
 138   ),
 139
 140 // ----------------------------------------------------------------------------
 141 // wxNotebook class itself
 142 // ----------------------------------------------------------------------------
 143
 144 #if defined(__WXUNIVERSAL__)
 145     #include "wx/univ/notebook.h"
 146 #elif defined(__WXMSW__)
 147     #include  "wx/msw/notebook.h"
 148 #elif defined(__WXMOTIF__)
 149     #include  "wx/generic/notebook.h"
 150 #elif defined(__WXGTK__)
 151     #include  "wx/gtk/notebook.h"
 152 #elif defined(__WXMAC__)
 153     #include  "wx/mac/notebook.h"
 154 #elif defined(__WXCOCOA__)
 155     #include  "wx/generic/notebook.h"
 156 #elif defined(__WXPM__)
 157     #include  "wx/os2/notebook.h"
 158 #endif
 159
 160 #endif // wxUSE_NOTEBOOK
 161
 162 #endif
 163     // _WX_NOTEBOOK_H_BASE_