src/mac/carbon/mdi.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        mdi.cpp
   3 // Purpose:     MDI classes
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:       wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13 #pragma implementation "mdi.h"
  14 #endif
  15
  16 #include "wx/wxprec.h"
  17
  18 #if wxUSE_MDI
  19
  20 #include "wx/mdi.h"
  21 #include "wx/menu.h"
  22 #include "wx/settings.h"
  23 #include "wx/log.h"
  24
  25 #include "wx/mac/private.h"
  26 #include "wx/mac/uma.h"
  27
  28 extern wxWindowList wxModelessWindows;
  29
  30 IMPLEMENT_DYNAMIC_CLASS(wxMDIParentFrame, wxFrame)
  31 IMPLEMENT_DYNAMIC_CLASS(wxMDIChildFrame, wxFrame)
  32 IMPLEMENT_DYNAMIC_CLASS(wxMDIClientWindow, wxWindow)
  33
  34 BEGIN_EVENT_TABLE(wxMDIParentFrame, wxFrame)
  35   EVT_ACTIVATE(wxMDIParentFrame::OnActivate)
  36   EVT_SYS_COLOUR_CHANGED(wxMDIParentFrame::OnSysColourChanged)
  37 END_EVENT_TABLE()
  38
  39 BEGIN_EVENT_TABLE(wxMDIClientWindow, wxWindow)
  40   EVT_SCROLL(wxMDIClientWindow::OnScroll)
  41 END_EVENT_TABLE()
  42
  43 static const wxChar *TRACE_MDI = _T("mdi");
  44
  45 static const int IDM_WINDOWTILE  = 4001;
  46 static const int IDM_WINDOWTILEHOR  = 4001;
  47 static const int IDM_WINDOWCASCADE = 4002;
  48 static const int IDM_WINDOWICONS = 4003;
  49 static const int IDM_WINDOWNEXT = 4004;
  50 static const int IDM_WINDOWTILEVERT = 4005;
  51 static const int IDM_WINDOWPREV = 4006;
  52
  53 // This range gives a maximum of 500 MDI children. Should be enough :-)
  54 static const int wxFIRST_MDI_CHILD = 4100;
  55 static const int wxLAST_MDI_CHILD = 4600;
  56
  57 // Status border dimensions
  58 static const int wxTHICK_LINE_BORDER = 3;
  59
  60 // ----------------------------------------------------------------------------
  61 // Parent frame
  62 // ----------------------------------------------------------------------------
  63
  64 void wxMDIParentFrame::Init()
  65 {
  66     m_clientWindow = NULL;
  67     m_currentChild = NULL;
  68     m_windowMenu = (wxMenu*) NULL;
  69     m_parentFrameActive = true;
  70     m_shouldBeShown = false;
  71 }
  72
  73 bool wxMDIParentFrame::Create(wxWindow *parent,
  74                               wxWindowID id,
  75                               const wxString& title,
  76                               const wxPoint& pos,
  77                               const wxSize& size,
  78                               long style,
  79                               const wxString& name)
  80 {
  81     // this style can be used to prevent a window from having the standard MDI
  82     // "Window" menu
  83     if ( style & wxFRAME_NO_WINDOW_MENU )
  84     {
  85         m_windowMenu = (wxMenu *)NULL;
  86         style -= wxFRAME_NO_WINDOW_MENU ;
  87     }
  88     else // normal case: we have the window menu, so construct it
  89     {
  90         m_windowMenu = new wxMenu;
  91
  92         m_windowMenu->Append(IDM_WINDOWCASCADE, wxT("&Cascade"));
  93         m_windowMenu->Append(IDM_WINDOWTILEHOR, wxT("Tile &Horizontally"));
  94         m_windowMenu->Append(IDM_WINDOWTILEVERT, wxT("Tile &Vertically"));
  95         m_windowMenu->AppendSeparator();
  96         m_windowMenu->Append(IDM_WINDOWICONS, wxT("&Arrange Icons"));
  97         m_windowMenu->Append(IDM_WINDOWNEXT, wxT("&Next"));
  98     }
  99
 100     wxFrame::Create( parent , id , title , pos , size , style , name ) ;
 101     m_parentFrameActive = true;
 102
 103     OnCreateClient();
 104
 105     return true;
 106 }
 107
 108 wxMDIParentFrame::~wxMDIParentFrame()
 109 {
 110     DestroyChildren();
 111     // already deleted by DestroyChildren()
 112     m_clientWindow = NULL ;
 113
 114     delete m_windowMenu;
 115 }
 116
 117
 118 void wxMDIParentFrame::SetMenuBar(wxMenuBar *menu_bar)
 119 {
 120     wxFrame::SetMenuBar( menu_bar ) ;
 121 }
 122
 123 void wxMDIParentFrame::GetRectForTopLevelChildren(int *x, int *y, int *w, int *h)
 124 {
 125     if(x)
 126         *x = 0;
 127     if(y)
 128         *y = 0;
 129     wxDisplaySize(w,h);
 130 }
 131
 132 void wxMDIParentFrame::AddChild(wxWindowBase *child)
 133 {
 134     if ( !m_currentChild )
 135     {
 136         m_currentChild = wxDynamicCast(child, wxMDIChildFrame);
 137
 138         if ( m_currentChild && IsShown() && ShouldBeVisible() )
 139         {
 140         }
 141     }
 142
 143     wxFrame::AddChild(child);
 144 }
 145
 146 void wxMDIParentFrame::RemoveChild(wxWindowBase *child)
 147 {
 148     if ( child == m_currentChild )
 149     {
 150         // the current child isn't active any more, try to find another one
 151         m_currentChild = NULL;
 152
 153         for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 154               node;
 155               node = node->GetNext() )
 156         {
 157             wxMDIChildFrame *
 158                 childCur = wxDynamicCast(node->GetData(), wxMDIChildFrame);
 159             if ( childCur != child )
 160             {
 161                 m_currentChild = childCur;
 162                 break;
 163             }
 164         }
 165     }
 166
 167     wxFrame::RemoveChild(child);
 168
 169     // if there are no more children left we need to show the frame if we
 170     // hadn't shown it before because there were active children and it was
 171     // useless (note that we have to do it after fully removing the child, i.e.
 172     // after calling the base class RemoveChild() as otherwise we risk to touch
 173     // pointer to the child being deleted)
 174     if ( !m_currentChild && m_shouldBeShown && !IsShown() )
 175     {
 176         // we have to show it, but at least move it out of sight and make it of
 177         // smallest possible size (unfortunately (0, 0) doesn't work so that it
 178         // doesn't appear in expose
 179         SetSize(-10000, -10000, 1, 1);
 180         Show();
 181     }
 182 }
 183
 184 void wxMDIParentFrame::MacActivate(long timestamp, bool activating)
 185 {
 186     wxLogTrace(TRACE_MDI, wxT("MDI PARENT=%p MacActivate(0x%08lx,%s)"),this,timestamp,activating?wxT("ACTIV"):wxT("deact"));
 187     if(activating)
 188     {
 189         if(s_macDeactivateWindow && s_macDeactivateWindow->GetParent()==this)
 190         {
 191             wxLogTrace(TRACE_MDI, wxT("child had been scheduled for deactivation, rehighlighting"));
 192             UMAHighlightAndActivateWindow((WindowRef)s_macDeactivateWindow->MacGetWindowRef(), true);
 193             wxLogTrace(TRACE_MDI, wxT("done highliting child"));
 194             s_macDeactivateWindow = NULL;
 195         }
 196         else if(s_macDeactivateWindow == this)
 197         {
 198             wxLogTrace(TRACE_MDI, wxT("Avoided deactivation/activation of this=%p"), this);
 199             s_macDeactivateWindow = NULL;
 200         }
 201         else // window to deactivate is NULL or is not us or one of our kids
 202         {
 203             // activate kid instead
 204             if(m_currentChild)
 205                 m_currentChild->MacActivate(timestamp,activating);
 206             else
 207                 wxFrame::MacActivate(timestamp,activating);
 208         }
 209     }
 210     else
 211     {
 212         // We were scheduled for deactivation, and now we do it.
 213         if(s_macDeactivateWindow==this)
 214         {
 215             s_macDeactivateWindow = NULL;
 216             if(m_currentChild)
 217                 m_currentChild->MacActivate(timestamp,activating);
 218             wxFrame::MacActivate(timestamp,activating);
 219         }
 220         else // schedule ourselves for deactivation
 221         {
 222             if(s_macDeactivateWindow)
 223                 wxLogTrace(TRACE_MDI, wxT("window=%p SHOULD have been deactivated, oh well!"),s_macDeactivateWindow);
 224             wxLogTrace(TRACE_MDI, wxT("Scheduling delayed MDI Parent deactivation"));
 225             s_macDeactivateWindow = this;
 226         }
 227     }
 228 }
 229
 230 void wxMDIParentFrame::OnActivate(wxActivateEvent& event)
 231 {
 232     event.Skip();
 233 }
 234
 235 // Returns the active MDI child window
 236 wxMDIChildFrame *wxMDIParentFrame::GetActiveChild() const
 237 {
 238     return m_currentChild ;
 239 }
 240
 241 // Create the client window class (don't Create the window,
 242 // just return a new class)
 243 wxMDIClientWindow *wxMDIParentFrame::OnCreateClient()
 244 {
 245     m_clientWindow = new wxMDIClientWindow( this );
 246     return m_clientWindow;
 247 }
 248
 249 // Responds to colour changes, and passes event on to children.
 250 void wxMDIParentFrame::OnSysColourChanged(wxSysColourChangedEvent& event)
 251 {
 252     // TODO
 253
 254     // Propagate the event to the non-top-level children
 255     wxFrame::OnSysColourChanged(event);
 256 }
 257
 258 // MDI operations
 259 void wxMDIParentFrame::Cascade()
 260 {
 261     // TODO
 262 }
 263
 264 void wxMDIParentFrame::Tile(wxOrientation WXUNUSED(orient))
 265 {
 266     // TODO
 267 }
 268
 269 void wxMDIParentFrame::ArrangeIcons()
 270 {
 271     // TODO
 272 }
 273
 274 void wxMDIParentFrame::ActivateNext()
 275 {
 276     // TODO
 277 }
 278
 279 void wxMDIParentFrame::ActivatePrevious()
 280 {
 281     // TODO
 282 }
 283
 284 bool wxMDIParentFrame::ShouldBeVisible() const
 285 {
 286     for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 287           node;
 288           node = node->GetNext() )
 289     {
 290         if ( !wxDynamicCast(node->GetData(), wxMDIChildFrame)
 291 #if wxUSE_STATUSBAR
 292                 && node->GetData() != GetStatusBar()
 293 #endif // wxUSE_STATUSBAR
 294                     && node->GetData() != GetClientWindow() )
 295         {
 296             // if we have a non-MDI child, do remain visible so that it could
 297             // be used
 298             return true;
 299         }
 300     }
 301
 302     return false;
 303 }
 304
 305 bool wxMDIParentFrame::Show( bool show )
 306 {
 307     m_shouldBeShown = false;
 308
 309     // don't really show the MDI frame unless it has any children other than
 310     // MDI children as it is pretty useless in this case
 311
 312     if ( show )
 313     {
 314         if ( !ShouldBeVisible() && m_currentChild )
 315         {
 316             // don't make the window visible now but remember that we should
 317             // have had done it
 318             m_shouldBeShown = true;
 319             return false;
 320         }
 321     }
 322
 323     return wxFrame::Show(show);
 324 }
 325
 326 // ----------------------------------------------------------------------------
 327 // Child frame
 328 // ----------------------------------------------------------------------------
 329
 330 wxMDIChildFrame::wxMDIChildFrame()
 331 {
 332     Init() ;
 333 }
 334 void wxMDIChildFrame::Init()
 335 {
 336 }
 337
 338 bool wxMDIChildFrame::Create(wxMDIParentFrame *parent,
 339                              wxWindowID id,
 340                              const wxString& title,
 341                              const wxPoint& pos,
 342                              const wxSize& size,
 343                              long style,
 344                              const wxString& name)
 345 {
 346     SetName(name);
 347
 348     if ( id > -1 )
 349         m_windowId = id;
 350     else
 351         m_windowId = (int)NewControlId();
 352
 353     if (parent) parent->AddChild(this);
 354
 355     MacCreateRealWindow( title, pos , size , MacRemoveBordersFromStyle(style) , name ) ;
 356
 357     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_APPWORKSPACE));
 358
 359     wxModelessWindows.Append(this);
 360     return false;
 361 }
 362
 363 wxMDIChildFrame::~wxMDIChildFrame()
 364 {
 365     DestroyChildren();
 366 }
 367
 368 void wxMDIChildFrame::SetMenuBar(wxMenuBar *menu_bar)
 369 {
 370     return wxFrame::SetMenuBar( menu_bar ) ;
 371 }
 372
 373 void wxMDIChildFrame::MacActivate(long timestamp, bool activating)
 374 {
 375     wxLogTrace(TRACE_MDI, wxT("MDI child=%p  MacActivate(0x%08lx,%s)"),this,timestamp,activating?wxT("ACTIV"):wxT("deact"));
 376     wxMDIParentFrame *mdiparent = wxDynamicCast(m_parent, wxMDIParentFrame);
 377     wxASSERT(mdiparent);
 378     if(activating)
 379     {
 380         if(s_macDeactivateWindow == m_parent)
 381         {
 382             wxLogTrace(TRACE_MDI, wxT("parent had been scheduled for deactivation, rehighlighting"));
 383             UMAHighlightAndActivateWindow((WindowRef)s_macDeactivateWindow->MacGetWindowRef(), true);
 384             wxLogTrace(TRACE_MDI, wxT("done highliting parent"));
 385             s_macDeactivateWindow = NULL;
 386         }
 387         else if((mdiparent->m_currentChild==this) || !s_macDeactivateWindow)
 388             mdiparent->wxFrame::MacActivate(timestamp,activating);
 389
 390         if(mdiparent->m_currentChild && mdiparent->m_currentChild!=this)
 391             mdiparent->m_currentChild->wxFrame::MacActivate(timestamp,false);
 392         mdiparent->m_currentChild = this;
 393
 394         if(s_macDeactivateWindow==this)
 395         {
 396             wxLogTrace(TRACE_MDI, wxT("Avoided deactivation/activation of this=%p"),this);
 397             s_macDeactivateWindow=NULL;
 398         }
 399         else
 400             wxFrame::MacActivate(timestamp, activating);
 401     }
 402     else
 403     {
 404         // We were scheduled for deactivation, and now we do it.
 405         if(s_macDeactivateWindow==this)
 406         {
 407             s_macDeactivateWindow = NULL;
 408             wxFrame::MacActivate(timestamp,activating);
 409             if(mdiparent->m_currentChild==this)
 410                 mdiparent->wxFrame::MacActivate(timestamp,activating);
 411         }
 412         else // schedule ourselves for deactivation
 413         {
 414             if(s_macDeactivateWindow)
 415                 wxLogTrace(TRACE_MDI, wxT("window=%p SHOULD have been deactivated, oh well!"),s_macDeactivateWindow);
 416             wxLogTrace(TRACE_MDI, wxT("Scheduling delayed deactivation"));
 417             s_macDeactivateWindow = this;
 418         }
 419     }
 420 }
 421
 422 // MDI operations
 423 void wxMDIChildFrame::Maximize()
 424 {
 425     wxFrame::Maximize() ;
 426 }
 427
 428 void wxMDIChildFrame::Restore()
 429 {
 430     wxFrame::Restore() ;
 431 }
 432
 433 void wxMDIChildFrame::Activate()
 434 {
 435 }
 436
 437 //-----------------------------------------------------------------------------
 438 // wxMDIClientWindow
 439 //-----------------------------------------------------------------------------
 440
 441 wxMDIClientWindow::wxMDIClientWindow()
 442 {
 443 }
 444
 445 wxMDIClientWindow::~wxMDIClientWindow()
 446 {
 447     DestroyChildren();
 448 }
 449
 450 bool wxMDIClientWindow::CreateClient(wxMDIParentFrame *parent, long style)
 451 {
 452     if ( !wxWindow::Create(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, style))
 453         return false;
 454
 455     wxModelessWindows.Append(this);
 456     return true;
 457 }
 458
 459 // Get size *available for subwindows* i.e. excluding menu bar.
 460 void wxMDIClientWindow::DoGetClientSize(int *x, int *y) const
 461 {
 462     wxDisplaySize( x , y ) ;
 463 }
 464
 465 // Explicitly call default scroll behaviour
 466 void wxMDIClientWindow::OnScroll(wxScrollEvent& event)
 467 {
 468 }
 469
 470 #endif // wxUSE_MDI
 471