]>
Commit | Line | Data |
---|---|---|
63fec618 | 1 | ///////////////////////////////////////////////////////////////////////////// |
7c0ea335 | 2 | // Name: common/framecmn.cpp |
63fec618 VZ |
3 | // Purpose: common (for all platforms) wxFrame functions |
4 | // Author: Julian Smart, Vadim Zeitlin | |
5 | // Created: 01/02/97 | |
439b3bf1 | 6 | // Id: $Id$ |
55d99c7a | 7 | // Copyright: (c) 1998 Robert Roebling and Julian Smart |
63fec618 VZ |
8 | // Licence: wxWindows licence |
9 | ///////////////////////////////////////////////////////////////////////////// | |
10 | ||
7c0ea335 VZ |
11 | // ============================================================================ |
12 | // declarations | |
13 | // ============================================================================ | |
14 | ||
15 | // ---------------------------------------------------------------------------- | |
16 | // headers | |
17 | // ---------------------------------------------------------------------------- | |
18 | ||
14f355c2 | 19 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) |
7c0ea335 VZ |
20 | #pragma implementation "framebase.h" |
21 | #endif | |
22 | ||
f701d7ab JS |
23 | // For compilers that support precompilation, includes "wx.h". |
24 | #include "wx/wxprec.h" | |
25 | ||
26 | #ifdef __BORLANDC__ | |
7c0ea335 | 27 | #pragma hdrstop |
f701d7ab JS |
28 | #endif |
29 | ||
1e6feb95 VZ |
30 | #ifndef WX_PRECOMP |
31 | #include "wx/frame.h" | |
32 | #include "wx/menu.h" | |
33 | #include "wx/menuitem.h" | |
34 | #include "wx/dcclient.h" | |
35 | #endif // WX_PRECOMP | |
7c0ea335 VZ |
36 | |
37 | #if wxUSE_TOOLBAR | |
38 | #include "wx/toolbar.h" | |
39 | #endif | |
40 | #if wxUSE_STATUSBAR | |
41 | #include "wx/statusbr.h" | |
42 | #endif | |
43 | ||
44 | // ---------------------------------------------------------------------------- | |
45 | // event table | |
46 | // ---------------------------------------------------------------------------- | |
47 | ||
96ac065f VZ |
48 | #if wxUSE_MENUS && wxUSE_STATUSBAR |
49 | ||
7d9f12f3 | 50 | BEGIN_EVENT_TABLE(wxFrameBase, wxTopLevelWindow) |
0b30bb0b | 51 | EVT_MENU_OPEN(wxFrameBase::OnMenuOpen) |
96ac065f VZ |
52 | EVT_MENU_CLOSE(wxFrameBase::OnMenuClose) |
53 | ||
7c0ea335 | 54 | EVT_MENU_HIGHLIGHT_ALL(wxFrameBase::OnMenuHighlight) |
7c0ea335 VZ |
55 | END_EVENT_TABLE() |
56 | ||
96ac065f VZ |
57 | #endif // wxUSE_MENUS && wxUSE_STATUSBAR |
58 | ||
7c0ea335 VZ |
59 | // ============================================================================ |
60 | // implementation | |
61 | // ============================================================================ | |
62 | ||
63 | // ---------------------------------------------------------------------------- | |
64 | // construction/destruction | |
65 | // ---------------------------------------------------------------------------- | |
66 | ||
67 | wxFrameBase::wxFrameBase() | |
68 | { | |
1e6feb95 | 69 | #if wxUSE_MENUS |
7c0ea335 | 70 | m_frameMenuBar = NULL; |
1e6feb95 | 71 | #endif // wxUSE_MENUS |
7c0ea335 VZ |
72 | |
73 | #if wxUSE_TOOLBAR | |
74 | m_frameToolBar = NULL; | |
75 | #endif // wxUSE_TOOLBAR | |
76 | ||
77 | #if wxUSE_STATUSBAR | |
78 | m_frameStatusBar = NULL; | |
79 | #endif // wxUSE_STATUSBAR | |
1f361cdd MB |
80 | |
81 | m_statusBarPane = 0; | |
7c0ea335 VZ |
82 | } |
83 | ||
799ea011 GD |
84 | wxFrameBase::~wxFrameBase() |
85 | { | |
86 | // this destructor is required for Darwin | |
87 | } | |
88 | ||
7c0ea335 VZ |
89 | wxFrame *wxFrameBase::New(wxWindow *parent, |
90 | wxWindowID id, | |
91 | const wxString& title, | |
92 | const wxPoint& pos, | |
93 | const wxSize& size, | |
94 | long style, | |
95 | const wxString& name) | |
96 | { | |
97 | return new wxFrame(parent, id, title, pos, size, style, name); | |
98 | } | |
99 | ||
100 | void wxFrameBase::DeleteAllBars() | |
101 | { | |
1e6feb95 | 102 | #if wxUSE_MENUS |
7c0ea335 VZ |
103 | if ( m_frameMenuBar ) |
104 | { | |
105 | delete m_frameMenuBar; | |
106 | m_frameMenuBar = (wxMenuBar *) NULL; | |
107 | } | |
1e6feb95 | 108 | #endif // wxUSE_MENUS |
7c0ea335 VZ |
109 | |
110 | #if wxUSE_STATUSBAR | |
111 | if ( m_frameStatusBar ) | |
112 | { | |
113 | delete m_frameStatusBar; | |
114 | m_frameStatusBar = (wxStatusBar *) NULL; | |
115 | } | |
116 | #endif // wxUSE_STATUSBAR | |
117 | ||
118 | #if wxUSE_TOOLBAR | |
119 | if ( m_frameToolBar ) | |
120 | { | |
121 | delete m_frameToolBar; | |
122 | m_frameToolBar = (wxToolBar *) NULL; | |
123 | } | |
124 | #endif // wxUSE_TOOLBAR | |
125 | } | |
126 | ||
1e6feb95 VZ |
127 | bool wxFrameBase::IsOneOfBars(const wxWindow *win) const |
128 | { | |
129 | #if wxUSE_MENUS | |
130 | if ( win == GetMenuBar() ) | |
131 | return TRUE; | |
132 | #endif // wxUSE_MENUS | |
133 | ||
134 | #if wxUSE_STATUSBAR | |
135 | if ( win == GetStatusBar() ) | |
136 | return TRUE; | |
137 | #endif // wxUSE_STATUSBAR | |
138 | ||
139 | #if wxUSE_TOOLBAR | |
140 | if ( win == GetToolBar() ) | |
141 | return TRUE; | |
142 | #endif // wxUSE_TOOLBAR | |
143 | ||
144 | return FALSE; | |
145 | } | |
146 | ||
1c4f8f8d VZ |
147 | // ---------------------------------------------------------------------------- |
148 | // wxFrame size management: we exclude the areas taken by menu/status/toolbars | |
149 | // from the client area, so the client area is what's really available for the | |
150 | // frame contents | |
151 | // ---------------------------------------------------------------------------- | |
152 | ||
153 | // get the origin of the client area in the client coordinates | |
154 | wxPoint wxFrameBase::GetClientAreaOrigin() const | |
155 | { | |
7d9f12f3 | 156 | wxPoint pt = wxTopLevelWindow::GetClientAreaOrigin(); |
1c4f8f8d | 157 | |
bf95a04f | 158 | #if wxUSE_TOOLBAR && !defined(__WXUNIVERSAL__) && !defined(__WXWINCE__) |
d4597e13 VZ |
159 | wxToolBar *toolbar = GetToolBar(); |
160 | if ( toolbar && toolbar->IsShown() ) | |
1c4f8f8d VZ |
161 | { |
162 | int w, h; | |
d4597e13 | 163 | toolbar->GetSize(&w, &h); |
1c4f8f8d | 164 | |
d4597e13 | 165 | if ( toolbar->GetWindowStyleFlag() & wxTB_VERTICAL ) |
1c4f8f8d VZ |
166 | { |
167 | pt.x += w; | |
168 | } | |
169 | else | |
170 | { | |
171 | pt.y += h; | |
172 | } | |
173 | } | |
174 | #endif // wxUSE_TOOLBAR | |
175 | ||
176 | return pt; | |
177 | } | |
178 | ||
7c0ea335 VZ |
179 | // ---------------------------------------------------------------------------- |
180 | // misc | |
181 | // ---------------------------------------------------------------------------- | |
182 | ||
7c0ea335 VZ |
183 | bool wxFrameBase::ProcessCommand(int id) |
184 | { | |
1e6feb95 | 185 | #if wxUSE_MENUS |
7c0ea335 VZ |
186 | wxMenuBar *bar = GetMenuBar(); |
187 | if ( !bar ) | |
188 | return FALSE; | |
189 | ||
3ca6a5f0 BP |
190 | wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id); |
191 | commandEvent.SetEventObject(this); | |
192 | ||
7c0ea335 | 193 | wxMenuItem *item = bar->FindItem(id); |
84f7908b | 194 | if (item) |
7c0ea335 | 195 | { |
84f7908b RR |
196 | if (!item->IsEnabled()) |
197 | return TRUE; | |
d4597e13 | 198 | |
84f7908b RR |
199 | if (item->IsCheckable()) |
200 | { | |
201 | item->Toggle(); | |
0472ece7 | 202 | |
84f7908b RR |
203 | // use the new value |
204 | commandEvent.SetInt(item->IsChecked()); | |
205 | } | |
3ca6a5f0 | 206 | } |
7c0ea335 | 207 | |
a01fe3d6 RD |
208 | GetEventHandler()->ProcessEvent(commandEvent); |
209 | return TRUE; | |
1e6feb95 VZ |
210 | #else // !wxUSE_MENUS |
211 | return FALSE; | |
212 | #endif // wxUSE_MENUS/!wxUSE_MENUS | |
7c0ea335 VZ |
213 | } |
214 | ||
e39af974 JS |
215 | // Do the UI update processing for this window. This is |
216 | // provided for the application to call if it wants to | |
217 | // force a UI update, particularly for the menus and toolbar. | |
218 | void wxFrameBase::UpdateWindowUI(long flags) | |
219 | { | |
220 | wxWindowBase::UpdateWindowUI(flags); | |
221 | ||
222 | #if wxUSE_TOOLBAR | |
223 | if (GetToolBar()) | |
224 | GetToolBar()->UpdateWindowUI(flags); | |
225 | #endif | |
226 | ||
227 | #if wxUSE_MENUS | |
228 | if (GetMenuBar()) | |
229 | { | |
230 | if ((flags & wxUPDATE_UI_FROMIDLE) && !wxUSE_IDLEMENUUPDATES) | |
231 | { | |
232 | // If coming from an idle event, we only | |
233 | // want to update the menus if we're | |
234 | // in the wxUSE_IDLEMENUUPDATES configuration: | |
235 | // so if we're not, do nothing | |
236 | } | |
237 | else | |
238 | DoMenuUpdates(); | |
239 | } | |
96ac065f | 240 | #endif // wxUSE_MENUS |
e39af974 JS |
241 | } |
242 | ||
7c0ea335 | 243 | // ---------------------------------------------------------------------------- |
96ac065f | 244 | // event handlers for status bar updates from menus |
7c0ea335 VZ |
245 | // ---------------------------------------------------------------------------- |
246 | ||
96ac065f VZ |
247 | #if wxUSE_MENUS && wxUSE_STATUSBAR |
248 | ||
7c0ea335 VZ |
249 | void wxFrameBase::OnMenuHighlight(wxMenuEvent& event) |
250 | { | |
251 | #if wxUSE_STATUSBAR | |
f6bcfd97 | 252 | (void)ShowMenuHelp(GetStatusBar(), event.GetMenuId()); |
7c0ea335 VZ |
253 | #endif // wxUSE_STATUSBAR |
254 | } | |
255 | ||
96ac065f VZ |
256 | void wxFrameBase::OnMenuOpen(wxMenuEvent& event) |
257 | { | |
258 | #if !wxUSE_IDLEMENUUPDATES | |
259 | DoMenuUpdates(event.GetMenu()); | |
260 | #endif // !wxUSE_IDLEMENUUPDATES | |
261 | } | |
262 | ||
263 | void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event)) | |
264 | { | |
265 | // do we have real status text to restore? | |
266 | if ( m_oldStatusText.length() > 1 || m_oldStatusText[0u] ) | |
267 | { | |
268 | if ( m_statusBarPane >= 0 ) | |
269 | { | |
270 | wxStatusBar *statbar = GetStatusBar(); | |
271 | if ( statbar ) | |
272 | statbar->SetStatusText(m_oldStatusText, m_statusBarPane); | |
273 | } | |
274 | ||
275 | m_oldStatusText.clear(); | |
276 | } | |
277 | } | |
278 | ||
279 | #endif // wxUSE_MENUS && wxUSE_STATUSBAR | |
280 | ||
e39af974 JS |
281 | // Implement internal behaviour (menu updating on some platforms) |
282 | void wxFrameBase::OnInternalIdle() | |
6522713c | 283 | { |
e2b6d07d JS |
284 | wxTopLevelWindow::OnInternalIdle(); |
285 | ||
0b30bb0b | 286 | #if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES |
e39af974 | 287 | if (wxUpdateUIEvent::CanUpdate(this)) |
0b30bb0b JS |
288 | DoMenuUpdates(); |
289 | #endif | |
290 | } | |
291 | ||
7c0ea335 VZ |
292 | // ---------------------------------------------------------------------------- |
293 | // status bar stuff | |
294 | // ---------------------------------------------------------------------------- | |
295 | ||
296 | #if wxUSE_STATUSBAR | |
297 | ||
298 | wxStatusBar* wxFrameBase::CreateStatusBar(int number, | |
299 | long style, | |
300 | wxWindowID id, | |
301 | const wxString& name) | |
302 | { | |
303 | // the main status bar can only be created once (or else it should be | |
304 | // deleted before calling CreateStatusBar() again) | |
305 | wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)NULL, | |
306 | wxT("recreating status bar in wxFrame") ); | |
307 | ||
308 | m_frameStatusBar = OnCreateStatusBar( number, style, id, name ); | |
309 | if ( m_frameStatusBar ) | |
310 | PositionStatusBar(); | |
311 | ||
312 | return m_frameStatusBar; | |
313 | } | |
314 | ||
315 | wxStatusBar *wxFrameBase::OnCreateStatusBar(int number, | |
316 | long style, | |
317 | wxWindowID id, | |
318 | const wxString& name) | |
319 | { | |
ed791986 | 320 | wxStatusBar *statusBar = new wxStatusBar(this, id, style, name); |
7c0ea335 | 321 | |
7c0ea335 VZ |
322 | statusBar->SetFieldsCount(number); |
323 | ||
324 | return statusBar; | |
325 | } | |
326 | ||
327 | void wxFrameBase::SetStatusText(const wxString& text, int number) | |
328 | { | |
7c0ea335 VZ |
329 | wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") ); |
330 | ||
331 | m_frameStatusBar->SetStatusText(text, number); | |
332 | } | |
333 | ||
334 | void wxFrameBase::SetStatusWidths(int n, const int widths_field[] ) | |
335 | { | |
7c0ea335 VZ |
336 | wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set widths for") ); |
337 | ||
338 | m_frameStatusBar->SetStatusWidths(n, widths_field); | |
339 | ||
340 | PositionStatusBar(); | |
341 | } | |
342 | ||
1f361cdd | 343 | void wxFrameBase::PushStatusText(const wxString& text, int number) |
f6bcfd97 | 344 | { |
1f361cdd MB |
345 | wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") ); |
346 | ||
347 | m_frameStatusBar->PushStatusText(text, number); | |
348 | } | |
f6bcfd97 | 349 | |
1f361cdd MB |
350 | void wxFrameBase::PopStatusText(int number) |
351 | { | |
352 | wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") ); | |
353 | ||
354 | m_frameStatusBar->PopStatusText(number); | |
355 | } | |
356 | ||
1f361cdd MB |
357 | bool wxFrameBase::ShowMenuHelp(wxStatusBar *WXUNUSED(statbar), int menuId) |
358 | { | |
359 | #if wxUSE_MENUS | |
f6bcfd97 BP |
360 | // if no help string found, we will clear the status bar text |
361 | wxString helpString; | |
1f361cdd | 362 | bool show = menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */; |
f6bcfd97 | 363 | |
1f361cdd | 364 | if ( show ) |
f6bcfd97 BP |
365 | { |
366 | wxMenuBar *menuBar = GetMenuBar(); | |
367 | if ( menuBar ) | |
368 | { | |
369 | // it's ok if we don't find the item because it might belong | |
370 | // to the popup menu | |
371 | wxMenuItem *item = menuBar->FindItem(menuId); | |
372 | if ( item ) | |
373 | helpString = item->GetHelp(); | |
374 | } | |
375 | } | |
376 | ||
1f361cdd | 377 | DoGiveHelp(helpString, show); |
f6bcfd97 BP |
378 | |
379 | return !helpString.IsEmpty(); | |
3379ed37 VZ |
380 | #else // !wxUSE_MENUS |
381 | return FALSE; | |
382 | #endif // wxUSE_MENUS/!wxUSE_MENUS | |
f6bcfd97 BP |
383 | } |
384 | ||
7c0ea335 VZ |
385 | #endif // wxUSE_STATUSBAR |
386 | ||
c60a36d5 VZ |
387 | void wxFrameBase::DoGiveHelp(const wxString& text, bool show) |
388 | { | |
389 | #if wxUSE_STATUSBAR | |
96ac065f VZ |
390 | if ( m_statusBarPane < 0 ) |
391 | { | |
392 | // status bar messages disabled | |
393 | return; | |
394 | } | |
395 | ||
396 | wxStatusBar *statbar = GetStatusBar(); | |
397 | if ( !statbar ) | |
398 | return; | |
399 | ||
400 | wxString help; | |
401 | if ( show ) | |
402 | help = text; | |
403 | ||
404 | // remember the old status bar text if this is the first time we're called | |
405 | // since the menu has been opened as we're going to overwrite it in our | |
406 | // DoGiveHelp() and we want to restore it when the menu is closed | |
407 | // | |
408 | // note that it would be logical to do this in OnMenuOpen() but under MSW | |
409 | // we get an EVT_MENU_HIGHLIGHT before EVT_MENU_OPEN, strangely enough, and | |
410 | // so this doesn't work and instead we use the ugly trick with using | |
411 | // special m_oldStatusText value as "menu opened" (but it is arguably | |
412 | // better than adding yet another member variable to wxFrame on all | |
413 | // platforms) | |
414 | if ( m_oldStatusText.empty() ) | |
415 | { | |
416 | m_oldStatusText = statbar->GetStatusText(m_statusBarPane); | |
417 | if ( m_oldStatusText.empty() ) | |
418 | { | |
419 | // use special value to prevent us from doing this the next time | |
420 | m_oldStatusText += _T('\0'); | |
421 | } | |
422 | } | |
c60a36d5 | 423 | |
96ac065f | 424 | statbar->SetStatusText(help, m_statusBarPane); |
c60a36d5 VZ |
425 | #endif // wxUSE_STATUSBAR |
426 | } | |
427 | ||
428 | ||
7c0ea335 VZ |
429 | // ---------------------------------------------------------------------------- |
430 | // toolbar stuff | |
431 | // ---------------------------------------------------------------------------- | |
432 | ||
433 | #if wxUSE_TOOLBAR | |
434 | ||
435 | wxToolBar* wxFrameBase::CreateToolBar(long style, | |
436 | wxWindowID id, | |
437 | const wxString& name) | |
438 | { | |
439 | // the main toolbar can't be recreated (unless it was explicitly deeleted | |
440 | // before) | |
441 | wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)NULL, | |
442 | wxT("recreating toolbar in wxFrame") ); | |
443 | ||
f9dae779 VZ |
444 | if ( style == -1 ) |
445 | { | |
446 | // use default style | |
447 | // | |
448 | // NB: we don't specify the default value in the method declaration | |
449 | // because | |
450 | // a) this allows us to have different defaults for different | |
451 | // platforms (even if we don't have them right now) | |
452 | // b) we don't need to include wx/toolbar.h in the header then | |
453 | style = wxBORDER_NONE | wxTB_HORIZONTAL | wxTB_FLAT; | |
454 | } | |
455 | ||
7c0ea335 VZ |
456 | m_frameToolBar = OnCreateToolBar(style, id, name); |
457 | ||
458 | return m_frameToolBar; | |
459 | } | |
460 | ||
461 | wxToolBar* wxFrameBase::OnCreateToolBar(long style, | |
462 | wxWindowID id, | |
463 | const wxString& name) | |
464 | { | |
465 | return new wxToolBar(this, id, | |
466 | wxDefaultPosition, wxDefaultSize, | |
467 | style, name); | |
468 | } | |
469 | ||
470 | #endif // wxUSE_TOOLBAR | |
471 | ||
472 | // ---------------------------------------------------------------------------- | |
6522713c | 473 | // menus |
7c0ea335 VZ |
474 | // ---------------------------------------------------------------------------- |
475 | ||
1e6feb95 VZ |
476 | #if wxUSE_MENUS |
477 | ||
63fec618 | 478 | // update all menus |
92f1a59c | 479 | void wxFrameBase::DoMenuUpdates(wxMenu* menu) |
63fec618 | 480 | { |
92f1a59c | 481 | wxEvtHandler* source = GetEventHandler(); |
54517652 | 482 | wxMenuBar* bar = GetMenuBar(); |
e702ff0f | 483 | |
92f1a59c JS |
484 | if (menu) |
485 | menu->UpdateUI(source); | |
486 | else if ( bar != NULL ) | |
54517652 RR |
487 | { |
488 | int nCount = bar->GetMenuCount(); | |
489 | for (int n = 0; n < nCount; n++) | |
18afa2ac | 490 | bar->GetMenu(n)->UpdateUI(source); |
63fec618 | 491 | } |
63fec618 | 492 | } |
1e6feb95 | 493 | |
6522713c VZ |
494 | void wxFrameBase::DetachMenuBar() |
495 | { | |
496 | if ( m_frameMenuBar ) | |
497 | { | |
498 | m_frameMenuBar->Detach(); | |
499 | m_frameMenuBar = NULL; | |
500 | } | |
501 | } | |
502 | ||
503 | void wxFrameBase::AttachMenuBar(wxMenuBar *menubar) | |
504 | { | |
505 | if ( menubar ) | |
506 | { | |
6522713c | 507 | menubar->Attach((wxFrame *)this); |
3dbe38c3 | 508 | m_frameMenuBar = menubar; |
6522713c VZ |
509 | } |
510 | } | |
511 | ||
512 | void wxFrameBase::SetMenuBar(wxMenuBar *menubar) | |
513 | { | |
514 | if ( menubar == GetMenuBar() ) | |
515 | { | |
516 | // nothing to do | |
517 | return; | |
518 | } | |
519 | ||
520 | DetachMenuBar(); | |
521 | ||
a96b4743 | 522 | this->AttachMenuBar(menubar); |
6522713c VZ |
523 | } |
524 | ||
1e6feb95 | 525 | #endif // wxUSE_MENUS |