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 license
  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, wxDefaultValidator, name) )
 146         return FALSE;
 147
 148     // notebook, so explicitly specify 0 as last parameter
 149     if ( !MSWCreateControl(WC_TABCONTROL, _T(""), pos, size,
 150                 style | wxTAB_TRAVERSAL) )
 151         return FALSE;
 152
 153     SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));
 154
 155     return TRUE;
 156 }
 157
 158 WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const
 159 {
 160     WXDWORD tabStyle = wxControl::MSWGetStyle(style, exstyle);
 161
 162     tabStyle |= WS_TABSTOP | TCS_TABS;
 163
 164     if ( style & wxNB_MULTILINE )
 165         tabStyle |= TCS_MULTILINE;
 166     if ( style & wxNB_FIXEDWIDTH )
 167         tabStyle |= TCS_FIXEDWIDTH;
 168
 169     if ( style & wxNB_BOTTOM )
 170         tabStyle |= TCS_RIGHT;
 171     else if ( style & wxNB_LEFT )
 172         tabStyle |= TCS_VERTICAL;
 173     else if ( style & wxNB_RIGHT )
 174         tabStyle |= TCS_VERTICAL | TCS_RIGHT;
 175
 176     // ex style
 177     if ( exstyle )
 178     {
 179         // note that we never want to have the default WS_EX_CLIENTEDGE style
 180         // as it looks too ugly for the notebooks
 181         *exstyle = 0;
 182     }
 183
 184     return tabStyle;
 185 }
 186
 187 // ----------------------------------------------------------------------------
 188 // wxNotebook accessors
 189 // ----------------------------------------------------------------------------
 190
 191 int wxNotebook::GetPageCount() const
 192 {
 193   // consistency check
 194   wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) );
 195
 196   return m_pages.Count();
 197 }
 198
 199 int wxNotebook::GetRowCount() const
 200 {
 201   return TabCtrl_GetRowCount(m_hwnd);
 202 }
 203
 204 int wxNotebook::SetSelection(int nPage)
 205 {
 206   wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
 207
 208   if ( nPage != m_nSelection )
 209   {
 210     wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
 211     event.SetSelection(nPage);
 212     event.SetOldSelection(m_nSelection);
 213     event.SetEventObject(this);
 214     if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 215     {
 216       // program allows the page change
 217       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
 218       (void)GetEventHandler()->ProcessEvent(event);
 219
 220       TabCtrl_SetCurSel(m_hwnd, nPage);
 221     }
 222   }
 223
 224   return m_nSelection;
 225 }
 226
 227 bool wxNotebook::SetPageText(int nPage, const wxString& strText)
 228 {
 229   wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
 230
 231   TC_ITEM tcItem;
 232   tcItem.mask = TCIF_TEXT;
 233   tcItem.pszText = (wxChar *)strText.c_str();
 234
 235   return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
 236 }
 237
 238 wxString wxNotebook::GetPageText(int nPage) const
 239 {
 240   wxCHECK_MSG( IS_VALID_PAGE(nPage), wxT(""), wxT("notebook page out of range") );
 241
 242   wxChar buf[256];
 243   TC_ITEM tcItem;
 244   tcItem.mask = TCIF_TEXT;
 245   tcItem.pszText = buf;
 246   tcItem.cchTextMax = WXSIZEOF(buf);
 247
 248   wxString str;
 249   if ( TabCtrl_GetItem(m_hwnd, nPage, &tcItem) )
 250     str = tcItem.pszText;
 251
 252   return str;
 253 }
 254
 255 int wxNotebook::GetPageImage(int nPage) const
 256 {
 257   wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
 258
 259   TC_ITEM tcItem;
 260   tcItem.mask = TCIF_IMAGE;
 261
 262   return TabCtrl_GetItem(m_hwnd, nPage, &tcItem) ? tcItem.iImage : -1;
 263 }
 264
 265 bool wxNotebook::SetPageImage(int nPage, int nImage)
 266 {
 267   wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
 268
 269   TC_ITEM tcItem;
 270   tcItem.mask = TCIF_IMAGE;
 271   tcItem.iImage = nImage;
 272
 273   return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
 274 }
 275
 276 void wxNotebook::SetImageList(wxImageList* imageList)
 277 {
 278   wxNotebookBase::SetImageList(imageList);
 279
 280   if ( imageList )
 281   {
 282     TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
 283   }
 284 }
 285
 286 // ----------------------------------------------------------------------------
 287 // wxNotebook size settings
 288 // ----------------------------------------------------------------------------
 289
 290 void wxNotebook::SetPageSize(const wxSize& size)
 291 {
 292     // transform the page size into the notebook size
 293     RECT rc;
 294     rc.left =
 295     rc.top = 0;
 296     rc.right = size.x;
 297     rc.bottom = size.y;
 298
 299     TabCtrl_AdjustRect(GetHwnd(), TRUE, &rc);
 300
 301     // and now set it
 302     SetSize(rc.right - rc.left, rc.bottom - rc.top);
 303 }
 304
 305 void wxNotebook::SetPadding(const wxSize& padding)
 306 {
 307     TabCtrl_SetPadding(GetHwnd(), padding.x, padding.y);
 308 }
 309
 310 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
 311 // style.
 312 void wxNotebook::SetTabSize(const wxSize& sz)
 313 {
 314     ::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y));
 315 }
 316
 317 // ----------------------------------------------------------------------------
 318 // wxNotebook operations
 319 // ----------------------------------------------------------------------------
 320
 321 // remove one page from the notebook, without deleting
 322 wxNotebookPage *wxNotebook::DoRemovePage(int nPage)
 323 {
 324     wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage);
 325     if ( !pageRemoved )
 326         return NULL;
 327
 328     TabCtrl_DeleteItem(m_hwnd, nPage);
 329
 330     if ( m_pages.IsEmpty() )
 331     {
 332         // no selection any more, the notebook becamse empty
 333         m_nSelection = -1;
 334     }
 335     else // notebook still not empty
 336     {
 337         // change the selected page if it was deleted or became invalid
 338         int selNew;
 339         if ( m_nSelection == GetPageCount() )
 340         {
 341             // last page deleted, make the new last page the new selection
 342             selNew = m_nSelection - 1;
 343         }
 344         else if ( nPage <= m_nSelection )
 345         {
 346             // we must show another page, even if it has the same index
 347             selNew = m_nSelection;
 348         }
 349         else // nothing changes for the currently selected page
 350         {
 351             selNew = -1;
 352
 353             // we still must refresh the current page: this needs to be done
 354             // for some unknown reason if the tab control shows the up-down
 355             // control (i.e. when there are too many pages) -- otherwise after
 356             // deleting a page nothing at all is shown
 357             m_pages[m_nSelection]->Refresh();
 358         }
 359
 360         if ( selNew != -1 )
 361         {
 362             // m_nSelection must be always valid so reset it before calling
 363             // SetSelection()
 364             m_nSelection = -1;
 365             SetSelection(selNew);
 366         }
 367     }
 368
 369     return pageRemoved;
 370 }
 371
 372 // remove all pages
 373 bool wxNotebook::DeleteAllPages()
 374 {
 375   int nPageCount = GetPageCount();
 376   int nPage;
 377   for ( nPage = 0; nPage < nPageCount; nPage++ )
 378     delete m_pages[nPage];
 379
 380   m_pages.Clear();
 381
 382   TabCtrl_DeleteAllItems(m_hwnd);
 383
 384   m_nSelection = -1;
 385
 386   return TRUE;
 387 }
 388
 389 // add a page to the notebook
 390 bool wxNotebook::AddPage(wxNotebookPage *pPage,
 391                          const wxString& strText,
 392                          bool bSelect,
 393                          int imageId)
 394 {
 395   return InsertPage(GetPageCount(), pPage, strText, bSelect, imageId);
 396 }
 397
 398 // same as AddPage() but does it at given position
 399 bool wxNotebook::InsertPage(int nPage,
 400                             wxNotebookPage *pPage,
 401                             const wxString& strText,
 402                             bool bSelect,
 403                             int imageId)
 404 {
 405     wxCHECK_MSG( pPage != NULL, FALSE, _T("NULL page in wxNotebook::InsertPage") );
 406     wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE,
 407                  _T("invalid index in wxNotebook::InsertPage") );
 408
 409
 410     // add a new tab to the control
 411     // ----------------------------
 412
 413     // init all fields to 0
 414     TC_ITEM tcItem;
 415     wxZeroMemory(tcItem);
 416
 417     // set the image, if any
 418     if ( imageId != -1 )
 419     {
 420         tcItem.mask |= TCIF_IMAGE;
 421         tcItem.iImage  = imageId;
 422     }
 423
 424     // and the text
 425     if ( !strText.IsEmpty() )
 426     {
 427         tcItem.mask |= TCIF_TEXT;
 428         tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
 429     }
 430
 431     // fit the notebook page to the tab control's display area: this should be
 432     // done before adding it to the notebook or TabCtrl_InsertItem() will
 433     // change the notebooks size itself!
 434     RECT rc;
 435     rc.left = rc.top = 0;
 436     GetSize((int *)&rc.right, (int *)&rc.bottom);
 437     TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
 438     pPage->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
 439
 440
 441     // finally do insert it
 442     if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 ) {
 443         wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
 444
 445         return FALSE;
 446     }
 447
 448     // succeeded: save the pointer to the page
 449     m_pages.Insert(pPage, nPage);
 450
 451     // hide the page: unless it is selected, it shouldn't be shown (and if it
 452     // is selected it will be shown later)
 453     HWND hwnd = GetWinHwnd(pPage);
 454     SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);
 455
 456     // this updates internal flag too -- otherwise it would get out of sync
 457     // with the real state
 458     pPage->Show(FALSE);
 459
 460
 461     // now deal with the selection
 462     // ---------------------------
 463
 464     // if the inserted page is before the selected one, we must update the
 465     // index of the selected page
 466     if ( nPage <= m_nSelection )
 467     {
 468         // one extra page added
 469         m_nSelection++;
 470     }
 471
 472     // some page should be selected: either this one or the first one if there
 473     // is still no selection
 474     int selNew = -1;
 475     if ( bSelect )
 476         selNew = nPage;
 477     else if ( m_nSelection == -1 )
 478         selNew = 0;
 479
 480     if ( selNew != -1 )
 481         SetSelection(selNew);
 482
 483     return TRUE;
 484 }
 485
 486 // ----------------------------------------------------------------------------
 487 // wxNotebook callbacks
 488 // ----------------------------------------------------------------------------
 489
 490 void wxNotebook::OnSize(wxSizeEvent& event)
 491 {
 492   // fit the notebook page to the tab control's display area
 493   RECT rc;
 494   rc.left = rc.top = 0;
 495   GetSize((int *)&rc.right, (int *)&rc.bottom);
 496
 497   TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
 498
 499   int width = rc.right - rc.left,
 500       height = rc.bottom - rc.top;
 501   size_t nCount = m_pages.Count();
 502   for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
 503     wxNotebookPage *pPage = m_pages[nPage];
 504     pPage->SetSize(rc.left, rc.top, width, height);
 505   }
 506
 507   event.Skip();
 508 }
 509
 510 void wxNotebook::OnSelChange(wxNotebookEvent& event)
 511 {
 512   // is it our tab control?
 513   if ( event.GetEventObject() == this )
 514   {
 515       int sel = event.GetOldSelection();
 516       if ( sel != -1 )
 517         m_pages[sel]->Show(FALSE);
 518
 519       sel = event.GetSelection();
 520       if ( sel != -1 )
 521       {
 522         wxNotebookPage *pPage = m_pages[sel];
 523         pPage->Show(TRUE);
 524         pPage->SetFocus();
 525       }
 526
 527       m_nSelection = sel;
 528   }
 529
 530   // we want to give others a chance to process this message as well
 531   event.Skip();
 532 }
 533
 534 void wxNotebook::OnSetFocus(wxFocusEvent& event)
 535 {
 536     // this function is only called when the focus is explicitly set (i.e. from
 537     // the program) to the notebook - in this case we don't need the
 538     // complicated OnNavigationKey() logic because the programmer knows better
 539     // what [s]he wants
 540
 541     // set focus to the currently selected page if any
 542     if ( m_nSelection != -1 )
 543         m_pages[m_nSelection]->SetFocus();
 544
 545     event.Skip();
 546 }
 547
 548 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 549 {
 550     if ( event.IsWindowChange() ) {
 551         // change pages
 552         AdvanceSelection(event.GetDirection());
 553     }
 554     else {
 555         // we get this event in 2 cases
 556         //
 557         // a) one of our pages might have generated it because the user TABbed
 558         // out from it in which case we should propagate the event upwards and
 559         // our parent will take care of setting the focus to prev/next sibling
 560         //
 561         // or
 562         //
 563         // b) the parent panel wants to give the focus to us so that we
 564         // forward it to our selected page. We can't deal with this in
 565         // OnSetFocus() because we don't know which direction the focus came
 566         // from in this case and so can't choose between setting the focus to
 567         // first or last panel child
 568
 569         wxWindow *parent = GetParent();
 570         if ( event.GetEventObject() == parent )
 571         {
 572             // no, it doesn't come from child, case (b): forward to a page
 573             if ( m_nSelection != -1 )
 574             {
 575                 // so that the page knows that the event comes from it's parent
 576                 // and is being propagated downwards
 577                 event.SetEventObject(this);
 578
 579                 wxWindow *page = m_pages[m_nSelection];
 580                 if ( !page->GetEventHandler()->ProcessEvent(event) )
 581                 {
 582                     page->SetFocus();
 583                 }
 584                 //else: page manages focus inside it itself
 585             }
 586             else
 587             {
 588                 // we have no pages - still have to give focus to _something_
 589                 SetFocus();
 590             }
 591         }
 592         else
 593         {
 594             // it comes from our child, case (a), pass to the parent
 595             if ( parent ) {
 596                 event.SetCurrentFocus(this);
 597                 parent->GetEventHandler()->ProcessEvent(event);
 598             }
 599         }
 600     }
 601 }
 602
 603 // ----------------------------------------------------------------------------
 604 // wxNotebook base class virtuals
 605 // ----------------------------------------------------------------------------
 606
 607 // override these 2 functions to do nothing: everything is done in OnSize
 608
 609 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
 610 {
 611   // don't set the sizes of the pages - their correct size is not yet known
 612   wxControl::SetConstraintSizes(FALSE);
 613 }
 614
 615 bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
 616 {
 617   return TRUE;
 618 }
 619
 620 // ----------------------------------------------------------------------------
 621 // wxNotebook Windows message handlers
 622 // ----------------------------------------------------------------------------
 623
 624 bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode,
 625                              WXWORD pos, WXHWND control)
 626 {
 627     // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
 628     // up-down control
 629     if ( control )
 630         return FALSE;
 631
 632     return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
 633 }
 634
 635 bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
 636 {
 637   wxNotebookEvent event(wxEVT_NULL, m_windowId);
 638
 639   NMHDR* hdr = (NMHDR *)lParam;
 640   switch ( hdr->code ) {
 641     case TCN_SELCHANGE:
 642       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
 643       break;
 644
 645     case TCN_SELCHANGING:
 646       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING);
 647       break;
 648
 649     default:
 650       return wxControl::MSWOnNotify(idCtrl, lParam, result);
 651   }
 652
 653   event.SetSelection(TabCtrl_GetCurSel(m_hwnd));
 654   event.SetOldSelection(m_nSelection);
 655   event.SetEventObject(this);
 656   event.SetInt(idCtrl);
 657
 658   bool processed = GetEventHandler()->ProcessEvent(event);
 659   *result = !event.IsAllowed();
 660   return processed;
 661 }
 662
 663 #endif // wxUSE_NOTEBOOK