| 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, use wxBK_HITTEST so other book controls can share them |
| 30 | // if wxUSE_NOTEBOOK is disabled |
| 31 | enum |
| 32 | { |
| 33 | wxNB_HITTEST_NOWHERE = wxBK_HITTEST_NOWHERE, |
| 34 | wxNB_HITTEST_ONICON = wxBK_HITTEST_ONICON, |
| 35 | wxNB_HITTEST_ONLABEL = wxBK_HITTEST_ONLABEL, |
| 36 | wxNB_HITTEST_ONITEM = wxBK_HITTEST_ONITEM, |
| 37 | wxNB_HITTEST_ONPAGE = wxBK_HITTEST_ONPAGE |
| 38 | }; |
| 39 | |
| 40 | // wxNotebook flags |
| 41 | |
| 42 | // use common book wxBK_* flags for describing alignment |
| 43 | #define wxNB_DEFAULT wxBK_DEFAULT |
| 44 | #define wxNB_TOP wxBK_TOP |
| 45 | #define wxNB_BOTTOM wxBK_BOTTOM |
| 46 | #define wxNB_LEFT wxBK_LEFT |
| 47 | #define wxNB_RIGHT wxBK_RIGHT |
| 48 | |
| 49 | #define wxNB_FIXEDWIDTH 0x0100 |
| 50 | #define wxNB_MULTILINE 0x0200 |
| 51 | #define wxNB_NOPAGETHEME 0x0400 |
| 52 | #define wxNB_FLAT 0x0800 |
| 53 | |
| 54 | |
| 55 | typedef wxWindow wxNotebookPage; // so far, any window can be a page |
| 56 | |
| 57 | extern WXDLLIMPEXP_DATA_CORE(const char) wxNotebookNameStr[]; |
| 58 | |
| 59 | // ---------------------------------------------------------------------------- |
| 60 | // wxNotebookBase: define wxNotebook interface |
| 61 | // ---------------------------------------------------------------------------- |
| 62 | |
| 63 | class WXDLLIMPEXP_CORE wxNotebookBase : public wxBookCtrlBase |
| 64 | { |
| 65 | public: |
| 66 | // ctors |
| 67 | // ----- |
| 68 | |
| 69 | wxNotebookBase() { } |
| 70 | |
| 71 | // wxNotebook-specific additions to wxBookCtrlBase interface |
| 72 | // --------------------------------------------------------- |
| 73 | |
| 74 | // get the number of rows for a control with wxNB_MULTILINE style (not all |
| 75 | // versions support it - they will always return 1 then) |
| 76 | virtual int GetRowCount() const { return 1; } |
| 77 | |
| 78 | // set the padding between tabs (in pixels) |
| 79 | virtual void SetPadding(const wxSize& padding) = 0; |
| 80 | |
| 81 | // set the size of the tabs for wxNB_FIXEDWIDTH controls |
| 82 | virtual void SetTabSize(const wxSize& sz) = 0; |
| 83 | |
| 84 | |
| 85 | |
| 86 | // implement some base class functions |
| 87 | virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const; |
| 88 | |
| 89 | // On platforms that support it, get the theme page background colour, else invalid colour |
| 90 | virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; } |
| 91 | |
| 92 | |
| 93 | // send wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING/ED events |
| 94 | |
| 95 | // returns false if the change to nPage is vetoed by the program |
| 96 | bool SendPageChangingEvent(int nPage); |
| 97 | |
| 98 | // sends the event about page change from old to new (or GetSelection() if |
| 99 | // new is -1) |
| 100 | void SendPageChangedEvent(int nPageOld, int nPageNew = -1); |
| 101 | |
| 102 | // wxBookCtrlBase overrides this method to return false but we do need |
| 103 | // focus because we have tabs |
| 104 | virtual bool AcceptsFocus() const { return wxControl::AcceptsFocus(); } |
| 105 | |
| 106 | protected: |
| 107 | DECLARE_NO_COPY_CLASS(wxNotebookBase) |
| 108 | }; |
| 109 | |
| 110 | // ---------------------------------------------------------------------------- |
| 111 | // notebook event class and related stuff |
| 112 | // ---------------------------------------------------------------------------- |
| 113 | |
| 114 | // wxNotebookEvent is obsolete and defined for compatibility only (notice that |
| 115 | // we use #define and not typedef to also keep compatibility with the existing |
| 116 | // code which forward declares it) |
| 117 | #define wxNotebookEvent wxBookCtrlEvent |
| 118 | typedef wxBookCtrlEventFunction wxNotebookEventFunction; |
| 119 | #define wxNotebookEventHandler(func) wxBookCtrlEventHandler(func) |
| 120 | |
| 121 | extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED; |
| 122 | extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING; |
| 123 | |
| 124 | #define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \ |
| 125 | wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxBookCtrlEventHandler(fn)) |
| 126 | |
| 127 | #define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \ |
| 128 | wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxBookCtrlEventHandler(fn)) |
| 129 | |
| 130 | // ---------------------------------------------------------------------------- |
| 131 | // wxNotebook class itself |
| 132 | // ---------------------------------------------------------------------------- |
| 133 | |
| 134 | #if defined(__WXUNIVERSAL__) |
| 135 | #include "wx/univ/notebook.h" |
| 136 | #elif defined(__WXMSW__) |
| 137 | #include "wx/msw/notebook.h" |
| 138 | #elif defined(__WXMOTIF__) |
| 139 | #include "wx/generic/notebook.h" |
| 140 | #elif defined(__WXGTK20__) |
| 141 | #include "wx/gtk/notebook.h" |
| 142 | #elif defined(__WXGTK__) |
| 143 | #include "wx/gtk1/notebook.h" |
| 144 | #elif defined(__WXMAC__) |
| 145 | #include "wx/osx/notebook.h" |
| 146 | #elif defined(__WXCOCOA__) |
| 147 | #include "wx/cocoa/notebook.h" |
| 148 | #elif defined(__WXPM__) |
| 149 | #include "wx/os2/notebook.h" |
| 150 | #endif |
| 151 | |
| 152 | #endif // wxUSE_NOTEBOOK |
| 153 | |
| 154 | #endif |
| 155 | // _WX_NOTEBOOK_H_BASE_ |