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 #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 extern WXDLLEXPORT_DATA(const wxChar*) wxNotebookNameStr;
  45
  46 #if WXWIN_COMPATIBILITY_2_4
  47     #define wxNOTEBOOK_NAME wxNotebookNameStr
  48 #endif
  49
  50 // ----------------------------------------------------------------------------
  51 // wxNotebookBase: define wxNotebook interface
  52 // ----------------------------------------------------------------------------
  53
  54 class WXDLLEXPORT wxNotebookBase : public wxBookCtrlBase
  55 {
  56 public:
  57     // ctors
  58     // -----
  59
  60     wxNotebookBase() { }
  61
  62     wxNotebookBase(wxWindow *parent,
  63                    wxWindowID winid,
  64                    const wxPoint& pos = wxDefaultPosition,
  65                    const wxSize& size = wxDefaultSize,
  66                    long style = 0,
  67                    const wxString& name = wxNotebookNameStr) ;
  68
  69     // wxNotebook-specific additions to wxBookCtrlBase 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     // On platforms that support it, get the theme page background colour, else invalid colour
  95     virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; }
  96
  97
  98     // Reserved for future use
  99     virtual void ReservedNotebookFunc1() {}
 100     virtual void ReservedNotebookFunc2() {}
 101     virtual void ReservedNotebookFunc3() {}
 102     virtual void ReservedNotebookFunc4() {}
 103     virtual void ReservedNotebookFunc5() {}
 104
 105 protected:
 106     DECLARE_NO_COPY_CLASS(wxNotebookBase)
 107 };
 108
 109 // ----------------------------------------------------------------------------
 110 // notebook event class and related stuff
 111 // ----------------------------------------------------------------------------
 112
 113 class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlBaseEvent
 114 {
 115 public:
 116     wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
 117                     int nSel = -1, int nOldSel = -1)
 118         : wxBookCtrlBaseEvent(commandType, winid, nSel, nOldSel)
 119     {
 120     }
 121
 122 private:
 123     DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebookEvent)
 124 };
 125
 126 BEGIN_DECLARE_EVENT_TYPES()
 127     DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 802)
 128     DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 803)
 129 END_DECLARE_EVENT_TYPES()
 130
 131 typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 132
 133 #define wxNotebookEventHandler(func) \
 134     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotebookEventFunction, &func)
 135
 136 #define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \
 137     wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxNotebookEventHandler(fn))
 138
 139 #define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \
 140     wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxNotebookEventHandler(fn))
 141
 142 // ----------------------------------------------------------------------------
 143 // wxNotebook class itself
 144 // ----------------------------------------------------------------------------
 145
 146 #if defined(__WXUNIVERSAL__)
 147     #include "wx/univ/notebook.h"
 148 #elif defined(__WXMSW__)
 149     #include  "wx/msw/notebook.h"
 150 #elif defined(__WXMOTIF__)
 151     #include  "wx/generic/notebook.h"
 152 #elif defined(__WXGTK__)
 153     #include  "wx/gtk/notebook.h"
 154 #elif defined(__WXMAC__)
 155     #include  "wx/mac/notebook.h"
 156 #elif defined(__WXCOCOA__)
 157     #include  "wx/cocoa/notebook.h"
 158 #elif defined(__WXPM__)
 159     #include  "wx/os2/notebook.h"
 160 #endif
 161
 162 #endif // wxUSE_NOTEBOOK
 163
 164 #endif
 165     // _WX_NOTEBOOK_H_BASE_