src/mac/carbon/toplevel.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        mac/toplevel.cpp
   3 // Purpose:     implements wxTopLevelWindow for MSW
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     24.09.01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2001 SciTech Software, Inc. (www.scitechsoft.com)
   9 // License:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "toplevel.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 #ifndef WX_PRECOMP
  32     #include "wx/app.h"
  33     #include "wx/toplevel.h"
  34     #include "wx/frame.h"
  35     #include "wx/string.h"
  36     #include "wx/log.h"
  37     #include "wx/intl.h"
  38 #endif //WX_PRECOMP
  39
  40 #include "wx/mac/uma.h"
  41 #include "wx/mac/aga.h"
  42 #include "wx/tooltip.h"
  43 #include "wx/dnd.h"
  44
  45 #define wxMAC_DEBUG_REDRAW 0
  46 #ifndef wxMAC_DEBUG_REDRAW
  47 #define wxMAC_DEBUG_REDRAW 0
  48 #endif
  49
  50 // ----------------------------------------------------------------------------
  51 // globals
  52 // ----------------------------------------------------------------------------
  53
  54 // list of all frames and modeless dialogs
  55 wxWindowList wxModelessWindows;
  56
  57 // ============================================================================
  58 // wxTopLevelWindowMac implementation
  59 // ============================================================================
  60
  61 // ---------------------------------------------------------------------------
  62 // wxWindowMac utility functions
  63 // ---------------------------------------------------------------------------
  64
  65 // Find an item given the Macintosh Window Reference
  66
  67 wxList *wxWinMacWindowList = NULL;
  68 wxTopLevelWindowMac *wxFindWinFromMacWindow(WXWindow inWindowRef)
  69 {
  70     wxNode *node = wxWinMacWindowList->Find((long)inWindowRef);
  71     if (!node)
  72         return NULL;
  73     return (wxTopLevelWindowMac *)node->Data();
  74 }
  75
  76 void wxAssociateWinWithMacWindow(WXWindow inWindowRef, wxTopLevelWindowMac *win)
  77 {
  78     // adding NULL WindowRef is (first) surely a result of an error and
  79     // (secondly) breaks menu command processing
  80     wxCHECK_RET( inWindowRef != (WindowRef) NULL, "attempt to add a NULL WindowRef to window list" );
  81
  82     if ( !wxWinMacWindowList->Find((long)inWindowRef) )
  83         wxWinMacWindowList->Append((long)inWindowRef, win);
  84 }
  85
  86 void wxRemoveMacWindowAssociation(wxTopLevelWindowMac *win)
  87 {
  88     wxWinMacWindowList->DeleteObject(win);
  89 }
  90
  91
  92 // ----------------------------------------------------------------------------
  93 // wxTopLevelWindowMac creation
  94 // ----------------------------------------------------------------------------
  95
  96 WXHWND wxTopLevelWindowMac::s_macWindowInUpdate = NULL;
  97
  98 void wxTopLevelWindowMac::Init()
  99 {
 100     m_iconized =
 101     m_maximizeOnShow = FALSE;
 102     m_macNoEraseUpdateRgn = NewRgn() ;
 103     m_macNeedsErasing = false ;
 104     m_macWindow = NULL ;
 105 }
 106
 107 bool wxTopLevelWindowMac::Create(wxWindow *parent,
 108                                  wxWindowID id,
 109                                  const wxString& title,
 110                                  const wxPoint& pos,
 111                                  const wxSize& size,
 112                                  long style,
 113                                  const wxString& name)
 114 {
 115     // init our fields
 116     Init();
 117
 118     m_windowStyle = style;
 119
 120     SetName(name);
 121
 122     m_windowId = id == -1 ? NewControlId() : id;
 123
 124     wxTopLevelWindows.Append(this);
 125
 126     if ( parent )
 127         parent->AddChild(this);
 128
 129     return TRUE;
 130 }
 131
 132 wxTopLevelWindowMac::~wxTopLevelWindowMac()
 133 {
 134     if ( m_macWindow )
 135     {
 136         wxToolTip::NotifyWindowDelete(m_macWindow) ;
 137         UMADisposeWindow( (WindowRef) m_macWindow ) ;
 138     }
 139
 140     wxRemoveMacWindowAssociation( this ) ;
 141
 142     wxTopLevelWindows.DeleteObject(this);
 143
 144     if ( wxModelessWindows.Find(this) )
 145         wxModelessWindows.DeleteObject(this);
 146
 147     // If this is the last top-level window, exit.
 148     if ( wxTheApp && (wxTopLevelWindows.Number() == 0) )
 149     {
 150         wxTheApp->SetTopWindow(NULL);
 151
 152         if ( wxTheApp->GetExitOnFrameDelete() )
 153         {
 154           wxTheApp->ExitMainLoop() ;
 155         }
 156     }
 157     DisposeRgn( (RgnHandle) m_macNoEraseUpdateRgn ) ;
 158 }
 159
 160
 161 // ----------------------------------------------------------------------------
 162 // wxTopLevelWindowMac maximize/minimize
 163 // ----------------------------------------------------------------------------
 164
 165 void wxTopLevelWindowMac::Maximize(bool maximize)
 166 {
 167     // not available on mac
 168 }
 169
 170 bool wxTopLevelWindowMac::IsMaximized() const
 171 {
 172     return false ;
 173 }
 174
 175 void wxTopLevelWindowMac::Iconize(bool iconize)
 176 {
 177     // not available on mac
 178 }
 179
 180 bool wxTopLevelWindowMac::IsIconized() const
 181 {
 182     // mac dialogs cannot be iconized
 183     return FALSE;
 184 }
 185
 186 void wxTopLevelWindowMac::Restore()
 187 {
 188     // not available on mac
 189 }
 190
 191 // ----------------------------------------------------------------------------
 192 // wxTopLevelWindowMac misc
 193 // ----------------------------------------------------------------------------
 194
 195 void wxTopLevelWindowMac::SetIcon(const wxIcon& icon)
 196 {
 197     // this sets m_icon
 198     wxTopLevelWindowBase::SetIcon(icon);
 199 }
 200
 201 void  wxTopLevelWindowMac::MacCreateRealWindow( const wxString& title,
 202            const wxPoint& pos,
 203            const wxSize& size,
 204            long style,
 205            const wxString& name )
 206 {
 207   SetName(name);
 208   m_windowStyle = style;
 209   m_isShown = FALSE;
 210
 211   // create frame.
 212
 213     Rect theBoundsRect;
 214
 215   m_x = (int)pos.x;
 216   m_y = (int)pos.y;
 217   if ( m_y < 50 )
 218     m_y = 50 ;
 219   if ( m_x < 20 )
 220     m_x = 20 ;
 221
 222   m_width = size.x;
 223     if (m_width == -1)
 224         m_width = 20;
 225   m_height = size.y;
 226     if (m_height == -1)
 227         m_height = 20;
 228
 229     ::SetRect(&theBoundsRect, m_x, m_y , m_x + m_width, m_y + m_height);
 230
 231     // translate the window attributes in the appropriate window class and attributes
 232
 233     WindowClass wclass = 0;
 234     WindowAttributes attr = kWindowNoAttributes ;
 235
 236     if ( HasFlag(wxTINY_CAPTION_HORIZ) ||  HasFlag(wxTINY_CAPTION_VERT) )
 237     {
 238         wclass = kFloatingWindowClass ;
 239         if ( HasFlag(wxTINY_CAPTION_VERT) )
 240         {
 241             attr |= kWindowSideTitlebarAttribute ;
 242         }
 243     }
 244     else if ( HasFlag( wxCAPTION ) )
 245     {
 246         if ( HasFlag( wxDIALOG_MODAL ) )
 247         {
 248             wclass = kMovableModalWindowClass ;
 249         }
 250         else
 251         {
 252             wclass = kDocumentWindowClass ;
 253         }
 254     }
 255     else
 256     {
 257         wclass = kModalWindowClass ;
 258     }
 259
 260     if ( HasFlag( wxMINIMIZE_BOX ) || HasFlag( wxMAXIMIZE_BOX ) )
 261     {
 262         attr |= kWindowFullZoomAttribute ;
 263         attr |= kWindowCollapseBoxAttribute ;
 264     }
 265     if ( HasFlag( wxRESIZE_BORDER ) )
 266     {
 267         attr |= kWindowResizableAttribute ;
 268     }
 269     if ( HasFlag( wxSYSTEM_MENU ) )
 270     {
 271         attr |= kWindowCloseBoxAttribute ;
 272     }
 273
 274     ::CreateNewWindow( wclass , attr , &theBoundsRect , (WindowRef*)&m_macWindow ) ;
 275     wxAssociateWinWithMacWindow( m_macWindow , this ) ;
 276     wxString label ;
 277     if( wxApp::s_macDefaultEncodingIsPC )
 278         label = wxMacMakeMacStringFromPC( title ) ;
 279     else
 280         label = title ;
 281     UMASetWTitleC( (WindowRef)m_macWindow , label ) ;
 282     ::CreateRootControl( (WindowRef)m_macWindow , (ControlHandle*)&m_macRootControl ) ;
 283
 284     m_macFocus = NULL ;
 285 }
 286
 287 void wxTopLevelWindowMac::MacGetPortParams(WXPOINTPTR localOrigin, WXRECTPTR clipRect, WXHWND *window  , wxWindowMac** rootwin)
 288 {
 289     ((Point*)localOrigin)->h = 0;
 290     ((Point*)localOrigin)->v = 0;
 291     ((Rect*)clipRect)->left = 0;
 292     ((Rect*)clipRect)->top = 0;
 293     ((Rect*)clipRect)->right = m_width;
 294     ((Rect*)clipRect)->bottom = m_height;
 295     *window = m_macWindow ;
 296     *rootwin = this ;
 297 }
 298
 299 void wxTopLevelWindowMac::Clear()
 300 {
 301   wxWindow::Clear() ;
 302 }
 303
 304 WXWidget wxTopLevelWindowMac::MacGetContainerForEmbedding()
 305 {
 306     return m_macRootControl ;
 307 }
 308
 309
 310 void wxTopLevelWindowMac::MacUpdate( long timestamp)
 311 {
 312
 313     wxMacPortStateHelper help( (GrafPtr) GetWindowPort( (WindowRef) m_macWindow) ) ;
 314
 315     BeginUpdate( (WindowRef)m_macWindow ) ;
 316
 317     RgnHandle       updateRgn = NewRgn();
 318     RgnHandle       diffRgn = NewRgn() ;
 319     if ( updateRgn && diffRgn )
 320     {
 321         GetPortVisibleRegion( GetWindowPort( (WindowRef)m_macWindow ), updateRgn );
 322         DiffRgn( updateRgn , (RgnHandle) m_macNoEraseUpdateRgn , diffRgn ) ;
 323         if ( !EmptyRgn( updateRgn ) )
 324         {
 325             MacRedraw( updateRgn , timestamp , m_macNeedsErasing || !EmptyRgn( diffRgn )  ) ;
 326         }
 327     }
 328     if ( updateRgn )
 329         DisposeRgn( updateRgn );
 330     if ( diffRgn )
 331         DisposeRgn( diffRgn );
 332     EndUpdate( (WindowRef)m_macWindow ) ;
 333     SetEmptyRgn( (RgnHandle) m_macNoEraseUpdateRgn ) ;
 334     m_macNeedsErasing = false ;
 335 }
 336
 337
 338 // Raise the window to the top of the Z order
 339 void wxTopLevelWindowMac::Raise()
 340 {
 341     ::BringToFront( (WindowRef)m_macWindow ) ;
 342 }
 343
 344 // Lower the window to the bottom of the Z order
 345 void wxTopLevelWindowMac::Lower()
 346 {
 347     ::SendBehind( (WindowRef)m_macWindow , NULL ) ;
 348 }
 349
 350 Point lastWhere ;
 351 long lastWhen = 0 ;
 352 extern int wxBusyCursorCount ;
 353
 354 void wxTopLevelWindowMac::MacFireMouseEvent( WXEVENTREF evr )
 355 {
 356     EventRecord *ev = (EventRecord*) evr ;
 357     wxMouseEvent event(wxEVT_LEFT_DOWN);
 358     bool isDown = !(ev->modifiers & btnState) ; // 1 is for up
 359     bool controlDown = ev->modifiers & controlKey ; // for simulating right mouse
 360
 361     event.m_leftDown = isDown && !controlDown;
 362
 363     event.m_middleDown = FALSE;
 364     event.m_rightDown = isDown && controlDown;
 365
 366     if ( ev->what == mouseDown )
 367     {
 368         if ( controlDown )
 369             event.SetEventType(wxEVT_RIGHT_DOWN ) ;
 370         else
 371             event.SetEventType(wxEVT_LEFT_DOWN ) ;
 372     }
 373     else if ( ev->what == mouseUp )
 374     {
 375         if ( controlDown )
 376             event.SetEventType(wxEVT_RIGHT_UP ) ;
 377         else
 378             event.SetEventType(wxEVT_LEFT_UP ) ;
 379     }
 380     else
 381     {
 382         event.SetEventType(wxEVT_MOTION ) ;
 383     }
 384
 385     event.m_shiftDown = ev->modifiers & shiftKey;
 386     event.m_controlDown = ev->modifiers & controlKey;
 387     event.m_altDown = ev->modifiers & optionKey;
 388     event.m_metaDown = ev->modifiers & cmdKey;
 389
 390     Point       localwhere = ev->where ;
 391
 392     GrafPtr     port ;
 393     ::GetPort( &port ) ;
 394     ::SetPort( UMAGetWindowPort( (WindowRef)m_macWindow ) ) ;
 395     ::GlobalToLocal( &localwhere ) ;
 396     ::SetPort( port ) ;
 397
 398     if ( ev->what == mouseDown )
 399     {
 400         if ( ev->when - lastWhen <= GetDblTime() )
 401         {
 402             if ( abs( localwhere.h - lastWhere.h ) < 3 || abs( localwhere.v - lastWhere.v ) < 3 )
 403             {
 404                 if ( controlDown )
 405                     event.SetEventType(wxEVT_RIGHT_DCLICK ) ;
 406                 else
 407                     event.SetEventType(wxEVT_LEFT_DCLICK ) ;
 408             }
 409             lastWhen = 0 ;
 410         }
 411         else
 412         {
 413             lastWhen = ev->when ;
 414         }
 415         lastWhere = localwhere ;
 416     }
 417
 418     event.m_x = localwhere.h;
 419     event.m_y = localwhere.v;
 420     event.m_x += m_x;
 421     event.m_y += m_y;
 422
 423     event.m_timeStamp = ev->when;
 424     event.SetEventObject(this);
 425     if ( wxTheApp->s_captureWindow )
 426     {
 427         int x = event.m_x ;
 428         int y = event.m_y ;
 429         wxTheApp->s_captureWindow->ScreenToClient( &x , &y ) ;
 430         event.m_x = x ;
 431         event.m_y = y ;
 432         wxTheApp->s_captureWindow->GetEventHandler()->ProcessEvent( event ) ;
 433
 434         if ( ev->what == mouseUp )
 435         {
 436             wxTheApp->s_captureWindow = NULL ;
 437             if ( wxBusyCursorCount == 0 )
 438             {
 439                 m_cursor.MacInstall() ;
 440             }
 441         }
 442     }
 443     else
 444     {
 445         MacDispatchMouseEvent( event ) ;
 446     }
 447 }
 448
 449 void wxTopLevelWindowMac::MacMouseDown( WXEVENTREF ev , short part)
 450 {
 451     MacFireMouseEvent( ev ) ;
 452 }
 453
 454 void wxTopLevelWindowMac::MacMouseUp( WXEVENTREF ev , short part)
 455 {
 456     switch (part)
 457     {
 458         case inContent:
 459             {
 460                 MacFireMouseEvent( ev ) ;
 461             }
 462             break ;
 463     }
 464 }
 465
 466 void wxTopLevelWindowMac::MacMouseMoved( WXEVENTREF ev , short part)
 467 {
 468     switch (part)
 469     {
 470         case inContent:
 471             {
 472                 MacFireMouseEvent( ev ) ;
 473             }
 474             break ;
 475     }
 476 }
 477 void wxTopLevelWindowMac::MacActivate( WXEVENTREF ev , bool inIsActivating )
 478 {
 479     wxActivateEvent event(wxEVT_ACTIVATE, inIsActivating , m_windowId);
 480     event.m_timeStamp = ((EventRecord*)ev)->when ;
 481     event.SetEventObject(this);
 482
 483     GetEventHandler()->ProcessEvent(event);
 484
 485     UMAHighlightAndActivateWindow( (WindowRef)m_macWindow , inIsActivating ) ;
 486
 487     MacSuperEnabled( inIsActivating ) ;
 488 }
 489
 490 void wxTopLevelWindowMac::MacKeyDown( WXEVENTREF ev )
 491 {
 492 }
 493
 494 void wxTopLevelWindowMac::SetTitle(const wxString& title)
 495 {
 496     wxWindow::SetTitle( title ) ;
 497
 498     wxString label ;
 499
 500     if( wxApp::s_macDefaultEncodingIsPC )
 501         label = wxMacMakeMacStringFromPC( m_label ) ;
 502     else
 503         label = m_label ;
 504
 505     UMASetWTitleC( (WindowRef)m_macWindow , label ) ;
 506 }
 507
 508 bool wxTopLevelWindowMac::Show(bool show)
 509 {
 510     if ( !wxWindow::Show(show) )
 511         return FALSE;
 512
 513     if (show)
 514     {
 515       ::ShowWindow( (WindowRef)m_macWindow ) ;
 516       ::SelectWindow( (WindowRef)m_macWindow ) ;
 517       // no need to generate events here, they will get them triggered by macos
 518       // actually they should be , but apparently they are not
 519       wxSize size(m_width, m_height);
 520       wxSizeEvent event(size, m_windowId);
 521       event.SetEventObject(this);
 522       GetEventHandler()->ProcessEvent(event);
 523     }
 524     else
 525     {
 526       ::HideWindow( (WindowRef)m_macWindow ) ;
 527     }
 528
 529     if ( !show )
 530     {
 531     }
 532     else
 533     {
 534         Refresh() ;
 535     }
 536
 537     return TRUE;
 538 }
 539
 540 void wxTopLevelWindowMac::DoMoveWindow(int x, int y, int width, int height)
 541 {
 542     int former_x = m_x ;
 543     int former_y = m_y ;
 544     int former_w = m_width ;
 545     int former_h = m_height ;
 546
 547   int actualWidth = width;
 548   int actualHeight = height;
 549   int actualX = x;
 550   int actualY = y;
 551
 552     if ((m_minWidth != -1) && (actualWidth < m_minWidth))
 553         actualWidth = m_minWidth;
 554     if ((m_minHeight != -1) && (actualHeight < m_minHeight))
 555         actualHeight = m_minHeight;
 556     if ((m_maxWidth != -1) && (actualWidth > m_maxWidth))
 557         actualWidth = m_maxWidth;
 558     if ((m_maxHeight != -1) && (actualHeight > m_maxHeight))
 559         actualHeight = m_maxHeight;
 560
 561     bool doMove = false ;
 562     bool doResize = false ;
 563
 564     if ( actualX != former_x || actualY != former_y )
 565     {
 566         doMove = true ;
 567     }
 568     if ( actualWidth != former_w || actualHeight != former_h )
 569     {
 570         doResize = true ;
 571     }
 572
 573     if ( doMove || doResize )
 574     {
 575         m_x = actualX ;
 576         m_y = actualY ;
 577         m_width = actualWidth ;
 578         m_height = actualHeight ;
 579
 580         if ( doMove )
 581             ::MoveWindow((WindowRef)m_macWindow, m_x, m_y  , false); // don't make frontmost
 582
 583         if ( doResize )
 584             ::SizeWindow((WindowRef)m_macWindow, m_width, m_height  , true);
 585
 586         // the OS takes care of invalidating and erasing the new area
 587         // we have erased the old one
 588
 589         if ( IsKindOf( CLASSINFO( wxFrame ) ) )
 590         {
 591             wxFrame* frame = (wxFrame*) this ;
 592             frame->PositionStatusBar();
 593             frame->PositionToolBar();
 594         }
 595         if ( doMove )
 596             wxWindowMac::MacTopLevelWindowChangedPosition() ; // like this only children will be notified
 597
 598         MacRepositionScrollBars() ;
 599         if ( doMove )
 600         {
 601             wxPoint point(m_x, m_y);
 602             wxMoveEvent event(point, m_windowId);
 603             event.SetEventObject(this);
 604             GetEventHandler()->ProcessEvent(event) ;
 605         }
 606         if ( doResize )
 607         {
 608              MacRepositionScrollBars() ;
 609              wxSize size(m_width, m_height);
 610              wxSizeEvent event(size, m_windowId);
 611              event.SetEventObject(this);
 612              GetEventHandler()->ProcessEvent(event);
 613         }
 614     }
 615
 616 }
 617
 618 /*
 619  * Invalidation Mechanism
 620  *
 621  * The update mechanism reflects exactely the windows mechanism
 622  * the rect gets added to the window invalidate region, if the eraseBackground flag
 623  * has been true for any part of the update rgn the background is erased in the entire region
 624  * not just in the specified rect.
 625  *
 626  * In order to achive this, we also have an internal m_macNoEraseUpdateRgn, all rects that have
 627  * the eraseBackground flag set to false are also added to this rgn. upon receiving an update event
 628  * the update rgn is compared to the m_macNoEraseUpdateRgn and in case they differ, every window
 629  * will get the eraseBackground event first
 630  */
 631
 632 void wxTopLevelWindowMac::MacInvalidate( const WXRECTPTR rect, bool eraseBackground )
 633 {
 634   GrafPtr formerPort ;
 635   GetPort( &formerPort ) ;
 636   SetPortWindowPort( (WindowRef)m_macWindow ) ;
 637
 638   m_macNeedsErasing |= eraseBackground ;
 639
 640   // if we already know that we will have to erase, there's no need to track the rest
 641   if ( !m_macNeedsErasing)
 642   {
 643     // we end only here if eraseBackground is false
 644     // if we already have a difference between m_macNoEraseUpdateRgn and UpdateRgn
 645     // we will have to erase anyway
 646
 647     RgnHandle       updateRgn = NewRgn();
 648     RgnHandle       diffRgn = NewRgn() ;
 649     if ( updateRgn && diffRgn )
 650     {
 651         GetWindowUpdateRgn( (WindowRef)m_macWindow , updateRgn );
 652         Point pt = {0,0} ;
 653         LocalToGlobal( &pt ) ;
 654         OffsetRgn( updateRgn , -pt.h , -pt.v ) ;
 655         DiffRgn( updateRgn , (RgnHandle) m_macNoEraseUpdateRgn , diffRgn ) ;
 656         if ( !EmptyRgn( diffRgn ) )
 657         {
 658             m_macNeedsErasing = true ;
 659         }
 660     }
 661     if ( updateRgn )
 662         DisposeRgn( updateRgn );
 663     if ( diffRgn )
 664         DisposeRgn( diffRgn );
 665
 666     if ( !m_macNeedsErasing )
 667     {
 668       RgnHandle rectRgn = NewRgn() ;
 669       SetRectRgn( rectRgn , ((Rect*)rect)->left , ((Rect*)rect)->top , ((Rect*)rect)->right , ((Rect*)rect)->bottom ) ;
 670       UnionRgn( (RgnHandle) m_macNoEraseUpdateRgn , rectRgn , (RgnHandle) m_macNoEraseUpdateRgn ) ;
 671       DisposeRgn( rectRgn ) ;
 672     }
 673   }
 674   InvalWindowRect( (WindowRef)m_macWindow , (Rect*)rect ) ;
 675   // turn this on to debug the refreshing cycle
 676 #if wxMAC_DEBUG_REDRAW
 677   PaintRect( rect ) ;
 678 #endif
 679   SetPort( formerPort ) ;
 680 }
 681