src/mac/carbon/notebmac.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        notebook.cpp
   3 // Purpose:     implementation of wxNotebook
   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 #ifdef __GNUG__
  13 #pragma implementation "notebook.h"
  14 #endif
  15
  16 // ============================================================================
  17 // declarations
  18 // ============================================================================
  19
  20 // ----------------------------------------------------------------------------
  21 // headers
  22 // ----------------------------------------------------------------------------
  23 #include "wx/app.h"
  24 #include "wx/string.h"
  25 #include "wx/log.h"
  26 #include "wx/imaglist.h"
  27 #include "wx/notebook.h"
  28 #include "wx/mac/uma.h"
  29 // ----------------------------------------------------------------------------
  30 // macros
  31 // ----------------------------------------------------------------------------
  32
  33 // check that the page index is valid
  34 #define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((nPage) < GetPageCount()))
  35
  36
  37 // ----------------------------------------------------------------------------
  38 // event table
  39 // ----------------------------------------------------------------------------
  40
  41 #if !USE_SHARED_LIBRARIES
  42 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
  43 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
  44
  45 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
  46 EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
  47 EVT_MOUSE_EVENTS(wxNotebook::OnMouse)
  48
  49 EVT_SIZE(wxNotebook::OnSize)
  50 EVT_SET_FOCUS(wxNotebook::OnSetFocus)
  51 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
  52 END_EVENT_TABLE()
  53
  54 IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
  55 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxCommandEvent)
  56 #endif
  57
  58 // ============================================================================
  59 // implementation
  60 // ============================================================================
  61
  62 // The Appearance Manager docs show using tab controls in either edge to edge
  63 // mode, or inset.  I think edge to edge conforms better to the other ports,
  64 // and inset mode is better accomplished with space around the wxNotebook rather
  65 // than within it.    --Robin
  66 #define wxMAC_EDGE_TO_EDGE 1
  67
  68 static inline int wxMacTabMargin(long nbStyle, long side)
  69 {
  70     static int tabMargin = -1;
  71     static int otherMargin = -1;
  72
  73     if ( tabMargin == -1)
  74     {
  75         if ( UMAHasAquaLayout() )
  76         {
  77             tabMargin = 26;    // From Appearance Manager docs for small tab control dimensions
  78 #if wxMAC_EDGE_TO_EDGE
  79             otherMargin = 0;
  80 #else
  81             otherMargin = 20;
  82 #endif
  83         }
  84         else
  85         {
  86             tabMargin = 30;
  87 #if wxMAC_EDGE_TO_EDGE
  88             otherMargin = 0;
  89 #else
  90             otherMargin = 16;
  91 #endif
  92         }
  93     }
  94
  95     // If the style matches the side asked for then return the tab margin,
  96     // but we have to special case wxNB_TOP since it is zero...
  97     if ( side == wxNB_TOP)
  98     {
  99         if ( nbStyle != 0 && nbStyle & (wxNB_LEFT|wxNB_RIGHT|wxNB_BOTTOM))
 100         {
 101             return otherMargin;
 102         }
 103         else
 104         {
 105             return tabMargin;
 106         }
 107     }
 108     else if ( nbStyle & side)
 109         return tabMargin;
 110     else
 111         return otherMargin;
 112 }
 113
 114 static inline int wxMacTabLeftMargin(long style)
 115 {
 116     return wxMacTabMargin(style, wxNB_LEFT);
 117 }
 118
 119 static inline int wxMacTabTopMargin(long style)
 120 {
 121     return wxMacTabMargin(style, wxNB_TOP);
 122 }
 123
 124 static inline int wxMacTabRightMargin(long style)
 125 {
 126     return wxMacTabMargin(style, wxNB_RIGHT);
 127 }
 128
 129 static inline int wxMacTabBottomMargin(long style)
 130 {
 131     return wxMacTabMargin(style, wxNB_BOTTOM);
 132 }
 133
 134 // ----------------------------------------------------------------------------
 135 // wxNotebook construction
 136 // ----------------------------------------------------------------------------
 137
 138 // common part of all ctors
 139 void wxNotebook::Init()
 140 {
 141     if ( UMAHasAquaLayout() )
 142     {
 143         // Should these depend on wxMAC_EDGE_TO_EDGE too?
 144         m_macHorizontalBorder = 7;
 145         m_macVerticalBorder = 8;
 146     }
 147
 148     m_nSelection = -1;
 149 }
 150
 151 // default for dynamic class
 152 wxNotebook::wxNotebook()
 153 {
 154     Init();
 155 }
 156
 157 // the same arguments as for wxControl
 158 wxNotebook::wxNotebook(wxWindow *parent,
 159                        wxWindowID id,
 160                        const wxPoint& pos,
 161                        const wxSize& size,
 162                        long style,
 163                        const wxString& name)
 164 {
 165     Init();
 166
 167     Create(parent, id, pos, size, style, name);
 168 }
 169
 170 // Create() function
 171 bool wxNotebook::Create(wxWindow *parent,
 172                         wxWindowID id,
 173                         const wxPoint& pos,
 174                         const wxSize& size,
 175                         long style,
 176                         const wxString& name)
 177 {
 178     Rect bounds ;
 179     Str255 title ;
 180
 181     MacPreControlCreate( parent , id ,  wxEmptyString , pos , size ,style, wxDefaultValidator , name , &bounds , title ) ;
 182
 183     int tabstyle = kControlTabSmallNorthProc ;
 184     if ( HasFlag(wxNB_LEFT) )
 185         tabstyle = kControlTabSmallWestProc ;
 186     else if ( HasFlag( wxNB_RIGHT ) )
 187         tabstyle = kControlTabSmallEastProc ;
 188     else if ( HasFlag( wxNB_BOTTOM ) )
 189         tabstyle = kControlTabSmallSouthProc ;
 190
 191
 192     m_macControl = ::NewControl( MAC_WXHWND(parent->MacGetRootWindow()) , &bounds , title , false , 0 , 0 , 1,
 193         tabstyle , (long) this ) ;
 194
 195     MacPostControlCreate() ;
 196     return TRUE ;
 197 }
 198
 199 // dtor
 200 wxNotebook::~wxNotebook()
 201 {
 202     m_macControl = NULL ;
 203 }
 204
 205 wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const
 206 {
 207     wxSize sizeTotal = sizePage;
 208
 209     int major,minor;
 210     wxGetOsVersion( &major, &minor );
 211
 212     // Mac has large notebook borders. Aqua even more so.
 213
 214     if ( HasFlag(wxNB_LEFT) || HasFlag(wxNB_RIGHT) )
 215     {
 216         sizeTotal.x += 90;
 217
 218         if (major >= 10)
 219             sizeTotal.y += 28;
 220         else
 221             sizeTotal.y += 20;
 222     }
 223     else
 224     {
 225         if (major >= 10)
 226         {
 227             sizeTotal.x += 34;
 228             sizeTotal.y += 46;
 229         }
 230         else
 231         {
 232             sizeTotal.x += 22;
 233             sizeTotal.y += 44;
 234         }
 235     }
 236
 237     return sizeTotal;
 238 }
 239
 240 // ----------------------------------------------------------------------------
 241 // wxNotebook accessors
 242 // ----------------------------------------------------------------------------
 243
 244 void wxNotebook::SetPadding(const wxSize& padding)
 245 {
 246     wxFAIL_MSG( wxT("wxNotebook::SetPadding not implemented") );
 247 }
 248
 249 void wxNotebook::SetTabSize(const wxSize& sz)
 250 {
 251     wxFAIL_MSG( wxT("wxNotebook::SetTabSize not implemented") );
 252 }
 253
 254 void wxNotebook::SetPageSize(const wxSize& size)
 255 {
 256     wxFAIL_MSG( wxT("wxNotebook::SetPageSize not implemented") );
 257 }
 258
 259 int wxNotebook::SetSelection(int nPage)
 260 {
 261     if( !IS_VALID_PAGE(nPage) )
 262         return m_nSelection ;
 263
 264     ChangePage(m_nSelection, nPage);
 265     SetControl32BitValue( (ControlHandle) m_macControl , m_nSelection + 1 ) ;
 266
 267     Refresh();
 268     return m_nSelection;
 269 }
 270
 271 bool wxNotebook::SetPageText(int nPage, const wxString& strText)
 272 {
 273     wxASSERT( IS_VALID_PAGE(nPage) );
 274
 275     wxNotebookPage *page = m_pages[nPage];
 276     page->SetLabel(strText);
 277     MacSetupTabs();
 278
 279     return true;
 280 }
 281
 282 wxString wxNotebook::GetPageText(int nPage) const
 283 {
 284     wxASSERT( IS_VALID_PAGE(nPage) );
 285
 286     wxNotebookPage *page = m_pages[nPage];
 287     return page->GetLabel();
 288 }
 289
 290 int wxNotebook::GetPageImage(int nPage) const
 291 {
 292     wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, _T("invalid notebook page") );
 293
 294     return m_images[nPage];
 295 }
 296
 297 bool wxNotebook::SetPageImage(int nPage, int nImage)
 298 {
 299     wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, _T("invalid notebook page") );
 300
 301     wxCHECK_MSG( m_imageList && nImage < m_imageList->GetImageCount(), FALSE,
 302         _T("invalid image index in SetPageImage()") );
 303
 304     if ( nImage != m_images[nPage] )
 305     {
 306         // if the item didn't have an icon before or, on the contrary, did have
 307         // it but has lost it now, its size will change - but if the icon just
 308         // changes, it won't
 309         m_images[nPage] = nImage;
 310
 311         MacSetupTabs() ;
 312     }
 313
 314     return TRUE;
 315 }
 316
 317 // ----------------------------------------------------------------------------
 318 // wxNotebook operations
 319 // ----------------------------------------------------------------------------
 320
 321 // remove one page from the notebook, without deleting the window
 322 wxNotebookPage* wxNotebook::DoRemovePage(int nPage)
 323 {
 324     wxCHECK( IS_VALID_PAGE(nPage), NULL );
 325     wxNotebookPage* page = m_pages[nPage] ;
 326     m_pages.RemoveAt(nPage);
 327
 328     MacSetupTabs();
 329
 330     if(m_nSelection >= GetPageCount()) {
 331         m_nSelection = GetPageCount() - 1;
 332     }
 333     if(m_nSelection >= 0) {
 334         m_pages[m_nSelection]->Show(true);
 335     }
 336     return page;
 337 }
 338
 339 // remove all pages
 340 bool wxNotebook::DeleteAllPages()
 341 {
 342     // TODO: delete native widget pages
 343
 344     WX_CLEAR_ARRAY(m_pages) ;
 345     MacSetupTabs();
 346
 347     return TRUE;
 348 }
 349
 350
 351 // same as AddPage() but does it at given position
 352 bool wxNotebook::InsertPage(int nPage,
 353                             wxNotebookPage *pPage,
 354                             const wxString& strText,
 355                             bool bSelect,
 356                             int imageId)
 357 {
 358     wxASSERT( pPage != NULL );
 359     wxCHECK( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE );
 360
 361     pPage->SetLabel(strText);
 362
 363     // save the pointer to the page
 364     m_pages.Insert(pPage, nPage);
 365
 366     m_images.Insert(imageId, nPage);
 367
 368     MacSetupTabs();
 369
 370     if ( bSelect ) {
 371         m_nSelection = nPage;
 372     }
 373     else if ( m_nSelection == -1 ) {
 374         m_nSelection = 0;
 375     }
 376     else if (m_nSelection >= nPage) {
 377         m_nSelection++;
 378     }
 379     // don't show pages by default (we'll need to adjust their size first)
 380     pPage->Show( false ) ;
 381
 382     int h, w;
 383     GetSize(&w, &h);
 384     pPage->SetSize(wxMacTabLeftMargin(GetWindowStyle()) + m_macHorizontalBorder,
 385                    wxMacTabTopMargin(GetWindowStyle()) + m_macVerticalBorder,
 386                    w - wxMacTabLeftMargin(GetWindowStyle()) - wxMacTabRightMargin(GetWindowStyle()) - 2*m_macHorizontalBorder,
 387                    h - wxMacTabTopMargin(GetWindowStyle()) - wxMacTabBottomMargin(GetWindowStyle()) - 2*m_macVerticalBorder);
 388     if ( pPage->GetAutoLayout() ) {
 389         pPage->Layout();
 390     }
 391
 392     return true;
 393 }
 394
 395 /* Added by Mark Newsam
 396 * When a page is added or deleted to the notebook this function updates
 397 * information held in the m_macControl so that it matches the order
 398 * the user would expect.
 399 */
 400 void wxNotebook::MacSetupTabs()
 401 {
 402     SetControl32BitMaximum( (ControlHandle) m_macControl , GetPageCount() ) ;
 403
 404     wxNotebookPage *page;
 405     ControlTabInfoRec info;
 406
 407     for(int ii = 0; ii < GetPageCount(); ii++)
 408     {
 409         page = m_pages[ii];
 410         info.version = 0;
 411         info.iconSuiteID = 0;
 412         wxMacStringToPascal( page->GetLabel() , info.name ) ;
 413
 414         SetControlData( (ControlHandle) m_macControl, ii+1, kControlTabInfoTag,
 415             sizeof( ControlTabInfoRec) , (char*) &info ) ;
 416         SetTabEnabled( (ControlHandle) m_macControl , ii+1 , true ) ;
 417 #if 0 // TARGET_CARBON
 418         if ( GetImageList() && GetPageImage(ii) >= 0 && UMAGetSystemVersion() >= 0x1020 )
 419         {
 420             // tab controls only support very specific types of images, therefore we are doing an odyssee
 421             // accross the icon worlds (even Apple DTS did not find a shorter path)
 422             // in order not to pollute the icon registry we put every icon into (OSType) 1 and immediately
 423             // afterwards Unregister it (IconRef is ref counted, so it will stay on the tab even if we
 424             // unregister it) in case this will ever lead to having the same icon everywhere add some kind
 425             // of static counter
 426             ControlButtonContentInfo info ;
 427             wxMacCreateBitmapButton( &info , *GetImageList()->GetBitmap( GetPageImage(ii ) ) , kControlContentPictHandle) ;
 428             IconFamilyHandle iconFamily = (IconFamilyHandle) NewHandle(0) ;
 429             OSErr err = SetIconFamilyData( iconFamily, 'PICT' , (Handle) info.u.picture ) ;
 430             wxASSERT_MSG( err == noErr , "Error when adding bitmap" ) ;
 431             IconRef iconRef ;
 432             err = RegisterIconRefFromIconFamily( 'WXNG' , (OSType) 1 , iconFamily, &iconRef ) ;
 433             wxASSERT_MSG( err == noErr , "Error when adding bitmap" ) ;
 434             info.contentType = kControlContentIconRef ;
 435             info.u.iconRef = iconRef ;
 436             SetControlData( (ControlHandle) m_macControl, ii+1,kControlTabImageContentTag,
 437                 sizeof( info ), (Ptr)&info );
 438             wxASSERT_MSG( err == noErr , "Error when setting icon on tab" ) ;
 439                UnregisterIconRef( 'WXNG' , (OSType) 1 ) ;
 440             ReleaseIconRef( iconRef ) ;
 441             DisposeHandle( (Handle) iconFamily ) ;
 442         }
 443 #endif
 444     }
 445     Rect bounds;
 446     GetControlBounds((ControlHandle)m_macControl, &bounds);
 447     InvalWindowRect((WindowRef)MacGetRootWindow(), &bounds);
 448 }
 449
 450 // ----------------------------------------------------------------------------
 451 // wxNotebook callbacks
 452 // ----------------------------------------------------------------------------
 453
 454 // @@@ OnSize() is used for setting the font when it's called for the first
 455 //     time because doing it in ::Create() doesn't work (for unknown reasons)
 456 void wxNotebook::OnSize(wxSizeEvent& event)
 457 {
 458     // emulate page change (it's esp. important to do it first time because
 459     // otherwise our page would stay invisible)
 460     int nSel = m_nSelection;
 461     m_nSelection = -1;
 462     SetSelection(nSel);
 463
 464     // fit the notebook page to the tab control's display area
 465     int w, h;
 466     GetSize(&w, &h);
 467
 468     unsigned int nCount = m_pages.Count();
 469     for ( unsigned int nPage = 0; nPage < nCount; nPage++ ) {
 470         wxNotebookPage *pPage = m_pages[nPage];
 471         pPage->SetSize(wxMacTabLeftMargin(GetWindowStyle()) + m_macHorizontalBorder,
 472                        wxMacTabTopMargin(GetWindowStyle()) + m_macVerticalBorder,
 473                        w - wxMacTabLeftMargin(GetWindowStyle()) - wxMacTabRightMargin(GetWindowStyle()) - 2*m_macHorizontalBorder,
 474                        h - wxMacTabTopMargin(GetWindowStyle()) - wxMacTabBottomMargin(GetWindowStyle()) - 2*m_macVerticalBorder);
 475         if ( pPage->GetAutoLayout() ) {
 476             pPage->Layout();
 477         }
 478     }
 479
 480     // Processing continues to next OnSize
 481     event.Skip();
 482 }
 483
 484 void wxNotebook::OnSelChange(wxNotebookEvent& event)
 485 {
 486     // is it our tab control?
 487     if ( event.GetEventObject() == this )
 488         ChangePage(event.GetOldSelection(), event.GetSelection());
 489
 490     // we want to give others a chance to process this message as well
 491     event.Skip();
 492 }
 493
 494 void wxNotebook::OnSetFocus(wxFocusEvent& event)
 495 {
 496     // set focus to the currently selected page if any
 497     if ( m_nSelection != -1 )
 498         m_pages[m_nSelection]->SetFocus();
 499
 500     event.Skip();
 501 }
 502
 503 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 504 {
 505     if ( event.IsWindowChange() ) {
 506         // change pages
 507         AdvanceSelection(event.GetDirection());
 508     }
 509     else {
 510         // pass to the parent
 511         if ( GetParent() ) {
 512             event.SetCurrentFocus(this);
 513             GetParent()->ProcessEvent(event);
 514         }
 515     }
 516 }
 517
 518 // ----------------------------------------------------------------------------
 519 // wxNotebook base class virtuals
 520 // ----------------------------------------------------------------------------
 521
 522 // override these 2 functions to do nothing: everything is done in OnSize
 523
 524 void wxNotebook::SetConstraintSizes(bool /* recurse */)
 525 {
 526     // don't set the sizes of the pages - their correct size is not yet known
 527     wxControl::SetConstraintSizes(FALSE);
 528 }
 529
 530 bool wxNotebook::DoPhase(int /* nPhase */)
 531 {
 532     return TRUE;
 533 }
 534
 535 void wxNotebook::Command(wxCommandEvent& event)
 536 {
 537     wxFAIL_MSG(wxT("wxNotebook::Command not implemented"));
 538 }
 539
 540 // ----------------------------------------------------------------------------
 541 // wxNotebook helper functions
 542 // ----------------------------------------------------------------------------
 543
 544 // hide the currently active panel and show the new one
 545 void wxNotebook::ChangePage(int nOldSel, int nSel)
 546 {
 547     // it's not an error (the message may be generated by the tab control itself)
 548     // and it may happen - just do nothing
 549     if ( nSel == nOldSel )
 550     {
 551         wxNotebookPage *pPage = m_pages[nSel];
 552         pPage->Show(FALSE);
 553         pPage->Show(TRUE);
 554         pPage->SetFocus();
 555         return;
 556     }
 557
 558     // Hide previous page
 559     if ( nOldSel != -1 ) {
 560         m_pages[nOldSel]->Show(FALSE);
 561     }
 562
 563     wxNotebookPage *pPage = m_pages[nSel];
 564     pPage->Show(TRUE);
 565     pPage->SetFocus();
 566
 567     m_nSelection = nSel;
 568 }
 569
 570
 571 void  wxNotebook::OnMouse( wxMouseEvent &event )
 572 {
 573     if ( (ControlHandle) m_macControl == NULL )
 574     {
 575         event.Skip() ;
 576         return ;
 577     }
 578
 579     if (event.GetEventType() == wxEVT_LEFT_DOWN || event.GetEventType() == wxEVT_LEFT_DCLICK )
 580     {
 581         int x = event.m_x ;
 582         int y = event.m_y ;
 583
 584         MacClientToRootWindow( &x , &y ) ;
 585
 586         ControlHandle   control ;
 587         Point       localwhere ;
 588         SInt16      controlpart ;
 589
 590         localwhere.h = x ;
 591         localwhere.v = y ;
 592
 593         short modifiers = 0;
 594
 595         if ( !event.m_leftDown && !event.m_rightDown )
 596             modifiers  |= btnState ;
 597
 598         if ( event.m_shiftDown )
 599             modifiers |= shiftKey ;
 600
 601         if ( event.m_controlDown )
 602             modifiers |= controlKey ;
 603
 604         if ( event.m_altDown )
 605             modifiers |= optionKey ;
 606
 607         if ( event.m_metaDown )
 608             modifiers |= cmdKey ;
 609
 610         control = (ControlHandle) m_macControl ;
 611         if ( control && ::IsControlActive( control ) )
 612         {
 613             {
 614                 wxNotebookEvent changing(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId,
 615                     ::GetControl32BitValue(control) - 1, m_nSelection);
 616                 changing.SetEventObject(this);
 617                 GetEventHandler()->ProcessEvent(changing);
 618
 619                 if(changing.IsAllowed())
 620                 {
 621                     controlpart = ::HandleControlClick(control, localwhere, modifiers,
 622                         (ControlActionUPP) -1);
 623                     wxTheApp->s_lastMouseDown = 0 ;
 624
 625                     wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, m_windowId,
 626                         ::GetControl32BitValue(control) - 1, m_nSelection);
 627                     event.SetEventObject(this);
 628
 629                     GetEventHandler()->ProcessEvent(event);
 630                 }
 631             }
 632         }
 633     }
 634 }
 635
 636
 637 void wxNotebook::MacHandleControlClick( WXWidget control , wxInt16 controlpart )
 638 {
 639 #if 0
 640     wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, m_windowId , ::GetControl32BitValue((ControlHandle)m_macControl) - 1, m_nSelection);
 641     event.SetEventObject(this);
 642
 643     ProcessEvent(event);
 644 #endif
 645 }
 646