]>
Commit | Line | Data |
---|---|---|
1e6feb95 VZ |
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$ | |
77ffb593 | 8 | // Copyright: (c) 1996-2000 wxWidgets team |
65571936 | 9 | // Licence: wxWindows licence |
1e6feb95 VZ |
10 | /////////////////////////////////////////////////////////////////////////////// |
11 | ||
34138703 JS |
12 | #ifndef _WX_NOTEBOOK_H_BASE_ |
13 | #define _WX_NOTEBOOK_H_BASE_ | |
53b28675 | 14 | |
12028905 | 15 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) |
07b8d7ec VZ |
16 | #pragma interface "notebookbase.h" |
17 | #endif | |
18 | ||
4d0f3cd6 VZ |
19 | // ---------------------------------------------------------------------------- |
20 | // headers | |
21 | // ---------------------------------------------------------------------------- | |
22 | ||
1e6feb95 VZ |
23 | #include "wx/defs.h" |
24 | ||
25 | #if wxUSE_NOTEBOOK | |
26 | ||
15aad3b9 | 27 | #include "wx/bookctrl.h" |
1e6feb95 | 28 | |
e450aa69 VZ |
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 | ||
1e6feb95 VZ |
42 | typedef wxWindow wxNotebookPage; // so far, any window can be a page |
43 | ||
630ad6c6 WS |
44 | WXDLLEXPORT_DATA(extern const wxChar*) wxNotebookNameStr; |
45 | ||
46 | #if WXWIN_COMPATIBILITY_2_4 | |
47 | #define wxNOTEBOOK_NAME wxNotebookNameStr | |
48 | #endif | |
1e6feb95 VZ |
49 | |
50 | // ---------------------------------------------------------------------------- | |
51 | // wxNotebookBase: define wxNotebook interface | |
52 | // ---------------------------------------------------------------------------- | |
53 | ||
61c083e7 | 54 | class WXDLLEXPORT wxNotebookBase : public wxBookCtrlBase |
1e6feb95 VZ |
55 | { |
56 | public: | |
15aad3b9 VZ |
57 | // ctors |
58 | // ----- | |
59 | ||
6463b9f5 | 60 | wxNotebookBase() { } |
15aad3b9 VZ |
61 | |
62 | wxNotebookBase(wxWindow *parent, | |
aa6f64c7 | 63 | wxWindowID winid, |
15aad3b9 VZ |
64 | const wxPoint& pos = wxDefaultPosition, |
65 | const wxSize& size = wxDefaultSize, | |
66 | long style = 0, | |
630ad6c6 | 67 | const wxString& name = wxNotebookNameStr) ; |
1e6feb95 | 68 | |
61c083e7 WS |
69 | // wxNotebook-specific additions to wxBookCtrlBase interface |
70 | // --------------------------------------------------------- | |
1e6feb95 VZ |
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 | ||
1e6feb95 VZ |
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 | ||
e450aa69 VZ |
82 | // hit test, returns which tab is hit and, optionally, where (icon, label) |
83 | // (not implemented on all platforms) | |
fc7a2a60 VZ |
84 | virtual int HitTest(const wxPoint& WXUNUSED(pt), |
85 | long * WXUNUSED(flags) = NULL) const | |
e450aa69 VZ |
86 | { |
87 | return wxNOT_FOUND; | |
88 | } | |
89 | ||
1e6feb95 | 90 | |
15aad3b9 VZ |
91 | // implement some base class functions |
92 | virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const; | |
22f3361e | 93 | |
15aad3b9 | 94 | protected: |
22f3361e | 95 | DECLARE_NO_COPY_CLASS(wxNotebookBase) |
1e6feb95 | 96 | }; |
4d0f3cd6 VZ |
97 | |
98 | // ---------------------------------------------------------------------------- | |
15aad3b9 | 99 | // notebook event class and related stuff |
4d0f3cd6 VZ |
100 | // ---------------------------------------------------------------------------- |
101 | ||
61c083e7 | 102 | class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlBaseEvent |
4d0f3cd6 VZ |
103 | { |
104 | public: | |
aa6f64c7 | 105 | wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0, |
4d0f3cd6 | 106 | int nSel = -1, int nOldSel = -1) |
61c083e7 | 107 | : wxBookCtrlBaseEvent(commandType, winid, nSel, nOldSel) |
15aad3b9 VZ |
108 | { |
109 | } | |
4d0f3cd6 VZ |
110 | |
111 | private: | |
fc7a2a60 | 112 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebookEvent) |
4d0f3cd6 VZ |
113 | }; |
114 | ||
2e4df4bf VZ |
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 | ||
4d0f3cd6 VZ |
120 | typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&); |
121 | ||
aa6f64c7 | 122 | #define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \ |
7e548f6b WS |
123 | DECLARE_EVENT_TABLE_ENTRY( \ |
124 | wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, \ | |
aa6f64c7 | 125 | winid, \ |
7e548f6b | 126 | wxID_ANY, \ |
3a818b15 | 127 | (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxNotebookEventFunction, &fn ), \ |
7e548f6b | 128 | NULL \ |
82a5f02c | 129 | ), |
4d0f3cd6 | 130 | |
aa6f64c7 | 131 | #define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \ |
7e548f6b WS |
132 | DECLARE_EVENT_TABLE_ENTRY( \ |
133 | wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \ | |
aa6f64c7 | 134 | winid, \ |
7e548f6b | 135 | wxID_ANY, \ |
3a818b15 | 136 | (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxNotebookEventFunction, &fn ), \ |
4d0f3cd6 | 137 | NULL \ |
82a5f02c | 138 | ), |
4d0f3cd6 VZ |
139 | |
140 | // ---------------------------------------------------------------------------- | |
141 | // wxNotebook class itself | |
142 | // ---------------------------------------------------------------------------- | |
143 | ||
1e6feb95 VZ |
144 | #if defined(__WXUNIVERSAL__) |
145 | #include "wx/univ/notebook.h" | |
146 | #elif defined(__WXMSW__) | |
aaace873 | 147 | #include "wx/msw/notebook.h" |
2049ba38 | 148 | #elif defined(__WXMOTIF__) |
1e6feb95 | 149 | #include "wx/generic/notebook.h" |
2049ba38 | 150 | #elif defined(__WXGTK__) |
1e6feb95 | 151 | #include "wx/gtk/notebook.h" |
34138703 | 152 | #elif defined(__WXMAC__) |
1e6feb95 | 153 | #include "wx/mac/notebook.h" |
0201182b | 154 | #elif defined(__WXCOCOA__) |
0754a4b3 | 155 | #include "wx/cocoa/notebook.h" |
1777b9bb | 156 | #elif defined(__WXPM__) |
1e6feb95 | 157 | #include "wx/os2/notebook.h" |
53b28675 RR |
158 | #endif |
159 | ||
1e6feb95 VZ |
160 | #endif // wxUSE_NOTEBOOK |
161 | ||
53b28675 | 162 | #endif |
34138703 | 163 | // _WX_NOTEBOOK_H_BASE_ |