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 wxWidgets 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 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 = wxNOTEBOOK_NAME) ;
  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 protected:
  91     DECLARE_NO_COPY_CLASS(wxNotebookBase)
  92 };
  93
  94 // ----------------------------------------------------------------------------
  95 // notebook event class and related stuff
  96 // ----------------------------------------------------------------------------
  97
  98 class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlBaseEvent
  99 {
 100 public:
 101     wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
 102                     int nSel = -1, int nOldSel = -1)
 103         : wxBookCtrlBaseEvent(commandType, winid, nSel, nOldSel)
 104     {
 105     }
 106
 107 private:
 108     DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebookEvent)
 109 };
 110
 111 BEGIN_DECLARE_EVENT_TYPES()
 112     DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 802)
 113     DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 803)
 114 END_DECLARE_EVENT_TYPES()
 115
 116 typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 117
 118 #define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn)                                   \
 119   DECLARE_EVENT_TABLE_ENTRY(                                                   \
 120     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,                                       \
 121     winid,                                                                     \
 122     wxID_ANY,                                                                  \
 123     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxNotebookEventFunction, &fn ),  \
 124     NULL                                                                       \
 125   ),
 126
 127 #define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn)                                  \
 128   DECLARE_EVENT_TABLE_ENTRY(                                                   \
 129     wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,                                      \
 130     winid,                                                                     \
 131     wxID_ANY,                                                                  \
 132     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxNotebookEventFunction, &fn ),  \
 133     NULL                                                                    \
 134   ),
 135
 136 // ----------------------------------------------------------------------------
 137 // wxNotebook class itself
 138 // ----------------------------------------------------------------------------
 139
 140 #if defined(__WXUNIVERSAL__)
 141     #include "wx/univ/notebook.h"
 142 #elif defined(__WXMSW__)
 143     #include  "wx/msw/notebook.h"
 144 #elif defined(__WXMOTIF__)
 145     #include  "wx/generic/notebook.h"
 146 #elif defined(__WXGTK__)
 147     #include  "wx/gtk/notebook.h"
 148 #elif defined(__WXMAC__)
 149     #include  "wx/mac/notebook.h"
 150 #elif defined(__WXCOCOA__)
 151     #include  "wx/cocoa/notebook.h"
 152 #elif defined(__WXPM__)
 153     #include  "wx/os2/notebook.h"
 154 #endif
 155
 156 #endif // wxUSE_NOTEBOOK
 157
 158 #endif
 159     // _WX_NOTEBOOK_H_BASE_