///////////////////////////////////////////////////////////////////////////////
-// 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"
// check that the page index is valid
#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__
-#define USE_NOTEBOOK_ANTIFLICKER 0
+ // notebooks are never resized under CE anyhow
+ #define USE_NOTEBOOK_ANTIFLICKER 0
#else
-// Set this to 1 to compile anti-flicker code, which creates a potentially
-// large bitmap for every paint event
-#define USE_NOTEBOOK_ANTIFLICKER 0
+ #define USE_NOTEBOOK_ANTIFLICKER 1
#endif
// ----------------------------------------------------------------------------
#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>
+#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(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
- EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
- EVT_SIZE(wxNotebook::OnSize)
- EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
+#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)
#endif
IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
-// ---------------------------------------------------------------------------
-// private functions
-// ---------------------------------------------------------------------------
-
-#if USE_NOTEBOOK_ANTIFLICKER
-// wnd proc for the spin button
-LRESULT APIENTRY _EXPORT wxNotebookSpinBtnWndProc(HWND hWnd,
- UINT message,
- WPARAM wParam,
- LPARAM lParam);
-
-// ---------------------------------------------------------------------------
-// global vars
-// ---------------------------------------------------------------------------
-
-// the pointer to standard spin button wnd proc
-static WXFARPROC s_wndprocNotebookSpinBtn = (WXFARPROC)NULL;
-#endif
-
// ============================================================================
// implementation
// ============================================================================
// common part of all ctors
void wxNotebook::Init()
{
- m_imageList = NULL;
- m_nSelection = -1;
+ m_imageList = NULL;
+ m_nSelection = -1;
#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
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 ( 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(GetHwnd()) );
+ // 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(GetHwnd());
+ 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 ( int(nPage) != m_nSelection )
{
- // program allows the page change
- event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
- (void)GetEventHandler()->ProcessEvent(event);
+ 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() )
+ {
+ // program allows the page change
+ event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
+ (void)GetEventHandler()->ProcessEvent(event);
- TabCtrl_SetCurSel(GetHwnd(), nPage);
+ TabCtrl_SetCurSel(GetHwnd(), nPage);
+ }
}
- }
- return m_nSelection;
+ 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.c_str();
+ TC_ITEM tcItem;
+ tcItem.mask = TCIF_TEXT;
+ tcItem.pszText = (wxChar *)strText.c_str();
- return TabCtrl_SetItem(GetHwnd(), nPage, &tcItem) != 0;
+ return TabCtrl_SetItem(GetHwnd(), nPage, &tcItem) != 0;
}
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(GetHwnd(), 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(GetHwnd(), 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(GetHwnd(), 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(GetHwnd(), (HIMAGELIST)imageList->GetHIMAGELIST());
- }
+ if ( imageList )
+ {
+ (void) 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(GetHwnd(), false, &rc);
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;
// 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(GetHwnd());
+ TabCtrl_DeleteAllItems(GetHwnd());
- m_nSelection = -1;
+ m_nSelection = -1;
- InvalidateBestSize();
- return true;
+ InvalidateBestSize();
+ return true;
}
// same as AddPage() but does it at given position
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
rect = wxRect(0, 0, 4, sz.y);
RefreshRect(rect);
}
-#endif
+#endif // !__WXWINCE__
// fit all the notebook pages to the tab control's display area
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;
}
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,
return processed;
}
-#ifndef __WXWINCE__
-void wxNotebook::OnEraseBackground(wxEraseEvent& WXUNUSED(event))
-{
- // do nothing here
-}
-
-void wxNotebook::OnPaint(wxPaintEvent& WXUNUSED(event))
-{
- // Better painting behaviour, at the expense of system resources
-#if USE_NOTEBOOK_ANTIFLICKER
- wxPaintDC dc(this);
- wxMemoryDC memdc;
- RECT rc;
- ::GetClientRect(GetHwnd(), &rc);
- wxBitmap bmp(rc.right, rc.bottom);
- memdc.SelectObject(bmp);
-
- // 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 ( !s_wndprocNotebookSpinBtn )
- s_wndprocNotebookSpinBtn = (WXFARPROC)wxGetWindowProc(child);
-
- wxSetWindowProc(child, wxNotebookSpinBtnWndProc);
- break;
- }
- }
-
- HBRUSH hbr = (HBRUSH)m_hbrBackground;
-
- // if there is no special brush just use the solid background colour
- 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
-}
-#endif
- // __WXWINCE__
-
-#if USE_NOTEBOOK_ANTIFLICKER
-// ---------------------------------------------------------------------------
-// window proc for spin button
-// ---------------------------------------------------------------------------
-
-LRESULT APIENTRY _EXPORT wxNotebookSpinBtnWndProc(HWND hwnd,
- UINT message,
- WPARAM wParam,
- LPARAM lParam)
-{
- if ( message == WM_ERASEBKGND )
- return 0;
-
- return ::CallWindowProc(CASTWNDPROC s_wndprocNotebookSpinBtn, hwnd, message, wParam, lParam);
-}
-
-#endif // USE_NOTEBOOK_ANTIFLICKER
-
#endif // wxUSE_NOTEBOOK