src/univ/notebook.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        univ/notebook.cpp
   3 // Purpose:     wxNotebook implementation
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     01.02.01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2001 SciTech Software, Inc. (www.scitechsoft.com)
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "univnotebook.h"
  22 #endif
  23
  24 #include "wx/wxprec.h"
  25
  26 #ifdef __BORLANDC__
  27     #pragma hdrstop
  28 #endif
  29
  30 #if wxUSE_NOTEBOOK
  31
  32 #include "wx/imaglist.h"
  33 #include "wx/notebook.h"
  34 #include "wx/spinbutt.h"
  35 #include "wx/dcmemory.h"
  36
  37 #include "wx/univ/renderer.h"
  38
  39 // ----------------------------------------------------------------------------
  40 // macros
  41 // ----------------------------------------------------------------------------
  42
  43 #define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((nPage) < GetPageCount()))
  44
  45 // ----------------------------------------------------------------------------
  46 // constants
  47 // ----------------------------------------------------------------------------
  48
  49 static const size_t INVALID_PAGE = (size_t)-1;
  50
  51 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
  52 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
  53
  54 // ----------------------------------------------------------------------------
  55 // private classes
  56 // ----------------------------------------------------------------------------
  57
  58 class wxNotebookSpinBtn : public wxSpinButton
  59 {
  60 public:
  61     wxNotebookSpinBtn(wxNotebook *nb)
  62         : wxSpinButton(nb, -1,
  63                        wxDefaultPosition, wxDefaultSize,
  64                        nb->IsVertical() ? wxSP_VERTICAL : wxSP_HORIZONTAL)
  65     {
  66         m_nb = nb;
  67     }
  68
  69 protected:
  70     void OnSpin(wxSpinEvent& event)
  71     {
  72         m_nb->PerformAction(wxACTION_NOTEBOOK_GOTO, event.GetPosition());
  73     }
  74
  75 private:
  76     wxNotebook *m_nb;
  77
  78     DECLARE_EVENT_TABLE()
  79 };
  80
  81 BEGIN_EVENT_TABLE(wxNotebookSpinBtn, wxSpinButton)
  82     EVT_SPIN(-1, wxNotebookSpinBtn::OnSpin)
  83 END_EVENT_TABLE()
  84
  85 // ============================================================================
  86 // implementation
  87 // ============================================================================
  88
  89 IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
  90 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxCommandEvent)
  91
  92 // ----------------------------------------------------------------------------
  93 // wxNotebook creation
  94 // ----------------------------------------------------------------------------
  95
  96 void wxNotebook::Init()
  97 {
  98     m_sel = INVALID_PAGE;
  99
 100     m_heightTab =
 101     m_widthMax = 0;
 102
 103     m_firstVisible =
 104     m_lastVisible =
 105     m_lastFullyVisible = 0;
 106
 107     m_offset = 0;
 108
 109     m_spinbtn = NULL;
 110 }
 111
 112 bool wxNotebook::Create(wxWindow *parent,
 113                         wxWindowID id,
 114                         const wxPoint& pos,
 115                         const wxSize& size,
 116                         long style,
 117                         const wxString& name)
 118 {
 119     if ( !wxControl::Create(parent, id, pos, size, style,
 120                             wxDefaultValidator, name) )
 121         return FALSE;
 122
 123     m_sizePad = GetRenderer()->GetTabPadding();
 124
 125     SetBestSize(size);
 126
 127     CreateInputHandler(wxINP_HANDLER_NOTEBOOK);
 128
 129     return TRUE;
 130 }
 131
 132 // ----------------------------------------------------------------------------
 133 // wxNotebook page titles and images
 134 // ----------------------------------------------------------------------------
 135
 136 wxString wxNotebook::GetPageText(int nPage) const
 137 {
 138     wxCHECK_MSG( IS_VALID_PAGE(nPage), _T(""), _T("invalid notebook page") );
 139
 140     return m_titles[nPage];
 141 }
 142
 143 bool wxNotebook::SetPageText(int nPage, const wxString& strText)
 144 {
 145     wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, _T("invalid notebook page") );
 146
 147     if ( strText != m_titles[nPage] )
 148     {
 149         m_accels[nPage] = FindAccelIndex(strText, &m_titles[nPage]);
 150
 151         if ( FixedSizeTabs() )
 152         {
 153             // it's enough to just reresh this one
 154             RefreshTab(nPage);
 155         }
 156         else // var width tabs
 157         {
 158             // we need to resize the tab to fit the new string
 159             ResizeTab(nPage);
 160         }
 161     }
 162
 163     return TRUE;
 164 }
 165
 166 int wxNotebook::GetPageImage(int nPage) const
 167 {
 168     wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, _T("invalid notebook page") );
 169
 170     return m_images[nPage];
 171 }
 172
 173 bool wxNotebook::SetPageImage(int nPage, int nImage)
 174 {
 175     wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, _T("invalid notebook page") );
 176
 177     wxCHECK_MSG( m_imageList && nImage < m_imageList->GetImageCount(), FALSE,
 178                  _T("invalid image index in SetPageImage()") );
 179
 180     if ( nImage != m_images[nPage] )
 181     {
 182         // if the item didn't have an icon before or, on the contrary, did have
 183         // it but has lost it now, its size will change - but if the icon just
 184         // changes, it won't
 185         bool tabSizeChanges = nImage == -1 || m_images[nPage] == -1;
 186         m_images[nPage] = nImage;
 187
 188         if ( tabSizeChanges )
 189             RefreshAllTabs();
 190         else
 191             RefreshTab(nPage);
 192     }
 193
 194     return TRUE;
 195 }
 196
 197 wxNotebook::~wxNotebook()
 198 {
 199 }
 200
 201 // ----------------------------------------------------------------------------
 202 // wxNotebook page switching
 203 // ----------------------------------------------------------------------------
 204
 205 int wxNotebook::SetSelection(int nPage)
 206 {
 207     wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, _T("invalid notebook page") );
 208
 209     if ( (size_t)nPage == m_sel )
 210     {
 211         // don't do anything if there is nothing to do
 212         return m_sel;
 213     }
 214
 215     // we need to change m_sel first, before calling RefreshTab() below as
 216     // otherwise the previously selected tab wouldn't be redrawn properly under
 217     // wxGTK which calls Refresh() immediately and not during the next event
 218     // loop iteration as wxMSW does and as it should
 219     size_t selOld = m_sel;
 220
 221     m_sel = nPage;
 222
 223     if ( selOld != INVALID_PAGE )
 224     {
 225         RefreshTab(selOld, TRUE /* this tab was selected */);
 226
 227         m_pages[selOld]->Hide();
 228     }
 229
 230     if ( m_sel != INVALID_PAGE ) // this is impossible - but test nevertheless
 231     {
 232         if ( HasSpinBtn() )
 233         {
 234             // keep it in sync
 235             m_spinbtn->SetValue(m_sel);
 236         }
 237
 238         if ( m_sel < m_firstVisible )
 239         {
 240             // selection is to the left of visible part of tabs
 241             ScrollTo(m_sel);
 242         }
 243         else if ( m_sel > m_lastFullyVisible )
 244         {
 245             // selection is to the right of visible part of tabs
 246             ScrollLastTo(m_sel);
 247         }
 248         else // we already see this tab
 249         {
 250             // no need to scroll
 251             RefreshTab(m_sel);
 252         }
 253
 254         m_pages[m_sel]->SetSize(GetPageRect());
 255         m_pages[m_sel]->Show();
 256     }
 257
 258     return m_sel;
 259 }
 260
 261 void wxNotebook::ChangePage(int nPage)
 262 {
 263     wxCHECK_RET( IS_VALID_PAGE(nPage), _T("invalid notebook page") );
 264
 265     if ( (size_t)nPage == m_sel )
 266     {
 267         // nothing to do
 268         return;
 269     }
 270
 271     wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
 272     event.SetSelection(nPage);
 273     event.SetOldSelection(m_sel);
 274     event.SetEventObject(this);
 275     if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() )
 276     {
 277         // program doesn't allow the page change
 278         return;
 279     }
 280
 281     SetSelection(nPage);
 282
 283     event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
 284     GetEventHandler()->ProcessEvent(event);
 285 }
 286
 287 // ----------------------------------------------------------------------------
 288 // wxNotebook pages adding/deleting
 289 // ----------------------------------------------------------------------------
 290
 291 bool wxNotebook::InsertPage(int nPage,
 292                             wxNotebookPage *pPage,
 293                             const wxString& strText,
 294                             bool bSelect,
 295                             int imageId)
 296 {
 297     int nPages = GetPageCount();
 298     wxCHECK_MSG( nPage == nPages || IS_VALID_PAGE(nPage), FALSE,
 299                  _T("invalid notebook page in InsertPage()") );
 300
 301     // modify the data
 302     m_pages.Insert(pPage, nPage);
 303
 304     wxString label;
 305     m_accels.Insert(FindAccelIndex(strText, &label), nPage);
 306     m_titles.Insert(label, nPage);
 307
 308     m_images.Insert(imageId, nPage);
 309
 310     // cache the tab geometry here
 311     wxSize sizeTab = CalcTabSize(nPage);
 312
 313     if ( sizeTab.y > m_heightTab )
 314         m_heightTab = sizeTab.y;
 315
 316     if ( FixedSizeTabs() && sizeTab.x > m_widthMax )
 317         m_widthMax = sizeTab.x;
 318
 319     m_widths.Insert(sizeTab.x, nPage);
 320
 321     // spin button may appear if we didn't have it before - but even if we did,
 322     // its range should change, so update it unconditionally
 323     UpdateSpinBtn();
 324
 325     // if the tab has just appeared, we have to relayout everything, otherwise
 326     // it's enough to just redraw the tabs
 327     if ( nPages == 0 )
 328     {
 329         // always select the first tab to have at least some selection
 330         bSelect = TRUE;
 331
 332         Relayout();
 333     }
 334     else // not the first tab
 335     {
 336         RefreshAllTabs();
 337     }
 338
 339     if ( bSelect )
 340     {
 341         SetSelection(nPage);
 342     }
 343     else // pages added to the notebook are initially hidden
 344     {
 345         pPage->Hide();
 346     }
 347
 348     return TRUE;
 349 }
 350
 351 bool wxNotebook::DeleteAllPages()
 352 {
 353     if ( !wxNotebookBase::DeleteAllPages() )
 354         return FALSE;
 355
 356     // clear the other arrays as well
 357     m_titles.Clear();
 358     m_images.Clear();
 359     m_accels.Clear();
 360     m_widths.Clear();
 361
 362     // it is not valid any longer
 363     m_sel = INVALID_PAGE;
 364
 365     // spin button is not needed any more
 366     UpdateSpinBtn();
 367
 368     Relayout();
 369
 370     return TRUE;
 371 }
 372
 373 wxNotebookPage *wxNotebook::DoRemovePage(int nPage)
 374 {
 375     wxCHECK_MSG( IS_VALID_PAGE(nPage), NULL, _T("invalid notebook page") );
 376
 377     wxNotebookPage *page = m_pages[nPage];
 378     m_pages.RemoveAt(nPage);
 379     m_titles.RemoveAt(nPage);
 380     m_accels.RemoveAt(nPage);
 381     m_widths.RemoveAt(nPage);
 382     m_images.RemoveAt(nPage);
 383
 384     // the spin button might not be needed any more
 385     // 2002-08-12 'if' commented out by JACS on behalf
 386     // of Hans Van Leemputten <Hansvl@softhome.net> who
 387     // points out that UpdateSpinBtn should always be called,
 388     // to ensure m_lastVisible is up to date.
 389     // if ( HasSpinBtn() )
 390     {
 391         UpdateSpinBtn();
 392     }
 393
 394     int count = GetPageCount();
 395     if ( count )
 396     {
 397         if ( m_sel == (size_t)nPage )
 398         {
 399             // avoid sending event to this page which doesn't exist in the
 400             // notebook any more
 401             m_sel = INVALID_PAGE;
 402
 403             SetSelection(nPage == count ? nPage - 1 : nPage);
 404         }
 405         else if ( m_sel > (size_t)nPage )
 406         {
 407             // no need to change selection, just adjust the index
 408             m_sel--;
 409         }
 410     }
 411     else // no more tabs left
 412     {
 413         m_sel = INVALID_PAGE;
 414     }
 415
 416     // have to refresh everything
 417     Relayout();
 418
 419     return page;
 420 }
 421
 422 // ----------------------------------------------------------------------------
 423 // wxNotebook drawing
 424 // ----------------------------------------------------------------------------
 425
 426 void wxNotebook::RefreshCurrent()
 427 {
 428     if ( m_sel != INVALID_PAGE )
 429     {
 430         RefreshTab(m_sel);
 431     }
 432 }
 433
 434 void wxNotebook::RefreshTab(int page, bool forceSelected)
 435 {
 436     wxCHECK_RET( IS_VALID_PAGE(page), _T("invalid notebook page") );
 437
 438     wxRect rect = GetTabRect(page);
 439     if ( forceSelected || ((size_t)page == m_sel) )
 440     {
 441         const wxSize indent = GetRenderer()->GetTabIndent();
 442         rect.Inflate(indent.x, indent.y);
 443     }
 444
 445     RefreshRect(rect);
 446 }
 447
 448 void wxNotebook::RefreshAllTabs()
 449 {
 450     wxRect rect = GetAllTabsRect();
 451     if ( rect.width || rect.height )
 452     {
 453         RefreshRect(rect);
 454     }
 455     //else: we don't have tabs at all
 456 }
 457
 458 void wxNotebook::DoDrawTab(wxDC& dc, const wxRect& rect, size_t n)
 459 {
 460     wxBitmap bmp;
 461     if ( HasImage(n) )
 462     {
 463         int image = m_images[n];
 464
 465 #ifdef __WXMSW__    // FIXME
 466         int w, h;
 467         m_imageList->GetSize(n, w, h);
 468         bmp.Create(w, h);
 469         wxMemoryDC dc;
 470         dc.SelectObject(bmp);
 471         dc.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID));
 472         m_imageList->Draw(image, dc, 0, 0, wxIMAGELIST_DRAW_NORMAL, TRUE);
 473         dc.SelectObject(wxNullBitmap);
 474 #else
 475         bmp = *m_imageList->GetBitmap(image);
 476 #endif
 477     }
 478
 479     int flags = 0;
 480     if ( n == m_sel )
 481     {
 482         flags |= wxCONTROL_SELECTED;
 483
 484         if ( IsFocused() )
 485             flags |= wxCONTROL_FOCUSED;
 486     }
 487
 488     GetRenderer()->DrawTab
 489                    (
 490                      dc,
 491                      rect,
 492                      GetTabOrientation(),
 493                      m_titles[n],
 494                      bmp,
 495                      flags,
 496                      m_accels[n]
 497                    );
 498 }
 499
 500 void wxNotebook::DoDraw(wxControlRenderer *renderer)
 501 {
 502     //wxRect rectUpdate = GetUpdateClientRect(); -- unused
 503
 504     wxDC& dc = renderer->GetDC();
 505     dc.SetFont(GetFont());
 506     dc.SetTextForeground(GetForegroundColour());
 507
 508     // redraw the border - it's simpler to always do it instead of checking
 509     // whether this needs to be done
 510     GetRenderer()->DrawBorder(dc, wxBORDER_RAISED, GetPagePart());
 511
 512     // avoid overwriting the spin button
 513     if ( HasSpinBtn() )
 514     {
 515         wxRect rectTabs = GetAllTabsRect();
 516         wxSize sizeSpinBtn = m_spinbtn->GetSize();
 517
 518         if ( IsVertical() )
 519             rectTabs.height -= sizeSpinBtn.y;
 520         else
 521             rectTabs.width -= sizeSpinBtn.x;
 522
 523         dc.SetClippingRegion(rectTabs);
 524     }
 525
 526     wxRect rect = GetTabsPart();
 527     bool isVertical = IsVertical();
 528
 529     wxRect rectSel;
 530     for ( size_t n = m_firstVisible; n < m_lastVisible; n++ )
 531     {
 532         GetTabSize(n, &rect.width, &rect.height);
 533
 534         if ( n == m_sel )
 535         {
 536             // don't redraw it now as this tab has to be drawn over the other
 537             // ones as it takes more place and spills over to them
 538             rectSel = rect;
 539         }
 540         else // not selected tab
 541         {
 542             // unfortunately we can't do this because the selected tab hangs
 543             // over its neighbours and so we might need to refresh more tabs -
 544             // of course, we could still avoid rereshing some of them with more
 545             // complicated checks, but it doesn't seem too bad to refresh all
 546             // of them, I still don't see flicker, so leaving as is for now
 547
 548             //if ( rectUpdate.Intersects(rect) )
 549             {
 550                 DoDrawTab(dc, rect, n);
 551             }
 552             //else: doesn't need to be refreshed
 553         }
 554
 555         // move the rect to the next tab
 556         if ( isVertical )
 557             rect.y += rect.height;
 558         else
 559             rect.x += rect.width;
 560     }
 561
 562     // now redraw the selected tab
 563     if ( rectSel.width )
 564     {
 565         DoDrawTab(dc, rectSel, m_sel);
 566     }
 567 }
 568
 569 // ----------------------------------------------------------------------------
 570 // wxNotebook geometry
 571 // ----------------------------------------------------------------------------
 572
 573 int wxNotebook::HitTest(const wxPoint& pt) const
 574 {
 575     // first check that it is in this window at all
 576     if ( !GetClientRect().Inside(pt) )
 577     {
 578         return -1;
 579     }
 580
 581     wxRect rectTabs = GetAllTabsRect();
 582
 583     switch ( GetTabOrientation() )
 584     {
 585         default:
 586             wxFAIL_MSG(_T("unknown tab orientation"));
 587             // fall through
 588
 589         case wxTOP:
 590             if ( pt.y > rectTabs.GetBottom() )
 591                 return -1;
 592             break;
 593
 594         case wxBOTTOM:
 595             if ( pt.y < rectTabs.y )
 596                 return -1;
 597             break;
 598
 599         case wxLEFT:
 600             if ( pt.x > rectTabs.GetRight() )
 601                 return -1;
 602             break;
 603
 604         case wxRIGHT:
 605             if ( pt.x < rectTabs.x )
 606                 return -1;
 607             break;
 608     }
 609
 610     for ( size_t n = m_firstVisible; n < m_lastVisible; n++ )
 611     {
 612         GetTabSize(n, &rectTabs.width, &rectTabs.height);
 613
 614         if ( rectTabs.Inside(pt) )
 615             return n;
 616
 617         // move the rectTabs to the next tab
 618         if ( IsVertical() )
 619             rectTabs.y += rectTabs.height;
 620         else
 621             rectTabs.x += rectTabs.width;
 622     }
 623
 624     return -1;
 625 }
 626
 627 bool wxNotebook::IsVertical() const
 628 {
 629     wxDirection dir = GetTabOrientation();
 630
 631     return dir == wxLEFT || dir == wxRIGHT;
 632 }
 633
 634 wxDirection wxNotebook::GetTabOrientation() const
 635 {
 636     long style = GetWindowStyle();
 637     if ( style & wxNB_BOTTOM )
 638         return wxBOTTOM;
 639     else if ( style & wxNB_RIGHT )
 640         return wxRIGHT;
 641     else if ( style & wxNB_LEFT )
 642         return wxLEFT;
 643
 644     // wxNB_TOP == 0 so we don't have to test for it
 645     return wxTOP;
 646 }
 647
 648 wxRect wxNotebook::GetTabRect(int page) const
 649 {
 650     wxRect rect;
 651     wxCHECK_MSG( IS_VALID_PAGE(page), rect, _T("invalid notebook page") );
 652
 653     // calc the size of this tab and of the preceding ones
 654     wxCoord widthThis, widthBefore;
 655     if ( FixedSizeTabs() )
 656     {
 657         widthThis = m_widthMax;
 658         widthBefore = page*m_widthMax;
 659     }
 660     else
 661     {
 662         widthBefore = 0;
 663         for ( int n = 0; n < page; n++ )
 664         {
 665             widthBefore += m_widths[n];
 666         }
 667
 668         widthThis = m_widths[page];
 669     }
 670
 671     rect = GetTabsPart();
 672     if ( IsVertical() )
 673     {
 674         rect.y += widthBefore - m_offset;
 675         rect.height = widthThis;
 676     }
 677     else // horz
 678     {
 679         rect.x += widthBefore - m_offset;
 680         rect.width = widthThis;
 681     }
 682
 683     return rect;
 684 }
 685
 686 wxRect wxNotebook::GetAllTabsRect() const
 687 {
 688     wxRect rect;
 689
 690     if ( GetPageCount() )
 691     {
 692         const wxSize indent = GetRenderer()->GetTabIndent();
 693         wxSize size = GetClientSize();
 694
 695         if ( IsVertical() )
 696         {
 697             rect.width = m_heightTab + indent.x;
 698             rect.x = GetTabOrientation() == wxLEFT ? 0 : size.x - rect.width;
 699             rect.y = 0;
 700             rect.height = size.y;
 701         }
 702         else // horz
 703         {
 704             rect.x = 0;
 705             rect.width = size.x;
 706             rect.height = m_heightTab + indent.y;
 707             rect.y = GetTabOrientation() == wxTOP ? 0 : size.y - rect.height;
 708         }
 709     }
 710     //else: no pages
 711
 712     return rect;
 713 }
 714
 715 wxRect wxNotebook::GetTabsPart() const
 716 {
 717     wxRect rect = GetAllTabsRect();
 718
 719     wxDirection dir = GetTabOrientation();
 720
 721     const wxSize indent = GetRenderer()->GetTabIndent();
 722     if ( IsVertical() )
 723     {
 724         rect.x += indent.y;
 725         rect.y += indent.x;
 726     }
 727     else // horz
 728     {
 729         rect.x += indent.x;
 730         if ( dir == wxTOP )
 731         {
 732             rect.y += indent.y;
 733             rect.height -= indent.y;
 734         }
 735         else // wxBOTTOM
 736         {
 737             rect.height -= indent.y;
 738         }
 739     }
 740
 741     return rect;
 742 }
 743
 744 void wxNotebook::GetTabSize(int page, wxCoord *w, wxCoord *h) const
 745 {
 746     wxCHECK_RET( w && h, _T("NULL pointer in GetTabSize") );
 747
 748     if ( IsVertical() )
 749     {
 750         // width and height have inverted meaning
 751         wxCoord *tmp = w;
 752         w = h;
 753         h = tmp;
 754     }
 755
 756     // height is always fixed
 757     *h = m_heightTab;
 758
 759     // width may also be fixed and be the same for all tabs
 760     *w = GetTabWidth(page);
 761 }
 762
 763 void wxNotebook::SetTabSize(const wxSize& sz)
 764 {
 765     wxCHECK_RET( FixedSizeTabs(), _T("SetTabSize() ignored") );
 766
 767     if ( IsVertical() )
 768     {
 769         m_heightTab = sz.x;
 770         m_widthMax = sz.y;
 771     }
 772     else // horz
 773     {
 774         m_widthMax = sz.x;
 775         m_heightTab = sz.y;
 776     }
 777 }
 778
 779 wxSize wxNotebook::CalcTabSize(int page) const
 780 {
 781     // NB: don't use m_widthMax, m_heightTab or m_widths here because this
 782     //     method is called to calculate them
 783
 784     wxSize size;
 785
 786     wxCHECK_MSG( IS_VALID_PAGE(page), size, _T("invalid notebook page") );
 787
 788     GetTextExtent(m_titles[page], &size.x, &size.y);
 789
 790     if ( HasImage(page) )
 791     {
 792         wxSize sizeImage;
 793         m_imageList->GetSize(m_images[page], sizeImage.x, sizeImage.y);
 794
 795         size.x += sizeImage.x + 5; // FIXME: hard coded margin
 796
 797         if ( sizeImage.y > size.y )
 798             size.y = sizeImage.y;
 799     }
 800
 801     size.x += 2*m_sizePad.x;
 802     size.y += 2*m_sizePad.y;
 803
 804     return size;
 805 }
 806
 807 void wxNotebook::ResizeTab(int page)
 808 {
 809     wxSize sizeTab = CalcTabSize(page);
 810
 811     // we only need full relayout if the page size changes
 812     bool needsRelayout = FALSE;
 813
 814     if ( IsVertical() )
 815     {
 816         // swap coordinates
 817         wxCoord tmp = sizeTab.x;
 818         sizeTab.x = sizeTab.y;
 819         sizeTab.y = tmp;
 820     }
 821
 822     if ( sizeTab.y > m_heightTab )
 823     {
 824         needsRelayout = TRUE;
 825
 826         m_heightTab = sizeTab.y;
 827     }
 828
 829     m_widths[page] = sizeTab.x;
 830
 831     if ( sizeTab.x > m_widthMax )
 832         m_widthMax = sizeTab.x;
 833
 834     // the total of the tabs has changed too
 835     UpdateSpinBtn();
 836
 837     if ( needsRelayout )
 838         Relayout();
 839     else
 840         RefreshAllTabs();
 841 }
 842
 843 void wxNotebook::SetPadding(const wxSize& padding)
 844 {
 845     if ( padding != m_sizePad )
 846     {
 847         m_sizePad = padding;
 848
 849         Relayout();
 850     }
 851 }
 852
 853 void wxNotebook::Relayout()
 854 {
 855     if ( GetPageCount() )
 856     {
 857         RefreshAllTabs();
 858
 859         UpdateSpinBtn();
 860
 861         if ( m_sel != INVALID_PAGE )
 862         {
 863             // resize the currently shown page
 864             wxRect rectPage = GetPageRect();
 865
 866             m_pages[m_sel]->SetSize(rectPage);
 867
 868             // also scroll it into view if needed (note that m_lastVisible
 869             // was updated by the call to UpdateSpinBtn() above, this is why it
 870             // is needed here)
 871             if ( HasSpinBtn() )
 872             {
 873                 if ( m_sel < m_firstVisible )
 874                 {
 875                     // selection is to the left of visible part of tabs
 876                     ScrollTo(m_sel);
 877                 }
 878                 else if ( m_sel > m_lastFullyVisible )
 879                 {
 880                     // selection is to the right of visible part of tabs
 881                     ScrollLastTo(m_sel);
 882                 }
 883             }
 884         }
 885     }
 886     else // we have no pages
 887     {
 888         // just refresh everything
 889         Refresh();
 890     }
 891 }
 892
 893 wxRect wxNotebook::GetPagePart() const
 894 {
 895     wxRect rectPage = GetClientRect();
 896
 897     if ( GetPageCount() )
 898     {
 899         wxRect rectTabs = GetAllTabsRect();
 900         wxDirection dir = GetTabOrientation();
 901         if ( IsVertical() )
 902         {
 903             rectPage.width -= rectTabs.width;
 904             if ( dir == wxLEFT )
 905                 rectPage.x += rectTabs.width;
 906         }
 907         else // horz
 908         {
 909             rectPage.height -= rectTabs.height;
 910             if ( dir == wxTOP )
 911                 rectPage.y += rectTabs.height;
 912         }
 913     }
 914     //else: no pages at all
 915
 916     return rectPage;
 917 }
 918
 919 wxRect wxNotebook::GetPageRect() const
 920 {
 921     wxRect rect = GetPagePart();
 922
 923     // leave space for the border
 924     wxRect rectBorder = GetRenderer()->GetBorderDimensions(wxBORDER_RAISED);
 925
 926     // FIXME: hardcoded +2!
 927     rect.Inflate(-(rectBorder.x + rectBorder.width + 2),
 928                  -(rectBorder.y + rectBorder.height + 2));
 929
 930     return rect;
 931 }
 932
 933 wxSize wxNotebook::GetSizeForPage(const wxSize& size) const
 934 {
 935     wxSize sizeNb = size;
 936     wxRect rect = GetAllTabsRect();
 937     if ( IsVertical() )
 938         sizeNb.x += rect.width;
 939     else
 940         sizeNb.y += rect.height;
 941
 942     return sizeNb;
 943 }
 944
 945 void wxNotebook::SetPageSize(const wxSize& size)
 946 {
 947     SetClientSize(GetSizeForPage(size));
 948 }
 949
 950 wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage)
 951 {
 952     return AdjustSize(GetSizeForPage(sizePage));
 953 }
 954
 955 // ----------------------------------------------------------------------------
 956 // wxNotebook spin button
 957 // ----------------------------------------------------------------------------
 958
 959 bool wxNotebook::HasSpinBtn() const
 960 {
 961     return m_spinbtn && m_spinbtn->IsShown();
 962 }
 963
 964 void wxNotebook::CalcLastVisibleTab()
 965 {
 966     bool isVertical = IsVertical();
 967
 968     wxCoord width = GetClientSize().x;
 969
 970     wxRect rect = GetTabsPart();
 971
 972     size_t count = GetPageCount();
 973
 974     wxCoord widthLast = 0;
 975     size_t n;
 976     for ( n = m_firstVisible; n < count; n++ )
 977     {
 978         GetTabSize(n, &rect.width, &rect.height);
 979         if ( rect.GetRight() > width )
 980         {
 981             break;
 982         }
 983
 984         // remember it to use below
 985         widthLast = rect.GetRight();
 986
 987         // move the rect to the next tab
 988         if ( isVertical )
 989             rect.y += rect.height;
 990         else
 991             rect.x += rect.width;
 992     }
 993
 994     if ( n == m_firstVisible )
 995     {
 996         // even the first tab isn't fully visible - but still pretend it is as
 997         // we have to show something
 998         m_lastFullyVisible = m_firstVisible;
 999     }
1000     else // more than one tab visible
1001     {
1002         m_lastFullyVisible = n - 1;
1003
1004         // but is it really fully visible? it shouldn't overlap with the spin
1005         // button if it is present (again, even if the first button does
1006         // overlap with it, we pretend that it doesn't as there is not much
1007         // else we can do)
1008         if ( (m_lastFullyVisible > m_firstVisible) && HasSpinBtn() )
1009         {
1010             // adjust width to be the width before the spin button
1011             wxSize sizeSpinBtn = m_spinbtn->GetSize();
1012             if ( IsVertical() )
1013                 width -= sizeSpinBtn.y;
1014             else
1015                 width -= sizeSpinBtn.x;
1016
1017             if ( widthLast > width )
1018             {
1019                 // the last button overlaps with spin button, so take he
1020                 // previous one
1021                 m_lastFullyVisible--;
1022             }
1023         }
1024     }
1025
1026     if ( n == count )
1027     {
1028         // everything is visible
1029         m_lastVisible = n;
1030     }
1031     else
1032     {
1033         // this tab is still (partially) visible, so m_lastVisible is the
1034         // next tab (remember, this is "exclusive" last)
1035         m_lastVisible = n + 1;
1036
1037     }
1038 }
1039
1040 void wxNotebook::UpdateSpinBtn()
1041 {
1042     // first decide if we need a spin button
1043     bool allTabsShown;
1044
1045     size_t count = (size_t)GetPageCount();
1046     if ( count == 0 )
1047     {
1048         // this case is special, get rid of it immediately: everything is
1049         // visible and we don't need any spin buttons
1050         allTabsShown = TRUE;
1051
1052         // have to reset them manually as we don't call CalcLastVisibleTab()
1053         m_firstVisible =
1054         m_lastVisible =
1055         m_lastFullyVisible = 0;
1056     }
1057     else
1058     {
1059         CalcLastVisibleTab();
1060
1061         // if all tabs after the first visible one are shown, it doesn't yet
1062         // mean that all tabs are shown - so we go backwards until we arrive to
1063         // the beginning (then all tabs are indeed shown) or find a tab such
1064         // that not all tabs after it are shown
1065         while ( (m_lastFullyVisible == count - 1) && (m_firstVisible > 0) )
1066         {
1067             // this is equivalent to ScrollTo(m_firstVisible - 1) but more
1068             // efficient
1069             m_offset -= GetTabWidth(m_firstVisible--);
1070
1071             // reclaculate after m_firstVisible change
1072             CalcLastVisibleTab();
1073         }
1074
1075         allTabsShown = m_lastFullyVisible == count - 1;
1076     }
1077
1078     if ( !allTabsShown )
1079     {
1080         if ( !m_spinbtn )
1081         {
1082             // create it once only
1083             m_spinbtn = new wxNotebookSpinBtn(this);
1084
1085             // set the correct value to keep it in sync
1086             m_spinbtn->SetValue(m_sel);
1087         }
1088
1089         // position it correctly
1090         PositionSpinBtn();
1091
1092         // and show it
1093         m_spinbtn->Show();
1094
1095         // also set/update the range
1096         m_spinbtn->SetRange(0, count - 1);
1097
1098         // update m_lastFullyVisible once again as it might have changed
1099         // because the spin button appeared
1100         //
1101         // FIXME: might do it more efficiently
1102         CalcLastVisibleTab();
1103     }
1104     else // all tabs are visible, we don't need spin button
1105     {
1106         if ( m_spinbtn )
1107         {
1108             m_spinbtn->Hide();
1109         }
1110     }
1111 }
1112
1113 void wxNotebook::PositionSpinBtn()
1114 {
1115     if ( !m_spinbtn )
1116         return;
1117
1118     wxCoord wBtn, hBtn;
1119     m_spinbtn->GetSize(&wBtn, &hBtn);
1120
1121     wxRect rectTabs = GetAllTabsRect();
1122
1123     wxCoord x, y;
1124     switch ( GetTabOrientation() )
1125     {
1126         default:
1127             wxFAIL_MSG(_T("unknown tab orientation"));
1128             // fall through
1129
1130         case wxTOP:
1131             x = rectTabs.GetRight() - wBtn;
1132             y = rectTabs.GetBottom() - hBtn;
1133             break;
1134
1135         case wxBOTTOM:
1136             x = rectTabs.GetRight() - wBtn;
1137             y = rectTabs.GetTop();
1138             break;
1139
1140         case wxLEFT:
1141             x = rectTabs.GetRight() - wBtn;
1142             y = rectTabs.GetBottom() - hBtn;
1143             break;
1144
1145         case wxRIGHT:
1146             x = rectTabs.GetLeft();
1147             y = rectTabs.GetBottom() - hBtn;
1148             break;
1149     }
1150
1151     m_spinbtn->Move(x, y);
1152 }
1153
1154 // ----------------------------------------------------------------------------
1155 // wxNotebook scrolling
1156 // ----------------------------------------------------------------------------
1157
1158 void wxNotebook::ScrollTo(int page)
1159 {
1160     wxCHECK_RET( IS_VALID_PAGE(page), _T("invalid notebook page") );
1161
1162     // set the first visible tab and offset (easy)
1163     m_firstVisible = (size_t)page;
1164     m_offset = 0;
1165     for ( size_t n = 0; n < m_firstVisible; n++ )
1166     {
1167         m_offset += GetTabWidth(n);
1168     }
1169
1170     // find the last visible tab too
1171     CalcLastVisibleTab();
1172
1173     RefreshAllTabs();
1174 }
1175
1176 void wxNotebook::ScrollLastTo(int page)
1177 {
1178     wxCHECK_RET( IS_VALID_PAGE(page), _T("invalid notebook page") );
1179
1180     // go backwards until we find the first tab which can be made visible
1181     // without hiding the given one
1182     wxSize size = GetClientSize();
1183     wxCoord widthAll = IsVertical() ? size.y : size.x,
1184             widthTabs = GetTabWidth(page);
1185
1186     // the total width is less than the width of the window if we have the spin
1187     // button
1188     if ( HasSpinBtn() )
1189     {
1190         wxSize sizeSpinBtn = m_spinbtn->GetSize();
1191         if ( IsVertical() )
1192             widthAll -= sizeSpinBtn.y;
1193         else
1194             widthAll -= sizeSpinBtn.x;
1195     }
1196
1197     m_firstVisible = page;
1198     while ( (m_firstVisible > 0) && (widthTabs <= widthAll) )
1199     {
1200         widthTabs += GetTabWidth(--m_firstVisible);
1201     }
1202
1203     if ( widthTabs > widthAll )
1204     {
1205         // take one step back (that it is forward) if we can
1206         if ( m_firstVisible < (size_t)GetPageCount() - 1 )
1207             m_firstVisible++;
1208     }
1209
1210     // go to it
1211     ScrollTo(m_firstVisible);
1212
1213     // consitency check: the page we were asked to show should be shown
1214     wxASSERT_MSG( (size_t)page < m_lastVisible, _T("bug in ScrollLastTo") );
1215 }
1216
1217 // ----------------------------------------------------------------------------
1218 // wxNotebook sizing/moving
1219 // ----------------------------------------------------------------------------
1220
1221 wxSize wxNotebook::DoGetBestClientSize() const
1222 {
1223     // calculate the max page size
1224     wxSize size(0, 0);
1225
1226     size_t count = GetPageCount();
1227     if ( count )
1228     {
1229         for ( size_t n = 0; n < count; n++ )
1230         {
1231             wxSize sizePage = m_pages[n]->GetSize();
1232
1233             if ( size.x < sizePage.x )
1234                 size.x = sizePage.x;
1235             if ( size.y < sizePage.y )
1236                 size.y = sizePage.y;
1237         }
1238     }
1239     else // no pages
1240     {
1241         // use some arbitrary default size
1242         size.x =
1243         size.y = 100;
1244     }
1245
1246     return GetSizeForPage(size);
1247 }
1248
1249 void wxNotebook::DoMoveWindow(int x, int y, int width, int height)
1250 {
1251     wxControl::DoMoveWindow(x, y, width, height);
1252
1253     // move the spin ctrl too (NOP if it doesn't exist)
1254     PositionSpinBtn();
1255 }
1256
1257 void wxNotebook::DoSetSize(int x, int y,
1258                            int width, int height,
1259                            int sizeFlags)
1260 {
1261     wxSize old_client_size = GetClientSize();
1262
1263     wxControl::DoSetSize(x, y, width, height, sizeFlags);
1264
1265     wxSize new_client_size = GetClientSize();
1266
1267     if (old_client_size != new_client_size)
1268         Relayout();
1269 }
1270
1271 // ----------------------------------------------------------------------------
1272 // wxNotebook input processing
1273 // ----------------------------------------------------------------------------
1274
1275 bool wxNotebook::PerformAction(const wxControlAction& action,
1276                                long numArg,
1277                                const wxString& strArg)
1278 {
1279     if ( action == wxACTION_NOTEBOOK_NEXT )
1280         ChangePage(GetNextPage(TRUE));
1281     else if ( action == wxACTION_NOTEBOOK_PREV )
1282         ChangePage(GetNextPage(FALSE));
1283     else if ( action == wxACTION_NOTEBOOK_GOTO )
1284         ChangePage((int)numArg);
1285     else
1286         return wxControl::PerformAction(action, numArg, strArg);
1287
1288     return TRUE;
1289 }
1290
1291 // ----------------------------------------------------------------------------
1292 // wxStdNotebookInputHandler
1293 // ----------------------------------------------------------------------------
1294
1295 wxStdNotebookInputHandler::wxStdNotebookInputHandler(wxInputHandler *inphand)
1296                          : wxStdInputHandler(inphand)
1297 {
1298 }
1299
1300 bool wxStdNotebookInputHandler::HandleKey(wxInputConsumer *consumer,
1301                                           const wxKeyEvent& event,
1302                                           bool pressed)
1303 {
1304     // ignore the key releases
1305     if ( pressed )
1306     {
1307         wxNotebook *notebook = wxStaticCast(consumer->GetInputWindow(), wxNotebook);
1308
1309         int page = 0;
1310         wxControlAction action;
1311         switch ( event.GetKeyCode() )
1312         {
1313             case WXK_UP:
1314                 if ( notebook->IsVertical() )
1315                     action = wxACTION_NOTEBOOK_PREV;
1316                 break;
1317
1318             case WXK_LEFT:
1319                 if ( !notebook->IsVertical() )
1320                     action = wxACTION_NOTEBOOK_PREV;
1321                 break;
1322
1323             case WXK_DOWN:
1324                 if ( notebook->IsVertical() )
1325                     action = wxACTION_NOTEBOOK_NEXT;
1326                 break;
1327
1328             case WXK_RIGHT:
1329                 if ( !notebook->IsVertical() )
1330                     action = wxACTION_NOTEBOOK_NEXT;
1331                 break;
1332
1333             case WXK_HOME:
1334                 action = wxACTION_NOTEBOOK_GOTO;
1335                 // page = 0; -- already has this value
1336                 break;
1337
1338             case WXK_END:
1339                 action = wxACTION_NOTEBOOK_GOTO;
1340                 page = notebook->GetPageCount() - 1;
1341                 break;
1342         }
1343
1344         if ( !!action )
1345         {
1346             return consumer->PerformAction(action, page);
1347         }
1348     }
1349
1350     return wxStdInputHandler::HandleKey(consumer, event, pressed);
1351 }
1352
1353 bool wxStdNotebookInputHandler::HandleMouse(wxInputConsumer *consumer,
1354                                             const wxMouseEvent& event)
1355 {
1356     if ( event.ButtonDown(1) )
1357     {
1358         wxNotebook *notebook = wxStaticCast(consumer->GetInputWindow(), wxNotebook);
1359         int page = notebook->HitTest(event.GetPosition());
1360         if ( page != -1 )
1361         {
1362             consumer->PerformAction(wxACTION_NOTEBOOK_GOTO, page);
1363
1364             return FALSE;
1365         }
1366     }
1367
1368     return wxStdInputHandler::HandleMouse(consumer, event);
1369 }
1370
1371 bool wxStdNotebookInputHandler::HandleMouseMove(wxInputConsumer *consumer,
1372                                                 const wxMouseEvent& event)
1373 {
1374     return wxStdInputHandler::HandleMouseMove(consumer, event);
1375 }
1376
1377 bool wxStdNotebookInputHandler::HandleFocus(wxInputConsumer *consumer,
1378                                             const wxFocusEvent& event)
1379 {
1380     HandleFocusChange(consumer);
1381
1382     return FALSE;
1383 }
1384
1385 bool wxStdNotebookInputHandler::HandleActivation(wxInputConsumer *consumer,
1386                                                  bool WXUNUSED(activated))
1387 {
1388     // we react to the focus change in the same way as to the [de]activation
1389     HandleFocusChange(consumer);
1390
1391     return FALSE;
1392 }
1393
1394 void wxStdNotebookInputHandler::HandleFocusChange(wxInputConsumer *consumer)
1395 {
1396     wxNotebook *notebook = wxStaticCast(consumer->GetInputWindow(), wxNotebook);
1397     notebook->RefreshCurrent();
1398 }
1399
1400 #endif // wxUSE_NOTEBOOK
1401