]> git.saurik.com Git - wxWidgets.git/blob - src/motif/mdi.cpp
Rewritten wxList docs
[wxWidgets.git] / src / motif / mdi.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/motif/mdi.cpp
3 // Purpose: MDI classes
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 17/09/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // For compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
14
15 #ifdef __VMS
16 #define XtDisplay XTDISPLAY
17 #define XtWindow XTWINDOW
18 #endif
19
20 #include "wx/mdi.h"
21
22 #ifndef WX_PRECOMP
23 #include "wx/menu.h"
24 #include "wx/icon.h"
25 #include "wx/settings.h"
26 #endif
27
28 #ifdef __VMS__
29 #pragma message disable nosimpint
30 #endif
31 #include <Xm/Xm.h>
32 #include <Xm/BulletinB.h>
33 #include <Xm/Form.h>
34 #include <Xm/MainW.h>
35 #include <Xm/RowColumn.h>
36 #include <Xm/CascadeBG.h>
37 #include <Xm/Text.h>
38 #include <Xm/PushBG.h>
39 #include <Xm/AtomMgr.h>
40 #include <Xm/Protocols.h>
41 #ifdef __VMS__
42 #pragma message enable nosimpint
43 #endif
44
45 #include "wx/motif/private.h"
46
47 extern wxList wxModelessWindows;
48
49 // Implemented in frame.cpp
50 extern void wxFrameFocusProc(Widget workArea, XtPointer clientData,
51 XmAnyCallbackStruct *cbs);
52
53 #define wxID_NOTEBOOK_CLIENT_AREA wxID_HIGHEST + 100
54
55 IMPLEMENT_DYNAMIC_CLASS(wxMDIParentFrame, wxFrame)
56 IMPLEMENT_DYNAMIC_CLASS(wxMDIChildFrame, wxFrame)
57 IMPLEMENT_DYNAMIC_CLASS(wxMDIClientWindow, wxNotebook)
58
59 BEGIN_EVENT_TABLE(wxMDIParentFrame, wxFrame)
60 EVT_SIZE(wxMDIParentFrame::OnSize)
61 EVT_ACTIVATE(wxMDIParentFrame::OnActivate)
62 EVT_SYS_COLOUR_CHANGED(wxMDIParentFrame::OnSysColourChanged)
63 EVT_MENU_HIGHLIGHT_ALL(wxMDIParentFrame::OnMenuHighlight)
64 END_EVENT_TABLE()
65
66 BEGIN_EVENT_TABLE(wxMDIClientWindow, wxNotebook)
67 EVT_SCROLL(wxMDIClientWindow::OnScroll)
68 EVT_NOTEBOOK_PAGE_CHANGED(wxID_NOTEBOOK_CLIENT_AREA, wxMDIClientWindow::OnPageChanged)
69 END_EVENT_TABLE()
70
71
72 // Parent frame
73
74 wxMDIParentFrame::wxMDIParentFrame()
75 {
76 m_clientWindow = (wxMDIClientWindow*) NULL;
77 m_activeChild = (wxMDIChildFrame*) NULL;
78 m_activeMenuBar = (wxMenuBar*) NULL;
79 }
80
81 bool wxMDIParentFrame::Create(wxWindow *parent,
82 wxWindowID id,
83 const wxString& title,
84 const wxPoint& pos,
85 const wxSize& size,
86 long style,
87 const wxString& name)
88 {
89 m_clientWindow = (wxMDIClientWindow*) NULL;
90 m_activeChild = (wxMDIChildFrame*) NULL;
91 m_activeMenuBar = (wxMenuBar*) NULL;
92
93 bool success = wxFrame::Create(parent, id, title, pos, size, style, name);
94 if (success)
95 {
96 // TODO: app cannot override OnCreateClient since
97 // wxMDIParentFrame::OnCreateClient will still be called
98 // (we're in the constructor). How to resolve?
99
100 m_clientWindow = OnCreateClient();
101
102 // Uses own style for client style
103 m_clientWindow->CreateClient(this, GetWindowStyleFlag());
104
105 int w, h;
106 GetClientSize(& w, & h);
107 m_clientWindow->SetSize(0, 0, w, h);
108 return true;
109 }
110 else
111 return false;
112 }
113
114 wxMDIParentFrame::~wxMDIParentFrame()
115 {
116 // Make sure we delete the client window last of all
117 RemoveChild(m_clientWindow);
118
119 DestroyChildren();
120
121 delete m_clientWindow;
122 m_clientWindow = NULL;
123 }
124
125 void wxMDIParentFrame::SetMenuBar(wxMenuBar *menu_bar)
126 {
127 m_frameMenuBar = menu_bar;
128
129 SetChildMenuBar((wxMDIChildFrame*) NULL);
130 }
131
132 void wxMDIParentFrame::OnSize(wxSizeEvent& WXUNUSED(event))
133 {
134 #if wxUSE_CONSTRAINTS
135 if (GetAutoLayout())
136 Layout();
137 #endif
138 int x = 0;
139 int y = 0;
140 int width, height;
141 GetClientSize(&width, &height);
142
143 if ( GetClientWindow() )
144 GetClientWindow()->SetSize(x, y, width, height);
145 }
146
147 void wxMDIParentFrame::DoGetClientSize(int *width, int *height) const
148 {
149 wxFrame::DoGetClientSize(width, height);
150 }
151
152 void wxMDIParentFrame::OnActivate(wxActivateEvent& WXUNUSED(event))
153 {
154 // Do nothing
155 }
156
157 // Returns the active MDI child window
158 wxMDIChildFrame *wxMDIParentFrame::GetActiveChild() const
159 {
160 return m_activeChild;
161 }
162
163 // Create the client window class (don't Create the window,
164 // just return a new class)
165 wxMDIClientWindow *wxMDIParentFrame::OnCreateClient()
166 {
167 return new wxMDIClientWindow ;
168 }
169
170 // Set the child's menu into the parent frame
171 void wxMDIParentFrame::SetChildMenuBar(wxMDIChildFrame* child)
172 {
173 wxMenuBar* oldMenuBar = m_activeMenuBar;
174
175 if (child == (wxMDIChildFrame*) NULL) // No child: use parent frame
176 {
177 if (GetMenuBar() && (GetMenuBar() != m_activeMenuBar))
178 {
179 // if (m_activeMenuBar)
180 // m_activeMenuBar->DestroyMenuBar();
181
182 m_activeMenuBar = GetMenuBar();
183 m_activeMenuBar->CreateMenuBar(this);
184 /*
185 if (oldMenuBar && XtIsManaged((Widget) oldMenuBar->GetMainWidget()))
186 XtUnmanageChild((Widget) oldMenuBar->GetMainWidget());
187 */
188 if (oldMenuBar && oldMenuBar->GetMainWidget())
189 XtUnmapWidget((Widget) oldMenuBar->GetMainWidget());
190
191 }
192 }
193 else if (child->GetMenuBar() == (wxMenuBar*) NULL) // No child menu bar: use parent frame
194 {
195 if (GetMenuBar() && (GetMenuBar() != m_activeMenuBar))
196 {
197 // if (m_activeMenuBar)
198 // m_activeMenuBar->DestroyMenuBar();
199 m_activeMenuBar = GetMenuBar();
200 m_activeMenuBar->CreateMenuBar(this);
201 /*
202 if (oldMenuBar && XtIsManaged((Widget) oldMenuBar->GetMainWidget()))
203 XtUnmanageChild((Widget) oldMenuBar->GetMainWidget());
204 */
205 if (oldMenuBar && oldMenuBar->GetMainWidget())
206 XtUnmapWidget((Widget) oldMenuBar->GetMainWidget());
207 }
208 }
209 else // The child has a menubar
210 {
211 if (child->GetMenuBar() != m_activeMenuBar)
212 {
213 // if (m_activeMenuBar)
214 // m_activeMenuBar->DestroyMenuBar();
215
216 m_activeMenuBar = child->GetMenuBar();
217 m_activeMenuBar->CreateMenuBar(this);
218 /*
219 if (oldMenuBar && XtIsManaged((Widget) oldMenuBar->GetMainWidget()))
220 XtUnmanageChild((Widget) oldMenuBar->GetMainWidget());
221 */
222 if (oldMenuBar && oldMenuBar->GetMainWidget())
223 XtUnmapWidget((Widget) oldMenuBar->GetMainWidget());
224 }
225 }
226 }
227
228 // Redirect events to active child first
229 bool wxMDIParentFrame::ProcessEvent(wxEvent& event)
230 {
231 // Stops the same event being processed repeatedly
232 static wxEventType inEvent = wxEVT_NULL;
233 if (inEvent == event.GetEventType())
234 return false;
235
236 inEvent = event.GetEventType();
237
238 bool res = false;
239 if (m_activeChild && event.IsKindOf(CLASSINFO(wxCommandEvent)))
240 {
241 res = m_activeChild->GetEventHandler()->ProcessEvent(event);
242 }
243
244 if (!res)
245 res = GetEventHandler()->wxEvtHandler::ProcessEvent(event);
246
247 inEvent = wxEVT_NULL;
248
249 return res;
250 }
251
252 void wxMDIParentFrame::DoSetSize(int x, int y,
253 int width, int height,
254 int sizeFlags)
255 {
256 wxWindow::DoSetSize(x, y, width, height, sizeFlags);
257 }
258
259 void wxMDIParentFrame::DoSetClientSize(int width, int height)
260 {
261 wxWindow::DoSetClientSize(width, height);
262 }
263
264 // Responds to colour changes, and passes event on to children.
265 void wxMDIParentFrame::OnSysColourChanged(wxSysColourChangedEvent& event)
266 {
267 // TODO
268
269 // Propagate the event to the non-top-level children
270 wxFrame::OnSysColourChanged(event);
271 }
272
273 // MDI operations
274 void wxMDIParentFrame::Cascade()
275 {
276 // TODO
277 }
278
279 void wxMDIParentFrame::Tile(wxOrientation WXUNUSED(orient))
280 {
281 // TODO
282 }
283
284 void wxMDIParentFrame::ArrangeIcons()
285 {
286 // TODO
287 }
288
289 void wxMDIParentFrame::ActivateNext()
290 {
291 // TODO
292 }
293
294 void wxMDIParentFrame::ActivatePrevious()
295 {
296 // TODO
297 }
298
299 // Default menu selection behaviour - display a help string
300 void wxMDIParentFrame::OnMenuHighlight(wxMenuEvent& event)
301 {
302 if (GetStatusBar())
303 {
304 if (event.GetMenuId() == -1)
305 SetStatusText(wxEmptyString);
306 else
307 {
308 wxMenuBar *menuBar = (wxMenuBar*) NULL;
309 if (GetActiveChild())
310 menuBar = GetActiveChild()->GetMenuBar();
311 else
312 menuBar = GetMenuBar();
313 if (menuBar)
314 {
315 wxString helpString(menuBar->GetHelpString(event.GetMenuId()));
316 if (!helpString.empty())
317 SetStatusText(helpString);
318 }
319 }
320 }
321 }
322
323 // Child frame
324
325 wxMDIChildFrame::wxMDIChildFrame()
326 {
327 m_mdiParentFrame = (wxMDIParentFrame*) NULL;
328 }
329
330 bool wxMDIChildFrame::Create(wxMDIParentFrame *parent,
331 wxWindowID id,
332 const wxString& title,
333 const wxPoint& pos,
334 const wxSize& size,
335 long style,
336 const wxString& name)
337 {
338 SetName(name);
339 SetWindowStyleFlag(style);
340
341 if ( id > -1 )
342 m_windowId = id;
343 else
344 m_windowId = (int)NewControlId();
345
346 wxMDIClientWindow* clientWindow = parent->GetClientWindow();
347
348 wxCHECK_MSG( clientWindow, false, "Missing MDI client window." );
349
350 clientWindow->AddChild(this);
351
352 SetMDIParentFrame(parent);
353 PreCreation();
354
355 int width = size.x;
356 int height = size.y;
357 if (width == -1)
358 width = 200; // TODO: give reasonable default
359 if (height == -1)
360 height = 200; // TODO: give reasonable default
361
362 // We're deactivating the old child
363 wxMDIChildFrame* oldActiveChild = parent->GetActiveChild();
364 if (oldActiveChild)
365 {
366 wxActivateEvent event(wxEVT_ACTIVATE, false, oldActiveChild->GetId());
367 event.SetEventObject( oldActiveChild );
368 oldActiveChild->GetEventHandler()->ProcessEvent(event);
369 }
370
371 // This is the currently active child
372 parent->SetActiveChild((wxMDIChildFrame*) this);
373
374 // This time we'll try a bog-standard bulletin board for
375 // the 'frame'. A main window doesn't seem to work.
376
377 m_mainWidget = (WXWidget) XtVaCreateWidget("client",
378 xmBulletinBoardWidgetClass, (Widget) clientWindow->GetTopWidget(),
379 XmNmarginWidth, 0,
380 XmNmarginHeight, 0,
381 /*
382 XmNrightAttachment, XmATTACH_FORM,
383 XmNleftAttachment, XmATTACH_FORM,
384 XmNtopAttachment, XmATTACH_FORM,
385 XmNbottomAttachment, XmATTACH_FORM,
386 */
387 XmNresizePolicy, XmRESIZE_NONE,
388 NULL);
389
390 XtAddEventHandler((Widget) m_mainWidget, ExposureMask,False,
391 wxUniversalRepaintProc, (XtPointer) this);
392
393 PostCreation();
394 AttachWidget (parent, m_mainWidget, (WXWidget) NULL, pos.x, pos.y, size.x, size.y);
395
396 XtManageChild((Widget) m_mainWidget);
397
398 SetTitle(title);
399
400 clientWindow->AddPage(this, title, true);
401 clientWindow->Refresh();
402
403 // Positions the toolbar and status bar -- but we don't have any.
404 // PreResize();
405
406 wxModelessWindows.Append(this);
407 return true;
408 }
409
410
411 wxMDIChildFrame::~wxMDIChildFrame()
412 {
413 if (m_mainWidget)
414 XtRemoveEventHandler((Widget) m_mainWidget, ExposureMask,False,
415 wxUniversalRepaintProc, (XtPointer) this);
416
417 if (GetMDIParentFrame())
418 {
419 wxMDIParentFrame* parentFrame = GetMDIParentFrame();
420
421 if (parentFrame->GetActiveChild() == this)
422 parentFrame->SetActiveChild((wxMDIChildFrame*) NULL);
423 wxMDIClientWindow* clientWindow = parentFrame->GetClientWindow();
424
425 // Remove page if still there
426 {
427 int i = clientWindow->FindPage(this);
428
429 if (i != -1)
430 {
431 clientWindow->RemovePage(i);
432 clientWindow->Refresh();
433 }
434 }
435
436 // Set the selection to the first remaining page
437 if (clientWindow->GetPageCount() > 0)
438 {
439 wxMDIChildFrame* child = (wxMDIChildFrame*) clientWindow->GetPage(0);
440 parentFrame->SetActiveChild(child);
441 parentFrame->SetChildMenuBar(child);
442 }
443 else
444 {
445 parentFrame->SetActiveChild((wxMDIChildFrame*) NULL);
446 parentFrame->SetChildMenuBar((wxMDIChildFrame*) NULL);
447 }
448 }
449 }
450
451 #if 0
452 // Implementation: intercept and act upon raise and lower commands.
453 void wxMDIChildFrame::OnRaise()
454 {
455 wxMDIParentFrame* parentFrame = (wxMDIParentFrame*) GetParent() ;
456 wxMDIChildFrame* oldActiveChild = parentFrame->GetActiveChild();
457 parentFrame->SetActiveChild(this);
458
459 if (oldActiveChild)
460 {
461 wxActivateEvent event(wxEVT_ACTIVATE, false, oldActiveChild->GetId());
462 event.SetEventObject( oldActiveChild );
463 oldActiveChild->GetEventHandler()->ProcessEvent(event);
464 }
465
466 wxActivateEvent event(wxEVT_ACTIVATE, true, this->GetId());
467 event.SetEventObject( this );
468 this->GetEventHandler()->ProcessEvent(event);
469 }
470
471 void wxMDIChildFrame::OnLower()
472 {
473 wxMDIParentFrame* parentFrame = (wxMDIParentFrame*) GetParent() ;
474 wxMDIChildFrame* oldActiveChild = parentFrame->GetActiveChild();
475
476 if (oldActiveChild == this)
477 {
478 wxActivateEvent event(wxEVT_ACTIVATE, false, oldActiveChild->GetId());
479 event.SetEventObject( oldActiveChild );
480 oldActiveChild->GetEventHandler()->ProcessEvent(event);
481 }
482 // TODO: unfortunately we don't now know which is the top-most child,
483 // so make the active child NULL.
484 parentFrame->SetActiveChild((wxMDIChildFrame*) NULL);
485 }
486 #endif
487
488 // Set the client size (i.e. leave the calculation of borders etc.
489 // to wxWidgets)
490 void wxMDIChildFrame::DoSetClientSize(int width, int height)
491 {
492 wxWindow::DoSetClientSize(width, height);
493 }
494
495 void wxMDIChildFrame::DoGetClientSize(int* width, int* height) const
496 {
497 wxWindow::DoGetSize(width, height);
498 }
499
500 void wxMDIChildFrame::DoSetSize(int x, int y, int width, int height, int sizeFlags)
501 {
502 wxWindow::DoSetSize(x, y, width, height, sizeFlags);
503 }
504
505 void wxMDIChildFrame::DoGetSize(int* width, int* height) const
506 {
507 wxWindow::DoGetSize(width, height);
508 }
509
510 void wxMDIChildFrame::DoGetPosition(int *x, int *y) const
511 {
512 wxWindow::DoGetPosition(x, y);
513 }
514
515 bool wxMDIChildFrame::Show(bool show)
516 {
517 SetVisibleStatus( show );
518 return wxWindow::Show(show);
519 }
520
521 void wxMDIChildFrame::SetMenuBar(wxMenuBar *menuBar)
522 {
523 // Don't create the underlying menubar yet; need to recreate
524 // it every time the child is activated.
525 m_frameMenuBar = menuBar;
526
527 // We make the assumption that if you're setting the menubar,
528 // this is the currently active child.
529 GetMDIParentFrame()->SetChildMenuBar(this);
530 }
531
532 // Set icon
533 void wxMDIChildFrame::SetIcon(const wxIcon& icon)
534 {
535 m_icons = wxIconBundle( icon );
536
537 if (icon.Ok())
538 {
539 // Not appropriate since there are no icons in
540 // a tabbed window
541 }
542 }
543
544 void wxMDIChildFrame::SetIcons(const wxIconBundle& icons)
545 {
546 m_icons = icons;
547 }
548
549 void wxMDIChildFrame::SetTitle(const wxString& title)
550 {
551 wxTopLevelWindow::SetTitle( title );
552 wxMDIClientWindow* clientWindow = GetMDIParentFrame()->GetClientWindow();
553
554 // Remove page if still there
555 {
556 int i = clientWindow->FindPage(this);
557
558 if (i != -1)
559 clientWindow->SetPageText(i, title);
560 }
561 }
562
563 // MDI operations
564 void wxMDIChildFrame::Maximize()
565 {
566 // TODO
567 }
568
569 void wxMDIChildFrame::Iconize(bool WXUNUSED(iconize))
570 {
571 // TODO
572 }
573
574 bool wxMDIChildFrame::IsIconized() const
575 {
576 return false;
577 }
578
579 // Is it maximized? Always maximized under Motif, using the
580 // tabbed MDI implementation.
581 bool wxMDIChildFrame::IsMaximized(void) const
582 {
583 return true;
584 }
585
586 void wxMDIChildFrame::Restore()
587 {
588 // TODO
589 }
590
591 void wxMDIChildFrame::Activate()
592 {
593 // TODO
594 }
595
596 void wxMDIChildFrame::CaptureMouse()
597 {
598 wxWindow::CaptureMouse();
599 }
600
601 void wxMDIChildFrame::ReleaseMouse()
602 {
603 wxWindow::ReleaseMouse();
604 }
605
606 void wxMDIChildFrame::Raise()
607 {
608 wxWindow::Raise();
609 }
610
611 void wxMDIChildFrame::Lower(void)
612 {
613 wxWindow::Raise();
614 }
615
616 void wxMDIChildFrame::DoSetSizeHints(int WXUNUSED(minW), int WXUNUSED(minH), int WXUNUSED(maxW), int WXUNUSED(maxH), int WXUNUSED(incW), int WXUNUSED(incH))
617 {
618 }
619
620 // Client window
621
622 wxMDIClientWindow::wxMDIClientWindow()
623 {
624 }
625
626 wxMDIClientWindow::~wxMDIClientWindow()
627 {
628 // By the time this destructor is called, the child frames will have been
629 // deleted and removed from the notebook/client window.
630 DestroyChildren();
631
632 m_mainWidget = (WXWidget) 0;
633 }
634
635 bool wxMDIClientWindow::CreateClient(wxMDIParentFrame *parent, long style)
636 {
637 SetWindowStyleFlag(style);
638
639 bool success = wxNotebook::Create(parent, wxID_NOTEBOOK_CLIENT_AREA, wxPoint(0, 0), wxSize(100, 100), 0);
640 if (success)
641 {
642 return true;
643 }
644 else
645 return false;
646 }
647
648 int wxMDIClientWindow::FindPage(const wxNotebookPage* page)
649 {
650 for (int i = GetPageCount() - 1; i >= 0; --i)
651 {
652 if (GetPage(i) == page)
653 return i;
654 }
655
656 return -1;
657 }
658
659 void wxMDIClientWindow::DoSetSize(int x, int y, int width, int height, int sizeFlags)
660 {
661 wxWindow::DoSetSize(x, y, width, height, sizeFlags);
662 }
663
664 void wxMDIClientWindow::DoSetClientSize(int width, int height)
665 {
666 wxWindow::DoSetClientSize(width, height);
667 }
668
669 void wxMDIClientWindow::DoGetClientSize(int *width, int *height) const
670 {
671 wxWindow::DoGetClientSize(width, height);
672 }
673
674 void wxMDIClientWindow::DoGetSize(int *width, int *height) const
675 {
676 wxWindow::DoGetSize(width, height);
677 }
678
679 void wxMDIClientWindow::DoGetPosition(int *x, int *y) const
680 {
681 wxWindow::DoGetPosition(x, y);
682 }
683
684 void wxMDIClientWindow::OnScroll(wxScrollEvent& event)
685 {
686 // Default(); // Default processing: OBSOLETE FUNCTION
687 event.Skip();
688 }
689
690 void wxMDIClientWindow::OnPageChanged(wxNotebookEvent& event)
691 {
692 // Notify child that it has been activated
693 if (event.GetOldSelection() != -1)
694 {
695 wxMDIChildFrame* oldChild = (wxMDIChildFrame*) GetPage(event.GetOldSelection());
696 if (oldChild)
697 {
698 wxActivateEvent event(wxEVT_ACTIVATE, false, oldChild->GetId());
699 event.SetEventObject( oldChild );
700 oldChild->GetEventHandler()->ProcessEvent(event);
701 }
702 }
703 if (event.GetSelection() != -1)
704 {
705 wxMDIChildFrame* activeChild = (wxMDIChildFrame*) GetPage(event.GetSelection());
706 if (activeChild)
707 {
708 wxActivateEvent event(wxEVT_ACTIVATE, true, activeChild->GetId());
709 event.SetEventObject( activeChild );
710 activeChild->GetEventHandler()->ProcessEvent(event);
711
712 if (activeChild->GetMDIParentFrame())
713 {
714 activeChild->GetMDIParentFrame()->SetActiveChild(activeChild);
715 activeChild->GetMDIParentFrame()->SetChildMenuBar(activeChild);
716 }
717 }
718 }
719 event.Skip();
720 }