]> git.saurik.com Git - wxWidgets.git/blob - src/msw/mdi.cpp
Docstring fixes
[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 // TODO: add a direction argument (hor/vert)
388 void wxMDIParentFrame::Tile()
389 {
390 ::SendMessage(GetWinHwnd(GetClientWindow()), WM_MDITILE, MDITILE_HORIZONTAL, 0);
391 }
392
393 void wxMDIParentFrame::ArrangeIcons()
394 {
395 ::SendMessage(GetWinHwnd(GetClientWindow()), WM_MDIICONARRANGE, 0, 0);
396 }
397
398 void wxMDIParentFrame::ActivateNext()
399 {
400 ::SendMessage(GetWinHwnd(GetClientWindow()), WM_MDINEXT, 0, 0);
401 }
402
403 void wxMDIParentFrame::ActivatePrevious()
404 {
405 ::SendMessage(GetWinHwnd(GetClientWindow()), WM_MDINEXT, 0, 1);
406 }
407
408 // ---------------------------------------------------------------------------
409 // the MDI parent frame window proc
410 // ---------------------------------------------------------------------------
411
412 WXLRESULT wxMDIParentFrame::MSWWindowProc(WXUINT message,
413 WXWPARAM wParam,
414 WXLPARAM lParam)
415 {
416 WXLRESULT rc = 0;
417 bool processed = false;
418
419 switch ( message )
420 {
421 case WM_ACTIVATE:
422 {
423 WXWORD state, minimized;
424 WXHWND hwnd;
425 UnpackActivate(wParam, lParam, &state, &minimized, &hwnd);
426
427 processed = HandleActivate(state, minimized != 0, hwnd);
428 }
429 break;
430
431 case WM_COMMAND:
432 {
433 WXWORD id, cmd;
434 WXHWND hwnd;
435 UnpackCommand(wParam, lParam, &id, &hwnd, &cmd);
436
437 (void)HandleCommand(id, cmd, hwnd);
438
439 // even if the frame didn't process it, there is no need to try it
440 // once again (i.e. call wxFrame::HandleCommand()) - we just did it,
441 // so pretend we processed the message anyhow
442 processed = true;
443 }
444
445 // always pass this message DefFrameProc(), otherwise MDI menu
446 // commands (and sys commands - more surprisingly!) won't work
447 MSWDefWindowProc(message, wParam, lParam);
448 break;
449
450 case WM_CREATE:
451 m_clientWindow = OnCreateClient();
452 // Uses own style for client style
453 if ( !m_clientWindow->CreateClient(this, GetWindowStyleFlag()) )
454 {
455 wxLogMessage(_("Failed to create MDI parent frame."));
456
457 rc = -1;
458 }
459
460 processed = true;
461 break;
462
463 case WM_ERASEBKGND:
464 processed = true;
465
466 // we erase background ourselves
467 rc = true;
468 break;
469
470 case WM_MENUSELECT:
471 {
472 WXWORD item, flags;
473 WXHMENU hmenu;
474 UnpackMenuSelect(wParam, lParam, &item, &flags, &hmenu);
475
476 if ( m_parentFrameActive )
477 {
478 processed = HandleMenuSelect(item, flags, hmenu);
479 }
480 else if (m_currentChild)
481 {
482 processed = m_currentChild->
483 HandleMenuSelect(item, flags, hmenu);
484 }
485 }
486 break;
487
488 case WM_SIZE:
489 // as we don't (usually) resize the MDI client to exactly fit the
490 // client area (we put it below the toolbar, above statusbar &c),
491 // we should not pass this one to DefFrameProc
492 break;
493 }
494
495 if ( !processed )
496 rc = wxFrame::MSWWindowProc(message, wParam, lParam);
497
498 return rc;
499 }
500
501 bool wxMDIParentFrame::HandleActivate(int state, bool minimized, WXHWND activate)
502 {
503 bool processed = false;
504
505 if ( wxWindow::HandleActivate(state, minimized, activate) )
506 {
507 // already processed
508 processed = true;
509 }
510
511 // If this window is an MDI parent, we must also send an OnActivate message
512 // to the current child.
513 if ( (m_currentChild != NULL) &&
514 ((state == WA_ACTIVE) || (state == WA_CLICKACTIVE)) )
515 {
516 wxActivateEvent event(wxEVT_ACTIVATE, true, m_currentChild->GetId());
517 event.SetEventObject( m_currentChild );
518 if ( m_currentChild->GetEventHandler()->ProcessEvent(event) )
519 processed = true;
520 }
521
522 return processed;
523 }
524
525 bool wxMDIParentFrame::HandleCommand(WXWORD id, WXWORD cmd, WXHWND hwnd)
526 {
527 // In case it's e.g. a toolbar.
528 if ( hwnd )
529 {
530 wxWindow *win = wxFindWinFromHandle(hwnd);
531 if ( win )
532 return win->MSWCommand(cmd, id);
533 }
534
535 // is it one of standard MDI commands?
536 WXWPARAM wParam = 0;
537 WXLPARAM lParam = 0;
538 int msg;
539 switch ( id )
540 {
541 case IDM_WINDOWCASCADE:
542 msg = WM_MDICASCADE;
543 wParam = MDITILE_SKIPDISABLED;
544 break;
545
546 case IDM_WINDOWTILEHOR:
547 wParam |= MDITILE_HORIZONTAL;
548 // fall through
549
550 case IDM_WINDOWTILEVERT:
551 if ( !wParam )
552 wParam = MDITILE_VERTICAL;
553 msg = WM_MDITILE;
554 wParam |= MDITILE_SKIPDISABLED;
555 break;
556
557 case IDM_WINDOWICONS:
558 msg = WM_MDIICONARRANGE;
559 break;
560
561 case IDM_WINDOWNEXT:
562 msg = WM_MDINEXT;
563 lParam = 0; // next child
564 break;
565
566 case IDM_WINDOWPREV:
567 msg = WM_MDINEXT;
568 lParam = 1; // previous child
569 break;
570
571 default:
572 msg = 0;
573 }
574
575 if ( msg )
576 {
577 ::SendMessage(GetWinHwnd(GetClientWindow()), msg, wParam, lParam);
578
579 return true;
580 }
581
582 // FIXME VZ: what does this test do??
583 if (id >= 0xF000)
584 {
585 return false; // Get WndProc to call default proc
586 }
587
588 if ( IsMdiCommandId(id) )
589 {
590 wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
591 while ( node )
592 {
593 wxWindow *child = node->GetData();
594 if ( child->GetHWND() )
595 {
596 long childId = wxGetWindowId(child->GetHWND());
597 if (childId == (long)id)
598 {
599 ::SendMessage( GetWinHwnd(GetClientWindow()),
600 WM_MDIACTIVATE,
601 (WPARAM)child->GetHWND(), 0);
602 return true;
603 }
604 }
605 node = node->GetNext();
606 }
607 }
608 else if ( m_parentFrameActive )
609 {
610 return ProcessCommand(id);
611 }
612 else if ( m_currentChild )
613 {
614 return m_currentChild->HandleCommand(id, cmd, hwnd);
615 }
616 else
617 {
618 // this shouldn't happen because it means that our messages are being
619 // lost (they're not sent to the parent frame nor to the children)
620 wxFAIL_MSG(wxT("MDI parent frame is not active, yet there is no active MDI child?"));
621 }
622
623 return false;
624 }
625
626 WXLRESULT wxMDIParentFrame::MSWDefWindowProc(WXUINT message,
627 WXWPARAM wParam,
628 WXLPARAM lParam)
629 {
630 WXHWND clientWnd;
631 if ( GetClientWindow() )
632 clientWnd = GetClientWindow()->GetHWND();
633 else
634 clientWnd = 0;
635
636 return DefFrameProc(GetHwnd(), (HWND)clientWnd, message, wParam, lParam);
637 }
638
639 bool wxMDIParentFrame::MSWTranslateMessage(WXMSG* msg)
640 {
641 MSG *pMsg = (MSG *)msg;
642
643 // first let the current child get it
644 if ( m_currentChild && m_currentChild->GetHWND() &&
645 m_currentChild->MSWTranslateMessage(msg) )
646 {
647 return true;
648 }
649
650 // then try out accel table (will also check the menu accels)
651 if ( wxFrame::MSWTranslateMessage(msg) )
652 {
653 return true;
654 }
655
656 // finally, check for MDI specific built in accel keys
657 if ( pMsg->message == WM_KEYDOWN || pMsg->message == WM_SYSKEYDOWN )
658 {
659 if ( ::TranslateMDISysAccel(GetWinHwnd(GetClientWindow()), pMsg))
660 return true;
661 }
662
663 return false;
664 }
665
666 // ===========================================================================
667 // wxMDIChildFrame
668 // ===========================================================================
669
670 void wxMDIChildFrame::Init()
671 {
672 m_needsResize = true;
673 m_needsInitialShow = true;
674 }
675
676 bool wxMDIChildFrame::Create(wxMDIParentFrame *parent,
677 wxWindowID id,
678 const wxString& title,
679 const wxPoint& pos,
680 const wxSize& size,
681 long style,
682 const wxString& name)
683 {
684 SetName(name);
685
686 if ( id != wxID_ANY )
687 m_windowId = id;
688 else
689 m_windowId = (int)NewControlId();
690
691 if ( parent )
692 {
693 parent->AddChild(this);
694 }
695
696 int x = pos.x;
697 int y = pos.y;
698 int width = size.x;
699 int height = size.y;
700
701 MDICREATESTRUCT mcs;
702
703 mcs.szClass = style & wxFULL_REPAINT_ON_RESIZE
704 ? wxMDIChildFrameClassName
705 : wxMDIChildFrameClassNameNoRedraw;
706 mcs.szTitle = title;
707 mcs.hOwner = wxGetInstance();
708 if (x != wxDefaultCoord)
709 mcs.x = x;
710 else
711 mcs.x = CW_USEDEFAULT;
712
713 if (y != wxDefaultCoord)
714 mcs.y = y;
715 else
716 mcs.y = CW_USEDEFAULT;
717
718 if (width != wxDefaultCoord)
719 mcs.cx = width;
720 else
721 mcs.cx = CW_USEDEFAULT;
722
723 if (height != wxDefaultCoord)
724 mcs.cy = height;
725 else
726 mcs.cy = CW_USEDEFAULT;
727
728 DWORD msflags = WS_OVERLAPPED | WS_CLIPCHILDREN;
729 if (style & wxMINIMIZE_BOX)
730 msflags |= WS_MINIMIZEBOX;
731 if (style & wxMAXIMIZE_BOX)
732 msflags |= WS_MAXIMIZEBOX;
733 if (style & wxTHICK_FRAME)
734 msflags |= WS_THICKFRAME;
735 if (style & wxSYSTEM_MENU)
736 msflags |= WS_SYSMENU;
737 if ((style & wxMINIMIZE) || (style & wxICONIZE))
738 msflags |= WS_MINIMIZE;
739 if (style & wxMAXIMIZE)
740 msflags |= WS_MAXIMIZE;
741 if (style & wxCAPTION)
742 msflags |= WS_CAPTION;
743
744 mcs.style = msflags;
745
746 mcs.lParam = 0;
747
748 wxWindowCreationHook hook(this);
749
750 m_hWnd = (WXHWND)::SendMessage(GetWinHwnd(parent->GetClientWindow()),
751 WM_MDICREATE, 0, (LONG)(LPSTR)&mcs);
752
753 wxAssociateWinWithHandle((HWND) GetHWND(), this);
754
755 return true;
756 }
757
758 wxMDIChildFrame::~wxMDIChildFrame()
759 {
760 // will be destroyed by DestroyChildren() but reset them before calling it
761 // to avoid using dangling pointers if a callback comes in the meanwhile
762 #if wxUSE_TOOLBAR
763 m_frameToolBar = NULL;
764 #endif
765 #if wxUSE_STATUSBAR
766 m_frameStatusBar = NULL;
767 #endif // wxUSE_STATUSBAR
768
769 DestroyChildren();
770
771 RemoveWindowMenu(NULL, m_hMenu);
772
773 MSWDestroyWindow();
774 }
775
776 bool wxMDIChildFrame::Show(bool show)
777 {
778 m_needsInitialShow = false;
779 return wxFrame::Show(show);
780 }
781
782 // Set the client size (i.e. leave the calculation of borders etc.
783 // to wxWidgets)
784 void wxMDIChildFrame::DoSetClientSize(int width, int height)
785 {
786 HWND hWnd = GetHwnd();
787
788 RECT rect;
789 ::GetClientRect(hWnd, &rect);
790
791 RECT rect2;
792 GetWindowRect(hWnd, &rect2);
793
794 // Find the difference between the entire window (title bar and all)
795 // and the client area; add this to the new client size to move the
796 // window
797 int actual_width = rect2.right - rect2.left - rect.right + width;
798 int actual_height = rect2.bottom - rect2.top - rect.bottom + height;
799
800 #if wxUSE_STATUSBAR
801 if (GetStatusBar() && GetStatusBar()->IsShown())
802 {
803 int sx, sy;
804 GetStatusBar()->GetSize(&sx, &sy);
805 actual_height += sy;
806 }
807 #endif // wxUSE_STATUSBAR
808
809 POINT point;
810 point.x = rect2.left;
811 point.y = rect2.top;
812
813 // If there's an MDI parent, must subtract the parent's top left corner
814 // since MoveWindow moves relative to the parent
815 wxMDIParentFrame *mdiParent = (wxMDIParentFrame *)GetParent();
816 ::ScreenToClient((HWND) mdiParent->GetClientWindow()->GetHWND(), &point);
817
818 MoveWindow(hWnd, point.x, point.y, actual_width, actual_height, (BOOL)true);
819
820 wxSize size(width, height);
821 wxSizeEvent event(size, m_windowId);
822 event.SetEventObject( this );
823 GetEventHandler()->ProcessEvent(event);
824 }
825
826 void wxMDIChildFrame::DoGetPosition(int *x, int *y) const
827 {
828 RECT rect;
829 GetWindowRect(GetHwnd(), &rect);
830 POINT point;
831 point.x = rect.left;
832 point.y = rect.top;
833
834 // Since we now have the absolute screen coords,
835 // if there's a parent we must subtract its top left corner
836 wxMDIParentFrame *mdiParent = (wxMDIParentFrame *)GetParent();
837 ::ScreenToClient((HWND) mdiParent->GetClientWindow()->GetHWND(), &point);
838
839 *x = point.x;
840 *y = point.y;
841 }
842
843 void wxMDIChildFrame::InternalSetMenuBar()
844 {
845 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
846
847 InsertWindowMenu(parent->GetClientWindow(),
848 m_hMenu, GetMDIWindowMenu(parent));
849
850 parent->m_parentFrameActive = false;
851 }
852
853 WXHICON wxMDIChildFrame::GetDefaultIcon() const
854 {
855 // we don't have any standard icons (any more)
856 return (WXHICON)0;
857 }
858
859 // ---------------------------------------------------------------------------
860 // MDI operations
861 // ---------------------------------------------------------------------------
862
863 void wxMDIChildFrame::Maximize(bool maximize)
864 {
865 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
866 if ( parent && parent->GetClientWindow() )
867 {
868 ::SendMessage(GetWinHwnd(parent->GetClientWindow()),
869 maximize ? WM_MDIMAXIMIZE : WM_MDIRESTORE,
870 (WPARAM)GetHwnd(), 0);
871 }
872 }
873
874 void wxMDIChildFrame::Restore()
875 {
876 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
877 if ( parent && parent->GetClientWindow() )
878 {
879 ::SendMessage(GetWinHwnd(parent->GetClientWindow()), WM_MDIRESTORE,
880 (WPARAM) GetHwnd(), 0);
881 }
882 }
883
884 void wxMDIChildFrame::Activate()
885 {
886 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
887 if ( parent && parent->GetClientWindow() )
888 {
889 ::SendMessage(GetWinHwnd(parent->GetClientWindow()), WM_MDIACTIVATE,
890 (WPARAM) GetHwnd(), 0);
891 }
892 }
893
894 // ---------------------------------------------------------------------------
895 // MDI window proc and message handlers
896 // ---------------------------------------------------------------------------
897
898 WXLRESULT wxMDIChildFrame::MSWWindowProc(WXUINT message,
899 WXWPARAM wParam,
900 WXLPARAM lParam)
901 {
902 WXLRESULT rc = 0;
903 bool processed = false;
904
905 switch ( message )
906 {
907 case WM_COMMAND:
908 {
909 WORD id, cmd;
910 WXHWND hwnd;
911 UnpackCommand((WXWPARAM)wParam, (WXLPARAM)lParam,
912 &id, &hwnd, &cmd);
913
914 processed = HandleCommand(id, cmd, (WXHWND)hwnd);
915 }
916 break;
917
918 case WM_GETMINMAXINFO:
919 processed = HandleGetMinMaxInfo((MINMAXINFO *)lParam);
920 break;
921
922 case WM_MDIACTIVATE:
923 {
924 WXWORD act;
925 WXHWND hwndAct, hwndDeact;
926 UnpackMDIActivate(wParam, lParam, &act, &hwndAct, &hwndDeact);
927
928 processed = HandleMDIActivate(act, hwndAct, hwndDeact);
929 }
930 // fall through
931
932 case WM_MOVE:
933 // must pass WM_MOVE to DefMDIChildProc() to recalculate MDI client
934 // scrollbars if necessary
935
936 // fall through
937
938 case WM_SIZE:
939 // must pass WM_SIZE to DefMDIChildProc(), otherwise many weird
940 // things happen
941 MSWDefWindowProc(message, wParam, lParam);
942 break;
943
944 case WM_SYSCOMMAND:
945 // DefMDIChildProc handles SC_{NEXT/PREV}WINDOW here, so pass it
946 // the message (the base class version does not)
947 return MSWDefWindowProc(message, wParam, lParam);
948
949 case WM_WINDOWPOSCHANGING:
950 processed = HandleWindowPosChanging((LPWINDOWPOS)lParam);
951 break;
952 }
953
954 if ( !processed )
955 rc = wxFrame::MSWWindowProc(message, wParam, lParam);
956
957 return rc;
958 }
959
960 bool wxMDIChildFrame::HandleCommand(WXWORD id, WXWORD cmd, WXHWND hwnd)
961 {
962 // In case it's e.g. a toolbar.
963 if ( hwnd )
964 {
965 wxWindow *win = wxFindWinFromHandle(hwnd);
966 if (win)
967 return win->MSWCommand(cmd, id);
968 }
969
970 if (wxCurrentPopupMenu)
971 {
972 wxMenu *popupMenu = wxCurrentPopupMenu;
973 wxCurrentPopupMenu = NULL;
974 if (popupMenu->MSWCommand(cmd, id))
975 return true;
976 }
977
978 bool processed;
979 if (GetMenuBar() && GetMenuBar()->FindItem(id))
980 {
981 processed = ProcessCommand(id);
982 }
983 else
984 {
985 processed = false;
986 }
987
988 return processed;
989 }
990
991 bool wxMDIChildFrame::HandleMDIActivate(long WXUNUSED(activate),
992 WXHWND hwndAct,
993 WXHWND hwndDeact)
994 {
995 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
996
997 HMENU menuToSet = 0;
998
999 bool activated;
1000
1001 if ( m_hWnd == hwndAct )
1002 {
1003 activated = true;
1004 parent->m_currentChild = this;
1005
1006 HMENU child_menu = (HMENU)GetWinMenu();
1007 if ( child_menu )
1008 {
1009 parent->m_parentFrameActive = false;
1010
1011 menuToSet = child_menu;
1012 }
1013 }
1014 else if ( m_hWnd == hwndDeact )
1015 {
1016 wxASSERT_MSG( parent->m_currentChild == this,
1017 wxT("can't deactivate MDI child which wasn't active!") );
1018
1019 activated = false;
1020 parent->m_currentChild = NULL;
1021
1022 HMENU parent_menu = (HMENU)parent->GetWinMenu();
1023
1024 // activate the the parent menu only when there is no other child
1025 // that has been activated
1026 if ( parent_menu && !hwndAct )
1027 {
1028 parent->m_parentFrameActive = true;
1029
1030 menuToSet = parent_menu;
1031 }
1032 }
1033 else
1034 {
1035 // we have nothing to do with it
1036 return false;
1037 }
1038
1039 if ( menuToSet )
1040 {
1041 MDISetMenu(parent->GetClientWindow(),
1042 menuToSet, GetMDIWindowMenu(parent));
1043 }
1044
1045 wxActivateEvent event(wxEVT_ACTIVATE, activated, m_windowId);
1046 event.SetEventObject( this );
1047
1048 ResetWindowStyle((void *)NULL);
1049
1050 return GetEventHandler()->ProcessEvent(event);
1051 }
1052
1053 bool wxMDIChildFrame::HandleWindowPosChanging(void *pos)
1054 {
1055 WINDOWPOS *lpPos = (WINDOWPOS *)pos;
1056 #if defined(__WIN95__)
1057 if (!(lpPos->flags & SWP_NOSIZE))
1058 {
1059 RECT rectClient;
1060 DWORD dwExStyle = ::GetWindowLong(GetHwnd(), GWL_EXSTYLE);
1061 DWORD dwStyle = ::GetWindowLong(GetHwnd(), GWL_STYLE);
1062 if (ResetWindowStyle((void *) & rectClient) && (dwStyle & WS_MAXIMIZE))
1063 {
1064 ::AdjustWindowRectEx(&rectClient, dwStyle, false, dwExStyle);
1065 lpPos->x = rectClient.left;
1066 lpPos->y = rectClient.top;
1067 lpPos->cx = rectClient.right - rectClient.left;
1068 lpPos->cy = rectClient.bottom - rectClient.top;
1069 }
1070 #if wxUSE_TOOLBAR
1071 wxMDIParentFrame* pFrameWnd = (wxMDIParentFrame *)GetParent();
1072 if (pFrameWnd && pFrameWnd->GetToolBar() && pFrameWnd->GetToolBar()->IsShown())
1073 {
1074 pFrameWnd->GetToolBar()->Refresh();
1075 }
1076 #endif
1077 }
1078 #endif // Win95
1079
1080 return false;
1081 }
1082
1083 bool wxMDIChildFrame::HandleGetMinMaxInfo(void *mmInfo)
1084 {
1085 MINMAXINFO *info = (MINMAXINFO *)mmInfo;
1086
1087 // let the default window proc calculate the size of MDI children
1088 // frames because it is based on the size of the MDI client window,
1089 // not on the values specified in wxWindow m_max variables
1090 bool processed = MSWDefWindowProc(WM_GETMINMAXINFO, 0, (LPARAM)mmInfo) != 0;
1091
1092 int minWidth = GetMinWidth(),
1093 minHeight = GetMinHeight();
1094
1095 // but allow GetSizeHints() to set the min size
1096 if ( minWidth != -1 )
1097 {
1098 info->ptMinTrackSize.x = minWidth;
1099
1100 processed = true;
1101 }
1102
1103 if ( minHeight != -1 )
1104 {
1105 info->ptMinTrackSize.y = minHeight;
1106
1107 processed = true;
1108 }
1109
1110 return processed;
1111 }
1112
1113 // ---------------------------------------------------------------------------
1114 // MDI specific message translation/preprocessing
1115 // ---------------------------------------------------------------------------
1116
1117 WXLRESULT wxMDIChildFrame::MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
1118 {
1119 return DefMDIChildProc(GetHwnd(),
1120 (UINT)message, (WPARAM)wParam, (LPARAM)lParam);
1121 }
1122
1123 bool wxMDIChildFrame::MSWTranslateMessage(WXMSG* msg)
1124 {
1125 return wxFrame::MSWTranslateMessage(msg);
1126 }
1127
1128 // ---------------------------------------------------------------------------
1129 // misc
1130 // ---------------------------------------------------------------------------
1131
1132 void wxMDIChildFrame::MSWDestroyWindow()
1133 {
1134 invalidHandle = GetHwnd();
1135
1136 wxMDIParentFrame *parent = (wxMDIParentFrame *)GetParent();
1137
1138 // Must make sure this handle is invalidated (set to NULL) since all sorts
1139 // of things could happen after the child client is destroyed, but before
1140 // the wxFrame is destroyed.
1141
1142 HWND oldHandle = (HWND)GetHWND();
1143 SendMessage(GetWinHwnd(parent->GetClientWindow()), WM_MDIDESTROY,
1144 (WPARAM)oldHandle, 0);
1145
1146 if (parent->GetActiveChild() == (wxMDIChildFrame*) NULL)
1147 ResetWindowStyle((void*) NULL);
1148
1149 invalidHandle = 0;
1150
1151 if (m_hMenu)
1152 {
1153 ::DestroyMenu((HMENU) m_hMenu);
1154 m_hMenu = 0;
1155 }
1156 wxRemoveHandleAssociation(this);
1157 m_hWnd = 0;
1158 }
1159
1160 // Change the client window's extended style so we don't get a client edge
1161 // style when a child is maximised (a double border looks silly.)
1162 bool wxMDIChildFrame::ResetWindowStyle(void *vrect)
1163 {
1164 #if defined(__WIN95__)
1165 RECT *rect = (RECT *)vrect;
1166 wxMDIParentFrame* pFrameWnd = (wxMDIParentFrame *)GetParent();
1167 wxMDIChildFrame* pChild = pFrameWnd->GetActiveChild();
1168 if (!pChild || (pChild == this))
1169 {
1170 HWND hwndClient = GetWinHwnd(pFrameWnd->GetClientWindow());
1171 DWORD dwStyle = ::GetWindowLong(hwndClient, GWL_EXSTYLE);
1172
1173 // we want to test whether there is a maximized child, so just set
1174 // dwThisStyle to 0 if there is no child at all
1175 DWORD dwThisStyle = pChild
1176 ? ::GetWindowLong(GetWinHwnd(pChild), GWL_STYLE) : 0;
1177 DWORD dwNewStyle = dwStyle;
1178 if ( dwThisStyle & WS_MAXIMIZE )
1179 dwNewStyle &= ~(WS_EX_CLIENTEDGE);
1180 else
1181 dwNewStyle |= WS_EX_CLIENTEDGE;
1182
1183 if (dwStyle != dwNewStyle)
1184 {
1185 // force update of everything
1186 ::RedrawWindow(hwndClient, NULL, NULL,
1187 RDW_INVALIDATE | RDW_ALLCHILDREN);
1188 ::SetWindowLong(hwndClient, GWL_EXSTYLE, dwNewStyle);
1189 ::SetWindowPos(hwndClient, NULL, 0, 0, 0, 0,
1190 SWP_FRAMECHANGED | SWP_NOACTIVATE |
1191 SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER |
1192 SWP_NOCOPYBITS);
1193 if (rect)
1194 ::GetClientRect(hwndClient, rect);
1195
1196 return true;
1197 }
1198 }
1199 #endif // Win95
1200
1201 return false;
1202 }
1203
1204 // ===========================================================================
1205 // wxMDIClientWindow: the window of predefined (by Windows) class which
1206 // contains the child frames
1207 // ===========================================================================
1208
1209 bool wxMDIClientWindow::CreateClient(wxMDIParentFrame *parent, long style)
1210 {
1211 m_backgroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_APPWORKSPACE);
1212
1213 CLIENTCREATESTRUCT ccs;
1214 m_windowStyle = style;
1215 m_parent = parent;
1216
1217 ccs.hWindowMenu = GetMDIWindowMenu(parent);
1218 ccs.idFirstChild = wxFIRST_MDI_CHILD;
1219
1220 DWORD msStyle = MDIS_ALLCHILDSTYLES | WS_VISIBLE | WS_CHILD |
1221 WS_CLIPCHILDREN | WS_CLIPSIBLINGS;
1222
1223 if ( style & wxHSCROLL )
1224 msStyle |= WS_HSCROLL;
1225 if ( style & wxVSCROLL )
1226 msStyle |= WS_VSCROLL;
1227
1228 #if defined(__WIN95__)
1229 DWORD exStyle = WS_EX_CLIENTEDGE;
1230 #else
1231 DWORD exStyle = 0;
1232 #endif
1233
1234 wxWindowCreationHook hook(this);
1235 m_hWnd = (WXHWND)::CreateWindowEx
1236 (
1237 exStyle,
1238 wxT("MDICLIENT"),
1239 NULL,
1240 msStyle,
1241 0, 0, 0, 0,
1242 GetWinHwnd(parent),
1243 NULL,
1244 wxGetInstance(),
1245 (LPSTR)(LPCLIENTCREATESTRUCT)&ccs);
1246 if ( !m_hWnd )
1247 {
1248 wxLogLastError(wxT("CreateWindowEx(MDI client)"));
1249
1250 return false;
1251 }
1252
1253 SubclassWin(m_hWnd);
1254
1255 return true;
1256 }
1257
1258 // Explicitly call default scroll behaviour
1259 void wxMDIClientWindow::OnScroll(wxScrollEvent& event)
1260 {
1261 // Note: for client windows, the scroll position is not set in
1262 // WM_HSCROLL, WM_VSCROLL, so we can't easily determine what
1263 // scroll position we're at.
1264 // This makes it hard to paint patterns or bitmaps in the background,
1265 // and have the client area scrollable as well.
1266
1267 if ( event.GetOrientation() == wxHORIZONTAL )
1268 m_scrollX = event.GetPosition(); // Always returns zero!
1269 else
1270 m_scrollY = event.GetPosition(); // Always returns zero!
1271
1272 event.Skip();
1273 }
1274
1275 void wxMDIClientWindow::DoSetSize(int x, int y, int width, int height, int sizeFlags)
1276 {
1277 // Try to fix a problem whereby if you show an MDI child frame, then reposition the
1278 // client area, you can end up with a non-refreshed portion in the client window
1279 // (see OGL studio sample). So check if the position is changed and if so,
1280 // redraw the MDI child frames.
1281
1282 wxPoint oldPos = GetPosition();
1283
1284 wxWindow::DoSetSize(x, y, width, height, sizeFlags);
1285
1286 wxPoint newPos = GetPosition();
1287
1288 if ((newPos.x != oldPos.x) || (newPos.y != oldPos.y))
1289 {
1290 if (GetParent())
1291 {
1292 wxWindowList::compatibility_iterator node = GetParent()->GetChildren().GetFirst();
1293 while (node)
1294 {
1295 wxWindow *child = node->GetData();
1296 if (child->IsKindOf(CLASSINFO(wxMDIChildFrame)))
1297 {
1298 ::RedrawWindow(GetHwndOf(child),
1299 NULL,
1300 NULL,
1301 RDW_FRAME |
1302 RDW_ALLCHILDREN |
1303 RDW_INVALIDATE);
1304 }
1305 node = node->GetNext();
1306 }
1307 }
1308 }
1309 }
1310
1311 void wxMDIChildFrame::OnIdle(wxIdleEvent& event)
1312 {
1313 // wxMSW prior to 2.5.3 created MDI child frames as visible, which resulted
1314 // in flicker e.g. when the frame contained controls with non-trivial
1315 // layout. Since 2.5.3, the frame is created hidden as all other top level
1316 // windows. In order to maintain backward compatibility, the frame is shown
1317 // in OnIdle, unless Show(false) was called by the programmer before.
1318 if ( m_needsInitialShow )
1319 {
1320 Show(true);
1321 }
1322
1323 // MDI child frames get their WM_SIZE when they're constructed but at this
1324 // moment they don't have any children yet so all child windows will be
1325 // positioned incorrectly when they are added later - to fix this, we
1326 // generate an artificial size event here
1327 if ( m_needsResize )
1328 {
1329 m_needsResize = false; // avoid any possibility of recursion
1330
1331 SendSizeEvent();
1332 }
1333
1334 event.Skip();
1335 }
1336
1337 // ---------------------------------------------------------------------------
1338 // non member functions
1339 // ---------------------------------------------------------------------------
1340
1341 static void MDISetMenu(wxWindow *win, HMENU hmenuFrame, HMENU hmenuWindow)
1342 {
1343 ::SendMessage(GetWinHwnd(win), WM_MDISETMENU,
1344 #ifdef __WIN32__
1345 (WPARAM)hmenuFrame, (LPARAM)hmenuWindow
1346 #else
1347 0, MAKELPARAM(hmenuFrame, hmenuWindow)
1348 #endif
1349 );
1350
1351 // update menu bar of the parent window
1352 wxWindow *parent = win->GetParent();
1353 wxCHECK_RET( parent, wxT("MDI client without parent frame? weird...") );
1354
1355 ::SendMessage(GetWinHwnd(win), WM_MDIREFRESHMENU, 0, 0L);
1356
1357 ::DrawMenuBar(GetWinHwnd(parent));
1358 }
1359
1360 static void InsertWindowMenu(wxWindow *win, WXHMENU menu, HMENU subMenu)
1361 {
1362 // Try to insert Window menu in front of Help, otherwise append it.
1363 HMENU hmenu = (HMENU)menu;
1364
1365 if (subMenu)
1366 {
1367 int N = GetMenuItemCount(hmenu);
1368 bool success = false;
1369 for ( int i = 0; i < N; i++ )
1370 {
1371 wxChar buf[256];
1372 int chars = GetMenuString(hmenu, i, buf, WXSIZEOF(buf), MF_BYPOSITION);
1373 if ( chars == 0 )
1374 {
1375 wxLogLastError(wxT("GetMenuString"));
1376
1377 continue;
1378 }
1379
1380 if ( wxStripMenuCodes(wxString(buf)).IsSameAs(_("Help")) )
1381 {
1382 success = true;
1383 ::InsertMenu(hmenu, i, MF_BYPOSITION | MF_POPUP | MF_STRING,
1384 (UINT)subMenu, _("&Window"));
1385 break;
1386 }
1387 }
1388
1389 if ( !success )
1390 {
1391 ::AppendMenu(hmenu, MF_POPUP, (UINT)subMenu, _("&Window"));
1392 }
1393 }
1394
1395 MDISetMenu(win, hmenu, subMenu);
1396 }
1397
1398 static void RemoveWindowMenu(wxWindow *win, WXHMENU menu)
1399 {
1400 HMENU hMenu = (HMENU)menu;
1401
1402 if ( hMenu )
1403 {
1404 wxChar buf[1024];
1405
1406 int N = ::GetMenuItemCount(hMenu);
1407 for ( int i = 0; i < N; i++ )
1408 {
1409 if ( !::GetMenuString(hMenu, i, buf, WXSIZEOF(buf), MF_BYPOSITION) )
1410 {
1411 // Ignore successful read of menu string with length 0 which
1412 // occurs, for example, for a maximized MDI childs system menu
1413 if ( ::GetLastError() != 0 )
1414 {
1415 wxLogLastError(wxT("GetMenuString"));
1416 }
1417
1418 continue;
1419 }
1420
1421 if ( wxStrcmp(buf, _("&Window")) == 0 )
1422 {
1423 if ( !::RemoveMenu(hMenu, i, MF_BYPOSITION) )
1424 {
1425 wxLogLastError(wxT("RemoveMenu"));
1426 }
1427
1428 break;
1429 }
1430 }
1431 }
1432
1433 if ( win )
1434 {
1435 // we don't change the windows menu, but we update the main one
1436 MDISetMenu(win, hMenu, NULL);
1437 }
1438 }
1439
1440 static void UnpackMDIActivate(WXWPARAM wParam, WXLPARAM lParam,
1441 WXWORD *activate, WXHWND *hwndAct, WXHWND *hwndDeact)
1442 {
1443 *activate = true;
1444 *hwndAct = (WXHWND)lParam;
1445 *hwndDeact = (WXHWND)wParam;
1446 }
1447
1448 #endif // wxUSE_MDI && !defined(__WXUNIVERSAL__)
1449