src/mac/carbon/notebmac.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/mac/carbon/notebmac.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 #include "wx/wxprec.h"
  13
  14 #if wxUSE_NOTEBOOK
  15
  16 #include "wx/app.h"
  17 #include "wx/string.h"
  18 #include "wx/log.h"
  19 #include "wx/imaglist.h"
  20 #include "wx/image.h"
  21 #include "wx/notebook.h"
  22 #include "wx/mac/uma.h"
  23
  24
  25 // check that the page index is valid
  26 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
  27
  28
  29 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
  30 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
  31
  32 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
  33     EVT_NOTEBOOK_PAGE_CHANGED(wxID_ANY, wxNotebook::OnSelChange)
  34
  35     EVT_SIZE(wxNotebook::OnSize)
  36     EVT_SET_FOCUS(wxNotebook::OnSetFocus)
  37     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
  38 END_EVENT_TABLE()
  39
  40 IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
  41 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxCommandEvent)
  42
  43
  44 // common part of all ctors
  45 void wxNotebook::Init()
  46 {
  47     m_nSelection = -1;
  48 }
  49
  50 // default for dynamic class
  51 wxNotebook::wxNotebook()
  52 {
  53     Init();
  54 }
  55
  56 // the same arguments as for wxControl
  57 wxNotebook::wxNotebook( wxWindow *parent,
  58     wxWindowID id,
  59     const wxPoint& pos,
  60     const wxSize& size,
  61     long style,
  62     const wxString& name )
  63 {
  64     Init();
  65
  66     Create( parent, id, pos, size, style, name );
  67 }
  68
  69 bool wxNotebook::Create( wxWindow *parent,
  70     wxWindowID id,
  71     const wxPoint& pos,
  72     const wxSize& size,
  73     long style,
  74     const wxString& name )
  75 {
  76     m_macIsUserPane = false ;
  77
  78     if ( !wxNotebookBase::Create( parent, id, pos, size, style, name ) )
  79         return false;
  80
  81     Rect bounds = wxMacGetBoundsForControl( this, pos, size );
  82
  83     if ( bounds.right <= bounds.left )
  84         bounds.right = bounds.left + 100;
  85     if ( bounds.bottom <= bounds.top )
  86         bounds.bottom = bounds.top + 100;
  87
  88     UInt16 tabstyle = kControlTabDirectionNorth;
  89     if ( HasFlag(wxBK_LEFT) )
  90         tabstyle = kControlTabDirectionWest;
  91     else if ( HasFlag( wxBK_RIGHT ) )
  92         tabstyle = kControlTabDirectionEast;
  93     else if ( HasFlag( wxBK_BOTTOM ) )
  94         tabstyle = kControlTabDirectionSouth;
  95
  96     ControlTabSize tabsize;
  97     switch (GetWindowVariant())
  98     {
  99         case wxWINDOW_VARIANT_MINI:
 100             if ( UMAGetSystemVersion() >= 0x1030 )
 101                 tabsize = 3 ;
 102             else
 103                 tabsize = kControlSizeSmall;
 104             break;
 105
 106         case wxWINDOW_VARIANT_SMALL:
 107             tabsize = kControlTabSizeSmall;
 108             break;
 109
 110         default:
 111             tabsize = kControlTabSizeLarge;
 112             break;
 113     }
 114
 115     m_peer = new wxMacControl( this );
 116     OSStatus err = CreateTabsControl(
 117         MAC_WXHWND(parent->MacGetTopLevelWindowRef()), &bounds,
 118         tabsize, tabstyle, 0, NULL, m_peer->GetControlRefAddr() );
 119     verify_noerr( err );
 120
 121     MacPostControlCreate( pos, size );
 122
 123     return true ;
 124 }
 125
 126 // dtor
 127 wxNotebook::~wxNotebook()
 128 {
 129 }
 130
 131 // ----------------------------------------------------------------------------
 132 // wxNotebook accessors
 133 // ----------------------------------------------------------------------------
 134
 135 void wxNotebook::SetPadding(const wxSize& padding)
 136 {
 137     // unsupported by OS
 138 }
 139
 140 void wxNotebook::SetTabSize(const wxSize& sz)
 141 {
 142     // unsupported by OS
 143 }
 144
 145 void wxNotebook::SetPageSize(const wxSize& size)
 146 {
 147     SetSize( CalcSizeFromPage( size ) );
 148 }
 149
 150 wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const
 151 {
 152     return DoGetSizeFromClientSize( sizePage );
 153 }
 154
 155 int wxNotebook::SetSelection(size_t nPage)
 156 {
 157     wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("SetSelection: invalid notebook page") );
 158
 159     if ( int(nPage) != m_nSelection )
 160     {
 161         wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
 162         event.SetSelection(nPage);
 163         event.SetOldSelection(m_nSelection);
 164         event.SetEventObject(this);
 165         if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 166         {
 167             // program allows the page change
 168             event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
 169             (void)GetEventHandler()->ProcessEvent(event);
 170
 171             ChangePage(m_nSelection, nPage);
 172         }
 173     }
 174
 175     return m_nSelection;
 176 }
 177
 178 bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
 179 {
 180     wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("SetPageText: invalid notebook page") );
 181
 182     wxNotebookPage *page = m_pages[nPage];
 183     page->SetLabel(strText);
 184     MacSetupTabs();
 185
 186     return true;
 187 }
 188
 189 wxString wxNotebook::GetPageText(size_t nPage) const
 190 {
 191     wxCHECK_MSG( IS_VALID_PAGE(nPage), wxEmptyString, wxT("GetPageText: invalid notebook page") );
 192
 193     wxNotebookPage *page = m_pages[nPage];
 194
 195     return page->GetLabel();
 196 }
 197
 198 int wxNotebook::GetPageImage(size_t nPage) const
 199 {
 200     wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("GetPageImage: invalid notebook page") );
 201
 202     return m_images[nPage];
 203 }
 204
 205 bool wxNotebook::SetPageImage(size_t nPage, int nImage)
 206 {
 207     wxCHECK_MSG( IS_VALID_PAGE(nPage), false,
 208         wxT("SetPageImage: invalid notebook page") );
 209     wxCHECK_MSG( m_imageList && nImage < m_imageList->GetImageCount(), false,
 210         wxT("SetPageImage: invalid image index") );
 211
 212     if ( nImage != m_images[nPage] )
 213     {
 214         // if the item didn't have an icon before or, on the contrary, did have
 215         // it but has lost it now, its size will change - but if the icon just
 216         // changes, it won't
 217         m_images[nPage] = nImage;
 218
 219         MacSetupTabs() ;
 220     }
 221
 222     return true;
 223 }
 224
 225 // ----------------------------------------------------------------------------
 226 // wxNotebook operations
 227 // ----------------------------------------------------------------------------
 228
 229 // remove one page from the notebook, without deleting the window
 230 wxNotebookPage* wxNotebook::DoRemovePage(size_t nPage)
 231 {
 232     wxCHECK_MSG( IS_VALID_PAGE(nPage), NULL,
 233         wxT("DoRemovePage: invalid notebook page") );
 234
 235     wxNotebookPage* page = m_pages[nPage] ;
 236     m_pages.RemoveAt(nPage);
 237
 238     MacSetupTabs();
 239
 240     if (m_nSelection >= (int)GetPageCount())
 241         m_nSelection = GetPageCount() - 1;
 242
 243     if (m_nSelection >= 0)
 244         m_pages[m_nSelection]->Show(true);
 245
 246     InvalidateBestSize();
 247
 248     return page;
 249 }
 250
 251 // remove all pages
 252 bool wxNotebook::DeleteAllPages()
 253 {
 254     WX_CLEAR_ARRAY(m_pages) ;
 255     MacSetupTabs();
 256     m_nSelection = -1 ;
 257     InvalidateBestSize();
 258
 259     return true;
 260 }
 261
 262 // same as AddPage() but does it at given position
 263 bool wxNotebook::InsertPage(size_t nPage,
 264     wxNotebookPage *pPage,
 265     const wxString& strText,
 266     bool bSelect,
 267     int imageId )
 268 {
 269     if ( !wxNotebookBase::InsertPage( nPage, pPage, strText, bSelect, imageId ) )
 270         return false;
 271
 272     wxASSERT_MSG( pPage->GetParent() == this, wxT("notebook pages must have notebook as parent") );
 273
 274     // don't show pages by default (we'll need to adjust their size first)
 275     pPage->Show( false ) ;
 276
 277     pPage->SetLabel( strText );
 278
 279     m_images.Insert( imageId, nPage );
 280
 281     MacSetupTabs();
 282
 283     wxRect rect = GetPageRect() ;
 284     pPage->SetSize( rect );
 285     if ( pPage->GetAutoLayout() )
 286         pPage->Layout();
 287
 288     // now deal with the selection
 289     // ---------------------------
 290
 291     // if the inserted page is before the selected one, we must update the
 292     // index of the selected page
 293
 294     if ( int(nPage) <= m_nSelection )
 295     {
 296         m_nSelection++;
 297
 298         // while this still is the same page showing, we need to update the tabs
 299         m_peer->SetValue( m_nSelection + 1 ) ;
 300     }
 301
 302     // some page should be selected: either this one or the first one if there
 303     // is still no selection
 304     int selNew = -1;
 305     if ( bSelect )
 306         selNew = nPage;
 307     else if ( m_nSelection == -1 )
 308         selNew = 0;
 309
 310     if ( selNew != -1 )
 311         SetSelection( selNew );
 312
 313     InvalidateBestSize();
 314
 315     return true;
 316 }
 317
 318 int wxNotebook::HitTest(const wxPoint& pt, long * flags) const
 319 {
 320     int resultV = wxNOT_FOUND;
 321
 322 #if TARGET_API_MAC_OSX
 323     const int countPages = GetPageCount();
 324
 325     // we have to convert from Client to Window relative coordinates
 326     wxPoint adjustedPt = pt + GetClientAreaOrigin();
 327     // and now to HIView native ones
 328     adjustedPt.x -= MacGetLeftBorderSize() ;
 329     adjustedPt.y -= MacGetTopBorderSize() ;
 330
 331     HIPoint hipoint= { adjustedPt.x , adjustedPt.y } ;
 332     HIViewPartCode outPart = 0 ;
 333     OSStatus err = HIViewGetPartHit( m_peer->GetControlRef(), &hipoint, &outPart );
 334
 335     int max = m_peer->GetMaximum() ;
 336     if ( outPart == 0 && max > 0 )
 337     {
 338         // this is a hack, as unfortunately a hit on an already selected tab returns 0,
 339         // so we have to go some extra miles to make sure we select something different
 340         // and try again ..
 341         int val = m_peer->GetValue() ;
 342         int maxval = max ;
 343         if ( max == 1 )
 344         {
 345             m_peer->SetMaximum( 2 ) ;
 346             maxval = 2 ;
 347         }
 348
 349         if ( val == 1 )
 350             m_peer->SetValue( maxval ) ;
 351         else
 352              m_peer->SetValue( 1 ) ;
 353
 354         err = HIViewGetPartHit( m_peer->GetControlRef(), &hipoint, &outPart );
 355
 356         m_peer->SetValue( val ) ;
 357         if ( max == 1 )
 358             m_peer->SetMaximum( 1 ) ;
 359     }
 360
 361     if ( outPart >= 1 && outPart <= countPages )
 362         resultV = outPart - 1 ;
 363 #endif // TARGET_API_MAC_OSX
 364
 365     if (flags != NULL)
 366     {
 367         *flags = 0;
 368
 369         // we cannot differentiate better
 370         if (resultV >= 0)
 371             *flags |= wxNB_HITTEST_ONLABEL;
 372         else
 373             *flags |= wxNB_HITTEST_NOWHERE;
 374     }
 375
 376     return resultV;
 377 }
 378
 379 // Added by Mark Newsam
 380 // When a page is added or deleted to the notebook this function updates
 381 // information held in the control so that it matches the order
 382 // the user would expect.
 383 //
 384 void wxNotebook::MacSetupTabs()
 385 {
 386     m_peer->SetMaximum( GetPageCount() ) ;
 387
 388     wxNotebookPage *page;
 389     ControlTabInfoRecV1 info;
 390
 391     const size_t countPages = GetPageCount();
 392     for (size_t ii = 0; ii < countPages; ii++)
 393     {
 394         page = m_pages[ii];
 395         info.version = kControlTabInfoVersionOne;
 396         info.iconSuiteID = 0;
 397         wxMacCFStringHolder cflabel( page->GetLabel(), m_font.GetEncoding() ) ;
 398         info.name = cflabel ;
 399         m_peer->SetData<ControlTabInfoRecV1>( ii + 1, kControlTabInfoTag, &info ) ;
 400
 401         if ( GetImageList() && GetPageImage(ii) >= 0 && UMAGetSystemVersion() >= 0x1020 )
 402         {
 403             const wxBitmap bmap = GetImageList()->GetBitmap( GetPageImage( ii ) ) ;
 404             if ( bmap.Ok() )
 405             {
 406                 ControlButtonContentInfo info ;
 407
 408                 wxMacCreateBitmapButton( &info, bmap ) ;
 409
 410                 OSStatus err = m_peer->SetData<ControlButtonContentInfo>( ii + 1, kControlTabImageContentTag, &info );
 411                 wxASSERT_MSG( err == noErr , wxT("Error when setting icon on tab") ) ;
 412
 413                 wxMacReleaseBitmapButton( &info ) ;
 414             }
 415         }
 416
 417         m_peer->SetTabEnabled( ii + 1, true ) ;
 418     }
 419
 420     Rect bounds;
 421     m_peer->GetRectInWindowCoords( &bounds ) ;
 422     InvalWindowRect( (WindowRef)MacGetTopLevelWindowRef(), &bounds );
 423 }
 424
 425 wxRect wxNotebook::GetPageRect() const
 426 {
 427     wxSize size = GetClientSize() ;
 428
 429     return wxRect( 0 , 0 , size.x , size.y ) ;
 430 }
 431
 432 // ----------------------------------------------------------------------------
 433 // wxNotebook callbacks
 434 // ----------------------------------------------------------------------------
 435
 436 // @@@ OnSize() is used for setting the font when it's called for the first
 437 //     time because doing it in ::Create() doesn't work (for unknown reasons)
 438 void wxNotebook::OnSize(wxSizeEvent& event)
 439 {
 440     unsigned int nCount = m_pages.Count();
 441     wxRect rect = GetPageRect() ;
 442
 443     for ( unsigned int nPage = 0; nPage < nCount; nPage++ )
 444     {
 445         wxNotebookPage *pPage = m_pages[nPage];
 446         pPage->SetSize(rect);
 447         if ( pPage->GetAutoLayout() )
 448             pPage->Layout();
 449     }
 450
 451     // Processing continues to next OnSize
 452     event.Skip();
 453 }
 454
 455 void wxNotebook::OnSelChange(wxNotebookEvent& event)
 456 {
 457     // is it our tab control?
 458     if ( event.GetEventObject() == this )
 459         ChangePage(event.GetOldSelection(), event.GetSelection());
 460
 461     // we want to give others a chance to process this message as well
 462     event.Skip();
 463 }
 464
 465 void wxNotebook::OnSetFocus(wxFocusEvent& event)
 466 {
 467     // set focus to the currently selected page if any
 468     if ( m_nSelection != -1 )
 469         m_pages[m_nSelection]->SetFocus();
 470
 471     event.Skip();
 472 }
 473
 474 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 475 {
 476     if ( event.IsWindowChange() )
 477     {
 478         // change pages
 479         AdvanceSelection( event.GetDirection() );
 480     }
 481     else
 482     {
 483         // we get this event in 2 cases
 484         //
 485         // a) one of our pages might have generated it because the user TABbed
 486         // out from it in which case we should propagate the event upwards and
 487         // our parent will take care of setting the focus to prev/next sibling
 488         //
 489         // or
 490         //
 491         // b) the parent panel wants to give the focus to us so that we
 492         // forward it to our selected page. We can't deal with this in
 493         // OnSetFocus() because we don't know which direction the focus came
 494         // from in this case and so can't choose between setting the focus to
 495         // first or last panel child
 496         wxWindow *parent = GetParent();
 497
 498         // the cast is here to fix a GCC ICE
 499         if ( ((wxWindow*)event.GetEventObject()) == parent )
 500         {
 501             // no, it doesn't come from child, case (b): forward to a page
 502             if ( m_nSelection != -1 )
 503             {
 504                 // so that the page knows that the event comes from it's parent
 505                 // and is being propagated downwards
 506                 event.SetEventObject( this );
 507
 508                 wxWindow *page = m_pages[m_nSelection];
 509                 if ( !page->GetEventHandler()->ProcessEvent( event ) )
 510                 {
 511                     page->SetFocus();
 512                 }
 513                 //else: page manages focus inside it itself
 514             }
 515             else
 516             {
 517                 // we have no pages - still have to give focus to _something_
 518                 SetFocus();
 519             }
 520         }
 521         else
 522         {
 523             // it comes from our child, case (a), pass to the parent
 524             if ( parent )
 525             {
 526                 event.SetCurrentFocus( this );
 527                 parent->GetEventHandler()->ProcessEvent( event );
 528             }
 529         }
 530     }
 531 }
 532
 533 // ----------------------------------------------------------------------------
 534 // wxNotebook base class virtuals
 535 // ----------------------------------------------------------------------------
 536
 537 #if wxUSE_CONSTRAINTS
 538
 539 // override these 2 functions to do nothing: everything is done in OnSize
 540
 541 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
 542 {
 543     // don't set the sizes of the pages - their correct size is not yet known
 544     wxControl::SetConstraintSizes( false );
 545 }
 546
 547 bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
 548 {
 549     return true;
 550 }
 551
 552 #endif // wxUSE_CONSTRAINTS
 553
 554 void wxNotebook::Command(wxCommandEvent& event)
 555 {
 556     wxFAIL_MSG(wxT("wxNotebook::Command not implemented"));
 557 }
 558
 559 // ----------------------------------------------------------------------------
 560 // wxNotebook helper functions
 561 // ----------------------------------------------------------------------------
 562
 563 // hide the currently active panel and show the new one
 564 void wxNotebook::ChangePage(int nOldSel, int nSel)
 565 {
 566     if (nOldSel == nSel)
 567         return;
 568
 569     if ( nOldSel != -1 )
 570         m_pages[nOldSel]->Show( false );
 571
 572     if ( nSel != -1 )
 573     {
 574         wxNotebookPage *pPage = m_pages[nSel];
 575         pPage->Show( true );
 576         pPage->SetFocus();
 577     }
 578
 579     m_nSelection = nSel;
 580     m_peer->SetValue( m_nSelection + 1 ) ;
 581 }
 582
 583 wxInt32 wxNotebook::MacControlHit(WXEVENTHANDLERREF WXUNUSED(handler) , WXEVENTREF WXUNUSED(event) )
 584 {
 585     OSStatus status = eventNotHandledErr ;
 586
 587     SInt32 newSel = m_peer->GetValue() - 1 ;
 588     if ( newSel != m_nSelection )
 589     {
 590         wxNotebookEvent changing(
 591             wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId,
 592             newSel , m_nSelection );
 593         changing.SetEventObject( this );
 594         GetEventHandler()->ProcessEvent( changing );
 595
 596         if ( changing.IsAllowed() )
 597         {
 598             wxNotebookEvent event(
 599                 wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, m_windowId,
 600                 newSel, m_nSelection );
 601             event.SetEventObject( this );
 602             GetEventHandler()->ProcessEvent( event );
 603         }
 604         else
 605         {
 606             m_peer->SetValue( m_nSelection + 1 ) ;
 607         }
 608
 609         status = noErr ;
 610     }
 611
 612     return (wxInt32)status ;
 613 }
 614
 615 #endif