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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  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 #include  "wx/app.h"
  36
  37 #include  "wx/msw/private.h"
  38
  39 // Windows standard headers
  40 #ifndef   __WIN95__
  41   #error  "wxNotebook is only supported Windows 95 and above"
  42 #endif    //Win95
  43
  44 #include  <windowsx.h>  // for SetWindowFont
  45
  46 #ifdef __GNUWIN32_OLD__
  47     #include "wx/msw/gnuwin32/extra.h"
  48 #endif
  49
  50 #if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
  51     #include <commctrl.h>
  52 #endif
  53
  54 #include "wx/msw/winundef.h"
  55
  56 #if wxUSE_UXTHEME
  57 #include "wx/msw/uxtheme.h"
  58
  59 #include "wx/radiobut.h"
  60 #include "wx/radiobox.h"
  61 #include "wx/checkbox.h"
  62 #include "wx/bmpbuttn.h"
  63 #include "wx/statline.h"
  64 #include "wx/statbox.h"
  65 #include "wx/stattext.h"
  66 #include "wx/slider.h"
  67 #include "wx/scrolwin.h"
  68 #include "wx/panel.h"
  69 #endif
  70
  71 // ----------------------------------------------------------------------------
  72 // macros
  73 // ----------------------------------------------------------------------------
  74
  75 // check that the page index is valid
  76 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
  77
  78 // hide the ugly cast
  79 #define m_hwnd    (HWND)GetHWND()
  80
  81 // ----------------------------------------------------------------------------
  82 // constants
  83 // ----------------------------------------------------------------------------
  84
  85 // This is a work-around for missing defines in gcc-2.95 headers
  86 #ifndef TCS_RIGHT
  87     #define TCS_RIGHT       0x0002
  88 #endif
  89
  90 #ifndef TCS_VERTICAL
  91     #define TCS_VERTICAL    0x0080
  92 #endif
  93
  94 #ifndef TCS_BOTTOM
  95     #define TCS_BOTTOM      TCS_RIGHT
  96 #endif
  97
  98 // ----------------------------------------------------------------------------
  99 // event table
 100 // ----------------------------------------------------------------------------
 101
 102 #include <wx/listimpl.cpp>
 103
 104 WX_DEFINE_LIST( wxNotebookPageInfoList ) ;
 105
 106 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
 107 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
 108
 109 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
 110     EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
 111
 112     EVT_SIZE(wxNotebook::OnSize)
 113
 114     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
 115 END_EVENT_TABLE()
 116
 117 #if wxUSE_EXTENDED_RTTI
 118 WX_DEFINE_FLAGS( wxNotebookStyle )
 119
 120 wxBEGIN_FLAGS( wxNotebookStyle )
 121     // new style border flags, we put them first to
 122     // use them for streaming out
 123     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
 124     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
 125     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
 126     wxFLAGS_MEMBER(wxBORDER_RAISED)
 127     wxFLAGS_MEMBER(wxBORDER_STATIC)
 128     wxFLAGS_MEMBER(wxBORDER_NONE)
 129
 130     // old style border flags
 131     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
 132     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
 133     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
 134     wxFLAGS_MEMBER(wxRAISED_BORDER)
 135     wxFLAGS_MEMBER(wxSTATIC_BORDER)
 136     wxFLAGS_MEMBER(wxBORDER)
 137
 138     // standard window styles
 139     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
 140     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
 141     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
 142     wxFLAGS_MEMBER(wxWANTS_CHARS)
 143     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
 144     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
 145     wxFLAGS_MEMBER(wxVSCROLL)
 146     wxFLAGS_MEMBER(wxHSCROLL)
 147
 148     wxFLAGS_MEMBER(wxNB_FIXEDWIDTH)
 149     wxFLAGS_MEMBER(wxNB_LEFT)
 150     wxFLAGS_MEMBER(wxNB_RIGHT)
 151     wxFLAGS_MEMBER(wxNB_BOTTOM)
 152
 153 wxEND_FLAGS( wxNotebookStyle )
 154
 155 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebook, wxControl,"wx/notebook.h")
 156 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebookPageInfo, wxObject , "wx/notebook.h" )
 157
 158 wxCOLLECTION_TYPE_INFO( wxNotebookPageInfo * , wxNotebookPageInfoList ) ;
 159
 160 template<> void wxCollectionToVariantArray( wxNotebookPageInfoList const &theList, wxxVariantArray &value)
 161 {
 162     wxListCollectionToVariantArray<wxNotebookPageInfoList::compatibility_iterator>( theList , value ) ;
 163 }
 164
 165 wxBEGIN_PROPERTIES_TABLE(wxNotebook)
 166     wxEVENT_PROPERTY( PageChanging , wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING , wxNotebookEvent )
 167     wxEVENT_PROPERTY( PageChanged , wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED , wxNotebookEvent )
 168
 169     wxPROPERTY_COLLECTION( PageInfos , wxNotebookPageInfoList , wxNotebookPageInfo* , AddPageInfo , GetPageInfos , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 170     wxPROPERTY_FLAGS( WindowStyle , wxNotebookStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
 171 wxEND_PROPERTIES_TABLE()
 172
 173 wxBEGIN_HANDLERS_TABLE(wxNotebook)
 174 wxEND_HANDLERS_TABLE()
 175
 176 wxCONSTRUCTOR_5( wxNotebook , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle)
 177
 178
 179 wxBEGIN_PROPERTIES_TABLE(wxNotebookPageInfo)
 180     wxREADONLY_PROPERTY( Page , wxNotebookPage* , GetPage , , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 181     wxREADONLY_PROPERTY( Text , wxString , GetText , wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 182     wxREADONLY_PROPERTY( Selected , bool , GetSelected , false, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
 183     wxREADONLY_PROPERTY( ImageId , int , GetImageId , -1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 184 wxEND_PROPERTIES_TABLE()
 185
 186 wxBEGIN_HANDLERS_TABLE(wxNotebookPageInfo)
 187 wxEND_HANDLERS_TABLE()
 188
 189 wxCONSTRUCTOR_4( wxNotebookPageInfo , wxNotebookPage* , Page , wxString , Text , bool , Selected , int , ImageId )
 190
 191 #else
 192 IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
 193 IMPLEMENT_DYNAMIC_CLASS(wxNotebookPageInfo, wxObject )
 194 #endif
 195 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
 196
 197 // ============================================================================
 198 // implementation
 199 // ============================================================================
 200
 201 // ----------------------------------------------------------------------------
 202 // wxNotebook construction
 203 // ----------------------------------------------------------------------------
 204
 205 const wxNotebookPageInfoList& wxNotebook::GetPageInfos() const
 206 {
 207     wxNotebookPageInfoList* list = const_cast< wxNotebookPageInfoList* >( &m_pageInfos ) ;
 208     WX_CLEAR_LIST( wxNotebookPageInfoList , *list ) ;
 209     for( size_t i = 0 ; i < GetPageCount() ; ++i )
 210     {
 211         wxNotebookPageInfo *info = new wxNotebookPageInfo() ;
 212         info->Create( const_cast<wxNotebook*>(this)->GetPage(i) , GetPageText(i) , GetSelection() == int(i) , GetPageImage(i) ) ;
 213         list->Append( info ) ;
 214     }
 215     return m_pageInfos ;
 216 }
 217
 218 // common part of all ctors
 219 void wxNotebook::Init()
 220 {
 221   m_imageList = NULL;
 222   m_nSelection = -1;
 223 }
 224
 225 // default for dynamic class
 226 wxNotebook::wxNotebook()
 227 {
 228   Init();
 229 }
 230
 231 // the same arguments as for wxControl
 232 wxNotebook::wxNotebook(wxWindow *parent,
 233                        wxWindowID id,
 234                        const wxPoint& pos,
 235                        const wxSize& size,
 236                        long style,
 237                        const wxString& name)
 238 {
 239   Init();
 240
 241   Create(parent, id, pos, size, style, name);
 242 }
 243
 244 // Create() function
 245 bool wxNotebook::Create(wxWindow *parent,
 246                         wxWindowID id,
 247                         const wxPoint& pos,
 248                         const wxSize& size,
 249                         long style,
 250                         const wxString& name)
 251 {
 252     // Does ComCtl32 support non-top tabs?
 253     int verComCtl32 = wxApp::GetComCtl32Version();
 254     if ( verComCtl32 < 470 || verComCtl32 >= 600 )
 255     {
 256         if (style & wxNB_BOTTOM)
 257             style &= ~wxNB_BOTTOM;
 258
 259         if (style & wxNB_LEFT)
 260             style &= ~wxNB_LEFT;
 261
 262         if (style & wxNB_RIGHT)
 263             style &= ~wxNB_RIGHT;
 264     }
 265
 266     if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL,
 267                         wxDefaultValidator, name) )
 268         return false;
 269
 270     if ( !MSWCreateControl(WC_TABCONTROL, wxEmptyString, pos, size) )
 271         return false;
 272
 273     SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));
 274
 275     return true;
 276 }
 277
 278 WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const
 279 {
 280     WXDWORD tabStyle = wxControl::MSWGetStyle(style, exstyle);
 281
 282     tabStyle |= WS_TABSTOP | TCS_TABS;
 283
 284     if ( style & wxNB_MULTILINE )
 285         tabStyle |= TCS_MULTILINE;
 286     if ( style & wxNB_FIXEDWIDTH )
 287         tabStyle |= TCS_FIXEDWIDTH;
 288
 289     if ( style & wxNB_BOTTOM )
 290         tabStyle |= TCS_RIGHT;
 291     else if ( style & wxNB_LEFT )
 292         tabStyle |= TCS_VERTICAL;
 293     else if ( style & wxNB_RIGHT )
 294         tabStyle |= TCS_VERTICAL | TCS_RIGHT;
 295
 296     // ex style
 297     if ( exstyle )
 298     {
 299         // note that we never want to have the default WS_EX_CLIENTEDGE style
 300         // as it looks too ugly for the notebooks
 301         *exstyle = 0;
 302     }
 303
 304     return tabStyle;
 305 }
 306
 307 // ----------------------------------------------------------------------------
 308 // wxNotebook accessors
 309 // ----------------------------------------------------------------------------
 310
 311 size_t wxNotebook::GetPageCount() const
 312 {
 313   // consistency check
 314   wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) );
 315
 316   return m_pages.Count();
 317 }
 318
 319 int wxNotebook::GetRowCount() const
 320 {
 321   return TabCtrl_GetRowCount(m_hwnd);
 322 }
 323
 324 int wxNotebook::SetSelection(size_t nPage)
 325 {
 326   wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
 327
 328   if ( int(nPage) != m_nSelection )
 329   {
 330     wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
 331     event.SetSelection(nPage);
 332     event.SetOldSelection(m_nSelection);
 333     event.SetEventObject(this);
 334     if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 335     {
 336       // program allows the page change
 337       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
 338       (void)GetEventHandler()->ProcessEvent(event);
 339
 340       TabCtrl_SetCurSel(m_hwnd, nPage);
 341     }
 342   }
 343
 344   return m_nSelection;
 345 }
 346
 347 bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
 348 {
 349   wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") );
 350
 351   TC_ITEM tcItem;
 352   tcItem.mask = TCIF_TEXT;
 353   tcItem.pszText = (wxChar *)strText.c_str();
 354
 355   return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
 356 }
 357
 358 wxString wxNotebook::GetPageText(size_t nPage) const
 359 {
 360   wxCHECK_MSG( IS_VALID_PAGE(nPage), wxEmptyString, wxT("notebook page out of range") );
 361
 362   wxChar buf[256];
 363   TC_ITEM tcItem;
 364   tcItem.mask = TCIF_TEXT;
 365   tcItem.pszText = buf;
 366   tcItem.cchTextMax = WXSIZEOF(buf);
 367
 368   wxString str;
 369   if ( TabCtrl_GetItem(m_hwnd, nPage, &tcItem) )
 370     str = tcItem.pszText;
 371
 372   return str;
 373 }
 374
 375 int wxNotebook::GetPageImage(size_t nPage) const
 376 {
 377   wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
 378
 379   TC_ITEM tcItem;
 380   tcItem.mask = TCIF_IMAGE;
 381
 382   return TabCtrl_GetItem(m_hwnd, nPage, &tcItem) ? tcItem.iImage : -1;
 383 }
 384
 385 bool wxNotebook::SetPageImage(size_t nPage, int nImage)
 386 {
 387   wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") );
 388
 389   TC_ITEM tcItem;
 390   tcItem.mask = TCIF_IMAGE;
 391   tcItem.iImage = nImage;
 392
 393   return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
 394 }
 395
 396 void wxNotebook::SetImageList(wxImageList* imageList)
 397 {
 398   wxNotebookBase::SetImageList(imageList);
 399
 400   if ( imageList )
 401   {
 402     TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
 403   }
 404 }
 405
 406 // ----------------------------------------------------------------------------
 407 // wxNotebook size settings
 408 // ----------------------------------------------------------------------------
 409
 410 void wxNotebook::SetPageSize(const wxSize& size)
 411 {
 412     // transform the page size into the notebook size
 413     RECT rc;
 414     rc.left =
 415     rc.top = 0;
 416     rc.right = size.x;
 417     rc.bottom = size.y;
 418
 419     TabCtrl_AdjustRect(GetHwnd(), true, &rc);
 420
 421     // and now set it
 422     SetSize(rc.right - rc.left, rc.bottom - rc.top);
 423 }
 424
 425 void wxNotebook::SetPadding(const wxSize& padding)
 426 {
 427     TabCtrl_SetPadding(GetHwnd(), padding.x, padding.y);
 428 }
 429
 430 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
 431 // style.
 432 void wxNotebook::SetTabSize(const wxSize& sz)
 433 {
 434     ::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y));
 435 }
 436
 437 wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const
 438 {
 439     wxSize sizeTotal = sizePage;
 440
 441     // We need to make getting tab size part of the wxWindows API.
 442     wxSize tabSize(0, 0);
 443     if (GetPageCount() > 0)
 444     {
 445         RECT rect;
 446         TabCtrl_GetItemRect((HWND) GetHWND(), 0, & rect);
 447         tabSize.x = rect.right - rect.left;
 448         tabSize.y = rect.bottom - rect.top;
 449     }
 450     if ( HasFlag(wxNB_LEFT) || HasFlag(wxNB_RIGHT) )
 451     {
 452         sizeTotal.x += tabSize.x + 7;
 453         sizeTotal.y += 7;
 454     }
 455     else
 456     {
 457         sizeTotal.x += 7;
 458         sizeTotal.y += tabSize.y + 7;
 459     }
 460
 461     return sizeTotal;
 462 }
 463
 464 void wxNotebook::AdjustPageSize(wxNotebookPage *page)
 465 {
 466     wxCHECK_RET( page, _T("NULL page in wxNotebook::AdjustPageSize") );
 467
 468     RECT rc;
 469     rc.left =
 470     rc.top = 0;
 471
 472     // get the page size from the notebook size
 473     GetSize((int *)&rc.right, (int *)&rc.bottom);
 474     TabCtrl_AdjustRect(m_hwnd, false, &rc);
 475
 476     page->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
 477 }
 478
 479 // ----------------------------------------------------------------------------
 480 // wxNotebook operations
 481 // ----------------------------------------------------------------------------
 482
 483 // remove one page from the notebook, without deleting
 484 wxNotebookPage *wxNotebook::DoRemovePage(size_t nPage)
 485 {
 486     wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage);
 487     if ( !pageRemoved )
 488         return NULL;
 489
 490     TabCtrl_DeleteItem(m_hwnd, nPage);
 491
 492     if ( m_pages.IsEmpty() )
 493     {
 494         // no selection any more, the notebook becamse empty
 495         m_nSelection = -1;
 496     }
 497     else // notebook still not empty
 498     {
 499         // change the selected page if it was deleted or became invalid
 500         int selNew;
 501         if ( m_nSelection == int(GetPageCount()) )
 502         {
 503             // last page deleted, make the new last page the new selection
 504             selNew = m_nSelection - 1;
 505         }
 506         else if ( int(nPage) <= m_nSelection )
 507         {
 508             // we must show another page, even if it has the same index
 509             selNew = m_nSelection;
 510         }
 511         else // nothing changes for the currently selected page
 512         {
 513             selNew = -1;
 514
 515             // we still must refresh the current page: this needs to be done
 516             // for some unknown reason if the tab control shows the up-down
 517             // control (i.e. when there are too many pages) -- otherwise after
 518             // deleting a page nothing at all is shown
 519             if (m_nSelection >= 0)
 520                 m_pages[m_nSelection]->Refresh();
 521         }
 522
 523         if ( selNew != -1 )
 524         {
 525             // m_nSelection must be always valid so reset it before calling
 526             // SetSelection()
 527             m_nSelection = -1;
 528             SetSelection(selNew);
 529         }
 530     }
 531
 532     return pageRemoved;
 533 }
 534
 535 // remove all pages
 536 bool wxNotebook::DeleteAllPages()
 537 {
 538   size_t nPageCount = GetPageCount();
 539   size_t nPage;
 540   for ( nPage = 0; nPage < nPageCount; nPage++ )
 541     delete m_pages[nPage];
 542
 543   m_pages.Clear();
 544
 545   TabCtrl_DeleteAllItems(m_hwnd);
 546
 547   m_nSelection = -1;
 548
 549   return true;
 550 }
 551
 552 // same as AddPage() but does it at given position
 553 bool wxNotebook::InsertPage(size_t nPage,
 554                             wxNotebookPage *pPage,
 555                             const wxString& strText,
 556                             bool bSelect,
 557                             int imageId)
 558 {
 559     wxCHECK_MSG( pPage != NULL, false, _T("NULL page in wxNotebook::InsertPage") );
 560     wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), false,
 561                  _T("invalid index in wxNotebook::InsertPage") );
 562
 563     wxASSERT_MSG( pPage->GetParent() == this,
 564                     _T("notebook pages must have notebook as parent") );
 565
 566 #if wxUSE_UXTHEME && wxUSE_UXTHEME_AUTO
 567     static bool g_TestedForTheme = false;
 568     static bool g_UseTheme = false;
 569     if (!g_TestedForTheme)
 570     {
 571         int commCtrlVersion = wxTheApp->GetComCtl32Version() ;
 572
 573         g_UseTheme = (commCtrlVersion >= 600);
 574         g_TestedForTheme = true;
 575     }
 576
 577     // Automatically apply the theme background,
 578     // changing the colour of the panel to match the
 579     // tab page colour. This won't work well with all
 580     // themes but it's a start.
 581     if (g_UseTheme && wxUxThemeEngine::Get() && pPage->IsKindOf(CLASSINFO(wxPanel)))
 582     {
 583         ApplyThemeBackground(pPage, GetThemeBackgroundColour());
 584     }
 585 #endif
 586
 587     // add a new tab to the control
 588     // ----------------------------
 589
 590     // init all fields to 0
 591     TC_ITEM tcItem;
 592     wxZeroMemory(tcItem);
 593
 594     // set the image, if any
 595     if ( imageId != -1 )
 596     {
 597         tcItem.mask |= TCIF_IMAGE;
 598         tcItem.iImage  = imageId;
 599     }
 600
 601     // and the text
 602     if ( !strText.IsEmpty() )
 603     {
 604         tcItem.mask |= TCIF_TEXT;
 605         tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
 606     }
 607
 608     // fit the notebook page to the tab control's display area: this should be
 609     // done before adding it to the notebook or TabCtrl_InsertItem() will
 610     // change the notebooks size itself!
 611     AdjustPageSize(pPage);
 612
 613     // finally do insert it
 614     if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 )
 615     {
 616         wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
 617
 618         return false;
 619     }
 620
 621     // succeeded: save the pointer to the page
 622     m_pages.Insert(pPage, nPage);
 623
 624     // for the first page (only) we need to adjust the size again because the
 625     // notebook size changed: the tabs which hadn't been there before are now
 626     // shown
 627     if ( m_pages.GetCount() == 1 )
 628     {
 629         AdjustPageSize(pPage);
 630     }
 631
 632     // hide the page: unless it is selected, it shouldn't be shown (and if it
 633     // is selected it will be shown later)
 634     HWND hwnd = GetWinHwnd(pPage);
 635     SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);
 636
 637     // this updates internal flag too -- otherwise it would get out of sync
 638     // with the real state
 639     pPage->Show(false);
 640
 641
 642     // now deal with the selection
 643     // ---------------------------
 644
 645     // if the inserted page is before the selected one, we must update the
 646     // index of the selected page
 647     if ( int(nPage) <= m_nSelection )
 648     {
 649         // one extra page added
 650         m_nSelection++;
 651     }
 652
 653     // some page should be selected: either this one or the first one if there
 654     // is still no selection
 655     int selNew = -1;
 656     if ( bSelect )
 657         selNew = nPage;
 658     else if ( m_nSelection == -1 )
 659         selNew = 0;
 660
 661     if ( selNew != -1 )
 662         SetSelection(selNew);
 663
 664     return true;
 665 }
 666
 667 int wxNotebook::HitTest(const wxPoint& pt, long *flags) const
 668 {
 669     TC_HITTESTINFO hitTestInfo;
 670     hitTestInfo.pt.x = pt.x;
 671     hitTestInfo.pt.y = pt.y;
 672     int item = TabCtrl_HitTest(GetHwnd(), &hitTestInfo);
 673
 674     if ( flags )
 675     {
 676         *flags = 0;
 677
 678         if ((hitTestInfo.flags & TCHT_NOWHERE) == TCHT_NOWHERE)
 679             *flags |= wxNB_HITTEST_NOWHERE;
 680         if ((hitTestInfo.flags & TCHT_ONITEM) == TCHT_ONITEM)
 681             *flags |= wxNB_HITTEST_ONITEM;
 682         if ((hitTestInfo.flags & TCHT_ONITEMICON) == TCHT_ONITEMICON)
 683             *flags |= wxNB_HITTEST_ONICON;
 684         if ((hitTestInfo.flags & TCHT_ONITEMLABEL) == TCHT_ONITEMLABEL)
 685             *flags |= wxNB_HITTEST_ONLABEL;
 686     }
 687
 688     return item;
 689 }
 690
 691
 692 // ----------------------------------------------------------------------------
 693 // wxNotebook callbacks
 694 // ----------------------------------------------------------------------------
 695
 696 void wxNotebook::OnSize(wxSizeEvent& event)
 697 {
 698   // fit the notebook page to the tab control's display area
 699   RECT rc;
 700   rc.left = rc.top = 0;
 701   GetSize((int *)&rc.right, (int *)&rc.bottom);
 702
 703   TabCtrl_AdjustRect(m_hwnd, false, &rc);
 704
 705   int width = rc.right - rc.left,
 706       height = rc.bottom - rc.top;
 707   size_t nCount = m_pages.Count();
 708   for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
 709     wxNotebookPage *pPage = m_pages[nPage];
 710     pPage->SetSize(rc.left, rc.top, width, height);
 711   }
 712
 713   event.Skip();
 714 }
 715
 716 void wxNotebook::OnSelChange(wxNotebookEvent& event)
 717 {
 718   // is it our tab control?
 719   if ( event.GetEventObject() == this )
 720   {
 721       int sel = event.GetOldSelection();
 722       if ( sel != -1 )
 723         m_pages[sel]->Show(false);
 724
 725       sel = event.GetSelection();
 726       if ( sel != -1 )
 727       {
 728         wxNotebookPage *pPage = m_pages[sel];
 729         pPage->Show(true);
 730       }
 731
 732       m_nSelection = sel;
 733   }
 734
 735   // we want to give others a chance to process this message as well
 736   event.Skip();
 737 }
 738
 739 bool wxNotebook::MSWTranslateMessage(WXMSG *wxmsg)
 740 {
 741     const MSG * const msg = (MSG *)wxmsg;
 742
 743     // we want to process (simple, i.e. without Shift or Ctrl) TAB to pass it
 744     // to our page for keyboard navigation
 745     if ( msg->message == WM_KEYDOWN && msg->wParam == VK_TAB &&
 746             msg->hwnd == m_hwnd &&
 747                 !wxIsCtrlDown() && !wxIsShiftDown() &&
 748                     m_nSelection != -1 )
 749     {
 750         return MSWProcessMessage(wxmsg);
 751     }
 752
 753     return false;
 754 }
 755
 756 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 757 {
 758     if ( event.IsWindowChange() ) {
 759         // change pages
 760         AdvanceSelection(event.GetDirection());
 761     }
 762     else {
 763         // we get this event in 3 cases
 764         //
 765         // a) one of our pages might have generated it because the user TABbed
 766         // out from it in which case we should propagate the event upwards and
 767         // our parent will take care of setting the focus to prev/next sibling
 768         //
 769         // or
 770         //
 771         // b) the parent panel wants to give the focus to us so that we
 772         // forward it to our selected page. We can't deal with this in
 773         // OnSetFocus() because we don't know which direction the focus came
 774         // from in this case and so can't choose between setting the focus to
 775         // first or last panel child
 776         //
 777         // or
 778         //
 779         // c) we ourselves (see MSWTranslateMessage) generated the event
 780         //
 781         wxWindow * const parent = GetParent();
 782
 783         const bool isFromParent = event.GetEventObject() == parent;
 784         const bool isFromSelf = event.GetEventObject() == this;
 785
 786         if ( isFromParent || isFromSelf )
 787         {
 788             // no, it doesn't come from child, case (b) or (c): forward to a
 789             // page but only if direction is backwards (TAB) or from ourselves,
 790             if ( m_nSelection != -1 &&
 791                     (!event.GetDirection() || isFromSelf) )
 792             {
 793                 // so that the page knows that the event comes from it's parent
 794                 // and is being propagated downwards
 795                 event.SetEventObject(this);
 796
 797                 wxWindow *page = m_pages[m_nSelection];
 798                 if ( !page->GetEventHandler()->ProcessEvent(event) )
 799                 {
 800                     page->SetFocus();
 801                 }
 802                 //else: page manages focus inside it itself
 803             }
 804             else // otherwise set the focus to the notebook itself
 805             {
 806                 SetFocus();
 807             }
 808         }
 809         else
 810         {
 811             // it comes from our child, case (a), pass to the parent, but only
 812             // if the direction is forwards. Otherwise set the focus to the
 813             // notebook itself. The notebook is always the 'first' control of a
 814             // page.
 815             if ( !event.GetDirection() )
 816             {
 817                 SetFocus();
 818             }
 819             else if ( parent )
 820             {
 821                 event.SetCurrentFocus(this);
 822                 parent->GetEventHandler()->ProcessEvent(event);
 823             }
 824         }
 825     }
 826 }
 827
 828 // ----------------------------------------------------------------------------
 829 // wxNotebook base class virtuals
 830 // ----------------------------------------------------------------------------
 831
 832 #if wxUSE_CONSTRAINTS
 833
 834 // override these 2 functions to do nothing: everything is done in OnSize
 835
 836 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
 837 {
 838   // don't set the sizes of the pages - their correct size is not yet known
 839   wxControl::SetConstraintSizes(false);
 840 }
 841
 842 bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
 843 {
 844   return true;
 845 }
 846
 847 #endif // wxUSE_CONSTRAINTS
 848
 849 // ----------------------------------------------------------------------------
 850 // wxNotebook Windows message handlers
 851 // ----------------------------------------------------------------------------
 852
 853 bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode,
 854                              WXWORD pos, WXHWND control)
 855 {
 856     // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
 857     // up-down control
 858     if ( control )
 859         return false;
 860
 861     return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
 862 }
 863
 864 bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
 865 {
 866   wxNotebookEvent event(wxEVT_NULL, m_windowId);
 867
 868   NMHDR* hdr = (NMHDR *)lParam;
 869   switch ( hdr->code ) {
 870     case TCN_SELCHANGE:
 871       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
 872       break;
 873
 874     case TCN_SELCHANGING:
 875       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING);
 876       break;
 877
 878     default:
 879       return wxControl::MSWOnNotify(idCtrl, lParam, result);
 880   }
 881
 882   event.SetSelection(TabCtrl_GetCurSel(m_hwnd));
 883   event.SetOldSelection(m_nSelection);
 884   event.SetEventObject(this);
 885   event.SetInt(idCtrl);
 886
 887   bool processed = GetEventHandler()->ProcessEvent(event);
 888   *result = !event.IsAllowed();
 889   return processed;
 890 }
 891
 892 // Windows only: attempts to get colour for UX theme page background
 893 wxColour wxNotebook::GetThemeBackgroundColour()
 894 {
 895 #if wxUSE_UXTHEME
 896     if (wxUxThemeEngine::Get())
 897     {
 898         wxUxThemeHandle hTheme(this, L"TAB");
 899         if (hTheme)
 900         {
 901             // This is total guesswork.
 902             // See PlatformSDK\Include\Tmschema.h for values
 903             COLORREF themeColor;
 904             wxUxThemeEngine::Get()->GetThemeColor
 905                                     (
 906                                         hTheme,
 907                                         10 /* TABP_BODY */,
 908                                         1 /* NORMAL */,
 909                                         3821, /* FILLCOLORHINT */
 910                                         & themeColor
 911                                     );
 912
 913             wxColour colour(GetRValue(themeColor), GetGValue(themeColor), GetBValue(themeColor));
 914             return colour;
 915         }
 916     }
 917 #endif // wxUSE_UXTHEME
 918
 919     return GetBackgroundColour();
 920 }
 921
 922 // Windows only: attempts to apply the UX theme page background to this page
 923 #if wxUSE_UXTHEME
 924 void wxNotebook::ApplyThemeBackground(wxWindow* window, const wxColour& colour)
 925 #else
 926 void wxNotebook::ApplyThemeBackground(wxWindow*, const wxColour&)
 927 #endif
 928 {
 929 #if wxUSE_UXTHEME
 930     // Don't set the background for buttons since this will
 931     // switch it into ownerdraw mode
 932     if (window->IsKindOf(CLASSINFO(wxButton)) && !window->IsKindOf(CLASSINFO(wxBitmapButton)))
 933         // This is essential, otherwise you'll see dark grey
 934         // corners in the buttons.
 935         ((wxButton*)window)->wxControl::SetBackgroundColour(colour);
 936     else if (window->IsKindOf(CLASSINFO(wxStaticText)) ||
 937              window->IsKindOf(CLASSINFO(wxStaticBox)) ||
 938              window->IsKindOf(CLASSINFO(wxStaticLine)) ||
 939              window->IsKindOf(CLASSINFO(wxRadioButton)) ||
 940              window->IsKindOf(CLASSINFO(wxRadioBox)) ||
 941              window->IsKindOf(CLASSINFO(wxCheckBox)) ||
 942              window->IsKindOf(CLASSINFO(wxBitmapButton)) ||
 943              window->IsKindOf(CLASSINFO(wxSlider)) ||
 944              window->IsKindOf(CLASSINFO(wxPanel)) ||
 945              (window->IsKindOf(CLASSINFO(wxNotebook)) && (window != this)) ||
 946              window->IsKindOf(CLASSINFO(wxScrolledWindow))
 947         )
 948     {
 949         window->SetBackgroundColour(colour);
 950     }
 951
 952     for ( wxWindowList::compatibility_iterator node = window->GetChildren().GetFirst(); node; node = node->GetNext() )
 953     {
 954         wxWindow *child = node->GetData();
 955         ApplyThemeBackground(child, colour);
 956     }
 957 #endif
 958 }
 959
 960 long wxNotebook::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 961 {
 962     static bool g_TestedForTheme = false;
 963     static bool g_UseTheme = false;
 964     switch ( nMsg )
 965     {
 966         case WM_ERASEBKGND:
 967         {
 968             if (!g_TestedForTheme)
 969             {
 970                 int commCtrlVersion = wxTheApp->GetComCtl32Version() ;
 971
 972                 g_UseTheme = (commCtrlVersion >= 600);
 973                 g_TestedForTheme = true;
 974             }
 975
 976             // If using XP themes, it seems we can get away
 977             // with not drawing a background, which reduces flicker.
 978             if (g_UseTheme)
 979                 return true;
 980         }
 981     }
 982
 983     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
 984 }
 985
 986
 987 #endif // wxUSE_NOTEBOOK