src/msw/notebook.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/notebook.cpp
   3 // Purpose:     implementation of wxNotebook
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     11.06.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef __GNUG__
  13 #pragma implementation "notebook.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20     #pragma hdrstop
  21 #endif
  22
  23 #if wxUSE_NOTEBOOK
  24
  25 // wxWindows
  26 #ifndef WX_PRECOMP
  27   #include  "wx/string.h"
  28 #endif  // WX_PRECOMP
  29
  30 #include  "wx/log.h"
  31 #include  "wx/imaglist.h"
  32 #include  "wx/event.h"
  33 #include  "wx/control.h"
  34 #include  "wx/notebook.h"
  35
  36 #include  "wx/msw/private.h"
  37
  38 // Windows standard headers
  39 #ifndef   __WIN95__
  40   #error  "wxNotebook is only supported Windows 95 and above"
  41 #endif    //Win95
  42
  43 #include  <windowsx.h>  // for SetWindowFont
  44
  45 #ifndef __TWIN32__
  46     #ifdef __GNUWIN32_OLD__
  47         #include "wx/msw/gnuwin32/extra.h"
  48     #endif
  49 #endif
  50
  51 #if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
  52     #include <commctrl.h>
  53 #endif
  54
  55 // ----------------------------------------------------------------------------
  56 // macros
  57 // ----------------------------------------------------------------------------
  58
  59 // check that the page index is valid
  60 #define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((nPage) < GetPageCount()))
  61
  62 // hide the ugly cast
  63 #define m_hwnd    (HWND)GetHWND()
  64
  65 // ----------------------------------------------------------------------------
  66 // constants
  67 // ----------------------------------------------------------------------------
  68
  69 // This is a work-around for missing defines in gcc-2.95 headers
  70 #ifndef TCS_RIGHT
  71     #define TCS_RIGHT       0x0002
  72 #endif
  73
  74 #ifndef TCS_VERTICAL
  75     #define TCS_VERTICAL    0x0080
  76 #endif
  77
  78 #ifndef TCS_BOTTOM
  79     #define TCS_BOTTOM      TCS_RIGHT
  80 #endif
  81
  82 // ----------------------------------------------------------------------------
  83 // event table
  84 // ----------------------------------------------------------------------------
  85
  86 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
  87 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
  88
  89 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
  90     EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
  91
  92     EVT_SIZE(wxNotebook::OnSize)
  93
  94     EVT_SET_FOCUS(wxNotebook::OnSetFocus)
  95
  96     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
  97 END_EVENT_TABLE()
  98
  99 IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
 100 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
 101
 102 // ============================================================================
 103 // implementation
 104 // ============================================================================
 105
 106 // ----------------------------------------------------------------------------
 107 // wxNotebook construction
 108 // ----------------------------------------------------------------------------
 109
 110 // common part of all ctors
 111 void wxNotebook::Init()
 112 {
 113   m_imageList = NULL;
 114   m_nSelection = -1;
 115 }
 116
 117 // default for dynamic class
 118 wxNotebook::wxNotebook()
 119 {
 120   Init();
 121 }
 122
 123 // the same arguments as for wxControl
 124 wxNotebook::wxNotebook(wxWindow *parent,
 125                        wxWindowID id,
 126                        const wxPoint& pos,
 127                        const wxSize& size,
 128                        long style,
 129                        const wxString& name)
 130 {
 131   Init();
 132
 133   Create(parent, id, pos, size, style, name);
 134 }
 135
 136 // Create() function
 137 bool wxNotebook::Create(wxWindow *parent,
 138                         wxWindowID id,
 139                         const wxPoint& pos,
 140                         const wxSize& size,
 141                         long style,
 142                         const wxString& name)
 143 {
 144     // base init
 145     if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL,
 146                         wxDefaultValidator, name) )
 147         return FALSE;
 148
 149     if ( !MSWCreateControl(WC_TABCONTROL, _T(""), pos, size) )
 150         return FALSE;
 151
 152     SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));
 153
 154     return TRUE;
 155 }
 156
 157 WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const
 158 {
 159     WXDWORD tabStyle = wxControl::MSWGetStyle(style, exstyle);
 160
 161     tabStyle |= WS_TABSTOP | TCS_TABS;
 162
 163     if ( style & wxNB_MULTILINE )
 164         tabStyle |= TCS_MULTILINE;
 165     if ( style & wxNB_FIXEDWIDTH )
 166         tabStyle |= TCS_FIXEDWIDTH;
 167
 168     if ( style & wxNB_BOTTOM )
 169         tabStyle |= TCS_RIGHT;
 170     else if ( style & wxNB_LEFT )
 171         tabStyle |= TCS_VERTICAL;
 172     else if ( style & wxNB_RIGHT )
 173         tabStyle |= TCS_VERTICAL | TCS_RIGHT;
 174
 175     // ex style
 176     if ( exstyle )
 177     {
 178         // note that we never want to have the default WS_EX_CLIENTEDGE style
 179         // as it looks too ugly for the notebooks
 180         *exstyle = 0;
 181     }
 182
 183     return tabStyle;
 184 }
 185
 186 // ----------------------------------------------------------------------------
 187 // wxNotebook accessors
 188 // ----------------------------------------------------------------------------
 189
 190 int wxNotebook::GetPageCount() const
 191 {
 192   // consistency check
 193   wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) );
 194
 195   return m_pages.Count();
 196 }
 197
 198 int wxNotebook::GetRowCount() const
 199 {
 200   return TabCtrl_GetRowCount(m_hwnd);
 201 }
 202
 203 int wxNotebook::SetSelection(int nPage)
 204 {
 205   wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
 206
 207   if ( nPage != m_nSelection )
 208   {
 209     wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
 210     event.SetSelection(nPage);
 211     event.SetOldSelection(m_nSelection);
 212     event.SetEventObject(this);
 213     if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 214     {
 215       // program allows the page change
 216       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
 217       (void)GetEventHandler()->ProcessEvent(event);
 218
 219       TabCtrl_SetCurSel(m_hwnd, nPage);
 220     }
 221   }
 222
 223   return m_nSelection;
 224 }
 225
 226 bool wxNotebook::SetPageText(int nPage, const wxString& strText)
 227 {
 228   wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
 229
 230   TC_ITEM tcItem;
 231   tcItem.mask = TCIF_TEXT;
 232   tcItem.pszText = (wxChar *)strText.c_str();
 233
 234   return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
 235 }
 236
 237 wxString wxNotebook::GetPageText(int nPage) const
 238 {
 239   wxCHECK_MSG( IS_VALID_PAGE(nPage), wxT(""), wxT("notebook page out of range") );
 240
 241   wxChar buf[256];
 242   TC_ITEM tcItem;
 243   tcItem.mask = TCIF_TEXT;
 244   tcItem.pszText = buf;
 245   tcItem.cchTextMax = WXSIZEOF(buf);
 246
 247   wxString str;
 248   if ( TabCtrl_GetItem(m_hwnd, nPage, &tcItem) )
 249     str = tcItem.pszText;
 250
 251   return str;
 252 }
 253
 254 int wxNotebook::GetPageImage(int nPage) const
 255 {
 256   wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
 257
 258   TC_ITEM tcItem;
 259   tcItem.mask = TCIF_IMAGE;
 260
 261   return TabCtrl_GetItem(m_hwnd, nPage, &tcItem) ? tcItem.iImage : -1;
 262 }
 263
 264 bool wxNotebook::SetPageImage(int nPage, int nImage)
 265 {
 266   wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
 267
 268   TC_ITEM tcItem;
 269   tcItem.mask = TCIF_IMAGE;
 270   tcItem.iImage = nImage;
 271
 272   return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
 273 }
 274
 275 void wxNotebook::SetImageList(wxImageList* imageList)
 276 {
 277   wxNotebookBase::SetImageList(imageList);
 278
 279   if ( imageList )
 280   {
 281     TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
 282   }
 283 }
 284
 285 // ----------------------------------------------------------------------------
 286 // wxNotebook size settings
 287 // ----------------------------------------------------------------------------
 288
 289 void wxNotebook::SetPageSize(const wxSize& size)
 290 {
 291     // transform the page size into the notebook size
 292     RECT rc;
 293     rc.left =
 294     rc.top = 0;
 295     rc.right = size.x;
 296     rc.bottom = size.y;
 297
 298     TabCtrl_AdjustRect(GetHwnd(), TRUE, &rc);
 299
 300     // and now set it
 301     SetSize(rc.right - rc.left, rc.bottom - rc.top);
 302 }
 303
 304 void wxNotebook::SetPadding(const wxSize& padding)
 305 {
 306     TabCtrl_SetPadding(GetHwnd(), padding.x, padding.y);
 307 }
 308
 309 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
 310 // style.
 311 void wxNotebook::SetTabSize(const wxSize& sz)
 312 {
 313     ::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y));
 314 }
 315
 316 // ----------------------------------------------------------------------------
 317 // wxNotebook operations
 318 // ----------------------------------------------------------------------------
 319
 320 // remove one page from the notebook, without deleting
 321 wxNotebookPage *wxNotebook::DoRemovePage(int nPage)
 322 {
 323     wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage);
 324     if ( !pageRemoved )
 325         return NULL;
 326
 327     TabCtrl_DeleteItem(m_hwnd, nPage);
 328
 329     if ( m_pages.IsEmpty() )
 330     {
 331         // no selection any more, the notebook becamse empty
 332         m_nSelection = -1;
 333     }
 334     else // notebook still not empty
 335     {
 336         // change the selected page if it was deleted or became invalid
 337         int selNew;
 338         if ( m_nSelection == GetPageCount() )
 339         {
 340             // last page deleted, make the new last page the new selection
 341             selNew = m_nSelection - 1;
 342         }
 343         else if ( nPage <= m_nSelection )
 344         {
 345             // we must show another page, even if it has the same index
 346             selNew = m_nSelection;
 347         }
 348         else // nothing changes for the currently selected page
 349         {
 350             selNew = -1;
 351
 352             // we still must refresh the current page: this needs to be done
 353             // for some unknown reason if the tab control shows the up-down
 354             // control (i.e. when there are too many pages) -- otherwise after
 355             // deleting a page nothing at all is shown
 356             m_pages[m_nSelection]->Refresh();
 357         }
 358
 359         if ( selNew != -1 )
 360         {
 361             // m_nSelection must be always valid so reset it before calling
 362             // SetSelection()
 363             m_nSelection = -1;
 364             SetSelection(selNew);
 365         }
 366     }
 367
 368     return pageRemoved;
 369 }
 370
 371 // remove all pages
 372 bool wxNotebook::DeleteAllPages()
 373 {
 374   int nPageCount = GetPageCount();
 375   int nPage;
 376   for ( nPage = 0; nPage < nPageCount; nPage++ )
 377     delete m_pages[nPage];
 378
 379   m_pages.Clear();
 380
 381   TabCtrl_DeleteAllItems(m_hwnd);
 382
 383   m_nSelection = -1;
 384
 385   return TRUE;
 386 }
 387
 388 // add a page to the notebook
 389 bool wxNotebook::AddPage(wxNotebookPage *pPage,
 390                          const wxString& strText,
 391                          bool bSelect,
 392                          int imageId)
 393 {
 394   return InsertPage(GetPageCount(), pPage, strText, bSelect, imageId);
 395 }
 396
 397 // same as AddPage() but does it at given position
 398 bool wxNotebook::InsertPage(int nPage,
 399                             wxNotebookPage *pPage,
 400                             const wxString& strText,
 401                             bool bSelect,
 402                             int imageId)
 403 {
 404     wxCHECK_MSG( pPage != NULL, FALSE, _T("NULL page in wxNotebook::InsertPage") );
 405     wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE,
 406                  _T("invalid index in wxNotebook::InsertPage") );
 407
 408
 409     // add a new tab to the control
 410     // ----------------------------
 411
 412     // init all fields to 0
 413     TC_ITEM tcItem;
 414     wxZeroMemory(tcItem);
 415
 416     // set the image, if any
 417     if ( imageId != -1 )
 418     {
 419         tcItem.mask |= TCIF_IMAGE;
 420         tcItem.iImage  = imageId;
 421     }
 422
 423     // and the text
 424     if ( !strText.IsEmpty() )
 425     {
 426         tcItem.mask |= TCIF_TEXT;
 427         tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
 428     }
 429
 430     // fit the notebook page to the tab control's display area: this should be
 431     // done before adding it to the notebook or TabCtrl_InsertItem() will
 432     // change the notebooks size itself!
 433     RECT rc;
 434     rc.left = rc.top = 0;
 435     GetSize((int *)&rc.right, (int *)&rc.bottom);
 436     TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
 437     pPage->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
 438
 439
 440     // finally do insert it
 441     if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 ) {
 442         wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
 443
 444         return FALSE;
 445     }
 446
 447     // succeeded: save the pointer to the page
 448     m_pages.Insert(pPage, nPage);
 449
 450     // hide the page: unless it is selected, it shouldn't be shown (and if it
 451     // is selected it will be shown later)
 452     HWND hwnd = GetWinHwnd(pPage);
 453     SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);
 454
 455     // this updates internal flag too -- otherwise it would get out of sync
 456     // with the real state
 457     pPage->Show(FALSE);
 458
 459
 460     // now deal with the selection
 461     // ---------------------------
 462
 463     // if the inserted page is before the selected one, we must update the
 464     // index of the selected page
 465     if ( nPage <= m_nSelection )
 466     {
 467         // one extra page added
 468         m_nSelection++;
 469     }
 470
 471     // some page should be selected: either this one or the first one if there
 472     // is still no selection
 473     int selNew = -1;
 474     if ( bSelect )
 475         selNew = nPage;
 476     else if ( m_nSelection == -1 )
 477         selNew = 0;
 478
 479     if ( selNew != -1 )
 480         SetSelection(selNew);
 481
 482     return TRUE;
 483 }
 484
 485 // ----------------------------------------------------------------------------
 486 // wxNotebook callbacks
 487 // ----------------------------------------------------------------------------
 488
 489 void wxNotebook::OnSize(wxSizeEvent& event)
 490 {
 491   // fit the notebook page to the tab control's display area
 492   RECT rc;
 493   rc.left = rc.top = 0;
 494   GetSize((int *)&rc.right, (int *)&rc.bottom);
 495
 496   TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
 497
 498   int width = rc.right - rc.left,
 499       height = rc.bottom - rc.top;
 500   size_t nCount = m_pages.Count();
 501   for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
 502     wxNotebookPage *pPage = m_pages[nPage];
 503     pPage->SetSize(rc.left, rc.top, width, height);
 504   }
 505
 506   event.Skip();
 507 }
 508
 509 void wxNotebook::OnSelChange(wxNotebookEvent& event)
 510 {
 511   // is it our tab control?
 512   if ( event.GetEventObject() == this )
 513   {
 514       int sel = event.GetOldSelection();
 515       if ( sel != -1 )
 516         m_pages[sel]->Show(FALSE);
 517
 518       sel = event.GetSelection();
 519       if ( sel != -1 )
 520       {
 521         wxNotebookPage *pPage = m_pages[sel];
 522         pPage->Show(TRUE);
 523         pPage->SetFocus();
 524       }
 525
 526       m_nSelection = sel;
 527   }
 528
 529   // we want to give others a chance to process this message as well
 530   event.Skip();
 531 }
 532
 533 void wxNotebook::OnSetFocus(wxFocusEvent& event)
 534 {
 535     // this function is only called when the focus is explicitly set (i.e. from
 536     // the program) to the notebook - in this case we don't need the
 537     // complicated OnNavigationKey() logic because the programmer knows better
 538     // what [s]he wants
 539
 540     // set focus to the currently selected page if any
 541     if ( m_nSelection != -1 )
 542         m_pages[m_nSelection]->SetFocus();
 543
 544     event.Skip();
 545 }
 546
 547 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 548 {
 549     if ( event.IsWindowChange() ) {
 550         // change pages
 551         AdvanceSelection(event.GetDirection());
 552     }
 553     else {
 554         // we get this event in 2 cases
 555         //
 556         // a) one of our pages might have generated it because the user TABbed
 557         // out from it in which case we should propagate the event upwards and
 558         // our parent will take care of setting the focus to prev/next sibling
 559         //
 560         // or
 561         //
 562         // b) the parent panel wants to give the focus to us so that we
 563         // forward it to our selected page. We can't deal with this in
 564         // OnSetFocus() because we don't know which direction the focus came
 565         // from in this case and so can't choose between setting the focus to
 566         // first or last panel child
 567
 568         wxWindow *parent = GetParent();
 569         if ( event.GetEventObject() == parent )
 570         {
 571             // no, it doesn't come from child, case (b): forward to a page
 572             if ( m_nSelection != -1 )
 573             {
 574                 // so that the page knows that the event comes from it's parent
 575                 // and is being propagated downwards
 576                 event.SetEventObject(this);
 577
 578                 wxWindow *page = m_pages[m_nSelection];
 579                 if ( !page->GetEventHandler()->ProcessEvent(event) )
 580                 {
 581                     page->SetFocus();
 582                 }
 583                 //else: page manages focus inside it itself
 584             }
 585             else
 586             {
 587                 // we have no pages - still have to give focus to _something_
 588                 SetFocus();
 589             }
 590         }
 591         else
 592         {
 593             // it comes from our child, case (a), pass to the parent
 594             if ( parent ) {
 595                 event.SetCurrentFocus(this);
 596                 parent->GetEventHandler()->ProcessEvent(event);
 597             }
 598         }
 599     }
 600 }
 601
 602 // ----------------------------------------------------------------------------
 603 // wxNotebook base class virtuals
 604 // ----------------------------------------------------------------------------
 605
 606 #if wxUSE_CONSTRAINTS
 607
 608 // override these 2 functions to do nothing: everything is done in OnSize
 609
 610 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
 611 {
 612   // don't set the sizes of the pages - their correct size is not yet known
 613   wxControl::SetConstraintSizes(FALSE);
 614 }
 615
 616 bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
 617 {
 618   return TRUE;
 619 }
 620
 621 #endif // wxUSE_CONSTRAINTS
 622
 623 // ----------------------------------------------------------------------------
 624 // wxNotebook Windows message handlers
 625 // ----------------------------------------------------------------------------
 626
 627 bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode,
 628                              WXWORD pos, WXHWND control)
 629 {
 630     // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
 631     // up-down control
 632     if ( control )
 633         return FALSE;
 634
 635     return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
 636 }
 637
 638 bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
 639 {
 640   wxNotebookEvent event(wxEVT_NULL, m_windowId);
 641
 642   NMHDR* hdr = (NMHDR *)lParam;
 643   switch ( hdr->code ) {
 644     case TCN_SELCHANGE:
 645       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
 646       break;
 647
 648     case TCN_SELCHANGING:
 649       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING);
 650       break;
 651
 652     default:
 653       return wxControl::MSWOnNotify(idCtrl, lParam, result);
 654   }
 655
 656   event.SetSelection(TabCtrl_GetCurSel(m_hwnd));
 657   event.SetOldSelection(m_nSelection);
 658   event.SetEventObject(this);
 659   event.SetInt(idCtrl);
 660
 661   bool processed = GetEventHandler()->ProcessEvent(event);
 662   *result = !event.IsAllowed();
 663   return processed;
 664 }
 665
 666 #endif // wxUSE_NOTEBOOK