X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6c9a19aabab3a878b565e6c2a5f2a3824277c4dc..655e246b86923bf721f1725191140451a189ca0c:/src/msw/notebook.cpp?ds=sidebyside diff --git a/src/msw/notebook.cpp b/src/msw/notebook.cpp index 84c156cb33..db3df7f538 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 /////////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "notebook.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -22,34 +18,32 @@ #if wxUSE_NOTEBOOK -// wxWindows +#include "wx/notebook.h" + #ifndef WX_PRECOMP - #include "wx/string.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" + #include "wx/panel.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/msw/private.h" - -// Windows standard headers -#ifndef __WIN95__ - #error "wxNotebook is only supported Windows 95 and above" -#endif //Win95 +#include "wx/imaglist.h" +#include "wx/sysopt.h" -#include // for SetWindowFont +#include "wx/msw/private.h" +#include "wx/msw/dc.h" -#ifndef __TWIN32__ - #ifdef __GNUWIN32_OLD__ - #include "wx/msw/gnuwin32/extra.h" - #endif -#endif +#include +#include "wx/msw/winundef.h" -#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__)) - #include +#if wxUSE_UXTHEME + #include "wx/msw/uxtheme.h" #endif // ---------------------------------------------------------------------------- @@ -57,10 +51,17 @@ // ---------------------------------------------------------------------------- // check that the page index is valid -#define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((nPage) < GetPageCount())) - -// hide the ugly cast -#define m_hwnd (HWND)GetHWND() +#define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount()) + +// 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 @@ -80,24 +81,51 @@ #endif // ---------------------------------------------------------------------------- -// event table +// global variables // ---------------------------------------------------------------------------- -DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING) +#if USE_NOTEBOOK_ANTIFLICKER -BEGIN_EVENT_TABLE(wxNotebook, wxControl) - EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange) +// the pointer to standard spin button wnd proc +static WXFARPROC gs_wndprocNotebookSpinBtn = (WXFARPROC)NULL; - EVT_SIZE(wxNotebook::OnSize) +// 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; +} - EVT_SET_FOCUS(wxNotebook::OnSetFocus) +// ---------------------------------------------------------------------------- +// event table +// ---------------------------------------------------------------------------- +BEGIN_EVENT_TABLE(wxNotebook, wxBookCtrlBase) + EVT_SIZE(wxNotebook::OnSize) EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey) -END_EVENT_TABLE() -IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl) -IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent) +#if USE_NOTEBOOK_ANTIFLICKER + EVT_ERASE_BACKGROUND(wxNotebook::OnEraseBackground) + EVT_PAINT(wxNotebook::OnPaint) +#endif // USE_NOTEBOOK_ANTIFLICKER +END_EVENT_TABLE() // ============================================================================ // implementation @@ -110,8 +138,15 @@ IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent) // common part of all ctors void wxNotebook::Init() { - m_imageList = NULL; - m_nSelection = -1; + m_imageList = NULL; + +#if wxUSE_UXTHEME + m_hbrBackground = NULL; +#endif // wxUSE_UXTHEME + +#if USE_NOTEBOOK_ANTIFLICKER + m_hasSubclassedUpdown = false; +#endif // USE_NOTEBOOK_ANTIFLICKER } // default for dynamic class @@ -141,17 +176,127 @@ bool wxNotebook::Create(wxWindow *parent, long style, const wxString& name) { - // base init + if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT ) + { +#if defined(__POCKETPC__) + style |= wxBK_BOTTOM | wxNB_FLAT; +#else + style |= wxBK_TOP; +#endif + } + +#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 &= ~(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 = + reinterpret_cast(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(wxT("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; + return false; + + if ( !MSWCreateControl(className, wxEmptyString, pos, size) ) + return false; - if ( !MSWCreateControl(WC_TABCONTROL, _T(""), 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(); + } - SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE))); + // 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""); - return TRUE; + // 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; } WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const @@ -165,127 +310,205 @@ 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 - if ( exstyle ) - { - // note that we never want to have the default WS_EX_CLIENTEDGE style - // as it looks too ugly for the notebooks - *exstyle = 0; - } - return tabStyle; } +wxNotebook::~wxNotebook() +{ +#if wxUSE_UXTHEME + if ( m_hbrBackground ) + ::DeleteObject((HBRUSH)m_hbrBackground); +#endif // wxUSE_UXTHEME +} + // ---------------------------------------------------------------------------- // wxNotebook accessors // ---------------------------------------------------------------------------- -int wxNotebook::GetPageCount() const +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(int nPage) +int wxNotebook::SetSelection(size_t nPage) { - 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") ); - if ( 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_selection == wxNOT_FOUND || nPage != (size_t)m_selection ) { - // program allows the page change - event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED); - (void)GetEventHandler()->ProcessEvent(event); + if ( SendPageChangingEvent(nPage) ) + { + // program allows the page change + const int selectionOld = m_selection; - TabCtrl_SetCurSel(m_hwnd, nPage); + UpdateSelection(nPage); + + TabCtrl_SetCurSel(GetHwnd(), nPage); + + SendPageChangedEvent(selectionOld, nPage); + } } - } - return m_nSelection; + return m_selection; } -bool wxNotebook::SetPageText(int nPage, const wxString& strText) +void wxNotebook::UpdateSelection(int selNew) { - wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") ); + if ( m_selection != wxNOT_FOUND ) + m_pages[m_selection]->Show(false); - TC_ITEM tcItem; - tcItem.mask = TCIF_TEXT; - tcItem.pszText = (wxChar *)strText.c_str(); + if ( selNew != wxNOT_FOUND ) + { + wxNotebookPage *pPage = m_pages[selNew]; + pPage->Show(true); + } + + // 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_selection = selNew; +} + +int wxNotebook::ChangeSelection(size_t nPage) +{ + wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("notebook page out of range") ); + + const int selOld = m_selection; + + if ( m_selection == wxNOT_FOUND || nPage != (size_t)m_selection ) + { + TabCtrl_SetCurSel(GetHwnd(), nPage); + + UpdateSelection(nPage); + } + + return selOld; +} + +bool wxNotebook::SetPageText(size_t nPage, const wxString& strText) +{ + 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(); - return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0; + 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 ret; } -wxString wxNotebook::GetPageText(int nPage) const +wxString wxNotebook::GetPageText(size_t nPage) const { - wxCHECK_MSG( IS_VALID_PAGE(nPage), wxT(""), 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(int nPage) const +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(int nPage, int nImage) +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 @@ -295,7 +518,7 @@ void wxNotebook::SetPageSize(const wxSize& size) rc.right = size.x; rc.bottom = size.y; - TabCtrl_AdjustRect(GetHwnd(), TRUE, &rc); + TabCtrl_AdjustRect(GetHwnd(), true, &rc); // and now set it SetSize(rc.right - rc.left, rc.bottom - rc.top); @@ -313,56 +536,102 @@ void wxNotebook::SetTabSize(const wxSize& sz) ::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y)); } +wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const +{ + // we can't use TabCtrl_AdjustRect here because it only works for wxNB_TOP + wxSize sizeTotal = sizePage; + + wxSize tabSize; + if ( GetPageCount() > 0 ) + { + RECT rect; + TabCtrl_GetItemRect(GetHwnd(), 0, &rect); + tabSize.x = rect.right - rect.left; + tabSize.y = rect.bottom - rect.top; + } + + const int rows = GetRowCount(); + + // add an extra margin in both directions + const int MARGIN = 8; + if ( IsVertical() ) + { + sizeTotal.x += MARGIN; + sizeTotal.y += tabSize.y * rows + MARGIN; + } + else // horizontal layout + { + sizeTotal.x += tabSize.x * rows + MARGIN; + sizeTotal.y += MARGIN; + } + + return sizeTotal; +} + +void wxNotebook::AdjustPageSize(wxNotebookPage *page) +{ + wxCHECK_RET( page, wxT("NULL page in wxNotebook::AdjustPageSize") ); + + const wxRect r = GetPageSize(); + if ( !r.IsEmpty() ) + { + page->SetSize(r); + } +} + // ---------------------------------------------------------------------------- // wxNotebook operations // ---------------------------------------------------------------------------- // remove one page from the notebook, without deleting -wxNotebookPage *wxNotebook::DoRemovePage(int nPage) +wxNotebookPage *wxNotebook::DoRemovePage(size_t nPage) { wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage); if ( !pageRemoved ) return NULL; - TabCtrl_DeleteItem(m_hwnd, nPage); + // hide the removed page to maintain the invariant that only the + // selected page is visible and others are hidden: + pageRemoved->Show(false); + + TabCtrl_DeleteItem(GetHwnd(), nPage); if ( m_pages.IsEmpty() ) { // no selection any more, the notebook becamse empty - m_nSelection = -1; + m_selection = wxNOT_FOUND; } else // notebook still not empty { - // change the selected page if it was deleted or became invalid - int selNew; - if ( m_nSelection == GetPageCount() ) + int selNew = TabCtrl_GetCurSel(GetHwnd()); + if ( selNew != wxNOT_FOUND ) { - // last page deleted, make the new last page the new selection - selNew = m_nSelection - 1; + // No selection change, just refresh the current selection. + // Because it could be that the slection index changed + // we need to update it. + // Note: this does not mean the selection it self changed. + m_selection = selNew; + m_pages[m_selection]->Refresh(); } - else if ( nPage <= m_nSelection ) + else if (int(nPage) == m_selection) { - // we must show another page, even if it has the same index - selNew = m_nSelection; - } - else // nothing changes for the currently selected page - { - selNew = -1; + // The selection was deleted. - // we still must refresh the current page: this needs to be done - // for some unknown reason if the tab control shows the up-down - // control (i.e. when there are too many pages) -- otherwise after - // deleting a page nothing at all is shown - m_pages[m_nSelection]->Refresh(); - } + // Determine new selection. + if (m_selection == int(GetPageCount())) + selNew = m_selection - 1; + else + selNew = m_selection; - if ( selNew != -1 ) - { - // m_nSelection must be always valid so reset it before calling + // m_selection must be always valid so reset it before calling // SetSelection() - m_nSelection = -1; + m_selection = wxNOT_FOUND; SetSelection(selNew); } + else + { + wxFAIL; // Windows did not behave ok. + } } return pageRemoved; @@ -371,40 +640,34 @@ wxNotebookPage *wxNotebook::DoRemovePage(int nPage) // remove all pages bool wxNotebook::DeleteAllPages() { - int nPageCount = GetPageCount(); - int 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_selection = wxNOT_FOUND; - return TRUE; -} - -// add a page to the notebook -bool wxNotebook::AddPage(wxNotebookPage *pPage, - const wxString& strText, - bool bSelect, - int imageId) -{ - return InsertPage(GetPageCount(), pPage, strText, bSelect, imageId); + InvalidateBestSize(); + return true; } // same as AddPage() but does it at given position -bool wxNotebook::InsertPage(int nPage, +bool wxNotebook::InsertPage(size_t nPage, wxNotebookPage *pPage, const wxString& strText, bool bSelect, int imageId) { - wxCHECK_MSG( pPage != NULL, FALSE, _T("NULL page in wxNotebook::InsertPage") ); - wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE, - _T("invalid index in wxNotebook::InsertPage") ); + wxCHECK_MSG( pPage != NULL, false, wxT("NULL page in wxNotebook::InsertPage") ); + wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), false, + wxT("invalid index in wxNotebook::InsertPage") ); + wxASSERT_MSG( pPage->GetParent() == this, + wxT("notebook pages must have notebook as parent") ); // add a new tab to the control // ---------------------------- @@ -421,125 +684,303 @@ bool wxNotebook::InsertPage(int nPage, } // and the text - if ( !strText.IsEmpty() ) + if ( !strText.empty() ) { tcItem.mask |= TCIF_TEXT; - tcItem.pszText = (wxChar *)strText.c_str(); // const_cast + tcItem.pszText = const_cast(strText.wx_str()); } + // hide the page: unless it is selected, it shouldn't be shown (and if it + // is selected it will be shown later) + HWND hwnd = GetWinHwnd(pPage); + SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE); + + // this updates internal flag too -- otherwise it would get out of sync + // with the real state + pPage->Show(false); + + // fit the notebook page to the tab control's display area: this should be // done before adding it to the notebook or TabCtrl_InsertItem() will // change the notebooks size itself! - RECT rc; - rc.left = rc.top = 0; - GetSize((int *)&rc.right, (int *)&rc.bottom); - TabCtrl_AdjustRect(m_hwnd, FALSE, &rc); - pPage->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top); - + 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; + 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); - // hide the page: unless it is selected, it shouldn't be shown (and if it - // is selected it will be shown later) - HWND hwnd = GetWinHwnd(pPage); - SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE); - - // this updates internal flag too -- otherwise it would get out of sync - // with the real state - pPage->Show(FALSE); - + // we may need to adjust the size again if the notebook size changed: + // normally this only happens for the first page we add (the tabs which + // hadn't been there before are now shown) but for a multiline notebook it + // can happen for any page at all as a new row could have been started + if ( m_pages.GetCount() == 1 || HasFlag(wxNB_MULTILINE) ) + { + AdjustPageSize(pPage); + } // now deal with the selection // --------------------------- // if the inserted page is before the selected one, we must update the // index of the selected page - if ( nPage <= m_nSelection ) + if ( int(nPage) <= m_selection ) { // one extra page added - m_nSelection++; + m_selection++; } - // some page should be selected: either this one or the first one if there - // is still no selection - int selNew = -1; - if ( bSelect ) - selNew = nPage; - else if ( m_nSelection == -1 ) - selNew = 0; + DoSetSelectionAfterInsertion(nPage, bSelect); + + InvalidateBestSize(); + + return true; +} + +int wxNotebook::HitTest(const wxPoint& pt, long *flags) const +{ + TC_HITTESTINFO hitTestInfo; + hitTestInfo.pt.x = pt.x; + hitTestInfo.pt.y = pt.y; + int item = TabCtrl_HitTest(GetHwnd(), &hitTestInfo); - if ( selNew != -1 ) - SetSelection(selNew); + if ( flags ) + { + *flags = 0; + + if ((hitTestInfo.flags & TCHT_NOWHERE) == TCHT_NOWHERE) + *flags |= wxBK_HITTEST_NOWHERE; + if ((hitTestInfo.flags & TCHT_ONITEM) == TCHT_ONITEM) + *flags |= wxBK_HITTEST_ONITEM; + if ((hitTestInfo.flags & TCHT_ONITEMICON) == TCHT_ONITEMICON) + *flags |= wxBK_HITTEST_ONICON; + if ((hitTestInfo.flags & TCHT_ONITEMLABEL) == TCHT_ONITEMLABEL) + *flags |= wxBK_HITTEST_ONLABEL; + if ( item == wxNOT_FOUND && GetPageSize().Contains(pt) ) + *flags |= wxBK_HITTEST_ONPAGE; + } - return TRUE; + return item; } // ---------------------------------------------------------------------------- -// wxNotebook callbacks +// flicker-less notebook redraw // ---------------------------------------------------------------------------- -void wxNotebook::OnSize(wxSizeEvent& event) +#if USE_NOTEBOOK_ANTIFLICKER + +// wnd proc for the spin button +LRESULT APIENTRY _EXPORT wxNotebookSpinBtnWndProc(HWND hwnd, + UINT message, + WPARAM wParam, + LPARAM lParam) { - // 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); + if ( message == WM_ERASEBKGND ) + return 0; - TabCtrl_AdjustRect(m_hwnd, FALSE, &rc); + return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebookSpinBtn, + hwnd, message, wParam, lParam); +} - 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); - } +LRESULT APIENTRY _EXPORT wxNotebookWndProc(HWND hwnd, + UINT message, + WPARAM wParam, + LPARAM lParam) +{ + return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebook, + hwnd, message, wParam, lParam); +} - event.Skip(); +void wxNotebook::OnEraseBackground(wxEraseEvent& WXUNUSED(event)) +{ + // do nothing here } -void wxNotebook::OnSelChange(wxNotebookEvent& event) +void wxNotebook::OnPaint(wxPaintEvent& WXUNUSED(event)) { - // is it our tab control? - if ( event.GetEventObject() == this ) - { - int sel = event.GetOldSelection(); - if ( sel != -1 ) - m_pages[sel]->Show(FALSE); + 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); + } - sel = event.GetSelection(); - if ( sel != -1 ) - { - wxNotebookPage *pPage = m_pages[sel]; - pPage->Show(TRUE); - pPage->SetFocus(); - } + wxMSWDCImpl *impl = (wxMSWDCImpl*) memdc.GetImpl(); - m_nSelection = sel; - } + ::FillRect(GetHdcOf(*impl), &rc, hbr); - // we want to give others a chance to process this message as well - event.Skip(); + 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); } -void wxNotebook::OnSetFocus(wxFocusEvent& event) +#endif // USE_NOTEBOOK_ANTIFLICKER + +// ---------------------------------------------------------------------------- +// wxNotebook callbacks +// ---------------------------------------------------------------------------- + +void wxNotebook::OnSize(wxSizeEvent& event) { - // this function is only called when the focus is explicitly set (i.e. from - // the program) to the notebook - in this case we don't need the - // complicated OnNavigationKey() logic because the programmer knows better - // what [s]he wants + 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. + + wxSize sz = GetClientSize(); + + // 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 - // set focus to the currently selected page if any - if ( m_nSelection != -1 ) - m_pages[m_nSelection]->SetFocus(); + 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; + } + + // The best size depends on the number of rows of tabs, which can + // change when the notepad is resized. + InvalidateBestSize(); + } + +#if wxUSE_UXTHEME + // background bitmap size has changed, update the brush using it too + UpdateBgBrush(); +#endif // wxUSE_UXTHEME + + TabCtrl_AdjustRect(GetHwnd(), false, &rc); + + 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 event.Skip(); } @@ -551,7 +992,7 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event) AdvanceSelection(event.GetDirection()); } else { - // we get this event in 2 cases + // we get this event in 3 cases // // a) one of our pages might have generated it because the user TABbed // out from it in which case we should propagate the event upwards and @@ -564,41 +1005,256 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event) // OnSetFocus() because we don't know which direction the focus came // from in this case and so can't choose between setting the focus to // first or last panel child + // + // or + // + // c) we ourselves (see MSWTranslateMessage) generated the event + // + wxWindow * const parent = GetParent(); + + // 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; + const bool isForward = event.GetDirection(); - wxWindow *parent = GetParent(); - if ( event.GetEventObject() == parent ) + if ( isFromSelf && !isForward ) + { + // focus is currently on notebook tab and should leave + // it backwards (Shift-TAB) + event.SetCurrentFocus(this); + parent->HandleWindowEvent(event); + } + else if ( isFromParent || isFromSelf ) { - // no, it doesn't come from child, case (b): forward to a page - if ( m_nSelection != -1 ) + // no, it doesn't come from child, case (b) or (c): forward to a + // page but only if entering notebook page (i.e. direction is + // backwards (Shift-TAB) comething from out-of-notebook, or + // direction is forward (TAB) from ourselves), + if ( m_selection != wxNOT_FOUND && + (!event.GetDirection() || isFromSelf) ) { // so that the page knows that the event comes from it's parent // and is being propagated downwards event.SetEventObject(this); - wxWindow *page = m_pages[m_nSelection]; - if ( !page->GetEventHandler()->ProcessEvent(event) ) + wxWindow *page = m_pages[m_selection]; + if ( !page->HandleWindowEvent(event) ) { page->SetFocus(); } //else: page manages focus inside it itself } - else + else // otherwise set the focus to the notebook itself { - // we have no pages - still have to give focus to _something_ SetFocus(); } } else { - // it comes from our child, case (a), pass to the parent - if ( parent ) { + // it comes from our child, case (a), pass to the parent, but only + // if the direction is forwards. Otherwise set the focus to the + // notebook itself. The notebook is always the 'first' control of a + // page. + if ( !isForward ) + { + SetFocus(); + } + else if ( parent ) + { event.SetCurrentFocus(this); - parent->GetEventHandler()->ProcessEvent(event); + parent->HandleWindowEvent(event); } } } } +#if wxUSE_UXTHEME + +bool wxNotebook::DoDrawBackground(WXHDC hDC, wxWindow *child) +{ + wxUxThemeHandle theme(child ? child : this, L"TAB"); + if ( !theme ) + return false; + + // 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, r.x + r.width, r.y + r.height); + + SelectInHDC selectBmp(hDCMem, hBmp); + + if ( !DoDrawBackground((WXHDC)(HDC)hDCMem) ) + return 0; + + 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 or we've got user-defined solid colour + { + m_hbrBackground = NULL; + } +} + +bool wxNotebook::MSWPrintChild(WXHDC hDC, wxWindow *child) +{ + // solid background colour overrides themed background drawing + if ( !UseBgCol() && DoDrawBackground(hDC, child) ) + return true; + + // If we're using a solid colour (for example if we've switched off + // theming for this notebook), paint it + if (UseBgCol()) + { + 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 // ---------------------------------------------------------------------------- @@ -610,12 +1266,12 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event) void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse)) { // don't set the sizes of the pages - their correct size is not yet known - wxControl::SetConstraintSizes(FALSE); + wxControl::SetConstraintSizes(false); } bool wxNotebook::DoPhase(int WXUNUSED(nPhase)) { - return TRUE; + return true; } #endif // wxUSE_CONSTRAINTS @@ -630,14 +1286,14 @@ bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode, // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the // up-down control if ( control ) - return FALSE; + return false; return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control); } bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result) { - wxNotebookEvent event(wxEVT_NULL, m_windowId); + wxBookCtrlEvent event(wxEVT_NULL, m_windowId); NMHDR* hdr = (NMHDR *)lParam; switch ( hdr->code ) { @@ -653,12 +1309,15 @@ bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result) return wxControl::MSWOnNotify(idCtrl, lParam, result); } - event.SetSelection(TabCtrl_GetCurSel(m_hwnd)); - event.SetOldSelection(m_nSelection); + event.SetSelection(TabCtrl_GetCurSel(GetHwnd())); + event.SetOldSelection(m_selection); event.SetEventObject(this); event.SetInt(idCtrl); - bool processed = GetEventHandler()->ProcessEvent(event); + bool processed = HandleWindowEvent(event); + if ( hdr->code == TCN_SELCHANGE ) + UpdateSelection(event.GetSelection()); + *result = !event.IsAllowed(); return processed; }