// Author: Vadim Zeitlin
// Modified by:
// Created: 11.06.98
-// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#include "wx/dcclient.h"
#include "wx/dcmemory.h"
#include "wx/control.h"
+ #include "wx/panel.h"
#endif // WX_PRECOMP
#include "wx/imaglist.h"
// event table
// ----------------------------------------------------------------------------
-#include "wx/listimpl.cpp"
-
-WX_DEFINE_LIST( wxNotebookPageInfoList )
-
BEGIN_EVENT_TABLE(wxNotebook, wxBookCtrlBase)
- EVT_NOTEBOOK_PAGE_CHANGED(wxID_ANY, wxNotebook::OnSelChange)
EVT_SIZE(wxNotebook::OnSize)
EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
#endif // USE_NOTEBOOK_ANTIFLICKER
END_EVENT_TABLE()
-#if wxUSE_EXTENDED_RTTI
-WX_DEFINE_FLAGS( wxNotebookStyle )
-
-wxBEGIN_FLAGS( wxNotebookStyle )
- // new style border flags, we put them first to
- // use them for streaming out
- wxFLAGS_MEMBER(wxBORDER_SIMPLE)
- wxFLAGS_MEMBER(wxBORDER_SUNKEN)
- wxFLAGS_MEMBER(wxBORDER_DOUBLE)
- wxFLAGS_MEMBER(wxBORDER_RAISED)
- wxFLAGS_MEMBER(wxBORDER_STATIC)
- wxFLAGS_MEMBER(wxBORDER_NONE)
-
- // old style border flags
- wxFLAGS_MEMBER(wxSIMPLE_BORDER)
- wxFLAGS_MEMBER(wxSUNKEN_BORDER)
- wxFLAGS_MEMBER(wxDOUBLE_BORDER)
- wxFLAGS_MEMBER(wxRAISED_BORDER)
- wxFLAGS_MEMBER(wxSTATIC_BORDER)
- wxFLAGS_MEMBER(wxBORDER)
-
- // standard window styles
- wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
- wxFLAGS_MEMBER(wxCLIP_CHILDREN)
- wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
- wxFLAGS_MEMBER(wxWANTS_CHARS)
- wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
- wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
- wxFLAGS_MEMBER(wxVSCROLL)
- wxFLAGS_MEMBER(wxHSCROLL)
-
- wxFLAGS_MEMBER(wxNB_FIXEDWIDTH)
- 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, wxBookCtrlBase,"wx/notebook.h")
-IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebookPageInfo, wxObject , "wx/notebook.h" )
-
-wxCOLLECTION_TYPE_INFO( wxNotebookPageInfo * , wxNotebookPageInfoList ) ;
-
-template<> void wxCollectionToVariantArray( wxNotebookPageInfoList const &theList, wxxVariantArray &value)
-{
- wxListCollectionToVariantArray<wxNotebookPageInfoList::compatibility_iterator>( theList , value ) ;
-}
-
-wxBEGIN_PROPERTIES_TABLE(wxNotebook)
- wxEVENT_PROPERTY( PageChanging , wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING , wxBookCtrlEvent )
- wxEVENT_PROPERTY( PageChanged , wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED , wxBookCtrlEvent )
-
- wxPROPERTY_COLLECTION( PageInfos , wxNotebookPageInfoList , wxNotebookPageInfo* , AddPageInfo , GetPageInfos , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
- wxPROPERTY_FLAGS( WindowStyle , wxNotebookStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
-wxEND_PROPERTIES_TABLE()
-
-wxBEGIN_HANDLERS_TABLE(wxNotebook)
-wxEND_HANDLERS_TABLE()
-
-wxCONSTRUCTOR_5( wxNotebook , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle)
-
-
-wxBEGIN_PROPERTIES_TABLE(wxNotebookPageInfo)
- wxREADONLY_PROPERTY( Page , wxNotebookPage* , GetPage , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
- wxREADONLY_PROPERTY( Text , wxString , GetText , wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
- wxREADONLY_PROPERTY( Selected , bool , GetSelected , false, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
- wxREADONLY_PROPERTY( ImageId , int , GetImageId , -1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
-wxEND_PROPERTIES_TABLE()
-
-wxBEGIN_HANDLERS_TABLE(wxNotebookPageInfo)
-wxEND_HANDLERS_TABLE()
-
-wxCONSTRUCTOR_4( wxNotebookPageInfo , wxNotebookPage* , Page , wxString , Text , bool , Selected , int , ImageId )
-
-#else
-IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxBookCtrlBase)
-IMPLEMENT_DYNAMIC_CLASS(wxNotebookPageInfo, wxObject )
-#endif
-
// ============================================================================
// implementation
// ============================================================================
// wxNotebook construction
// ----------------------------------------------------------------------------
-const wxNotebookPageInfoList& wxNotebook::GetPageInfos() const
-{
- wxNotebookPageInfoList* list = const_cast< wxNotebookPageInfoList* >( &m_pageInfos ) ;
- WX_CLEAR_LIST( wxNotebookPageInfoList , *list ) ;
- for( size_t i = 0 ; i < GetPageCount() ; ++i )
- {
- wxNotebookPageInfo *info = new wxNotebookPageInfo() ;
- info->Create( const_cast<wxNotebook*>(this)->GetPage(i) , GetPageText(i) , GetSelection() == int(i) , GetPageImage(i) ) ;
- list->Append( info ) ;
- }
- return m_pageInfos ;
-}
-
// common part of all ctors
void wxNotebook::Init()
{
- m_imageList = NULL;
- m_nSelection = wxNOT_FOUND;
-
#if wxUSE_UXTHEME
m_hbrBackground = NULL;
#endif // wxUSE_UXTHEME
#if USE_NOTEBOOK_ANTIFLICKER
m_hasSubclassedUpdown = false;
+ m_doneUpdateHack = false;
#endif // USE_NOTEBOOK_ANTIFLICKER
}
}
else
{
- wxLogLastError(_T("GetClassInfoEx(SysTabCtl32)"));
+ wxLogLastError(wxT("GetClassInfoEx(SysTabCtl32)"));
}
}
if ( !MSWCreateControl(className, wxEmptyString, pos, size) )
return false;
+ // Inherit parent attributes and, unlike the default, also inherit the
+ // parent background colour in order to blend in with its background if
+ // it's set to a non-default value.
+ InheritAttributes();
+ if ( parent->InheritsBackgroundColour() && !UseBgCol() )
+ SetBackgroundColour(parent->GetBackgroundColour());
+
#if wxUSE_UXTHEME
if ( HasFlag(wxNB_NOPAGETHEME) ||
wxSystemOptions::IsFalse(wxT("msw.notebook.themed-background")) )
{
wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("notebook page out of range") );
- if ( m_nSelection == wxNOT_FOUND || nPage != (size_t)m_nSelection )
+ if ( m_selection == wxNOT_FOUND || nPage != (size_t)m_selection )
{
if ( SendPageChangingEvent(nPage) )
{
// program allows the page change
- SendPageChangedEvent(m_nSelection, nPage);
+ const int selectionOld = m_selection;
+
+ UpdateSelection(nPage);
TabCtrl_SetCurSel(GetHwnd(), nPage);
+
+ SendPageChangedEvent(selectionOld, nPage);
}
}
- return m_nSelection;
+ return m_selection;
}
void wxNotebook::UpdateSelection(int selNew)
{
- if ( m_nSelection != wxNOT_FOUND )
- m_pages[m_nSelection]->Show(false);
+ if ( m_selection != wxNOT_FOUND )
+ m_pages[m_selection]->Show(false);
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();
+ // In addition to showing the page, we also want to give focus to it to
+ // make it possible to work with it from keyboard easily. However there
+ // are two exceptions: first, don't touch the focus at all if the
+ // notebook itself is not currently shown.
+ if ( ::IsWindowVisible(GetHwnd()) )
+ {
+ // And second, don't give focus away if the tab control itself has
+ // it, as this is how the native property sheets behave: if you
+ // explicitly click on the tab label giving it focus, it will
+ // remain after switching to another page. But if the focus was
+ // inside the notebook page, it switches to the new page.
+ if ( !HasFocus() )
+ pPage->SetFocus();
+ }
+ }
- m_nSelection = selNew;
+ m_selection = 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 )
+ const int selOld = m_selection;
+
+ if ( m_selection == wxNOT_FOUND || nPage != (size_t)m_selection )
{
TabCtrl_SetCurSel(GetHwnd(), nPage);
UpdateSelection(nPage);
}
- return m_nSelection;
+ return selOld;
}
bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
TC_ITEM tcItem;
tcItem.mask = TCIF_TEXT;
- tcItem.pszText = (wxChar *)strText.wx_str();
+ tcItem.pszText = wxMSW_CONV_LPTSTR(strText);
if ( !HasFlag(wxNB_MULTILINE) )
return TabCtrl_SetItem(GetHwnd(), nPage, &tcItem) != 0;
void wxNotebook::AdjustPageSize(wxNotebookPage *page)
{
- wxCHECK_RET( page, _T("NULL page in wxNotebook::AdjustPageSize") );
+ wxCHECK_RET( page, wxT("NULL page in wxNotebook::AdjustPageSize") );
const wxRect r = GetPageSize();
if ( !r.IsEmpty() )
if ( !pageRemoved )
return NULL;
+ // 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 = wxNOT_FOUND;
+ m_selection = wxNOT_FOUND;
}
else // notebook still not empty
{
// 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_nSelection = selNew;
- m_pages[m_nSelection]->Refresh();
+ m_selection = selNew;
+ m_pages[m_selection]->Refresh();
}
- else if (int(nPage) == m_nSelection)
+ else if (int(nPage) == m_selection)
{
// The selection was deleted.
// Determine new selection.
- if (m_nSelection == int(GetPageCount()))
- selNew = m_nSelection - 1;
+ if (m_selection == int(GetPageCount()))
+ selNew = m_selection - 1;
else
- selNew = m_nSelection;
+ selNew = m_selection;
- // 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 = wxNOT_FOUND;
+ m_selection = wxNOT_FOUND;
SetSelection(selNew);
}
else
TabCtrl_DeleteAllItems(GetHwnd());
- m_nSelection = wxNOT_FOUND;
+ m_selection = wxNOT_FOUND;
InvalidateBestSize();
return true;
bool bSelect,
int imageId)
{
- wxCHECK_MSG( pPage != NULL, false, _T("NULL page in wxNotebook::InsertPage") );
+ wxCHECK_MSG( pPage != NULL, false, wxT("NULL page in wxNotebook::InsertPage") );
wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), false,
- _T("invalid index in wxNotebook::InsertPage") );
+ wxT("invalid index in wxNotebook::InsertPage") );
wxASSERT_MSG( pPage->GetParent() == this,
- _T("notebook pages must have notebook as parent") );
+ wxT("notebook pages must have notebook as parent") );
// add a new tab to the control
// ----------------------------
if ( !strText.empty() )
{
tcItem.mask |= TCIF_TEXT;
- tcItem.pszText = (wxChar *)strText.wx_str(); // const_cast
+ tcItem.pszText = wxMSW_CONV_LPTSTR(strText);
}
// hide the page: unless it is selected, it shouldn't be shown (and if it
if ( m_pages.GetCount() == 1 || HasFlag(wxNB_MULTILINE) )
{
AdjustPageSize(pPage);
+
+ // Additionally, force the layout of the notebook itself by posting a
+ // size event to it. If we don't do it, notebooks with pages on the
+ // left or the right side may fail to account for the fact that they
+ // are now big enough to fit all all of their pages on one row and
+ // still reserve space for the second row of tabs, see #1792.
+ const wxSize s = GetSize();
+ ::PostMessage(GetHwnd(), WM_SIZE, SIZE_RESTORED, MAKELPARAM(s.x, s.y));
}
// now deal with the selection
// if the inserted page is before the selected one, we must update the
// index of the selected page
- if ( int(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 = wxNOT_FOUND;
- if ( bSelect )
- selNew = nPage;
- else if ( m_nSelection == wxNOT_FOUND )
- selNew = 0;
-
- if ( selNew != wxNOT_FOUND )
- SetSelection(selNew);
+ DoSetSelectionAfterInsertion(nPage, bSelect);
InvalidateBestSize();
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 )
+ const HDC hdc = GetHdcOf(memdc);
+
+ // The drawing logic of the native tab control is absolutely impenetrable
+ // but observation shows that in the current Windows versions (XP and 7),
+ // the tab control always erases its entire background in its window proc
+ // when the tabs are top-aligned but does not do it when the tabs are in
+ // any other position.
+ //
+ // This means that we can't rely on our background colour being used for
+ // the blank area in the tab row because this doesn't work in the default
+ // top-aligned case, hence the hack with ExtFloodFill() below. But it also
+ // means that we still do need to erase the DC to account for the other
+ // cases.
+ //
+ // Moreover, just in case some very old or very new (or even future,
+ // although it seems unlikely that this is ever going to change by now)
+ // version of Windows didn't do it like this, do both things in all cases
+ // instead of optimizing away the one of them which doesn't do anything for
+ // the effectively used tab orientation -- better safe than fast.
+
+ // Notice that we use our own background here, not the background used for
+ // the pages, because the tab row background must blend with the parent and
+ // so the background colour inherited from it (if any) must be used.
+ AutoHBRUSH hbr(wxColourToRGB(GetBackgroundColour()));
+
+ ::FillRect(hdc, &rc, hbr);
+
+ MSWDefWindowProc(WM_PAINT, (WPARAM)hdc, 0);
+
+ // At least for the top-aligned tabs, our background colour was overwritten
+ // and so we now replace the default background with our colour. This is
+ // horribly inefficient, of course, but seems to be the only way to do it.
+ if ( UseBgCol() )
{
- brush = wxBrush(GetBackgroundColour());
- hbr = GetHbrushOf(brush);
- }
+ SelectInHDC selectBrush(hdc, hbr);
+
+ // Find the point which must contain the default background colour:
+ // this is a hack, of course, but using this point "close" to the
+ // corner seems to work fine in practice.
+ int x = 0,
+ y = 0;
+
+ switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
+ {
+ case wxBK_TOP:
+ x = rc.right - 2;
+ y = 2;
+ break;
- wxMSWDCImpl *impl = (wxMSWDCImpl*) memdc.GetImpl();
+ case wxBK_BOTTOM:
+ x = rc.right - 2;
+ y = rc.bottom - 2;
+ break;
- ::FillRect(GetHdcOf(*impl), &rc, hbr);
+ case wxBK_LEFT:
+ x = 2;
+ y = rc.bottom - 2;
+ break;
+
+ case wxBK_RIGHT:
+ x = 2;
+ y = rc.bottom - 2;
+ break;
+ }
- MSWDefWindowProc(WM_PAINT, (WPARAM)(impl->GetHDC()), 0);
+ ::ExtFloodFill(hdc, x, y, ::GetSysColor(COLOR_BTNFACE), FLOODFILLSURFACE);
+ }
// For some reason in RTL mode, source offset has to be -1, otherwise the
// right border (physical) remains unpainted.
}
}
}
-#endif // USE_NOTEBOOK_ANTIFLICKER
- event.Skip();
-}
-
-void wxNotebook::OnSelChange(wxBookCtrlEvent& event)
-{
- // is it our tab control?
- if ( event.GetEventObject() == this )
+ // Probably because of the games we play above to avoid flicker sometimes
+ // the text controls inside notebook pages are not shown correctly (they
+ // don't have their borders) when the notebook is shown for the first time.
+ // It's not really clear why does this happen and maybe the bug is in
+ // wxTextCtrl itself and not here but updating the page when it's about to
+ // be shown doesn't cost much and works around the problem so do it here
+ // for now.
+ if ( !m_doneUpdateHack && IsShownOnScreen() )
{
- UpdateSelection(event.GetSelection());
+ m_doneUpdateHack = true;
+ wxWindow* const page = GetCurrentPage();
+ if ( page )
+ page->Update();
}
+#endif // USE_NOTEBOOK_ANTIFLICKER
- // we want to give others a chance to process this message as well
event.Skip();
}
// 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();
- if ( isFromParent || isFromSelf )
+ 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) or (c): forward to a
- // page but only if direction is backwards (TAB) or from ourselves,
- if ( m_nSelection != wxNOT_FOUND &&
+ // 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];
+ wxWindow *page = m_pages[m_selection];
if ( !page->HandleWindowEvent(event) )
{
page->SetFocus();
// if the direction is forwards. Otherwise set the focus to the
// notebook itself. The notebook is always the 'first' control of a
// page.
- if ( !event.GetDirection() )
+ if ( !isForward )
{
SetFocus();
}
}
}
-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((HWND)hWnd, &rc);
-
- ::MapWindowPoints(NULL, GetHwnd(), (POINT *)&rc, 1);
-
- if ( !::SetBrushOrgEx((HDC)hDC, -rc.left, -rc.top, NULL) )
- {
- wxLogLastError(_T("SetBrushOrgEx(notebook bg brush)"));
- }
-
- return m_hbrBackground;
- }
-
- return wxNotebookBase::MSWGetBgBrushForChild(hDC, hWnd);
-}
-
bool wxNotebook::MSWPrintChild(WXHDC hDC, wxWindow *child)
{
// solid background colour overrides themed background drawing
NMHDR* hdr = (NMHDR *)lParam;
switch ( hdr->code ) {
case TCN_SELCHANGE:
- event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
+ event.SetEventType(wxEVT_NOTEBOOK_PAGE_CHANGED);
break;
case TCN_SELCHANGING:
- event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING);
+ event.SetEventType(wxEVT_NOTEBOOK_PAGE_CHANGING);
break;
default:
}
event.SetSelection(TabCtrl_GetCurSel(GetHwnd()));
- event.SetOldSelection(m_nSelection);
+ event.SetOldSelection(m_selection);
event.SetEventObject(this);
event.SetInt(idCtrl);
+ // Change the selection before generating the event as its handler should
+ // already see the new page selected.
+ if ( hdr->code == TCN_SELCHANGE )
+ UpdateSelection(event.GetSelection());
+
bool processed = HandleWindowEvent(event);
*result = !event.IsAllowed();
return processed;