///////////////////////////////////////////////////////////////////////////////
-// Name: msw/notebook.cpp
+// Name: src/msw/notebook.cpp
// Purpose: implementation of wxNotebook
// Author: Vadim Zeitlin
// Modified by:
// 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"
#include "wx/notebook.h"
#include "wx/app.h"
#include "wx/sysopt.h"
+#include "wx/dcclient.h"
+#include "wx/dcmemory.h"
#include "wx/msw/private.h"
#include <windowsx.h>
-#ifdef __GNUWIN32_OLD__
- #include "wx/msw/gnuwin32/extra.h"
-#endif
-
-#if !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
- #include <commctrl.h>
-#endif
+#include <commctrl.h>
#include "wx/msw/winundef.h"
// 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
#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
+
// ----------------------------------------------------------------------------
// event table
// ----------------------------------------------------------------------------
#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)
EVT_NOTEBOOK_PAGE_CHANGED(-1, 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
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)
#if wxUSE_UXTHEME
m_hbrBackground = NULL;
#endif // wxUSE_UXTHEME
+
+#if USE_NOTEBOOK_ANTIFLICKER
+ m_hasSubclassedUpdown = false;
+#endif // USE_NOTEBOOK_ANTIFLICKER
}
// default for dynamic class
if ( wxUxThemeEngine::GetIfActive() )
#endif
{
- style &= ~(wxNB_BOTTOM | wxNB_LEFT | wxNB_RIGHT);
+ style &= ~(wxBK_BOTTOM | wxBK_LEFT | wxBK_RIGHT);
}
}
LPCTSTR className = WC_TABCONTROL;
+#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)
// get a copy of standard class and modify it
WNDCLASS wc;
- if ( ::GetClassInfo(::GetModuleHandle(NULL), WC_TABCONTROL, &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
className = s_clsNotebook.GetName().c_str();
}
}
+#endif // USE_NOTEBOOK_ANTIFLICKER
if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL,
wxDefaultValidator, name) )
{
SetBackgroundColour(GetThemeBackgroundColour());
}
+ else // use themed background by default
+ {
+ // create backing store
+ UpdateBgBrush();
+ }
#endif // wxUSE_UXTHEME
// Undocumented hack to get flat notebook style
#if defined(__POCKETPC__) || defined(__SMARTPHONE__)
if (HasFlag(wxNB_FLAT))
{
- SendMessage(m_hwnd, CCM_SETVERSION, COMCTL32_VERSION, 0);
+ SendMessage(GetHwnd(), CCM_SETVERSION, COMCTL32_VERSION, 0);
if (!m_hasBgCol)
SetBackgroundColour(*wxWHITE);
}
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
size_t wxNotebook::GetPageCount() const
{
// consistency check
- wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) );
+ wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(GetHwnd()) );
return m_pages.Count();
}
int wxNotebook::GetRowCount() const
{
- return TabCtrl_GetRowCount(m_hwnd);
+ return TabCtrl_GetRowCount(GetHwnd());
}
int wxNotebook::SetSelection(size_t nPage)
event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
(void)GetEventHandler()->ProcessEvent(event);
- TabCtrl_SetCurSel(m_hwnd, nPage);
+ TabCtrl_SetCurSel(GetHwnd(), nPage);
}
}
tcItem.mask = TCIF_TEXT;
tcItem.pszText = (wxChar *)strText.c_str();
- return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
+ return TabCtrl_SetItem(GetHwnd(), nPage, &tcItem) != 0;
}
wxString wxNotebook::GetPageText(size_t nPage) const
tcItem.cchTextMax = WXSIZEOF(buf);
wxString str;
- if ( TabCtrl_GetItem(m_hwnd, nPage, &tcItem) )
+ if ( TabCtrl_GetItem(GetHwnd(), nPage, &tcItem) )
str = tcItem.pszText;
return str;
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 : -1;
}
bool wxNotebook::SetPageImage(size_t nPage, int nImage)
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)
if ( imageList )
{
- TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
+ TabCtrl_SetImageList(GetHwnd(), (HIMAGELIST)imageList->GetHIMAGELIST());
}
}
::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 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 ( !HasFlag(wxNB_MULTILINE) || (rc.right > 20 && rc.bottom > 20) )
+ // 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(m_hwnd, false, &rc);
+ TabCtrl_AdjustRect(GetHwnd(), false, &rc);
wxCopyRECTToRect(rc, r);
}
tabSize.x = rect.right - rect.left;
tabSize.y = rect.bottom - rect.top;
}
- if ( HasFlag(wxNB_LEFT) || HasFlag(wxNB_RIGHT) )
+ if ( HasFlag(wxBK_LEFT) || HasFlag(wxBK_RIGHT) )
{
sizeTotal.x += tabSize.x + 7;
sizeTotal.y += 7;
if ( !pageRemoved )
return NULL;
- TabCtrl_DeleteItem(m_hwnd, nPage);
+ TabCtrl_DeleteItem(GetHwnd(), nPage);
if ( m_pages.IsEmpty() )
{
}
else // notebook still not empty
{
- int selNew = TabCtrl_GetCurSel(m_hwnd);
+ int selNew = TabCtrl_GetCurSel(GetHwnd());
if (selNew != -1)
{
// No selection change, just refresh the current selection.
m_pages.Clear();
- TabCtrl_DeleteAllItems(m_hwnd);
+ TabCtrl_DeleteAllItems(GetHwnd());
m_nSelection = -1;
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 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);
+
+ // if there is no special brush just use the solid background colour
+ HBRUSH hbr = (HBRUSH)m_hbrBackground;
+ wxBrush brush;
+ if ( !hbr )
+ {
+ brush = wxBrush(GetBackgroundColour());
+ hbr = GetHbrushOf(brush);
+ }
+
+ ::FillRect(GetHdcOf(memdc), &rc, hbr);
+
+ MSWDefWindowProc(WM_PAINT, (WPARAM)memdc.GetHDC(), 0);
+
+ dc.Blit(0, 0, rc.right, rc.bottom, &memdc, 0, 0);
+}
+
+#endif // USE_NOTEBOOK_ANTIFLICKER
// ----------------------------------------------------------------------------
// wxNotebook callbacks
void wxNotebook::OnSize(wxSizeEvent& event)
{
-#if wxUSE_UXTHEME
- // background bitmap size has changed, update the brush using it too
- UpdateBgBrush();
-#endif // wxUSE_UXTHEME
-
if ( GetPageCount() == 0 )
{
// Prevents droppings on resize, but does cause some flicker
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
}
}
- TabCtrl_AdjustRect(m_hwnd, false, &rc);
+#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;
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.bottom, height),
+ 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();
}
{
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();
+ // 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.
- }
- else // no pages in the notebook, give the focus to itself
- {
- SetFocus();
- }
+ // but don't do this is the notebook is hidden
+ if ( ::IsWindowVisible(GetHwnd()) )
+ SetFocus();
m_nSelection = sel;
}
// 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 &&
+ msg->hwnd == GetHwnd() &&
(wxIsCtrlDown() || !wxIsShiftDown()) )
{
return MSWProcessMessage(wxmsg);
//
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 )
{
if ( child )
::MapWindowPoints(GetHwnd(), GetHwndOf(child), (POINT *)&rc, 2);
-
- // apparently DrawThemeBackground() modifies the rect passed to it and if we
- // don't do these adjustments, there are some drawing artifacts which are
- // only visible with some non default themes; so modify the rect here using
- // the magic numbers below so that it still paints the correct area
- rc.left -= 2;
- rc.top -= 2;
- rc.right += 4;
- rc.bottom += 5;
-
-
+ // 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) hDC,
9 /* TABP_PANE */,
0,
&rc,
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);
}
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);