added orient parameter to wxMDIParentFrame::Tile()
[wxWidgets.git] / src / msw / mdi.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/mdi.cpp
3 // Purpose: MDI classes for wxMSW
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ===========================================================================
13 // declarations
14 // ===========================================================================
15
16 // ---------------------------------------------------------------------------
17 // headers
18 // ---------------------------------------------------------------------------
19
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "mdi.h"
22 #endif
23
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
26
27 #ifdef __BORLANDC__
28 #pragma hdrstop
29 #endif
30
31 #if wxUSE_MDI && !defined(__WXUNIVERSAL__)
32
33 #ifndef WX_PRECOMP
34 #include "wx/setup.h"
35 #include "wx/frame.h"
36 #include "wx/menu.h"
37 #include "wx/app.h"
38 #include "wx/utils.h"
39 #include "wx/dialog.h"
40 #if wxUSE_STATUSBAR
41 #include "wx/statusbr.h"
42 #endif
43 #include "wx/settings.h"
44 #include "wx/intl.h"
45 #include "wx/log.h"
46 #endif
47
48 #include "wx/mdi.h"
49 #include "wx/msw/private.h"
50
51 #if wxUSE_STATUSBAR && wxUSE_NATIVE_STATUSBAR
52 #include "wx/msw/statbr95.h"
53 #endif
54
55 #if wxUSE_TOOLBAR
56 #include "wx/toolbar.h"
57 #endif // wxUSE_TOOLBAR
58
59 #include <string.h>
60
61 // ---------------------------------------------------------------------------
62 // global variables
63 // ---------------------------------------------------------------------------
64
65 extern wxMenu *wxCurrentPopupMenu;
66
67 extern const wxChar *wxMDIFrameClassName; // from app.cpp
68 extern const wxChar *wxMDIChildFrameClassName;
69 extern const wxChar *wxMDIChildFrameClassNameNoRedraw;
70 extern void wxAssociateWinWithHandle(HWND hWnd, wxWindow *win);
71 extern void wxRemoveHandleAssociation(wxWindow *win);
72
73 static HWND invalidHandle = 0;
74
75 // ---------------------------------------------------------------------------
76 // constants
77 // ---------------------------------------------------------------------------
78
79 static const int IDM_WINDOWTILE = 4001;
80 static const int IDM_WINDOWTILEHOR = 4001;
81 static const int IDM_WINDOWCASCADE = 4002;
82 static const int IDM_WINDOWICONS = 4003;
83 static const int IDM_WINDOWNEXT = 4004;
84 static const int IDM_WINDOWTILEVERT = 4005;
85 static const int IDM_WINDOWPREV = 4006;
86
87 // This range gives a maximum of 500 MDI children. Should be enough :-)
88 static const int wxFIRST_MDI_CHILD = 4100;
89 static const int wxLAST_MDI_CHILD = 4600;
90
91 // Status border dimensions
92 static const int wxTHICK_LINE_BORDER = 3;
93 static const int wxTHICK_LINE_WIDTH = 1;
94
95 // ---------------------------------------------------------------------------
96 // private functions
97 // ---------------------------------------------------------------------------
98
99 // set the MDI menus (by sending the WM_MDISETMENU message) and update the menu
100 // of the parent of win (which is supposed to be the MDI client window)
101 static void MDISetMenu(wxWindow *win, HMENU hmenuFrame, HMENU hmenuWindow);
102
103 // insert the window menu (subMenu) into menu just before "Help" submenu or at
104 // the very end if not found
105 static void InsertWindowMenu(wxWindow *win, WXHMENU menu, HMENU subMenu);
106
107 // Remove the window menu
108 static void RemoveWindowMenu(wxWindow *win, WXHMENU menu);
109
110 // is this an id of an MDI child?
111 inline bool IsMdiCommandId(int id)
112 {
113 return (id >= wxFIRST_MDI_CHILD) && (id <= wxLAST_MDI_CHILD);
114 }
115
116 // unpack the parameters of WM_MDIACTIVATE message
117 static void UnpackMDIActivate(WXWPARAM wParam, WXLPARAM lParam,
118 WXWORD *activate, WXHWND *hwndAct, WXHWND *hwndDeact);
119
120 // return the HMENU of the MDI menu
121 static inline HMENU GetMDIWindowMenu(wxMDIParentFrame *frame)
122 {
123 wxMenu *menu = frame->GetWindowMenu();
124 return menu ? GetHmenuOf(menu) : 0;
125 }
126
127 // ===========================================================================
128 // implementation
129 // ===========================================================================
130
131 // ---------------------------------------------------------------------------
132 // wxWin macros
133 // ---------------------------------------------------------------------------
134
135 IMPLEMENT_DYNAMIC_CLASS(wxMDIParentFrame, wxFrame)
136 IMPLEMENT_DYNAMIC_CLASS(wxMDIChildFrame, wxFrame)
137 IMPLEMENT_DYNAMIC_CLASS(wxMDIClientWindow, wxWindow)
138
139 BEGIN_EVENT_TABLE(wxMDIParentFrame, wxFrame)
140 EVT_SIZE(wxMDIParentFrame::OnSize)
141 EVT_SYS_COLOUR_CHANGED(wxMDIParentFrame::OnSysColourChanged)
142 END_EVENT_TABLE()
143
144 BEGIN_EVENT_TABLE(wxMDIChildFrame, wxFrame)
145 EVT_IDLE(wxMDIChildFrame::OnIdle)
146 END_EVENT_TABLE()
147
148 BEGIN_EVENT_TABLE(wxMDIClientWindow, wxWindow)
149 EVT_SCROLL(wxMDIClientWindow::OnScroll)
150 END_EVENT_TABLE()
151
152 // ===========================================================================
153 // wxMDIParentFrame: the frame which contains the client window which manages
154 // the children
155 // ===========================================================================
156
157 wxMDIParentFrame::wxMDIParentFrame()
158 {
159 m_clientWindow = NULL;
160 m_currentChild = NULL;
161 m_windowMenu = (wxMenu*) NULL;
162 m_parentFrameActive = true;
163 }
164
165 bool wxMDIParentFrame::Create(wxWindow *parent,
166 wxWindowID id,
167 const wxString& title,
168 const wxPoint& pos,
169 const wxSize& size,
170 long style,
171 const wxString& name)
172 {
173 m_clientWindow = NULL;
174 m_currentChild = NULL;
175
176 // this style can be used to prevent a window from having the standard MDI
177 // "Window" menu
178 if ( style & wxFRAME_NO_WINDOW_MENU )
179 {
180 m_windowMenu = (wxMenu *)NULL;
181 }
182 else // normal case: we have the window menu, so construct it
183 {
184 m_windowMenu = new wxMenu;
185
186 m_windowMenu->Append(IDM_WINDOWCASCADE, _("&Cascade"));
187 m_windowMenu->Append(IDM_WINDOWTILEHOR, _("Tile &Horizontally"));
188 m_windowMenu->Append(IDM_WINDOWTILEVERT, _("Tile &Vertically"));
189 m_windowMenu->AppendSeparator();
190 m_windowMenu->Append(IDM_WINDOWICONS, _("&Arrange Icons"));
191 m_windowMenu->Append(IDM_WINDOWNEXT, _("&Next"));
192 m_windowMenu->Append(IDM_WINDOWPREV, _("&Previous"));
193 }
194
195 m_parentFrameActive = true;
196
197 if (!parent)
198 wxTopLevelWindows.Append(this);
199
200 SetName(name);
201 m_windowStyle = style;
202
203 if ( parent )
204 parent->AddChild(this);
205
206 if ( id != wxID_ANY )
207 m_windowId = id;
208 else
209 m_windowId = NewControlId();
210
211 WXDWORD exflags;
212 WXDWORD msflags = MSWGetCreateWindowFlags(&exflags);
213 msflags &= ~WS_VSCROLL;
214 msflags &= ~WS_HSCROLL;
215
216 if ( !wxWindow::MSWCreate(wxMDIFrameClassName,
217 title,
218 pos, size,
219 msflags,
220 exflags) )
221 {
222 return false;
223 }
224
225 // unlike (almost?) all other windows, frames are created hidden
226 m_isShown = false;
227
228 return true;
229 }
230
231 wxMDIParentFrame::~wxMDIParentFrame()
232 {
233 // see comment in ~wxMDIChildFrame
234 #if wxUSE_TOOLBAR
235 m_frameToolBar = NULL;
236 #endif
237 #if wxUSE_STATUSBAR
238 m_frameStatusBar = NULL;
239 #endif // wxUSE_STATUSBAR
240
241 DestroyChildren();
242
243 if (m_windowMenu)
244 {
245 delete m_windowMenu;
246 m_windowMenu = (wxMenu*) NULL;
247 }
248
249 // the MDI frame menubar is not automatically deleted by Windows unlike for
250 // the normal frames
251 if ( m_hMenu )
252 {
253 ::DestroyMenu((HMENU)m_hMenu);
254 m_hMenu = (WXHMENU)NULL;
255 }
256
257 if ( m_clientWindow )
258 {
259 if ( m_clientWindow->MSWGetOldWndProc() )
260 m_clientWindow->UnsubclassWin();
261
262 m_clientWindow->SetHWND(0);
263 delete m_clientWindow;
264 }
265 }
266
267 #if wxUSE_MENUS_NATIVE
268
269 void wxMDIParentFrame::InternalSetMenuBar()
270 {
271 m_parentFrameActive = true;
272
273 InsertWindowMenu(GetClientWindow(), m_hMenu, GetMDIWindowMenu(this));
274 }
275
276 #endif // wxUSE_MENUS_NATIVE
277
278 void wxMDIParentFrame::SetWindowMenu(wxMenu* menu)
279 {
280 if (m_windowMenu)
281 {
282 if (GetMenuBar())
283 {
284 // Remove old window menu
285 RemoveWindowMenu(GetClientWindow(), m_hMenu);
286 }
287
288 delete m_windowMenu;
289 m_windowMenu = (wxMenu*) NULL;
290 }
291
292 if (menu)
293 {
294 m_windowMenu = menu;
295 if (GetMenuBar())
296 {
297 InsertWindowMenu(GetClientWindow(), m_hMenu,
298 GetHmenuOf(m_windowMenu));
299 }
300 }
301 }
302
303 void wxMDIParentFrame::DoMenuUpdates(wxMenu* menu)
304 {
305 wxMDIChildFrame *child = GetActiveChild();
306 if ( child )
307 {
308 wxEvtHandler* source = child->GetEventHandler();
309 wxMenuBar* bar = child->GetMenuBar();
310
311 if (menu)
312 {
313 menu->UpdateUI(source);
314 }
315 else
316 {
317 if ( bar != NULL )
318 {
319 int nCount = bar->GetMenuCount();
320 for (int n = 0; n < nCount; n++)
321 bar->GetMenu(n)->UpdateUI(source);
322 }
323 }
324 }
325 else
326 {
327 wxFrameBase::DoMenuUpdates(menu);
328 }
329 }
330
331 void wxMDIParentFrame::OnSize(wxSizeEvent&)
332 {
333 if ( GetClientWindow() )
334 {
335 int width, height;
336 GetClientSize(&width, &height);
337
338 GetClientWindow()->SetSize(0, 0, width, height);
339 }
340 }
341
342 // Returns the active MDI child window
343 wxMDIChildFrame *wxMDIParentFrame::GetActiveChild() const
344 {
345 HWND hWnd = (HWND)::SendMessage(GetWinHwnd(GetClientWindow()),
346 WM_MDIGETACTIVE, 0, 0L);
347 if ( hWnd == 0 )
348 return NULL;
349 else
350 return (wxMDIChildFrame *)wxFindWinFromHandle((WXHWND) hWnd);
351 }
352
353 // Create the client window class (don't Create the window, just return a new
354 // class)
355 wxMDIClientWindow *wxMDIParentFrame::OnCreateClient()
356 {
357 return new wxMDIClientWindow;
358 }
359
360 // Responds to colour changes, and passes event on to children.
361 void wxMDIParentFrame::OnSysColourChanged(wxSysColourChangedEvent& event)
362 {
363 if ( m_clientWindow )
364 {
365 m_clientWindow->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_APPWORKSPACE));
366 m_clientWindow->Refresh();
367 }
368
369 event.Skip();
370 }
371
372 WXHICON wxMDIParentFrame::GetDefaultIcon() const
373 {
374 // we don't have any standard icons (any more)
375 return (WXHICON)0;
376 }
377
378 // ---------------------------------------------------------------------------
379 // MDI operations
380 // ---------------------------------------------------------------------------
381
382 void wxMDIParentFrame::Cascade()
383 {
384 ::SendMessage(GetWinHwnd(GetClientWindow()), WM_MDICASCADE, 0, 0);
385 }
386
387 void wxMDIParentFrame::Tile(wxOrientation orient)
388 {
389 wxASSERT_MSG( orient == wxHORIZONTAL || orient == wxVERTICAL,
390 _T("invalid orientation value") );
391
392 ::SendMessage(GetWinHwnd(GetClientWindow()), WM_MDITILE,
393 orient == wxHORIZONTAL ? MDITILE_HORIZONTAL
394 : MDITILE_VERTICAL, 0);
395 }
396
397 void wxMDIParentFrame::ArrangeIcons()
398 {
399 ::SendMessage(GetWinHwnd(GetClientWindow()), WM_MDIICONARRANGE, 0, 0);
400 }
401
402 void wxMDIParentFrame::ActivateNext()
403 {
404 ::SendMessage(GetWinHwnd(GetClientWindow()), WM_MDINEXT, 0, 0);
405 }
406
407 void wxMDIParentFrame::ActivatePrevious()
408 {
409 ::SendMessage(GetWinHwnd(GetClientWindow()), WM_MDINEXT, 0, 1);
410 }
411
412 // ---------------------------------------------------------------------------
413 // the MDI parent frame window proc
414 // ---------------------------------------------------------------------------
415
416 WXLRESULT wxMDIParentFrame::MSWWindowProc(WXUINT message,
417 WXWPARAM wParam,
418 WXLPARAM lParam)
419 {
420 WXLRESULT rc = 0;
421 bool processed = false;
422
423 switch ( message )
424 {
425 case WM_ACTIVATE:
426 {
427 WXWORD state, minimized;
428 WXHWND hwnd;
429 UnpackActivate(wParam, lParam, &state, &minimized, &hwnd);
430
431 processed = HandleActivate(state, minimized != 0, hwnd);
432 }
433 break;
434
435 case WM_COMMAND:
436 {
437 WXWORD id, cmd;
438 WXHWND hwnd;
439 UnpackCommand(wParam, lParam, &id, &hwnd, &cmd);
440
441 (void)HandleCommand(id, cmd, hwnd);
442
443 // even if the frame didn't process it, there is no need to try it
444 // once again (i.e. call wxFrame::HandleCommand()) - we just did it,
445 // so pretend we processed the message anyhow
446 processed = true;
447 }
448
449 // always pass this message DefFrameProc(), otherwise MDI menu
450 // commands (and sys commands - more surprisingly!) won't work
451 MSWDefWindowProc(message, wParam, lParam);
452 break;
453
454 case WM_CREATE:
455 m_clientWindow = OnCreateClient();
456 // Uses own style for client style
457 if ( !m_clientWindow->CreateClient(this, GetWindowStyleFlag()) )
458 {
459 wxLogMessage(_("Failed to create MDI parent frame."));
460
461 rc = -1;
462 }
463
464 processed = true;
465 break;
466
467 case WM_ERASEBKGND:
468 processed = true;
469
470 // we erase background ourselves
471 rc = true;
472 break;
473
474 case WM_MENUSELECT:
475 {
476 WXWORD item, flags;
477 WXHMENU hmenu;
478 UnpackMenuSelect(wParam, lParam, &item, &flags, &hmenu);
479
480 if ( m_parentFrameActive )
481 {
482 processed = HandleMenuSelect(item, flags, hmenu);
483 }
484 else if (m_currentChild)
485 {
486 processed = m_currentChild->
487 HandleMenuSelect(item, flags, hmenu);
488 }
489 }
490 break;
491
492 case WM_SIZE:
493 // as we don't (usually) resize the MDI client to exactly fit the
494 // client area (we put it below the toolbar, above statusbar &c),
495 // we should not pass this one to DefFrameProc
496 break;
497 }
498
499 if ( !processed )
500 rc = wxFrame::MSWWindowProc(message, wParam, lParam);
501
502 return rc;
503 }
504
505 bool wxMDIParentFrame::HandleActivate(int state, bool minimized, WXHWND activate)
506 {
507 bool processed = false;
508
509 if ( wxWindow::HandleActivate(state, minimized, activate) )
510 {
511 // already processed
512 processed = true;
513 }
514
515 // If this window is an MDI parent, we must also send an OnActivate message
516 // to the current child.
517 if ( (m_currentChild != NULL) &&
518 ((state == WA_ACTIVE) || (state == WA_CLICKACTIVE)) )
519 {
520 wxActivateEvent event(wxEVT_ACTIVATE, true, m_currentChild->GetId());
521 event.SetEventObject( m_currentChild );
522 if ( m_currentChild->GetEventHandler()->ProcessEvent(event) )
523 processed = true;
524 }
525
526 return processed;
527 }
528
529 bool wxMDIParentFrame::HandleCommand(WXWORD id, WXWORD cmd, WXHWND hwnd)
530 {
531 // In case it's e.g. a toolbar.
532 if ( hwnd )
533 {
534 wxWindow *win = wxFindWinFromHandle(hwnd);
535 if ( win )
536 return win->MSWCommand(cmd, id);
537 }
538
539 // is it one of standard MDI commands?
540 WXWPARAM wParam = 0;
541 WXLPARAM lParam = 0;
542 int msg;
543 switch ( id )
544 {
545 case IDM_WINDOWCASCADE:
546 msg = WM_MDICASCADE;
547 wParam = MDITILE_SKIPDISABLED;
548 break;
549
550 case IDM_WINDOWTILEHOR:
551 wParam |= MDITILE_HORIZONTAL;
552 // fall through
553
554 case IDM_WINDOWTILEVERT:
555 if ( !wParam )
556 wParam = MDITILE_VERTICAL;
557 msg = WM_MDITILE;
558 wParam |= MDITILE_SKIPDISABLED;
559 break;
560
561 case IDM_WINDOWICONS:
562 msg = WM_MDIICONARRANGE;
563 break;
564
565 case IDM_WINDOWNEXT:
566 msg = WM_MDINEXT;
567 lParam = 0; // next child
568 break;
569
570 case IDM_WINDOWPREV:
571 msg = WM_MDINEXT;
572 lParam = 1; // previous child
573 break;
574
575 default:
576 msg = 0;
577 }
578
579 if ( msg )
580 {
581 ::SendMessage(GetWinHwnd(GetClientWindow()), msg, wParam, lParam);
582
583 return true;
584 }
585
586 // FIXME VZ: what does this test do??
587 if (id >= 0xF000)
588 {
589 return false; // Get WndProc to call default proc
590 }
591
592 if ( IsMdiCommandId(id) )
593 {
594 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
595 while ( node )
596 {
597 wxWindow *child = node->GetData();
598 if ( child->GetHWND() )
599 {
600 long childId = wxGetWindowId(child->GetHWND());
601 if (childId == (long)id)
602 {
603 ::SendMessage( GetWinHwnd(GetClientWindow()),
604 WM_MDIACTIVATE,
605 (WPARAM)child->GetHWND(), 0);
606 return true;
607 }
608 }
609 node = node->GetNext();
610 }
611 }
612 else if ( m_parentFrameActive )
613 {
614 return ProcessCommand(id);
615 }
616 else if ( m_currentChild )
617 {
618 return m_currentChild->HandleCommand(id, cmd, hwnd);
619 }
620 else
621 {
622 // this shouldn't happen because it means that our messages are being
623 // lost (they're not sent to the parent frame nor to the children)
624 wxFAIL_MSG(wxT("MDI parent frame is not active, yet there is no active MDI child?"));
625 }
626
627 return false;
628 }
629
630 WXLRESULT wxMDIParentFrame::MSWDefWindowProc(WXUINT message,
631 WXWPARAM wParam,
632 WXLPARAM lParam)
633 {
634 WXHWND clientWnd;
635 if ( GetClientWindow() )
636 clientWnd = GetClientWindow()->GetHWND();
637 else
638 clientWnd = 0;
639
640 return DefFrameProc(GetHwnd(), (HWND)clientWnd, message, wParam, lParam);
641 }
642
643 bool wxMDIParentFrame::MSWTranslateMessage(WXMSG* msg)
644 {
645 MSG *pMsg = (MSG *)msg;
646
647 // first let the current child get it
648 if ( m_currentChild && m_currentChild->GetHWND() &&
649 m_currentChild->MSWTranslateMessage(msg) )
650 {
651 return true;
652 }
653
654 // then try out accel table (will also check the menu accels)
655 if ( wxFrame::MSWTranslateMessage(msg) )
656 {
657 return true;
658 }
659
660 // finally, check for MDI specific built in accel keys
661 if ( pMsg->message == WM_KEYDOWN || pMsg->message == WM_SYSKEYDOWN )
662 {
663 if ( ::TranslateMDISysAccel(GetWinHwnd(GetClientWindow()), pMsg))
664 return true;
665 }
666
667 return false;
668 }
669
670 // ===========================================================================
671 // wxMDIChildFrame
672 // ===========================================================================
673
674 void wxMDIChildFrame::Init()
675 {
676 m_needsResize = true;
677 m_needsInitialShow = true;
678 }
679
680 bool wxMDIChildFrame::Create(wxMDIParentFrame *parent,
681 wxWindowID id,
682 const wxString& title,
683 const wxPoint& pos,
684 const wxSize& size,
685 long style,
686 const wxString& name)
687 {
688 SetName(name);
689
690 if ( id != wxID_ANY )
691 m_windowId = id;
692 else
693 m_windowId = (int)NewControlId();
694
695 if ( parent )
696 {
697 parent->AddChild(this);
698 }
699
700 int x = pos.x;
701 int y = pos.y;
702 int width = size.x;
703 int height = size.y;
704
705 MDICREATESTRUCT mcs;
706
707 mcs.szClass = style & wxFULL_REPAINT_ON_RESIZE
708 ? wxMDIChildFrameClassName
709 : wxMDIChildFrameClassNameNoRedraw;
710 mcs.szTitle = title;
711 mcs.hOwner = wxGetInstance();
712 if (x != wxDefaultCoord)
713 mcs.x = x;
714 else
715 mcs.x = CW_USEDEFAULT;
716
717 if (y != wxDefaultCoord)
718 mcs.y = y;
719 else
720 mcs.y = CW_USEDEFAULT;
721
722 if (width != wxDefaultCoord)
723 mcs.cx = width;
724 else
725 mcs.cx = CW_USEDEFAULT;
726
727 if (height != wxDefaultCoord)
728 mcs.cy = height;
729 else
730 mcs.cy = CW_USEDEFAULT;
731
732 DWORD msflags = WS_OVERLAPPED | WS_CLIPCHILDREN;
733 if (style & wxMINIMIZE_BOX)
734 msflags |= WS_MINIMIZEBOX;
735 if (style & wxMAXIMIZE_BOX)
736 msflags |= WS_MAXIMIZEBOX;
737 if (style & wxTHICK_FRAME)
738 msflags |= WS_THICKFRAME;
739 if (style & wxSYSTEM_MENU)
740 msflags |= WS_SYSMENU;
741 if ((style & wxMINIMIZE) || (style & wxICONIZE))
742 msflags |= WS_MINIMIZE;
743 if (style & wxMAXIMIZE)
744 msflags |= WS_MAXIMIZE;
745 if (style & wxCAPTION)
746 msflags |= WS_CAPTION;
747
748 mcs.style = msflags;
749
750 mcs.lParam = 0;
751
752 wxWindowCreationHook hook(this);
753
754 m_hWnd = (WXHWND)::SendMessage(GetWinHwnd(parent->GetClientWindow()),
755 WM_MDICREATE, 0, (LONG)(LPSTR)&mcs);
756
757 wxAssociateWinWithHandle((HWND) GetHWND(), this);
758
759 return true;
760 }
761
762 wxMDIChildFrame::~wxMDIChildFrame()
763 {
764 // will be destroyed by DestroyChildren() but reset them before calling it
765 // to avoid using dangling pointers if a callback comes in the meanwhile
766 #if wxUSE_TOOLBAR
767 m_frameToolBar = NULL;
768 #endif
769 #if wxUSE_STATUSBAR
770 m_frameStatusBar = NULL;
771 #endif // wxUSE_STATUSBAR
772
773 DestroyChildren();
774
775 RemoveWindowMenu(NULL, m_hMenu);
776
777 MSWDestroyWindow();
778 }
779
780 bool wxMDIChildFrame::Show(bool show)
781 {
782 m_needsInitialShow = false;
783 return wxFrame::Show(show);
784 }
785
786 // Set the client size (i.e. leave the calculation of borders etc.
787 // to wxWidgets)
788 void wxMDIChildFrame::DoSetClientSize(int width, int height)
789 {
790 HWND hWnd = GetHwnd();
791
792 RECT rect;
793 ::GetClientRect(hWnd, &rect);
794
795 RECT rect2;
796 GetWindowRect(hWnd, &rect2);
797
798 // Find the difference between the entire window (title bar and all)
799 // and the client area; add this to the new client size to move the
800 // window
801 int actual_width = rect2.right - rect2.left - rect.right + width;
802 int actual_height = rect2.bottom - rect2.top - rect.bottom + height;
803
804 #if wxUSE_STATUSBAR
805 if (GetStatusBar() && GetStatusBar()->IsShown())
806 {
807 int sx, sy;
808 GetStatusBar()->GetSize(&sx, &sy);
809 actual_height += sy;
810 }
811 #endif // wxUSE_STATUSBAR
812
813 POINT point;
814 point.x = rect2.left;
815 point.y = rect2.top;
816
817 // If there's an MDI parent, must subtract the parent's top left corner
818 // since MoveWindow moves relative to the parent
819 wxMDIParentFrame *mdiParent = (wxMDIParentFrame *)GetParent();
820 ::ScreenToClient((HWND) mdiParent->GetClientWindow()->GetHWND(), &point);
821
822 MoveWindow(hWnd, point.x, point.y, actual_width, actual_height, (BOOL)true);
823
824 wxSize size(width, height);
825 wxSizeEvent event(size, m_windowId);
826 event.SetEventObject( this );
827 GetEventHandler()->ProcessEvent(event);
828 }
829
830 void wxMDIChildFrame::DoGetPosition(int *x, int *y) const
831 {
832 RECT rect;
833 GetWindowRect(GetHwnd(), &rect);
834 POINT point;
835 point.x = rect.left;
836 point.y = rect.top;
837
838 // Since we now have the absolute screen coords,
839 // if there's a parent we must subtract its top left corner
840 wxMDIParentFrame *mdiParent = (wxMDIParentFrame *)GetParent();
841 ::ScreenToClient((HWND) mdiParent->GetClientWindow()->GetHWND(), &point);
842
843 *x = point.x;
844 *y = point.y;
845 }
846
847 void wxMDIChildFrame::InternalSetMenuBar()
848 {
849 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
850
851 InsertWindowMenu(parent->GetClientWindow(),
852 m_hMenu, GetMDIWindowMenu(parent));
853
854 parent->m_parentFrameActive = false;
855 }
856
857 WXHICON wxMDIChildFrame::GetDefaultIcon() const
858 {
859 // we don't have any standard icons (any more)
860 return (WXHICON)0;
861 }
862
863 // ---------------------------------------------------------------------------
864 // MDI operations
865 // ---------------------------------------------------------------------------
866
867 void wxMDIChildFrame::Maximize(bool maximize)
868 {
869 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
870 if ( parent && parent->GetClientWindow() )
871 {
872 ::SendMessage(GetWinHwnd(parent->GetClientWindow()),
873 maximize ? WM_MDIMAXIMIZE : WM_MDIRESTORE,
874 (WPARAM)GetHwnd(), 0);
875 }
876 }
877
878 void wxMDIChildFrame::Restore()
879 {
880 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
881 if ( parent && parent->GetClientWindow() )
882 {
883 ::SendMessage(GetWinHwnd(parent->GetClientWindow()), WM_MDIRESTORE,
884 (WPARAM) GetHwnd(), 0);
885 }
886 }
887
888 void wxMDIChildFrame::Activate()
889 {
890 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
891 if ( parent && parent->GetClientWindow() )
892 {
893 ::SendMessage(GetWinHwnd(parent->GetClientWindow()), WM_MDIACTIVATE,
894 (WPARAM) GetHwnd(), 0);
895 }
896 }
897
898 // ---------------------------------------------------------------------------
899 // MDI window proc and message handlers
900 // ---------------------------------------------------------------------------
901
902 WXLRESULT wxMDIChildFrame::MSWWindowProc(WXUINT message,
903 WXWPARAM wParam,
904 WXLPARAM lParam)
905 {
906 WXLRESULT rc = 0;
907 bool processed = false;
908
909 switch ( message )
910 {
911 case WM_COMMAND:
912 {
913 WORD id, cmd;
914 WXHWND hwnd;
915 UnpackCommand((WXWPARAM)wParam, (WXLPARAM)lParam,
916 &id, &hwnd, &cmd);
917
918 processed = HandleCommand(id, cmd, (WXHWND)hwnd);
919 }
920 break;
921
922 case WM_GETMINMAXINFO:
923 processed = HandleGetMinMaxInfo((MINMAXINFO *)lParam);
924 break;
925
926 case WM_MDIACTIVATE:
927 {
928 WXWORD act;
929 WXHWND hwndAct, hwndDeact;
930 UnpackMDIActivate(wParam, lParam, &act, &hwndAct, &hwndDeact);
931
932 processed = HandleMDIActivate(act, hwndAct, hwndDeact);
933 }
934 // fall through
935
936 case WM_MOVE:
937 // must pass WM_MOVE to DefMDIChildProc() to recalculate MDI client
938 // scrollbars if necessary
939
940 // fall through
941
942 case WM_SIZE:
943 // must pass WM_SIZE to DefMDIChildProc(), otherwise many weird
944 // things happen
945 MSWDefWindowProc(message, wParam, lParam);
946 break;
947
948 case WM_SYSCOMMAND:
949 // DefMDIChildProc handles SC_{NEXT/PREV}WINDOW here, so pass it
950 // the message (the base class version does not)
951 return MSWDefWindowProc(message, wParam, lParam);
952
953 case WM_WINDOWPOSCHANGING:
954 processed = HandleWindowPosChanging((LPWINDOWPOS)lParam);
955 break;
956 }
957
958 if ( !processed )
959 rc = wxFrame::MSWWindowProc(message, wParam, lParam);
960
961 return rc;
962 }
963
964 bool wxMDIChildFrame::HandleCommand(WXWORD id, WXWORD cmd, WXHWND hwnd)
965 {
966 // In case it's e.g. a toolbar.
967 if ( hwnd )
968 {
969 wxWindow *win = wxFindWinFromHandle(hwnd);
970 if (win)
971 return win->MSWCommand(cmd, id);
972 }
973
974 if (wxCurrentPopupMenu)
975 {
976 wxMenu *popupMenu = wxCurrentPopupMenu;
977 wxCurrentPopupMenu = NULL;
978 if (popupMenu->MSWCommand(cmd, id))
979 return true;
980 }
981
982 bool processed;
983 if (GetMenuBar() && GetMenuBar()->FindItem(id))
984 {
985 processed = ProcessCommand(id);
986 }
987 else
988 {
989 processed = false;
990 }
991
992 return processed;
993 }
994
995 bool wxMDIChildFrame::HandleMDIActivate(long WXUNUSED(activate),
996 WXHWND hwndAct,
997 WXHWND hwndDeact)
998 {
999 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
1000
1001 HMENU menuToSet = 0;
1002
1003 bool activated;
1004
1005 if ( m_hWnd == hwndAct )
1006 {
1007 activated = true;
1008 parent->m_currentChild = this;
1009
1010 HMENU child_menu = (HMENU)GetWinMenu();
1011 if ( child_menu )
1012 {
1013 parent->m_parentFrameActive = false;
1014
1015 menuToSet = child_menu;
1016 }
1017 }
1018 else if ( m_hWnd == hwndDeact )
1019 {
1020 wxASSERT_MSG( parent->m_currentChild == this,
1021 wxT("can't deactivate MDI child which wasn't active!") );
1022
1023 activated = false;
1024 parent->m_currentChild = NULL;
1025
1026 HMENU parent_menu = (HMENU)parent->GetWinMenu();
1027
1028 // activate the the parent menu only when there is no other child
1029 // that has been activated
1030 if ( parent_menu && !hwndAct )
1031 {
1032 parent->m_parentFrameActive = true;
1033
1034 menuToSet = parent_menu;
1035 }
1036 }
1037 else
1038 {
1039 // we have nothing to do with it
1040 return false;
1041 }
1042
1043 if ( menuToSet )
1044 {
1045 MDISetMenu(parent->GetClientWindow(),
1046 menuToSet, GetMDIWindowMenu(parent));
1047 }
1048
1049 wxActivateEvent event(wxEVT_ACTIVATE, activated, m_windowId);
1050 event.SetEventObject( this );
1051
1052 ResetWindowStyle((void *)NULL);
1053
1054 return GetEventHandler()->ProcessEvent(event);
1055 }
1056
1057 bool wxMDIChildFrame::HandleWindowPosChanging(void *pos)
1058 {
1059 WINDOWPOS *lpPos = (WINDOWPOS *)pos;
1060 #if defined(__WIN95__)
1061 if (!(lpPos->flags & SWP_NOSIZE))
1062 {
1063 RECT rectClient;
1064 DWORD dwExStyle = ::GetWindowLong(GetHwnd(), GWL_EXSTYLE);
1065 DWORD dwStyle = ::GetWindowLong(GetHwnd(), GWL_STYLE);
1066 if (ResetWindowStyle((void *) & rectClient) && (dwStyle & WS_MAXIMIZE))
1067 {
1068 ::AdjustWindowRectEx(&rectClient, dwStyle, false, dwExStyle);
1069 lpPos->x = rectClient.left;
1070 lpPos->y = rectClient.top;
1071 lpPos->cx = rectClient.right - rectClient.left;
1072 lpPos->cy = rectClient.bottom - rectClient.top;
1073 }
1074 #if wxUSE_TOOLBAR
1075 wxMDIParentFrame* pFrameWnd = (wxMDIParentFrame *)GetParent();
1076 if (pFrameWnd && pFrameWnd->GetToolBar() && pFrameWnd->GetToolBar()->IsShown())
1077 {
1078 pFrameWnd->GetToolBar()->Refresh();
1079 }
1080 #endif
1081 }
1082 #endif // Win95
1083
1084 return false;
1085 }
1086
1087 bool wxMDIChildFrame::HandleGetMinMaxInfo(void *mmInfo)
1088 {
1089 MINMAXINFO *info = (MINMAXINFO *)mmInfo;
1090
1091 // let the default window proc calculate the size of MDI children
1092 // frames because it is based on the size of the MDI client window,
1093 // not on the values specified in wxWindow m_max variables
1094 bool processed = MSWDefWindowProc(WM_GETMINMAXINFO, 0, (LPARAM)mmInfo) != 0;
1095
1096 int minWidth = GetMinWidth(),
1097 minHeight = GetMinHeight();
1098
1099 // but allow GetSizeHints() to set the min size
1100 if ( minWidth != -1 )
1101 {
1102 info->ptMinTrackSize.x = minWidth;
1103
1104 processed = true;
1105 }
1106
1107 if ( minHeight != -1 )
1108 {
1109 info->ptMinTrackSize.y = minHeight;
1110
1111 processed = true;
1112 }
1113
1114 return processed;
1115 }
1116
1117 // ---------------------------------------------------------------------------
1118 // MDI specific message translation/preprocessing
1119 // ---------------------------------------------------------------------------
1120
1121 WXLRESULT wxMDIChildFrame::MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
1122 {
1123 return DefMDIChildProc(GetHwnd(),
1124 (UINT)message, (WPARAM)wParam, (LPARAM)lParam);
1125 }
1126
1127 bool wxMDIChildFrame::MSWTranslateMessage(WXMSG* msg)
1128 {
1129 return wxFrame::MSWTranslateMessage(msg);
1130 }
1131
1132 // ---------------------------------------------------------------------------
1133 // misc
1134 // ---------------------------------------------------------------------------
1135
1136 void wxMDIChildFrame::MSWDestroyWindow()
1137 {
1138 invalidHandle = GetHwnd();
1139
1140 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
1141
1142 // Must make sure this handle is invalidated (set to NULL) since all sorts
1143 // of things could happen after the child client is destroyed, but before
1144 // the wxFrame is destroyed.
1145
1146 HWND oldHandle = (HWND)GetHWND();
1147 SendMessage(GetWinHwnd(parent->GetClientWindow()), WM_MDIDESTROY,
1148 (WPARAM)oldHandle, 0);
1149
1150 if (parent->GetActiveChild() == (wxMDIChildFrame*) NULL)
1151 ResetWindowStyle((void*) NULL);
1152
1153 invalidHandle = 0;
1154
1155 if (m_hMenu)
1156 {
1157 ::DestroyMenu((HMENU) m_hMenu);
1158 m_hMenu = 0;
1159 }
1160 wxRemoveHandleAssociation(this);
1161 m_hWnd = 0;
1162 }
1163
1164 // Change the client window's extended style so we don't get a client edge
1165 // style when a child is maximised (a double border looks silly.)
1166 bool wxMDIChildFrame::ResetWindowStyle(void *vrect)
1167 {
1168 #if defined(__WIN95__)
1169 RECT *rect = (RECT *)vrect;
1170 wxMDIParentFrame* pFrameWnd = (wxMDIParentFrame *)GetParent();
1171 wxMDIChildFrame* pChild = pFrameWnd->GetActiveChild();
1172 if (!pChild || (pChild == this))
1173 {
1174 HWND hwndClient = GetWinHwnd(pFrameWnd->GetClientWindow());
1175 DWORD dwStyle = ::GetWindowLong(hwndClient, GWL_EXSTYLE);
1176
1177 // we want to test whether there is a maximized child, so just set
1178 // dwThisStyle to 0 if there is no child at all
1179 DWORD dwThisStyle = pChild
1180 ? ::GetWindowLong(GetWinHwnd(pChild), GWL_STYLE) : 0;
1181 DWORD dwNewStyle = dwStyle;
1182 if ( dwThisStyle & WS_MAXIMIZE )
1183 dwNewStyle &= ~(WS_EX_CLIENTEDGE);
1184 else
1185 dwNewStyle |= WS_EX_CLIENTEDGE;
1186
1187 if (dwStyle != dwNewStyle)
1188 {
1189 // force update of everything
1190 ::RedrawWindow(hwndClient, NULL, NULL,
1191 RDW_INVALIDATE | RDW_ALLCHILDREN);
1192 ::SetWindowLong(hwndClient, GWL_EXSTYLE, dwNewStyle);
1193 ::SetWindowPos(hwndClient, NULL, 0, 0, 0, 0,
1194 SWP_FRAMECHANGED | SWP_NOACTIVATE |
1195 SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER |
1196 SWP_NOCOPYBITS);
1197 if (rect)
1198 ::GetClientRect(hwndClient, rect);
1199
1200 return true;
1201 }
1202 }
1203 #endif // Win95
1204
1205 return false;
1206 }
1207
1208 // ===========================================================================
1209 // wxMDIClientWindow: the window of predefined (by Windows) class which
1210 // contains the child frames
1211 // ===========================================================================
1212
1213 bool wxMDIClientWindow::CreateClient(wxMDIParentFrame *parent, long style)
1214 {
1215 m_backgroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_APPWORKSPACE);
1216
1217 CLIENTCREATESTRUCT ccs;
1218 m_windowStyle = style;
1219 m_parent = parent;
1220
1221 ccs.hWindowMenu = GetMDIWindowMenu(parent);
1222 ccs.idFirstChild = wxFIRST_MDI_CHILD;
1223
1224 DWORD msStyle = MDIS_ALLCHILDSTYLES | WS_VISIBLE | WS_CHILD |
1225 WS_CLIPCHILDREN | WS_CLIPSIBLINGS;
1226
1227 if ( style & wxHSCROLL )
1228 msStyle |= WS_HSCROLL;
1229 if ( style & wxVSCROLL )
1230 msStyle |= WS_VSCROLL;
1231
1232 #if defined(__WIN95__)
1233 DWORD exStyle = WS_EX_CLIENTEDGE;
1234 #else
1235 DWORD exStyle = 0;
1236 #endif
1237
1238 wxWindowCreationHook hook(this);
1239 m_hWnd = (WXHWND)::CreateWindowEx
1240 (
1241 exStyle,
1242 wxT("MDICLIENT"),
1243 NULL,
1244 msStyle,
1245 0, 0, 0, 0,
1246 GetWinHwnd(parent),
1247 NULL,
1248 wxGetInstance(),
1249 (LPSTR)(LPCLIENTCREATESTRUCT)&ccs);
1250 if ( !m_hWnd )
1251 {
1252 wxLogLastError(wxT("CreateWindowEx(MDI client)"));
1253
1254 return false;
1255 }
1256
1257 SubclassWin(m_hWnd);
1258
1259 return true;
1260 }
1261
1262 // Explicitly call default scroll behaviour
1263 void wxMDIClientWindow::OnScroll(wxScrollEvent& event)
1264 {
1265 // Note: for client windows, the scroll position is not set in
1266 // WM_HSCROLL, WM_VSCROLL, so we can't easily determine what
1267 // scroll position we're at.
1268 // This makes it hard to paint patterns or bitmaps in the background,
1269 // and have the client area scrollable as well.
1270
1271 if ( event.GetOrientation() == wxHORIZONTAL )
1272 m_scrollX = event.GetPosition(); // Always returns zero!
1273 else
1274 m_scrollY = event.GetPosition(); // Always returns zero!
1275
1276 event.Skip();
1277 }
1278
1279 void wxMDIClientWindow::DoSetSize(int x, int y, int width, int height, int sizeFlags)
1280 {
1281 // Try to fix a problem whereby if you show an MDI child frame, then reposition the
1282 // client area, you can end up with a non-refreshed portion in the client window
1283 // (see OGL studio sample). So check if the position is changed and if so,
1284 // redraw the MDI child frames.
1285
1286 wxPoint oldPos = GetPosition();
1287
1288 wxWindow::DoSetSize(x, y, width, height, sizeFlags);
1289
1290 wxPoint newPos = GetPosition();
1291
1292 if ((newPos.x != oldPos.x) || (newPos.y != oldPos.y))
1293 {
1294 if (GetParent())
1295 {
1296 wxWindowList::compatibility_iterator node = GetParent()->GetChildren().GetFirst();
1297 while (node)
1298 {
1299 wxWindow *child = node->GetData();
1300 if (child->IsKindOf(CLASSINFO(wxMDIChildFrame)))
1301 {
1302 ::RedrawWindow(GetHwndOf(child),
1303 NULL,
1304 NULL,
1305 RDW_FRAME |
1306 RDW_ALLCHILDREN |
1307 RDW_INVALIDATE);
1308 }
1309 node = node->GetNext();
1310 }
1311 }
1312 }
1313 }
1314
1315 void wxMDIChildFrame::OnIdle(wxIdleEvent& event)
1316 {
1317 // wxMSW prior to 2.5.3 created MDI child frames as visible, which resulted
1318 // in flicker e.g. when the frame contained controls with non-trivial
1319 // layout. Since 2.5.3, the frame is created hidden as all other top level
1320 // windows. In order to maintain backward compatibility, the frame is shown
1321 // in OnIdle, unless Show(false) was called by the programmer before.
1322 if ( m_needsInitialShow )
1323 {
1324 Show(true);
1325 }
1326
1327 // MDI child frames get their WM_SIZE when they're constructed but at this
1328 // moment they don't have any children yet so all child windows will be
1329 // positioned incorrectly when they are added later - to fix this, we
1330 // generate an artificial size event here
1331 if ( m_needsResize )
1332 {
1333 m_needsResize = false; // avoid any possibility of recursion
1334
1335 SendSizeEvent();
1336 }
1337
1338 event.Skip();
1339 }
1340
1341 // ---------------------------------------------------------------------------
1342 // non member functions
1343 // ---------------------------------------------------------------------------
1344
1345 static void MDISetMenu(wxWindow *win, HMENU hmenuFrame, HMENU hmenuWindow)
1346 {
1347 ::SendMessage(GetWinHwnd(win), WM_MDISETMENU,
1348 #ifdef __WIN32__
1349 (WPARAM)hmenuFrame, (LPARAM)hmenuWindow
1350 #else
1351 0, MAKELPARAM(hmenuFrame, hmenuWindow)
1352 #endif
1353 );
1354
1355 // update menu bar of the parent window
1356 wxWindow *parent = win->GetParent();
1357 wxCHECK_RET( parent, wxT("MDI client without parent frame? weird...") );
1358
1359 ::SendMessage(GetWinHwnd(win), WM_MDIREFRESHMENU, 0, 0L);
1360
1361 ::DrawMenuBar(GetWinHwnd(parent));
1362 }
1363
1364 static void InsertWindowMenu(wxWindow *win, WXHMENU menu, HMENU subMenu)
1365 {
1366 // Try to insert Window menu in front of Help, otherwise append it.
1367 HMENU hmenu = (HMENU)menu;
1368
1369 if (subMenu)
1370 {
1371 int N = GetMenuItemCount(hmenu);
1372 bool success = false;
1373 for ( int i = 0; i < N; i++ )
1374 {
1375 wxChar buf[256];
1376 int chars = GetMenuString(hmenu, i, buf, WXSIZEOF(buf), MF_BYPOSITION);
1377 if ( chars == 0 )
1378 {
1379 wxLogLastError(wxT("GetMenuString"));
1380
1381 continue;
1382 }
1383
1384 if ( wxStripMenuCodes(wxString(buf)).IsSameAs(_("Help")) )
1385 {
1386 success = true;
1387 ::InsertMenu(hmenu, i, MF_BYPOSITION | MF_POPUP | MF_STRING,
1388 (UINT)subMenu, _("&Window"));
1389 break;
1390 }
1391 }
1392
1393 if ( !success )
1394 {
1395 ::AppendMenu(hmenu, MF_POPUP, (UINT)subMenu, _("&Window"));
1396 }
1397 }
1398
1399 MDISetMenu(win, hmenu, subMenu);
1400 }
1401
1402 static void RemoveWindowMenu(wxWindow *win, WXHMENU menu)
1403 {
1404 HMENU hMenu = (HMENU)menu;
1405
1406 if ( hMenu )
1407 {
1408 wxChar buf[1024];
1409
1410 int N = ::GetMenuItemCount(hMenu);
1411 for ( int i = 0; i < N; i++ )
1412 {
1413 if ( !::GetMenuString(hMenu, i, buf, WXSIZEOF(buf), MF_BYPOSITION) )
1414 {
1415 // Ignore successful read of menu string with length 0 which
1416 // occurs, for example, for a maximized MDI childs system menu
1417 if ( ::GetLastError() != 0 )
1418 {
1419 wxLogLastError(wxT("GetMenuString"));
1420 }
1421
1422 continue;
1423 }
1424
1425 if ( wxStrcmp(buf, _("&Window")) == 0 )
1426 {
1427 if ( !::RemoveMenu(hMenu, i, MF_BYPOSITION) )
1428 {
1429 wxLogLastError(wxT("RemoveMenu"));
1430 }
1431
1432 break;
1433 }
1434 }
1435 }
1436
1437 if ( win )
1438 {
1439 // we don't change the windows menu, but we update the main one
1440 MDISetMenu(win, hMenu, NULL);
1441 }
1442 }
1443
1444 static void UnpackMDIActivate(WXWPARAM wParam, WXLPARAM lParam,
1445 WXWORD *activate, WXHWND *hwndAct, WXHWND *hwndDeact)
1446 {
1447 *activate = true;
1448 *hwndAct = (WXHWND)lParam;
1449 *hwndDeact = (WXHWND)wParam;
1450 }
1451
1452 #endif // wxUSE_MDI && !defined(__WXUNIVERSAL__)
1453