X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/82a16d7e5e5c83e95a4caa7314de2dbfbd1debdc..f60ca3e24c9c09f3053310807b9e4dab8a613578:/src/msw/notebook.cpp diff --git a/src/msw/notebook.cpp b/src/msw/notebook.cpp index b060534c71..5c9cd14cd2 100644 --- a/src/msw/notebook.cpp +++ b/src/msw/notebook.cpp @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: msw/notebook.cpp +// Name: src/msw/notebook.cpp // Purpose: implementation of wxNotebook // Author: Vadim Zeitlin // Modified by: @@ -9,10 +9,6 @@ // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma implementation "notebook.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -22,37 +18,27 @@ #if wxUSE_NOTEBOOK -// wxWidgets +#include "wx/notebook.h" + #ifndef WX_PRECOMP - #include "wx/string.h" - #include "wx/dc.h" + #include "wx/msw/wrapcctl.h" // include "properly" + #include "wx/string.h" + #include "wx/dc.h" + #include "wx/log.h" + #include "wx/event.h" + #include "wx/app.h" + #include "wx/dcclient.h" + #include "wx/dcmemory.h" + #include "wx/control.h" #endif // WX_PRECOMP -#include "wx/log.h" -#include "wx/imaglist.h" -#include "wx/event.h" -#include "wx/control.h" -#include "wx/notebook.h" -#include "wx/sysopt.h" -#include "wx/app.h" - -#include "wx/msw/private.h" - -// Windows standard headers -#ifndef __WIN95__ - #error "wxNotebook is only supported Windows 95 and above" -#endif //Win95 - -#include // for SetWindowFont - -#ifdef __GNUWIN32_OLD__ - #include "wx/msw/gnuwin32/extra.h" -#endif +#include "wx/imaglist.h" +#include "wx/sysopt.h" -#if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__)) - #include -#endif +#include "wx/msw/private.h" +#include "wx/msw/dc.h" +#include #include "wx/msw/winundef.h" #if wxUSE_UXTHEME @@ -66,8 +52,15 @@ // check that the page index is valid #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount()) -// hide the ugly cast -#define m_hwnd (HWND)GetHWND() +// you can set USE_NOTEBOOK_ANTIFLICKER to 0 for desktop Windows versions too +// to disable code whih results in flicker-less notebook redrawing at the +// expense of some extra GDI resource consumption +#ifdef __WXWINCE__ + // notebooks are never resized under CE anyhow + #define USE_NOTEBOOK_ANTIFLICKER 0 +#else + #define USE_NOTEBOOK_ANTIFLICKER 1 +#endif // ---------------------------------------------------------------------------- // constants @@ -86,23 +79,59 @@ #define TCS_BOTTOM TCS_RIGHT #endif +// ---------------------------------------------------------------------------- +// global variables +// ---------------------------------------------------------------------------- + +#if USE_NOTEBOOK_ANTIFLICKER + +// the pointer to standard spin button wnd proc +static WXFARPROC gs_wndprocNotebookSpinBtn = (WXFARPROC)NULL; + +// the pointer to standard tab control wnd proc +static WXFARPROC gs_wndprocNotebook = (WXFARPROC)NULL; + +LRESULT APIENTRY _EXPORT wxNotebookWndProc(HWND hwnd, + UINT message, + WPARAM wParam, + LPARAM lParam); + +#endif // USE_NOTEBOOK_ANTIFLICKER + +// ---------------------------------------------------------------------------- +// global functions +// ---------------------------------------------------------------------------- + +static bool HasTroubleWithNonTopTabs() +{ + const int verComCtl32 = wxApp::GetComCtl32Version(); + + // 600 is XP, 616 is Vista -- and both have a problem with tabs not on top + // (but don't just test for >= 600 as Microsoft might decide to fix it in + // later versions, who knows...) + return verComCtl32 >= 600 && verComCtl32 <= 616; +} + // ---------------------------------------------------------------------------- // event table // ---------------------------------------------------------------------------- -#include +#include "wx/listimpl.cpp" -WX_DEFINE_LIST( wxNotebookPageInfoList ) ; +WX_DEFINE_LIST( wxNotebookPageInfoList ) DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED) DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING) -BEGIN_EVENT_TABLE(wxNotebook, wxControl) - EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange) - +BEGIN_EVENT_TABLE(wxNotebook, wxBookCtrlBase) + EVT_NOTEBOOK_PAGE_CHANGED(wxID_ANY, wxNotebook::OnSelChange) EVT_SIZE(wxNotebook::OnSize) - EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey) + +#if USE_NOTEBOOK_ANTIFLICKER + EVT_ERASE_BACKGROUND(wxNotebook::OnEraseBackground) + EVT_PAINT(wxNotebook::OnPaint) +#endif // USE_NOTEBOOK_ANTIFLICKER END_EVENT_TABLE() #if wxUSE_EXTENDED_RTTI @@ -137,13 +166,17 @@ wxBEGIN_FLAGS( wxNotebookStyle ) wxFLAGS_MEMBER(wxHSCROLL) wxFLAGS_MEMBER(wxNB_FIXEDWIDTH) - wxFLAGS_MEMBER(wxNB_LEFT) - wxFLAGS_MEMBER(wxNB_RIGHT) - wxFLAGS_MEMBER(wxNB_BOTTOM) + wxFLAGS_MEMBER(wxBK_DEFAULT) + wxFLAGS_MEMBER(wxBK_TOP) + wxFLAGS_MEMBER(wxBK_LEFT) + wxFLAGS_MEMBER(wxBK_RIGHT) + wxFLAGS_MEMBER(wxBK_BOTTOM) + wxFLAGS_MEMBER(wxNB_NOPAGETHEME) + wxFLAGS_MEMBER(wxNB_FLAT) wxEND_FLAGS( wxNotebookStyle ) -IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebook, wxControl,"wx/notebook.h") +IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebook, wxBookCtrlBase,"wx/notebook.h") IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebookPageInfo, wxObject , "wx/notebook.h" ) wxCOLLECTION_TYPE_INFO( wxNotebookPageInfo * , wxNotebookPageInfoList ) ; @@ -180,7 +213,7 @@ wxEND_HANDLERS_TABLE() wxCONSTRUCTOR_4( wxNotebookPageInfo , wxNotebookPage* , Page , wxString , Text , bool , Selected , int , ImageId ) #else -IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl) +IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxBookCtrlBase) IMPLEMENT_DYNAMIC_CLASS(wxNotebookPageInfo, wxObject ) #endif IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent) @@ -209,12 +242,16 @@ const wxNotebookPageInfoList& wxNotebook::GetPageInfos() const // common part of all ctors void wxNotebook::Init() { - m_imageList = NULL; - m_nSelection = -1; + m_imageList = NULL; + m_nSelection = wxNOT_FOUND; #if wxUSE_UXTHEME - m_hbrBackground = NULL; + m_hbrBackground = NULL; #endif // wxUSE_UXTHEME + +#if USE_NOTEBOOK_ANTIFLICKER + m_hasSubclassedUpdown = false; +#endif // USE_NOTEBOOK_ANTIFLICKER } // default for dynamic class @@ -244,30 +281,126 @@ bool wxNotebook::Create(wxWindow *parent, long style, const wxString& name) { - // some versions of comctl32.dll 6.0 included with Windows XP don't - // support non-top tabs (the control is simply not rendered correctly) but - // we can't detect which ones, so be pessimistic by default and disable non - // top tabs under XP but allow the user to override this by using a special - // system option - bool nonTopTabsOk = wxSystemOptions::GetOptionInt(_T("msw.xp-tab-ok")) != 0; - if ( !nonTopTabsOk ) + if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT ) { - int verComCtl32 = wxApp::GetComCtl32Version(); - nonTopTabsOk = verComCtl32 < 470 || verComCtl32 >= 600; +#if defined(__POCKETPC__) + style |= wxBK_BOTTOM | wxNB_FLAT; +#else + style |= wxBK_TOP; +#endif } - if ( !nonTopTabsOk ) +#ifdef __WXWINCE__ + // Not sure why, but without this style, there is no border + // around the notebook tabs. + if (style & wxNB_FLAT) + style |= wxBORDER_SUNKEN; +#endif + +#if !wxUSE_UXTHEME + // ComCtl32 notebook tabs simply don't work unless they're on top if we + // have uxtheme, we can work around it later (after control creation), but + // if we have been compiled without uxtheme support, we have to clear those + // styles + if ( HasTroubleWithNonTopTabs() ) { - style &= ~(wxNB_BOTTOM | wxNB_LEFT | wxNB_RIGHT); + style &= ~(wxBK_BOTTOM | wxBK_LEFT | wxBK_RIGHT); } +#endif //wxUSE_UXTHEME + +#if defined(__WINE__) && wxUSE_UNICODE + LPCTSTR className = L"SysTabControl32"; +#else + LPCTSTR className = WC_TABCONTROL; +#endif + +#if USE_NOTEBOOK_ANTIFLICKER + // SysTabCtl32 class has natively CS_HREDRAW and CS_VREDRAW enabled and it + // causes horrible flicker when resizing notebook, so get rid of it by + // using a class without these styles (but otherwise identical to it) + if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE) ) + { + static ClassRegistrar s_clsNotebook; + if ( !s_clsNotebook.IsInitialized() ) + { + // get a copy of standard class and modify it + WNDCLASS wc; + + if ( ::GetClassInfo(NULL, WC_TABCONTROL, &wc) ) + { + gs_wndprocNotebook = + wx_reinterpret_cast(WXFARPROC, wc.lpfnWndProc); + wc.lpszClassName = wxT("_wx_SysTabCtl32"); + wc.style &= ~(CS_HREDRAW | CS_VREDRAW); + wc.hInstance = wxGetInstance(); + wc.lpfnWndProc = wxNotebookWndProc; + s_clsNotebook.Register(wc); + } + else + { + wxLogLastError(_T("GetClassInfoEx(SysTabCtl32)")); + } + } + + // use our custom class if available but fall back to the standard + // notebook if we failed to register it + if ( s_clsNotebook.IsRegistered() ) + { + // it's ok to use c_str() here as the static s_clsNotebook object + // has sufficiently long lifetime + className = s_clsNotebook.GetName().c_str(); + } + } +#endif // USE_NOTEBOOK_ANTIFLICKER if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL, wxDefaultValidator, name) ) return false; - if ( !MSWCreateControl(WC_TABCONTROL, wxEmptyString, pos, size) ) + if ( !MSWCreateControl(className, wxEmptyString, pos, size) ) return false; +#if wxUSE_UXTHEME + if ( HasFlag(wxNB_NOPAGETHEME) || + wxSystemOptions::IsFalse(wxT("msw.notebook.themed-background")) ) + { + SetBackgroundColour(GetThemeBackgroundColour()); + } + else // use themed background by default + { + // create backing store + UpdateBgBrush(); + } + + // comctl32.dll 6.0 doesn't support non-top tabs with visual styles (the + // control is simply not rendered correctly), so we disable themes + // if possible, otherwise we simply clear the styles. + if ( HasTroubleWithNonTopTabs() && + (style & (wxBK_BOTTOM | wxBK_LEFT | wxBK_RIGHT)) ) + { + // check if we use themes at all -- if we don't, we're still okay + if ( wxUxThemeEngine::GetIfActive() ) + { + wxUxThemeEngine::GetIfActive()->SetWindowTheme(GetHwnd(), L"", L""); + + // correct the background color for the new non-themed control + SetBackgroundColour(GetThemeBackgroundColour()); + } + } +#endif // wxUSE_UXTHEME + + // Undocumented hack to get flat notebook style + // In fact, we should probably only do this in some + // curcumstances, i.e. if we know we will have a border + // at the bottom (the tab control doesn't draw it itself) +#if defined(__POCKETPC__) || defined(__SMARTPHONE__) + if (HasFlag(wxNB_FLAT)) + { + SendMessage(GetHwnd(), CCM_SETVERSION, COMCTL32_VERSION, 0); + if (!m_hasBgCol) + SetBackgroundColour(*wxWHITE); + } +#endif return true; } @@ -282,11 +415,11 @@ WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const if ( style & wxNB_FIXEDWIDTH ) tabStyle |= TCS_FIXEDWIDTH; - if ( style & wxNB_BOTTOM ) + if ( style & wxBK_BOTTOM ) tabStyle |= TCS_RIGHT; - else if ( style & wxNB_LEFT ) + else if ( style & wxBK_LEFT ) tabStyle |= TCS_VERTICAL; - else if ( style & wxNB_RIGHT ) + else if ( style & wxBK_RIGHT ) tabStyle |= TCS_VERTICAL | TCS_RIGHT; // ex style @@ -314,103 +447,175 @@ wxNotebook::~wxNotebook() size_t wxNotebook::GetPageCount() const { - // consistency check - wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) ); + // consistency check + wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(GetHwnd()) ); - return m_pages.Count(); + return m_pages.Count(); } int wxNotebook::GetRowCount() const { - return TabCtrl_GetRowCount(m_hwnd); + return TabCtrl_GetRowCount(GetHwnd()); } int wxNotebook::SetSelection(size_t nPage) { - wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("notebook page out of range") ); + wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("notebook page out of range") ); - if ( int(nPage) != m_nSelection ) - { - wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId); - event.SetSelection(nPage); - event.SetOldSelection(m_nSelection); - event.SetEventObject(this); - if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() ) + if ( m_nSelection == wxNOT_FOUND || nPage != (size_t)m_nSelection ) { - // program allows the page change - event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED); - (void)GetEventHandler()->ProcessEvent(event); + if ( SendPageChangingEvent(nPage) ) + { + // program allows the page change + SendPageChangedEvent(m_nSelection, nPage); - TabCtrl_SetCurSel(m_hwnd, nPage); + TabCtrl_SetCurSel(GetHwnd(), nPage); + } + } + + return m_nSelection; +} + +void wxNotebook::UpdateSelection(int selNew) +{ + if ( m_nSelection != wxNOT_FOUND ) + m_pages[m_nSelection]->Show(false); + + if ( selNew != wxNOT_FOUND ) + { + wxNotebookPage *pPage = m_pages[selNew]; + pPage->Show(true); } - } - return m_nSelection; + // Changing the page should give the focus to it but, as per bug report + // http://sf.net/tracker/index.php?func=detail&aid=1150659&group_id=9863&atid=109863, + // we should not set the focus to it directly since it erroneously + // selects radio buttons and breaks keyboard handling for a notebook's + // scroll buttons. So give focus to the notebook and not the page. + + // but don't do this is the notebook is hidden + if ( ::IsWindowVisible(GetHwnd()) ) + SetFocus(); + + m_nSelection = selNew; +} + +int wxNotebook::ChangeSelection(size_t nPage) +{ + wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("notebook page out of range") ); + + if ( m_nSelection == wxNOT_FOUND || nPage != (size_t)m_nSelection ) + { + TabCtrl_SetCurSel(GetHwnd(), nPage); + + UpdateSelection(nPage); + } + + return m_nSelection; } bool wxNotebook::SetPageText(size_t nPage, const wxString& strText) { - wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") ); + wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") ); + + TC_ITEM tcItem; + tcItem.mask = TCIF_TEXT; + tcItem.pszText = (wxChar *)strText.wx_str(); - TC_ITEM tcItem; - tcItem.mask = TCIF_TEXT; - tcItem.pszText = (wxChar *)strText.c_str(); + if ( !HasFlag(wxNB_MULTILINE) ) + return TabCtrl_SetItem(GetHwnd(), nPage, &tcItem) != 0; + + // multiline - we need to set new page size if a line is added or removed + int rows = GetRowCount(); + bool ret = TabCtrl_SetItem(GetHwnd(), nPage, &tcItem) != 0; + + if ( ret && rows != GetRowCount() ) + { + const wxRect r = GetPageSize(); + const size_t count = m_pages.Count(); + for ( size_t page = 0; page < count; page++ ) + m_pages[page]->SetSize(r); + } - return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0; + return ret; } wxString wxNotebook::GetPageText(size_t nPage) const { - wxCHECK_MSG( IS_VALID_PAGE(nPage), wxEmptyString, wxT("notebook page out of range") ); + wxCHECK_MSG( IS_VALID_PAGE(nPage), wxEmptyString, wxT("notebook page out of range") ); - wxChar buf[256]; - TC_ITEM tcItem; - tcItem.mask = TCIF_TEXT; - tcItem.pszText = buf; - tcItem.cchTextMax = WXSIZEOF(buf); + wxChar buf[256]; + TC_ITEM tcItem; + tcItem.mask = TCIF_TEXT; + tcItem.pszText = buf; + tcItem.cchTextMax = WXSIZEOF(buf); - wxString str; - if ( TabCtrl_GetItem(m_hwnd, nPage, &tcItem) ) - str = tcItem.pszText; + wxString str; + if ( TabCtrl_GetItem(GetHwnd(), nPage, &tcItem) ) + str = tcItem.pszText; - return str; + return str; } int wxNotebook::GetPageImage(size_t nPage) const { - wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") ); + wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("notebook page out of range") ); - TC_ITEM tcItem; - tcItem.mask = TCIF_IMAGE; + TC_ITEM tcItem; + tcItem.mask = TCIF_IMAGE; - return TabCtrl_GetItem(m_hwnd, nPage, &tcItem) ? tcItem.iImage : -1; + return TabCtrl_GetItem(GetHwnd(), nPage, &tcItem) ? tcItem.iImage + : wxNOT_FOUND; } bool wxNotebook::SetPageImage(size_t nPage, int nImage) { - wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") ); + wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") ); - TC_ITEM tcItem; - tcItem.mask = TCIF_IMAGE; - tcItem.iImage = nImage; + TC_ITEM tcItem; + tcItem.mask = TCIF_IMAGE; + tcItem.iImage = nImage; - return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0; + return TabCtrl_SetItem(GetHwnd(), nPage, &tcItem) != 0; } void wxNotebook::SetImageList(wxImageList* imageList) { - wxNotebookBase::SetImageList(imageList); + wxNotebookBase::SetImageList(imageList); - if ( imageList ) - { - TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST()); - } + if ( imageList ) + { + (void) TabCtrl_SetImageList(GetHwnd(), GetHimagelistOf(imageList)); + } } // ---------------------------------------------------------------------------- // wxNotebook size settings // ---------------------------------------------------------------------------- +wxRect wxNotebook::GetPageSize() const +{ + wxRect r; + + RECT rc; + ::GetClientRect(GetHwnd(), &rc); + + // This check is to work around a bug in TabCtrl_AdjustRect which will + // cause a crash on win2k or on XP with themes disabled if either + // wxNB_MULTILINE is used or tabs are placed on a side, if the rectangle + // is too small. + // + // The value of 20 is chosen arbitrarily but seems to work + if ( rc.right > 20 && rc.bottom > 20 ) + { + TabCtrl_AdjustRect(GetHwnd(), false, &rc); + + wxCopyRECTToRect(rc, r); + } + + return r; +} + void wxNotebook::SetPageSize(const wxSize& size) { // transform the page size into the notebook size @@ -440,26 +645,29 @@ void wxNotebook::SetTabSize(const wxSize& sz) wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const { + // we can't use TabCtrl_AdjustRect here because it only works for wxNB_TOP wxSize sizeTotal = sizePage; - // We need to make getting tab size part of the wxWidgets API. - wxSize tabSize(0, 0); - if (GetPageCount() > 0) + wxSize tabSize; + if ( GetPageCount() > 0 ) { RECT rect; - TabCtrl_GetItemRect((HWND) GetHWND(), 0, & rect); + TabCtrl_GetItemRect(GetHwnd(), 0, &rect); tabSize.x = rect.right - rect.left; tabSize.y = rect.bottom - rect.top; } - if ( HasFlag(wxNB_LEFT) || HasFlag(wxNB_RIGHT) ) + + // add an extra margin in both directions + const int MARGIN = 8; + if ( IsVertical() ) { - sizeTotal.x += tabSize.x + 7; - sizeTotal.y += 7; + sizeTotal.x += MARGIN; + sizeTotal.y += tabSize.y + MARGIN; } - else + else // horizontal layout { - sizeTotal.x += 7; - sizeTotal.y += tabSize.y + 7; + sizeTotal.x += tabSize.x + MARGIN; + sizeTotal.y += MARGIN; } return sizeTotal; @@ -469,23 +677,10 @@ void wxNotebook::AdjustPageSize(wxNotebookPage *page) { wxCHECK_RET( page, _T("NULL page in wxNotebook::AdjustPageSize") ); - RECT rc; - rc.left = - rc.top = 0; - - // get the page size from the notebook size - GetSize((int *)&rc.right, (int *)&rc.bottom); - - // This check is to work around a bug in TabCtrl_AdjustRect which will - // cause a crash on win2k, or on XP with themes disabled, if the - // wxNB_MULTILINE style is used and the rectangle is very small, (such as - // when the notebook is first created.) The value of 20 is just - // arbitrarily chosen, if there is a better way to determine this value - // then please do so. --RD - if (rc.right > 20 && rc.bottom > 20) + const wxRect r = GetPageSize(); + if ( !r.IsEmpty() ) { - TabCtrl_AdjustRect(m_hwnd, false, &rc); - page->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top); + page->SetSize(r); } } @@ -500,17 +695,17 @@ wxNotebookPage *wxNotebook::DoRemovePage(size_t nPage) if ( !pageRemoved ) return NULL; - TabCtrl_DeleteItem(m_hwnd, nPage); + TabCtrl_DeleteItem(GetHwnd(), nPage); if ( m_pages.IsEmpty() ) { // no selection any more, the notebook becamse empty - m_nSelection = -1; + m_nSelection = wxNOT_FOUND; } else // notebook still not empty { - int selNew = TabCtrl_GetCurSel(m_hwnd); - if (selNew != -1) + int selNew = TabCtrl_GetCurSel(GetHwnd()); + if ( selNew != wxNOT_FOUND ) { // No selection change, just refresh the current selection. // Because it could be that the slection index changed @@ -531,7 +726,7 @@ wxNotebookPage *wxNotebook::DoRemovePage(size_t nPage) // m_nSelection must be always valid so reset it before calling // SetSelection() - m_nSelection = -1; + m_nSelection = wxNOT_FOUND; SetSelection(selNew); } else @@ -546,19 +741,19 @@ wxNotebookPage *wxNotebook::DoRemovePage(size_t nPage) // remove all pages bool wxNotebook::DeleteAllPages() { - size_t nPageCount = GetPageCount(); - size_t nPage; - for ( nPage = 0; nPage < nPageCount; nPage++ ) - delete m_pages[nPage]; + size_t nPageCount = GetPageCount(); + size_t nPage; + for ( nPage = 0; nPage < nPageCount; nPage++ ) + delete m_pages[nPage]; - m_pages.Clear(); + m_pages.Clear(); - TabCtrl_DeleteAllItems(m_hwnd); + TabCtrl_DeleteAllItems(GetHwnd()); - m_nSelection = -1; + m_nSelection = wxNOT_FOUND; - InvalidateBestSize(); - return true; + InvalidateBestSize(); + return true; } // same as AddPage() but does it at given position @@ -590,10 +785,10 @@ bool wxNotebook::InsertPage(size_t nPage, } // and the text - if ( !strText.IsEmpty() ) + if ( !strText.empty() ) { tcItem.mask |= TCIF_TEXT; - tcItem.pszText = (wxChar *)strText.c_str(); // const_cast + tcItem.pszText = (wxChar *)strText.wx_str(); // const_cast } // hide the page: unless it is selected, it shouldn't be shown (and if it @@ -612,13 +807,22 @@ bool wxNotebook::InsertPage(size_t nPage, AdjustPageSize(pPage); // finally do insert it - if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 ) + if ( TabCtrl_InsertItem(GetHwnd(), nPage, &tcItem) == -1 ) { wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str()); return false; } + // need to update the bg brush when the first page is added + // so the first panel gets the correct themed background + if ( m_pages.empty() ) + { +#if wxUSE_UXTHEME + UpdateBgBrush(); +#endif // wxUSE_UXTHEME + } + // succeeded: save the pointer to the page m_pages.Insert(pPage, nPage); @@ -644,16 +848,17 @@ bool wxNotebook::InsertPage(size_t nPage, // some page should be selected: either this one or the first one if there // is still no selection - int selNew = -1; + int selNew = wxNOT_FOUND; if ( bSelect ) selNew = nPage; - else if ( m_nSelection == -1 ) + else if ( m_nSelection == wxNOT_FOUND ) selNew = 0; - if ( selNew != -1 ) + if ( selNew != wxNOT_FOUND ) SetSelection(selNew); InvalidateBestSize(); + return true; } @@ -669,18 +874,91 @@ int wxNotebook::HitTest(const wxPoint& pt, long *flags) const *flags = 0; if ((hitTestInfo.flags & TCHT_NOWHERE) == TCHT_NOWHERE) - *flags |= wxNB_HITTEST_NOWHERE; + *flags |= wxBK_HITTEST_NOWHERE; if ((hitTestInfo.flags & TCHT_ONITEM) == TCHT_ONITEM) - *flags |= wxNB_HITTEST_ONITEM; + *flags |= wxBK_HITTEST_ONITEM; if ((hitTestInfo.flags & TCHT_ONITEMICON) == TCHT_ONITEMICON) - *flags |= wxNB_HITTEST_ONICON; + *flags |= wxBK_HITTEST_ONICON; if ((hitTestInfo.flags & TCHT_ONITEMLABEL) == TCHT_ONITEMLABEL) - *flags |= wxNB_HITTEST_ONLABEL; + *flags |= wxBK_HITTEST_ONLABEL; + if ( item == wxNOT_FOUND && GetPageSize().Contains(pt) ) + *flags |= wxBK_HITTEST_ONPAGE; } return item; } +// ---------------------------------------------------------------------------- +// flicker-less notebook redraw +// ---------------------------------------------------------------------------- + +#if USE_NOTEBOOK_ANTIFLICKER + +// wnd proc for the spin button +LRESULT APIENTRY _EXPORT wxNotebookSpinBtnWndProc(HWND hwnd, + UINT message, + WPARAM wParam, + LPARAM lParam) +{ + if ( message == WM_ERASEBKGND ) + return 0; + + return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebookSpinBtn, + hwnd, message, wParam, lParam); +} + +LRESULT APIENTRY _EXPORT wxNotebookWndProc(HWND hwnd, + UINT message, + WPARAM wParam, + LPARAM lParam) +{ + return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebook, + hwnd, message, wParam, lParam); +} + +void wxNotebook::OnEraseBackground(wxEraseEvent& WXUNUSED(event)) +{ + // do nothing here +} + +void wxNotebook::OnPaint(wxPaintEvent& WXUNUSED(event)) +{ + wxPaintDC dc(this); + wxMemoryDC memdc; + RECT rc; + ::GetClientRect(GetHwnd(), &rc); + wxBitmap bmp(rc.right, rc.bottom); + memdc.SelectObject(bmp); + + const wxLayoutDirection dir = dc.GetLayoutDirection(); + memdc.SetLayoutDirection(dir); + + // if there is no special brush just use the solid background colour +#if wxUSE_UXTHEME + HBRUSH hbr = (HBRUSH)m_hbrBackground; +#else + HBRUSH hbr = 0; +#endif + wxBrush brush; + if ( !hbr ) + { + brush = wxBrush(GetBackgroundColour()); + hbr = GetHbrushOf(brush); + } + + wxMSWDCImpl *impl = (wxMSWDCImpl*) memdc.GetImpl(); + + ::FillRect(GetHdcOf(*impl), &rc, hbr); + + MSWDefWindowProc(WM_PAINT, (WPARAM)(impl->GetHDC()), 0); + + // For some reason in RTL mode, source offset has to be -1, otherwise the + // right border (physical) remains unpainted. + const wxCoord ofs = dir == wxLayout_RightToLeft ? -1 : 0; + dc.Blit(ofs, 0, rc.right, rc.bottom, &memdc, ofs, 0); +} + +#endif // USE_NOTEBOOK_ANTIFLICKER // ---------------------------------------------------------------------------- // wxNotebook callbacks @@ -688,108 +966,141 @@ int wxNotebook::HitTest(const wxPoint& pt, long *flags) const void wxNotebook::OnSize(wxSizeEvent& event) { - // fit the notebook page to the tab control's display area - RECT rc; - rc.left = rc.top = 0; - GetSize((int *)&rc.right, (int *)&rc.bottom); - - // there seems to be a bug in the implementation of TabCtrl_AdjustRect(): it - // returns completely false values for multiline tab controls after the tabs - // are added but before getting the first WM_SIZE (off by ~50 pixels, see - // - // http://sf.net/tracker/index.php?func=detail&aid=645323&group_id=9863&atid=109863 - // - // and the only work around I could find was this ugly hack... without it - // simply toggling the "multiline" checkbox in the notebook sample resulted - // in a noticeable page displacement - if ( HasFlag(wxNB_MULTILINE) ) - { - // avoid an infinite recursion: we get another notification too! - static bool s_isInOnSize = false; - - if ( !s_isInOnSize ) - { - s_isInOnSize = true; - SendMessage(GetHwnd(), WM_SIZE, SIZE_RESTORED, - MAKELPARAM(rc.right, rc.bottom)); - s_isInOnSize = false; - } - } + if ( GetPageCount() == 0 ) + { + // Prevents droppings on resize, but does cause some flicker + // when there are no pages. + Refresh(); + event.Skip(); + return; + } +#ifndef __WXWINCE__ + else + { + // Without this, we can sometimes get droppings at the edges + // of a notebook, for example a notebook in a splitter window. + // This needs to be reconciled with the RefreshRect calls + // at the end of this function, which weren't enough to prevent + // the droppings. - TabCtrl_AdjustRect(m_hwnd, false, &rc); + wxSize sz = GetClientSize(); - int width = rc.right - rc.left, - height = rc.bottom - rc.top; - size_t nCount = m_pages.Count(); - for ( size_t nPage = 0; nPage < nCount; nPage++ ) { - wxNotebookPage *pPage = m_pages[nPage]; - pPage->SetSize(rc.left, rc.top, width, height); - } + // Refresh right side + wxRect rect(sz.x-4, 0, 4, sz.y); + RefreshRect(rect); + + // Refresh bottom side + rect = wxRect(0, sz.y-4, sz.x, 4); + RefreshRect(rect); + + // Refresh left side + rect = wxRect(0, 0, 4, sz.y); + RefreshRect(rect); + } +#endif // !__WXWINCE__ + + // fit all the notebook pages to the tab control's display area + + RECT rc; + rc.left = rc.top = 0; + GetSize((int *)&rc.right, (int *)&rc.bottom); + + // save the total size, we'll use it below + int widthNbook = rc.right - rc.left, + heightNbook = rc.bottom - rc.top; + + // there seems to be a bug in the implementation of TabCtrl_AdjustRect(): it + // returns completely false values for multiline tab controls after the tabs + // are added but before getting the first WM_SIZE (off by ~50 pixels, see + // + // http://sf.net/tracker/index.php?func=detail&aid=645323&group_id=9863&atid=109863 + // + // and the only work around I could find was this ugly hack... without it + // simply toggling the "multiline" checkbox in the notebook sample resulted + // in a noticeable page displacement + if ( HasFlag(wxNB_MULTILINE) ) + { + // avoid an infinite recursion: we get another notification too! + static bool s_isInOnSize = false; + + if ( !s_isInOnSize ) + { + s_isInOnSize = true; + SendMessage(GetHwnd(), WM_SIZE, SIZE_RESTORED, + MAKELPARAM(rc.right, rc.bottom)); + s_isInOnSize = false; + } + } #if wxUSE_UXTHEME - UpdateBgBrush(); + // background bitmap size has changed, update the brush using it too + UpdateBgBrush(); #endif // wxUSE_UXTHEME - event.Skip(); -} + TabCtrl_AdjustRect(GetHwnd(), false, &rc); -void wxNotebook::OnSelChange(wxNotebookEvent& event) -{ - // is it our tab control? - if ( event.GetEventObject() == this ) - { - int sel = event.GetOldSelection(); - if ( sel != -1 ) - m_pages[sel]->Show(false); - - sel = event.GetSelection(); - if ( sel != -1 ) - { - wxNotebookPage *pPage = m_pages[sel]; - pPage->Show(true); - pPage->SetFocus(); - - // If the newly focused window is not a child of the new page, - // SetFocus was not successful and the notebook itself should be - // focused - wxWindow *currentFocus = FindFocus(); - wxWindow *startFocus = currentFocus; - while ( currentFocus && currentFocus != pPage && currentFocus != this ) - currentFocus = currentFocus->GetParent(); - - if ( startFocus == pPage || currentFocus != pPage ) - SetFocus(); - - } - else // no pages in the notebook, give the focus to itself - { - SetFocus(); - } - - m_nSelection = sel; - } + int width = rc.right - rc.left, + height = rc.bottom - rc.top; + size_t nCount = m_pages.Count(); + for ( size_t nPage = 0; nPage < nCount; nPage++ ) { + wxNotebookPage *pPage = m_pages[nPage]; + pPage->SetSize(rc.left, rc.top, width, height); + } + + + // unless we had already repainted everything, we now need to refresh + if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE) ) + { + // invalidate areas not covered by pages + RefreshRect(wxRect(0, 0, widthNbook, rc.top), false); + RefreshRect(wxRect(0, rc.top, rc.left, height), false); + RefreshRect(wxRect(0, rc.bottom, widthNbook, heightNbook - rc.bottom), + false); + RefreshRect(wxRect(rc.right, rc.top, widthNbook - rc.right, height), + false); + } + +#if USE_NOTEBOOK_ANTIFLICKER + // subclass the spin control used by the notebook to scroll pages to + // prevent it from flickering on resize + if ( !m_hasSubclassedUpdown ) + { + // iterate over all child windows to find spin button + for ( HWND child = ::GetWindow(GetHwnd(), GW_CHILD); + child; + child = ::GetWindow(child, GW_HWNDNEXT) ) + { + wxWindow *childWindow = wxFindWinFromHandle((WXHWND)child); + + // see if it exists, if no wxWindow found then assume it's the spin + // btn + if ( !childWindow ) + { + // subclass the spin button to override WM_ERASEBKGND + if ( !gs_wndprocNotebookSpinBtn ) + gs_wndprocNotebookSpinBtn = (WXFARPROC)wxGetWindowProc(child); + + wxSetWindowProc(child, wxNotebookSpinBtnWndProc); + m_hasSubclassedUpdown = true; + break; + } + } + } +#endif // USE_NOTEBOOK_ANTIFLICKER - // we want to give others a chance to process this message as well - event.Skip(); + event.Skip(); } -bool wxNotebook::MSWTranslateMessage(WXMSG *wxmsg) +void wxNotebook::OnSelChange(wxNotebookEvent& event) { - const MSG * const msg = (MSG *)wxmsg; - - // intercept TAB, CTRL+TAB and CTRL+SHIFT+TAB for processing by wxNotebook. - // TAB will be passed to the currently selected page, CTRL+TAB and - // CTRL+SHIFT+TAB will be processed by the notebook itself. do not - // intercept SHIFT+TAB. This goes to the parent of the notebook which will - // process it. - if ( msg->message == WM_KEYDOWN && msg->wParam == VK_TAB && - msg->hwnd == m_hwnd && - (wxIsCtrlDown() || !wxIsShiftDown()) ) + // is it our tab control? + if ( event.GetEventObject() == this ) { - return MSWProcessMessage(wxmsg); + UpdateSelection(event.GetSelection()); } - return false; + // we want to give others a chance to process this message as well + event.Skip(); } void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event) @@ -819,14 +1130,15 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event) // wxWindow * const parent = GetParent(); - const bool isFromParent = event.GetEventObject() == parent; - const bool isFromSelf = event.GetEventObject() == this; + // the wxObject* casts are required to avoid MinGW GCC 2.95.3 ICE + const bool isFromParent = event.GetEventObject() == (wxObject*) parent; + const bool isFromSelf = event.GetEventObject() == (wxObject*) this; if ( isFromParent || isFromSelf ) { // no, it doesn't come from child, case (b) or (c): forward to a // page but only if direction is backwards (TAB) or from ourselves, - if ( m_nSelection != -1 && + if ( m_nSelection != wxNOT_FOUND && (!event.GetDirection() || isFromSelf) ) { // so that the page knows that the event comes from it's parent @@ -834,7 +1146,7 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event) event.SetEventObject(this); wxWindow *page = m_pages[m_nSelection]; - if ( !page->GetEventHandler()->ProcessEvent(event) ) + if ( !page->HandleWindowEvent(event) ) { page->SetFocus(); } @@ -858,7 +1170,7 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event) else if ( parent ) { event.SetCurrentFocus(this); - parent->GetEventHandler()->ProcessEvent(event); + parent->HandleWindowEvent(event); } } } @@ -866,41 +1178,90 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event) #if wxUSE_UXTHEME -void wxNotebook::UpdateBgBrush() +bool wxNotebook::DoDrawBackground(WXHDC hDC, wxWindow *child) { - if ( m_hbrBackground ) - ::DeleteObject((HBRUSH)m_hbrBackground); + wxUxThemeHandle theme(child ? child : this, L"TAB"); + if ( !theme ) + return false; - if ( wxUxThemeEngine::GetIfActive() ) - { - RECT rc; - GetWindowRect(GetHwnd(), &rc); + // get the notebook client rect (we're not interested in drawing tabs + // themselves) + wxRect r = GetPageSize(); + if ( r.IsEmpty() ) + return false; + + RECT rc; + wxCopyRectToRECT(r, rc); + + // map rect to the coords of the window we're drawing in + if ( child ) + ::MapWindowPoints(GetHwnd(), GetHwndOf(child), (POINT *)&rc, 2); + + // we have the content area (page size), but we need to draw all of the + // background for it to be aligned correctly + wxUxThemeEngine::Get()->GetThemeBackgroundExtent + ( + theme, + (HDC) hDC, + 9 /* TABP_PANE */, + 0, + &rc, + &rc + ); + wxUxThemeEngine::Get()->DrawThemeBackground + ( + theme, + (HDC) hDC, + 9 /* TABP_PANE */, + 0, + &rc, + NULL + ); + + return true; +} + +WXHBRUSH wxNotebook::QueryBgBitmap() +{ + wxRect r = GetPageSize(); + if ( r.IsEmpty() ) + return 0; - WindowHDC hDC(GetHwnd()); - MemoryHDC hDCMem(hDC); - CompatibleBitmap hBmp(hDC, rc.right - rc.left, rc.bottom - rc.top); + WindowHDC hDC(GetHwnd()); + MemoryHDC hDCMem(hDC); + CompatibleBitmap hBmp(hDC, r.x + r.width, r.y + r.height); - SelectInHDC selectBmp(hDCMem, hBmp); + SelectInHDC selectBmp(hDCMem, hBmp); - SendMessage(GetHwnd(), WM_PRINTCLIENT, (WPARAM)(HDC)hDCMem, - PRF_ERASEBKGND | PRF_CLIENT | PRF_NONCLIENT); + if ( !DoDrawBackground((WXHDC)(HDC)hDCMem) ) + return 0; - m_hbrBackground = (WXHBRUSH)::CreatePatternBrush(hBmp); + return (WXHBRUSH)::CreatePatternBrush(hBmp); +} + +void wxNotebook::UpdateBgBrush() +{ + if ( m_hbrBackground ) + ::DeleteObject((HBRUSH)m_hbrBackground); + + if ( !m_hasBgCol && wxUxThemeEngine::GetIfActive() ) + { + m_hbrBackground = QueryBgBitmap(); } - else // no themes + else // no themes or we've got user-defined solid colour { m_hbrBackground = NULL; } } -WXHBRUSH wxNotebook::GetThemeBackgroundBrush(WXHDC hDC, wxWindow *win) const +WXHBRUSH wxNotebook::MSWGetBgBrushForChild(WXHDC hDC, WXHWND hWnd) { if ( m_hbrBackground ) { // before drawing with the background brush, we need to position it // correctly RECT rc; - ::GetWindowRect(GetHwndOf(win), &rc); + ::GetWindowRect((HWND)hWnd, &rc); ::MapWindowPoints(NULL, GetHwnd(), (POINT *)&rc, 1); @@ -908,34 +1269,122 @@ WXHBRUSH wxNotebook::GetThemeBackgroundBrush(WXHDC hDC, wxWindow *win) const { wxLogLastError(_T("SetBrushOrgEx(notebook bg brush)")); } + + return m_hbrBackground; } - return m_hbrBackground; + return wxNotebookBase::MSWGetBgBrushForChild(hDC, hWnd); } -void wxNotebook::DoEraseBackground(wxEraseEvent& event) +bool wxNotebook::MSWPrintChild(WXHDC hDC, wxWindow *child) { - DoEraseBackground((wxWindow *)event.GetEventObject(), - (WXHDC)GetHdcOf(*event.GetDC())); -} + // solid background colour overrides themed background drawing + if ( !UseBgCol() && DoDrawBackground(hDC, child) ) + return true; -void wxNotebook::DoEraseBackground(wxWindow *win, WXHDC hDC) -{ - // we can either draw the background ourselves or let DrawThemeBackground() - // do it, but as we already have the correct brush, let's do it ourselves - // (note that we use the same code in wxControl::MSWControlColor(), so if - // it breaks, it should at least break in consistent way) - WXHBRUSH hbr = GetThemeBackgroundBrush(hDC, win); - if ( hbr ) + // If we're using a solid colour (for example if we've switched off + // theming for this notebook), paint it + if (UseBgCol()) { - RECT rectClient; - ::GetClientRect(GetHwndOf(win), &rectClient); - ::FillRect((HDC)hDC, &rectClient, (HBRUSH)hbr); + wxRect r = GetPageSize(); + if ( r.IsEmpty() ) + return false; + + RECT rc; + wxCopyRectToRECT(r, rc); + + // map rect to the coords of the window we're drawing in + if ( child ) + ::MapWindowPoints(GetHwnd(), GetHwndOf(child), (POINT *)&rc, 2); + + wxBrush brush(GetBackgroundColour()); + HBRUSH hbr = GetHbrushOf(brush); + + ::FillRect((HDC) hDC, &rc, hbr); + + return true; } + + return wxNotebookBase::MSWPrintChild(hDC, child); } #endif // wxUSE_UXTHEME +// Windows only: attempts to get colour for UX theme page background +wxColour wxNotebook::GetThemeBackgroundColour() const +{ +#if wxUSE_UXTHEME + if (wxUxThemeEngine::Get()) + { + wxUxThemeHandle hTheme((wxNotebook*) this, L"TAB"); + if (hTheme) + { + // This is total guesswork. + // See PlatformSDK\Include\Tmschema.h for values. + // JACS: can also use 9 (TABP_PANE) + COLORREF themeColor; + bool success = (S_OK == wxUxThemeEngine::Get()->GetThemeColor( + hTheme, + 10 /* TABP_BODY */, + 1 /* NORMAL */, + 3821 /* FILLCOLORHINT */, + &themeColor)); + if (!success) + return GetBackgroundColour(); + + /* + [DS] Workaround for WindowBlinds: + Some themes return a near black theme color using FILLCOLORHINT, + this makes notebook pages have an ugly black background and makes + text (usually black) unreadable. Retry again with FILLCOLOR. + + This workaround potentially breaks appearance of some themes, + but in practice it already fixes some themes. + */ + if (themeColor == 1) + { + wxUxThemeEngine::Get()->GetThemeColor( + hTheme, + 10 /* TABP_BODY */, + 1 /* NORMAL */, + 3802 /* FILLCOLOR */, + &themeColor); + } + + wxColour colour = wxRGBToColour(themeColor); + + // Under Vista, the tab background colour is reported incorrectly. + // So for the default theme at least, hard-code the colour to something + // that will blend in. + + static int s_AeroStatus = -1; + if (s_AeroStatus == -1) + { + WCHAR szwThemeFile[1024]; + WCHAR szwThemeColor[256]; + if (S_OK == wxUxThemeEngine::Get()->GetCurrentThemeName(szwThemeFile, 1024, szwThemeColor, 256, NULL, 0)) + { + wxString themeFile(szwThemeFile), themeColor(szwThemeColor); + if (themeFile.Find(wxT("Aero")) != -1 && themeColor == wxT("NormalColor")) + s_AeroStatus = 1; + else + s_AeroStatus = 0; + } + else + s_AeroStatus = 0; + } + + if (s_AeroStatus == 1) + colour = wxColour(255, 255, 255); + + return colour; + } + } +#endif // wxUSE_UXTHEME + + return GetBackgroundColour(); +} + // ---------------------------------------------------------------------------- // wxNotebook base class virtuals // ---------------------------------------------------------------------------- @@ -990,12 +1439,12 @@ bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result) return wxControl::MSWOnNotify(idCtrl, lParam, result); } - event.SetSelection(TabCtrl_GetCurSel(m_hwnd)); + event.SetSelection(TabCtrl_GetCurSel(GetHwnd())); event.SetOldSelection(m_nSelection); event.SetEventObject(this); event.SetInt(idCtrl); - bool processed = GetEventHandler()->ProcessEvent(event); + bool processed = HandleWindowEvent(event); *result = !event.IsAllowed(); return processed; }