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