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