]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/frame.h | |
3 | // Purpose: wxFrame class interface | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 15.11.99 | |
7 | // Copyright: (c) wxWidgets team | |
8 | // Licence: wxWindows licence | |
9 | ///////////////////////////////////////////////////////////////////////////// | |
10 | ||
11 | #ifndef _WX_FRAME_H_BASE_ | |
12 | #define _WX_FRAME_H_BASE_ | |
13 | ||
14 | // ---------------------------------------------------------------------------- | |
15 | // headers | |
16 | // ---------------------------------------------------------------------------- | |
17 | ||
18 | #include "wx/toplevel.h" // the base class | |
19 | #include "wx/statusbr.h" | |
20 | ||
21 | // the default names for various classs | |
22 | extern WXDLLIMPEXP_DATA_CORE(const char) wxStatusLineNameStr[]; | |
23 | extern WXDLLIMPEXP_DATA_CORE(const char) wxToolBarNameStr[]; | |
24 | ||
25 | class WXDLLIMPEXP_FWD_CORE wxFrame; | |
26 | class WXDLLIMPEXP_FWD_CORE wxMenuBar; | |
27 | class WXDLLIMPEXP_FWD_CORE wxMenuItem; | |
28 | class WXDLLIMPEXP_FWD_CORE wxStatusBar; | |
29 | class WXDLLIMPEXP_FWD_CORE wxToolBar; | |
30 | ||
31 | // ---------------------------------------------------------------------------- | |
32 | // constants | |
33 | // ---------------------------------------------------------------------------- | |
34 | ||
35 | // wxFrame-specific (i.e. not for wxDialog) styles | |
36 | // | |
37 | // Also see the bit summary table in wx/toplevel.h. | |
38 | #define wxFRAME_NO_TASKBAR 0x0002 // No taskbar button (MSW only) | |
39 | #define wxFRAME_TOOL_WINDOW 0x0004 // No taskbar button, no system menu | |
40 | #define wxFRAME_FLOAT_ON_PARENT 0x0008 // Always above its parent | |
41 | ||
42 | // ---------------------------------------------------------------------------- | |
43 | // wxFrame is a top-level window with optional menubar, statusbar and toolbar | |
44 | // | |
45 | // For each of *bars, a frame may have several of them, but only one is | |
46 | // managed by the frame, i.e. resized/moved when the frame is and whose size | |
47 | // is accounted for in client size calculations - all others should be taken | |
48 | // care of manually. The CreateXXXBar() functions create this, main, XXXBar, | |
49 | // but the actual creation is done in OnCreateXXXBar() functions which may be | |
50 | // overridden to create custom objects instead of standard ones when | |
51 | // CreateXXXBar() is called. | |
52 | // ---------------------------------------------------------------------------- | |
53 | ||
54 | class WXDLLIMPEXP_CORE wxFrameBase : public wxTopLevelWindow | |
55 | { | |
56 | public: | |
57 | // construction | |
58 | wxFrameBase(); | |
59 | virtual ~wxFrameBase(); | |
60 | ||
61 | wxFrame *New(wxWindow *parent, | |
62 | wxWindowID winid, | |
63 | const wxString& title, | |
64 | const wxPoint& pos = wxDefaultPosition, | |
65 | const wxSize& size = wxDefaultSize, | |
66 | long style = wxDEFAULT_FRAME_STYLE, | |
67 | const wxString& name = wxFrameNameStr); | |
68 | ||
69 | // frame state | |
70 | // ----------- | |
71 | ||
72 | // get the origin of the client area (which may be different from (0, 0) | |
73 | // if the frame has a toolbar) in client coordinates | |
74 | virtual wxPoint GetClientAreaOrigin() const; | |
75 | ||
76 | ||
77 | // menu bar functions | |
78 | // ------------------ | |
79 | ||
80 | #if wxUSE_MENUS | |
81 | virtual void SetMenuBar(wxMenuBar *menubar); | |
82 | virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; } | |
83 | ||
84 | // find the item by id in the frame menu bar: this is an internal function | |
85 | // and exists mainly in order to be overridden in the MDI parent frame | |
86 | // which also looks at its active child menu bar | |
87 | virtual wxMenuItem *FindItemInMenuBar(int menuId) const; | |
88 | ||
89 | // generate menu command corresponding to the given menu item | |
90 | // | |
91 | // returns true if processed | |
92 | bool ProcessCommand(wxMenuItem *item); | |
93 | ||
94 | // generate menu command corresponding to the given menu command id | |
95 | // | |
96 | // returns true if processed | |
97 | bool ProcessCommand(int winid); | |
98 | #else | |
99 | bool ProcessCommand(int WXUNUSED(winid)) { return false; } | |
100 | #endif // wxUSE_MENUS | |
101 | ||
102 | // status bar functions | |
103 | // -------------------- | |
104 | #if wxUSE_STATUSBAR | |
105 | // create the main status bar by calling OnCreateStatusBar() | |
106 | virtual wxStatusBar* CreateStatusBar(int number = 1, | |
107 | long style = wxSTB_DEFAULT_STYLE, | |
108 | wxWindowID winid = 0, | |
109 | const wxString& name = wxStatusLineNameStr); | |
110 | // return a new status bar | |
111 | virtual wxStatusBar *OnCreateStatusBar(int number, | |
112 | long style, | |
113 | wxWindowID winid, | |
114 | const wxString& name); | |
115 | // get the main status bar | |
116 | virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; } | |
117 | ||
118 | // sets the main status bar | |
119 | virtual void SetStatusBar(wxStatusBar *statBar); | |
120 | ||
121 | // forward these to status bar | |
122 | virtual void SetStatusText(const wxString &text, int number = 0); | |
123 | virtual void SetStatusWidths(int n, const int widths_field[]); | |
124 | void PushStatusText(const wxString &text, int number = 0); | |
125 | void PopStatusText(int number = 0); | |
126 | ||
127 | // set the status bar pane the help will be shown in | |
128 | void SetStatusBarPane(int n) { m_statusBarPane = n; } | |
129 | int GetStatusBarPane() const { return m_statusBarPane; } | |
130 | #endif // wxUSE_STATUSBAR | |
131 | ||
132 | // toolbar functions | |
133 | // ----------------- | |
134 | ||
135 | #if wxUSE_TOOLBAR | |
136 | // create main toolbar bycalling OnCreateToolBar() | |
137 | virtual wxToolBar* CreateToolBar(long style = -1, | |
138 | wxWindowID winid = wxID_ANY, | |
139 | const wxString& name = wxToolBarNameStr); | |
140 | // return a new toolbar | |
141 | virtual wxToolBar *OnCreateToolBar(long style, | |
142 | wxWindowID winid, | |
143 | const wxString& name ); | |
144 | ||
145 | // get/set the main toolbar | |
146 | virtual wxToolBar *GetToolBar() const { return m_frameToolBar; } | |
147 | virtual void SetToolBar(wxToolBar *toolbar); | |
148 | #endif // wxUSE_TOOLBAR | |
149 | ||
150 | // implementation only from now on | |
151 | // ------------------------------- | |
152 | ||
153 | // event handlers | |
154 | #if wxUSE_MENUS | |
155 | #if wxUSE_STATUSBAR | |
156 | void OnMenuOpen(wxMenuEvent& event); | |
157 | void OnMenuClose(wxMenuEvent& event); | |
158 | void OnMenuHighlight(wxMenuEvent& event); | |
159 | #endif // wxUSE_STATUSBAR | |
160 | ||
161 | // send wxUpdateUIEvents for all menu items in the menubar, | |
162 | // or just for menu if non-NULL | |
163 | virtual void DoMenuUpdates(wxMenu* menu = NULL); | |
164 | #endif // wxUSE_MENUS | |
165 | ||
166 | // do the UI update processing for this window | |
167 | virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE); | |
168 | ||
169 | // Implement internal behaviour (menu updating on some platforms) | |
170 | virtual void OnInternalIdle(); | |
171 | ||
172 | #if wxUSE_MENUS || wxUSE_TOOLBAR | |
173 | // show help text for the currently selected menu or toolbar item | |
174 | // (typically in the status bar) or hide it and restore the status bar text | |
175 | // originally shown before the menu was opened if show == false | |
176 | virtual void DoGiveHelp(const wxString& text, bool show); | |
177 | #endif | |
178 | ||
179 | virtual bool IsClientAreaChild(const wxWindow *child) const | |
180 | { | |
181 | return !IsOneOfBars(child) && wxTopLevelWindow::IsClientAreaChild(child); | |
182 | } | |
183 | ||
184 | protected: | |
185 | // the frame main menu/status/tool bars | |
186 | // ------------------------------------ | |
187 | ||
188 | // this (non virtual!) function should be called from dtor to delete the | |
189 | // main menubar, statusbar and toolbar (if any) | |
190 | void DeleteAllBars(); | |
191 | ||
192 | // test whether this window makes part of the frame | |
193 | virtual bool IsOneOfBars(const wxWindow *win) const; | |
194 | ||
195 | #if wxUSE_MENUS | |
196 | // override to update menu bar position when the frame size changes | |
197 | virtual void PositionMenuBar() { } | |
198 | ||
199 | // override to do something special when the menu bar is being removed | |
200 | // from the frame | |
201 | virtual void DetachMenuBar(); | |
202 | ||
203 | // override to do something special when the menu bar is attached to the | |
204 | // frame | |
205 | virtual void AttachMenuBar(wxMenuBar *menubar); | |
206 | ||
207 | // Return true if we should update the menu item state from idle event | |
208 | // handler or false if we should delay it until the menu is opened. | |
209 | static bool ShouldUpdateMenuFromIdle(); | |
210 | ||
211 | wxMenuBar *m_frameMenuBar; | |
212 | #endif // wxUSE_MENUS | |
213 | ||
214 | #if wxUSE_STATUSBAR && (wxUSE_MENUS || wxUSE_TOOLBAR) | |
215 | // the saved status bar text overwritten by DoGiveHelp() | |
216 | wxString m_oldStatusText; | |
217 | ||
218 | // the last help string we have shown in the status bar | |
219 | wxString m_lastHelpShown; | |
220 | #endif | |
221 | ||
222 | #if wxUSE_STATUSBAR | |
223 | // override to update status bar position (or anything else) when | |
224 | // something changes | |
225 | virtual void PositionStatusBar() { } | |
226 | ||
227 | // show the help string for the given menu item using DoGiveHelp() if the | |
228 | // given item does have a help string (as determined by FindInMenuBar()), | |
229 | // return false if there is no help for such item | |
230 | bool ShowMenuHelp(int helpid); | |
231 | ||
232 | wxStatusBar *m_frameStatusBar; | |
233 | #endif // wxUSE_STATUSBAR | |
234 | ||
235 | ||
236 | int m_statusBarPane; | |
237 | ||
238 | #if wxUSE_TOOLBAR | |
239 | // override to update status bar position (or anything else) when | |
240 | // something changes | |
241 | virtual void PositionToolBar() { } | |
242 | ||
243 | wxToolBar *m_frameToolBar; | |
244 | #endif // wxUSE_TOOLBAR | |
245 | ||
246 | #if wxUSE_MENUS && wxUSE_STATUSBAR | |
247 | DECLARE_EVENT_TABLE() | |
248 | #endif // wxUSE_MENUS && wxUSE_STATUSBAR | |
249 | ||
250 | wxDECLARE_NO_COPY_CLASS(wxFrameBase); | |
251 | }; | |
252 | ||
253 | // include the real class declaration | |
254 | #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__) | |
255 | #include "wx/univ/frame.h" | |
256 | #else // !__WXUNIVERSAL__ | |
257 | #if defined(__WXMSW__) | |
258 | #include "wx/msw/frame.h" | |
259 | #elif defined(__WXGTK20__) | |
260 | #include "wx/gtk/frame.h" | |
261 | #elif defined(__WXGTK__) | |
262 | #include "wx/gtk1/frame.h" | |
263 | #elif defined(__WXMOTIF__) | |
264 | #include "wx/motif/frame.h" | |
265 | #elif defined(__WXMAC__) | |
266 | #include "wx/osx/frame.h" | |
267 | #elif defined(__WXCOCOA__) | |
268 | #include "wx/cocoa/frame.h" | |
269 | #elif defined(__WXPM__) | |
270 | #include "wx/os2/frame.h" | |
271 | #endif | |
272 | #endif | |
273 | ||
274 | #endif | |
275 | // _WX_FRAME_H_BASE_ |