1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/notebook.cpp
3 // Purpose: implementation of wxNotebook
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
21 #include "wx/notebook.h"
24 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
25 #include "wx/string.h"
30 #include "wx/dcclient.h"
31 #include "wx/dcmemory.h"
32 #include "wx/control.h"
35 #include "wx/imaglist.h"
36 #include "wx/sysopt.h"
38 #include "wx/msw/private.h"
41 #include "wx/msw/winundef.h"
44 #include "wx/msw/uxtheme.h"
47 // ----------------------------------------------------------------------------
49 // ----------------------------------------------------------------------------
51 // check that the page index is valid
52 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
54 // you can set USE_NOTEBOOK_ANTIFLICKER to 0 for desktop Windows versions too
55 // to disable code whih results in flicker-less notebook redrawing at the
56 // expense of some extra GDI resource consumption
58 // notebooks are never resized under CE anyhow
59 #define USE_NOTEBOOK_ANTIFLICKER 0
61 #define USE_NOTEBOOK_ANTIFLICKER 1
64 // ----------------------------------------------------------------------------
66 // ----------------------------------------------------------------------------
68 // This is a work-around for missing defines in gcc-2.95 headers
70 #define TCS_RIGHT 0x0002
74 #define TCS_VERTICAL 0x0080
78 #define TCS_BOTTOM TCS_RIGHT
81 // ----------------------------------------------------------------------------
83 // ----------------------------------------------------------------------------
85 #if USE_NOTEBOOK_ANTIFLICKER
87 // the pointer to standard spin button wnd proc
88 static WXFARPROC gs_wndprocNotebookSpinBtn
= (WXFARPROC
)NULL
;
90 // the pointer to standard tab control wnd proc
91 static WXFARPROC gs_wndprocNotebook
= (WXFARPROC
)NULL
;
93 LRESULT APIENTRY _EXPORT
wxNotebookWndProc(HWND hwnd
,
98 #endif // USE_NOTEBOOK_ANTIFLICKER
100 // ----------------------------------------------------------------------------
102 // ----------------------------------------------------------------------------
104 static bool HasTroubleWithNonTopTabs()
106 const int verComCtl32
= wxApp::GetComCtl32Version();
108 // 600 is XP, 616 is Vista -- and both have a problem with tabs not on top
109 // (but don't just test for >= 600 as Microsoft might decide to fix it in
110 // later versions, who knows...)
111 return verComCtl32
>= 600 && verComCtl32
<= 616;
114 // ----------------------------------------------------------------------------
116 // ----------------------------------------------------------------------------
118 #include "wx/listimpl.cpp"
120 WX_DEFINE_LIST( wxNotebookPageInfoList
)
122 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
)
123 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
)
125 BEGIN_EVENT_TABLE(wxNotebook
, wxControl
)
126 EVT_NOTEBOOK_PAGE_CHANGED(wxID_ANY
, wxNotebook::OnSelChange
)
127 EVT_SIZE(wxNotebook::OnSize
)
128 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
130 #if USE_NOTEBOOK_ANTIFLICKER
131 EVT_ERASE_BACKGROUND(wxNotebook::OnEraseBackground
)
132 EVT_PAINT(wxNotebook::OnPaint
)
133 #endif // USE_NOTEBOOK_ANTIFLICKER
136 #if wxUSE_EXTENDED_RTTI
137 WX_DEFINE_FLAGS( wxNotebookStyle
)
139 wxBEGIN_FLAGS( wxNotebookStyle
)
140 // new style border flags, we put them first to
141 // use them for streaming out
142 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
143 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
144 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
145 wxFLAGS_MEMBER(wxBORDER_RAISED
)
146 wxFLAGS_MEMBER(wxBORDER_STATIC
)
147 wxFLAGS_MEMBER(wxBORDER_NONE
)
149 // old style border flags
150 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
151 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
152 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
153 wxFLAGS_MEMBER(wxRAISED_BORDER
)
154 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
155 wxFLAGS_MEMBER(wxBORDER
)
157 // standard window styles
158 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
159 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
160 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
161 wxFLAGS_MEMBER(wxWANTS_CHARS
)
162 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
163 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
164 wxFLAGS_MEMBER(wxVSCROLL
)
165 wxFLAGS_MEMBER(wxHSCROLL
)
167 wxFLAGS_MEMBER(wxNB_FIXEDWIDTH
)
168 wxFLAGS_MEMBER(wxBK_DEFAULT
)
169 wxFLAGS_MEMBER(wxBK_TOP
)
170 wxFLAGS_MEMBER(wxBK_LEFT
)
171 wxFLAGS_MEMBER(wxBK_RIGHT
)
172 wxFLAGS_MEMBER(wxBK_BOTTOM
)
173 wxFLAGS_MEMBER(wxNB_NOPAGETHEME
)
174 wxFLAGS_MEMBER(wxNB_FLAT
)
176 wxEND_FLAGS( wxNotebookStyle
)
178 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebook
, wxControl
,"wx/notebook.h")
179 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebookPageInfo
, wxObject
, "wx/notebook.h" )
181 wxCOLLECTION_TYPE_INFO( wxNotebookPageInfo
* , wxNotebookPageInfoList
) ;
183 template<> void wxCollectionToVariantArray( wxNotebookPageInfoList
const &theList
, wxxVariantArray
&value
)
185 wxListCollectionToVariantArray
<wxNotebookPageInfoList::compatibility_iterator
>( theList
, value
) ;
188 wxBEGIN_PROPERTIES_TABLE(wxNotebook
)
189 wxEVENT_PROPERTY( PageChanging
, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
, wxNotebookEvent
)
190 wxEVENT_PROPERTY( PageChanged
, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
, wxNotebookEvent
)
192 wxPROPERTY_COLLECTION( PageInfos
, wxNotebookPageInfoList
, wxNotebookPageInfo
* , AddPageInfo
, GetPageInfos
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
193 wxPROPERTY_FLAGS( WindowStyle
, wxNotebookStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
194 wxEND_PROPERTIES_TABLE()
196 wxBEGIN_HANDLERS_TABLE(wxNotebook
)
197 wxEND_HANDLERS_TABLE()
199 wxCONSTRUCTOR_5( wxNotebook
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
202 wxBEGIN_PROPERTIES_TABLE(wxNotebookPageInfo
)
203 wxREADONLY_PROPERTY( Page
, wxNotebookPage
* , GetPage
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
204 wxREADONLY_PROPERTY( Text
, wxString
, GetText
, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
205 wxREADONLY_PROPERTY( Selected
, bool , GetSelected
, false, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
206 wxREADONLY_PROPERTY( ImageId
, int , GetImageId
, -1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
207 wxEND_PROPERTIES_TABLE()
209 wxBEGIN_HANDLERS_TABLE(wxNotebookPageInfo
)
210 wxEND_HANDLERS_TABLE()
212 wxCONSTRUCTOR_4( wxNotebookPageInfo
, wxNotebookPage
* , Page
, wxString
, Text
, bool , Selected
, int , ImageId
)
215 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
, wxControl
)
216 IMPLEMENT_DYNAMIC_CLASS(wxNotebookPageInfo
, wxObject
)
218 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent
, wxNotifyEvent
)
220 // ============================================================================
222 // ============================================================================
224 // ----------------------------------------------------------------------------
225 // wxNotebook construction
226 // ----------------------------------------------------------------------------
228 const wxNotebookPageInfoList
& wxNotebook::GetPageInfos() const
230 wxNotebookPageInfoList
* list
= const_cast< wxNotebookPageInfoList
* >( &m_pageInfos
) ;
231 WX_CLEAR_LIST( wxNotebookPageInfoList
, *list
) ;
232 for( size_t i
= 0 ; i
< GetPageCount() ; ++i
)
234 wxNotebookPageInfo
*info
= new wxNotebookPageInfo() ;
235 info
->Create( const_cast<wxNotebook
*>(this)->GetPage(i
) , GetPageText(i
) , GetSelection() == int(i
) , GetPageImage(i
) ) ;
236 list
->Append( info
) ;
241 // common part of all ctors
242 void wxNotebook::Init()
245 m_nSelection
= wxNOT_FOUND
;
248 m_hbrBackground
= NULL
;
249 #endif // wxUSE_UXTHEME
251 #if USE_NOTEBOOK_ANTIFLICKER
252 m_hasSubclassedUpdown
= false;
253 #endif // USE_NOTEBOOK_ANTIFLICKER
256 // default for dynamic class
257 wxNotebook::wxNotebook()
262 // the same arguments as for wxControl
263 wxNotebook::wxNotebook(wxWindow
*parent
,
268 const wxString
& name
)
272 Create(parent
, id
, pos
, size
, style
, name
);
276 bool wxNotebook::Create(wxWindow
*parent
,
281 const wxString
& name
)
283 if ( (style
& wxBK_ALIGN_MASK
) == wxBK_DEFAULT
)
285 #if defined(__POCKETPC__)
286 style
|= wxBK_BOTTOM
| wxNB_FLAT
;
293 // Not sure why, but without this style, there is no border
294 // around the notebook tabs.
295 if (style
& wxNB_FLAT
)
296 style
|= wxBORDER_SUNKEN
;
300 // ComCtl32 notebook tabs simply don't work unless they're on top if we
301 // have uxtheme, we can work around it later (after control creation), but
302 // if we have been compiled without uxtheme support, we have to clear those
304 if ( HasTroubleWithNonTopTabs() )
306 style
&= ~(wxBK_BOTTOM
| wxBK_LEFT
| wxBK_RIGHT
);
308 #endif //wxUSE_UXTHEME
310 #if defined(__WINE__) && wxUSE_UNICODE
311 LPCTSTR className
= L
"SysTabControl32";
313 LPCTSTR className
= WC_TABCONTROL
;
316 #if USE_NOTEBOOK_ANTIFLICKER
317 // SysTabCtl32 class has natively CS_HREDRAW and CS_VREDRAW enabled and it
318 // causes horrible flicker when resizing notebook, so get rid of it by
319 // using a class without these styles (but otherwise identical to it)
320 if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE
) )
322 static ClassRegistrar s_clsNotebook
;
323 if ( !s_clsNotebook
.IsInitialized() )
325 // get a copy of standard class and modify it
328 if ( ::GetClassInfo(NULL
, WC_TABCONTROL
, &wc
) )
331 wx_reinterpret_cast(WXFARPROC
, wc
.lpfnWndProc
);
332 wc
.lpszClassName
= wxT("_wx_SysTabCtl32");
333 wc
.style
&= ~(CS_HREDRAW
| CS_VREDRAW
);
334 wc
.hInstance
= wxGetInstance();
335 wc
.lpfnWndProc
= wxNotebookWndProc
;
336 s_clsNotebook
.Register(wc
);
340 wxLogLastError(_T("GetClassInfoEx(SysTabCtl32)"));
344 // use our custom class if available but fall back to the standard
345 // notebook if we failed to register it
346 if ( s_clsNotebook
.IsRegistered() )
348 // it's ok to use c_str() here as the static s_clsNotebook object
349 // has sufficiently long lifetime
350 className
= s_clsNotebook
.GetName().c_str();
353 #endif // USE_NOTEBOOK_ANTIFLICKER
355 if ( !CreateControl(parent
, id
, pos
, size
, style
| wxTAB_TRAVERSAL
,
356 wxDefaultValidator
, name
) )
359 if ( !MSWCreateControl(className
, wxEmptyString
, pos
, size
) )
363 if ( HasFlag(wxNB_NOPAGETHEME
) ||
364 wxSystemOptions::IsFalse(wxT("msw.notebook.themed-background")) )
366 SetBackgroundColour(GetThemeBackgroundColour());
368 else // use themed background by default
370 // create backing store
374 // comctl32.dll 6.0 doesn't support non-top tabs with visual styles (the
375 // control is simply not rendered correctly), so we disable themes
376 // if possible, otherwise we simply clear the styles.
377 if ( HasTroubleWithNonTopTabs() &&
378 (style
& (wxBK_BOTTOM
| wxBK_LEFT
| wxBK_RIGHT
)) )
380 // check if we use themes at all -- if we don't, we're still okay
381 if ( wxUxThemeEngine::GetIfActive() )
383 wxUxThemeEngine::GetIfActive()->SetWindowTheme(GetHwnd(), L
"", L
"");
385 // correct the background color for the new non-themed control
386 SetBackgroundColour(GetThemeBackgroundColour());
389 #endif // wxUSE_UXTHEME
391 // Undocumented hack to get flat notebook style
392 // In fact, we should probably only do this in some
393 // curcumstances, i.e. if we know we will have a border
394 // at the bottom (the tab control doesn't draw it itself)
395 #if defined(__POCKETPC__) || defined(__SMARTPHONE__)
396 if (HasFlag(wxNB_FLAT
))
398 SendMessage(GetHwnd(), CCM_SETVERSION
, COMCTL32_VERSION
, 0);
400 SetBackgroundColour(*wxWHITE
);
406 WXDWORD
wxNotebook::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
408 WXDWORD tabStyle
= wxControl::MSWGetStyle(style
, exstyle
);
410 tabStyle
|= WS_TABSTOP
| TCS_TABS
;
412 if ( style
& wxNB_MULTILINE
)
413 tabStyle
|= TCS_MULTILINE
;
414 if ( style
& wxNB_FIXEDWIDTH
)
415 tabStyle
|= TCS_FIXEDWIDTH
;
417 if ( style
& wxBK_BOTTOM
)
418 tabStyle
|= TCS_RIGHT
;
419 else if ( style
& wxBK_LEFT
)
420 tabStyle
|= TCS_VERTICAL
;
421 else if ( style
& wxBK_RIGHT
)
422 tabStyle
|= TCS_VERTICAL
| TCS_RIGHT
;
427 // note that we never want to have the default WS_EX_CLIENTEDGE style
428 // as it looks too ugly for the notebooks
435 wxNotebook::~wxNotebook()
438 if ( m_hbrBackground
)
439 ::DeleteObject((HBRUSH
)m_hbrBackground
);
440 #endif // wxUSE_UXTHEME
443 // ----------------------------------------------------------------------------
444 // wxNotebook accessors
445 // ----------------------------------------------------------------------------
447 size_t wxNotebook::GetPageCount() const
450 wxASSERT( (int)m_pages
.Count() == TabCtrl_GetItemCount(GetHwnd()) );
452 return m_pages
.Count();
455 int wxNotebook::GetRowCount() const
457 return TabCtrl_GetRowCount(GetHwnd());
460 int wxNotebook::SetSelection(size_t nPage
)
462 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
464 if ( m_nSelection
== wxNOT_FOUND
|| nPage
!= (size_t)m_nSelection
)
466 if ( SendPageChangingEvent(nPage
) )
468 // program allows the page change
469 SendPageChangedEvent(m_nSelection
, nPage
);
471 TabCtrl_SetCurSel(GetHwnd(), nPage
);
478 void wxNotebook::UpdateSelection(int selNew
)
480 if ( m_nSelection
!= wxNOT_FOUND
)
481 m_pages
[m_nSelection
]->Show(false);
483 if ( selNew
!= wxNOT_FOUND
)
485 wxNotebookPage
*pPage
= m_pages
[selNew
];
489 // Changing the page should give the focus to it but, as per bug report
490 // http://sf.net/tracker/index.php?func=detail&aid=1150659&group_id=9863&atid=109863,
491 // we should not set the focus to it directly since it erroneously
492 // selects radio buttons and breaks keyboard handling for a notebook's
493 // scroll buttons. So give focus to the notebook and not the page.
495 // but don't do this is the notebook is hidden
496 if ( ::IsWindowVisible(GetHwnd()) )
499 m_nSelection
= selNew
;
502 int wxNotebook::ChangeSelection(size_t nPage
)
504 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
506 if ( m_nSelection
== wxNOT_FOUND
|| nPage
!= (size_t)m_nSelection
)
508 TabCtrl_SetCurSel(GetHwnd(), nPage
);
510 UpdateSelection(nPage
);
516 bool wxNotebook::SetPageText(size_t nPage
, const wxString
& strText
)
518 wxCHECK_MSG( IS_VALID_PAGE(nPage
), false, wxT("notebook page out of range") );
521 tcItem
.mask
= TCIF_TEXT
;
522 tcItem
.pszText
= (wxChar
*)strText
.wx_str();
524 if ( !HasFlag(wxNB_MULTILINE
) )
525 return TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
527 // multiline - we need to set new page size if a line is added or removed
528 int rows
= GetRowCount();
529 bool ret
= TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
531 if ( ret
&& rows
!= GetRowCount() )
533 const wxRect r
= GetPageSize();
534 const size_t count
= m_pages
.Count();
535 for ( size_t page
= 0; page
< count
; page
++ )
536 m_pages
[page
]->SetSize(r
);
542 wxString
wxNotebook::GetPageText(size_t nPage
) const
544 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxEmptyString
, wxT("notebook page out of range") );
548 tcItem
.mask
= TCIF_TEXT
;
549 tcItem
.pszText
= buf
;
550 tcItem
.cchTextMax
= WXSIZEOF(buf
);
553 if ( TabCtrl_GetItem(GetHwnd(), nPage
, &tcItem
) )
554 str
= tcItem
.pszText
;
559 int wxNotebook::GetPageImage(size_t nPage
) const
561 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
564 tcItem
.mask
= TCIF_IMAGE
;
566 return TabCtrl_GetItem(GetHwnd(), nPage
, &tcItem
) ? tcItem
.iImage
570 bool wxNotebook::SetPageImage(size_t nPage
, int nImage
)
572 wxCHECK_MSG( IS_VALID_PAGE(nPage
), false, wxT("notebook page out of range") );
575 tcItem
.mask
= TCIF_IMAGE
;
576 tcItem
.iImage
= nImage
;
578 return TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
581 void wxNotebook::SetImageList(wxImageList
* imageList
)
583 wxNotebookBase::SetImageList(imageList
);
587 (void) TabCtrl_SetImageList(GetHwnd(), GetHimagelistOf(imageList
));
591 // ----------------------------------------------------------------------------
592 // wxNotebook size settings
593 // ----------------------------------------------------------------------------
595 wxRect
wxNotebook::GetPageSize() const
600 ::GetClientRect(GetHwnd(), &rc
);
602 // This check is to work around a bug in TabCtrl_AdjustRect which will
603 // cause a crash on win2k or on XP with themes disabled if either
604 // wxNB_MULTILINE is used or tabs are placed on a side, if the rectangle
607 // The value of 20 is chosen arbitrarily but seems to work
608 if ( rc
.right
> 20 && rc
.bottom
> 20 )
610 TabCtrl_AdjustRect(GetHwnd(), false, &rc
);
612 wxCopyRECTToRect(rc
, r
);
618 void wxNotebook::SetPageSize(const wxSize
& size
)
620 // transform the page size into the notebook size
627 TabCtrl_AdjustRect(GetHwnd(), true, &rc
);
630 SetSize(rc
.right
- rc
.left
, rc
.bottom
- rc
.top
);
633 void wxNotebook::SetPadding(const wxSize
& padding
)
635 TabCtrl_SetPadding(GetHwnd(), padding
.x
, padding
.y
);
638 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
640 void wxNotebook::SetTabSize(const wxSize
& sz
)
642 ::SendMessage(GetHwnd(), TCM_SETITEMSIZE
, 0, MAKELPARAM(sz
.x
, sz
.y
));
645 wxSize
wxNotebook::CalcSizeFromPage(const wxSize
& sizePage
) const
647 // we can't use TabCtrl_AdjustRect here because it only works for wxNB_TOP
648 wxSize sizeTotal
= sizePage
;
651 if ( GetPageCount() > 0 )
654 TabCtrl_GetItemRect(GetHwnd(), 0, &rect
);
655 tabSize
.x
= rect
.right
- rect
.left
;
656 tabSize
.y
= rect
.bottom
- rect
.top
;
659 // add an extra margin in both directions
660 const int MARGIN
= 8;
663 sizeTotal
.x
+= MARGIN
;
664 sizeTotal
.y
+= tabSize
.y
+ MARGIN
;
666 else // horizontal layout
668 sizeTotal
.x
+= tabSize
.x
+ MARGIN
;
669 sizeTotal
.y
+= MARGIN
;
675 void wxNotebook::AdjustPageSize(wxNotebookPage
*page
)
677 wxCHECK_RET( page
, _T("NULL page in wxNotebook::AdjustPageSize") );
679 const wxRect r
= GetPageSize();
686 // ----------------------------------------------------------------------------
687 // wxNotebook operations
688 // ----------------------------------------------------------------------------
690 // remove one page from the notebook, without deleting
691 wxNotebookPage
*wxNotebook::DoRemovePage(size_t nPage
)
693 wxNotebookPage
*pageRemoved
= wxNotebookBase::DoRemovePage(nPage
);
697 TabCtrl_DeleteItem(GetHwnd(), nPage
);
699 if ( m_pages
.IsEmpty() )
701 // no selection any more, the notebook becamse empty
702 m_nSelection
= wxNOT_FOUND
;
704 else // notebook still not empty
706 int selNew
= TabCtrl_GetCurSel(GetHwnd());
707 if ( selNew
!= wxNOT_FOUND
)
709 // No selection change, just refresh the current selection.
710 // Because it could be that the slection index changed
711 // we need to update it.
712 // Note: this does not mean the selection it self changed.
713 m_nSelection
= selNew
;
714 m_pages
[m_nSelection
]->Refresh();
716 else if (int(nPage
) == m_nSelection
)
718 // The selection was deleted.
720 // Determine new selection.
721 if (m_nSelection
== int(GetPageCount()))
722 selNew
= m_nSelection
- 1;
724 selNew
= m_nSelection
;
726 // m_nSelection must be always valid so reset it before calling
728 m_nSelection
= wxNOT_FOUND
;
729 SetSelection(selNew
);
733 wxFAIL
; // Windows did not behave ok.
741 bool wxNotebook::DeleteAllPages()
743 size_t nPageCount
= GetPageCount();
745 for ( nPage
= 0; nPage
< nPageCount
; nPage
++ )
746 delete m_pages
[nPage
];
750 TabCtrl_DeleteAllItems(GetHwnd());
752 m_nSelection
= wxNOT_FOUND
;
754 InvalidateBestSize();
758 // same as AddPage() but does it at given position
759 bool wxNotebook::InsertPage(size_t nPage
,
760 wxNotebookPage
*pPage
,
761 const wxString
& strText
,
765 wxCHECK_MSG( pPage
!= NULL
, false, _T("NULL page in wxNotebook::InsertPage") );
766 wxCHECK_MSG( IS_VALID_PAGE(nPage
) || nPage
== GetPageCount(), false,
767 _T("invalid index in wxNotebook::InsertPage") );
769 wxASSERT_MSG( pPage
->GetParent() == this,
770 _T("notebook pages must have notebook as parent") );
772 // add a new tab to the control
773 // ----------------------------
775 // init all fields to 0
777 wxZeroMemory(tcItem
);
779 // set the image, if any
782 tcItem
.mask
|= TCIF_IMAGE
;
783 tcItem
.iImage
= imageId
;
787 if ( !strText
.empty() )
789 tcItem
.mask
|= TCIF_TEXT
;
790 tcItem
.pszText
= (wxChar
*)strText
.wx_str(); // const_cast
793 // hide the page: unless it is selected, it shouldn't be shown (and if it
794 // is selected it will be shown later)
795 HWND hwnd
= GetWinHwnd(pPage
);
796 SetWindowLong(hwnd
, GWL_STYLE
, GetWindowLong(hwnd
, GWL_STYLE
) & ~WS_VISIBLE
);
798 // this updates internal flag too -- otherwise it would get out of sync
799 // with the real state
803 // fit the notebook page to the tab control's display area: this should be
804 // done before adding it to the notebook or TabCtrl_InsertItem() will
805 // change the notebooks size itself!
806 AdjustPageSize(pPage
);
808 // finally do insert it
809 if ( TabCtrl_InsertItem(GetHwnd(), nPage
, &tcItem
) == -1 )
811 wxLogError(wxT("Can't create the notebook page '%s'."), strText
.c_str());
816 // need to update the bg brush when the first page is added
817 // so the first panel gets the correct themed background
818 if ( m_pages
.empty() )
822 #endif // wxUSE_UXTHEME
825 // succeeded: save the pointer to the page
826 m_pages
.Insert(pPage
, nPage
);
828 // we may need to adjust the size again if the notebook size changed:
829 // normally this only happens for the first page we add (the tabs which
830 // hadn't been there before are now shown) but for a multiline notebook it
831 // can happen for any page at all as a new row could have been started
832 if ( m_pages
.GetCount() == 1 || HasFlag(wxNB_MULTILINE
) )
834 AdjustPageSize(pPage
);
837 // now deal with the selection
838 // ---------------------------
840 // if the inserted page is before the selected one, we must update the
841 // index of the selected page
842 if ( int(nPage
) <= m_nSelection
)
844 // one extra page added
848 // some page should be selected: either this one or the first one if there
849 // is still no selection
850 int selNew
= wxNOT_FOUND
;
853 else if ( m_nSelection
== wxNOT_FOUND
)
856 if ( selNew
!= wxNOT_FOUND
)
857 SetSelection(selNew
);
859 InvalidateBestSize();
864 int wxNotebook::HitTest(const wxPoint
& pt
, long *flags
) const
866 TC_HITTESTINFO hitTestInfo
;
867 hitTestInfo
.pt
.x
= pt
.x
;
868 hitTestInfo
.pt
.y
= pt
.y
;
869 int item
= TabCtrl_HitTest(GetHwnd(), &hitTestInfo
);
875 if ((hitTestInfo
.flags
& TCHT_NOWHERE
) == TCHT_NOWHERE
)
876 *flags
|= wxBK_HITTEST_NOWHERE
;
877 if ((hitTestInfo
.flags
& TCHT_ONITEM
) == TCHT_ONITEM
)
878 *flags
|= wxBK_HITTEST_ONITEM
;
879 if ((hitTestInfo
.flags
& TCHT_ONITEMICON
) == TCHT_ONITEMICON
)
880 *flags
|= wxBK_HITTEST_ONICON
;
881 if ((hitTestInfo
.flags
& TCHT_ONITEMLABEL
) == TCHT_ONITEMLABEL
)
882 *flags
|= wxBK_HITTEST_ONLABEL
;
883 if ( item
== wxNOT_FOUND
&& GetPageSize().Contains(pt
) )
884 *flags
|= wxBK_HITTEST_ONPAGE
;
890 // ----------------------------------------------------------------------------
891 // flicker-less notebook redraw
892 // ----------------------------------------------------------------------------
894 #if USE_NOTEBOOK_ANTIFLICKER
896 // wnd proc for the spin button
897 LRESULT APIENTRY _EXPORT
wxNotebookSpinBtnWndProc(HWND hwnd
,
902 if ( message
== WM_ERASEBKGND
)
905 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebookSpinBtn
,
906 hwnd
, message
, wParam
, lParam
);
909 LRESULT APIENTRY _EXPORT
wxNotebookWndProc(HWND hwnd
,
914 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebook
,
915 hwnd
, message
, wParam
, lParam
);
918 void wxNotebook::OnEraseBackground(wxEraseEvent
& WXUNUSED(event
))
923 void wxNotebook::OnPaint(wxPaintEvent
& WXUNUSED(event
))
928 ::GetClientRect(GetHwnd(), &rc
);
929 wxBitmap
bmp(rc
.right
, rc
.bottom
);
930 memdc
.SelectObject(bmp
);
932 const wxLayoutDirection dir
= dc
.GetLayoutDirection();
933 memdc
.SetLayoutDirection(dir
);
935 // if there is no special brush just use the solid background colour
937 HBRUSH hbr
= (HBRUSH
)m_hbrBackground
;
944 brush
= wxBrush(GetBackgroundColour());
945 hbr
= GetHbrushOf(brush
);
948 ::FillRect(GetHdcOf(memdc
), &rc
, hbr
);
950 MSWDefWindowProc(WM_PAINT
, (WPARAM
)memdc
.GetHDC(), 0);
952 // For some reason in RTL mode, source offset has to be -1, otherwise the
953 // right border (physical) remains unpainted.
954 const wxCoord ofs
= dir
== wxLayout_RightToLeft
? -1 : 0;
955 dc
.Blit(ofs
, 0, rc
.right
, rc
.bottom
, &memdc
, ofs
, 0);
958 #endif // USE_NOTEBOOK_ANTIFLICKER
960 // ----------------------------------------------------------------------------
961 // wxNotebook callbacks
962 // ----------------------------------------------------------------------------
964 void wxNotebook::OnSize(wxSizeEvent
& event
)
966 if ( GetPageCount() == 0 )
968 // Prevents droppings on resize, but does cause some flicker
969 // when there are no pages.
977 // Without this, we can sometimes get droppings at the edges
978 // of a notebook, for example a notebook in a splitter window.
979 // This needs to be reconciled with the RefreshRect calls
980 // at the end of this function, which weren't enough to prevent
983 wxSize sz
= GetClientSize();
985 // Refresh right side
986 wxRect
rect(sz
.x
-4, 0, 4, sz
.y
);
989 // Refresh bottom side
990 rect
= wxRect(0, sz
.y
-4, sz
.x
, 4);
994 rect
= wxRect(0, 0, 4, sz
.y
);
997 #endif // !__WXWINCE__
999 // fit all the notebook pages to the tab control's display area
1002 rc
.left
= rc
.top
= 0;
1003 GetSize((int *)&rc
.right
, (int *)&rc
.bottom
);
1005 // save the total size, we'll use it below
1006 int widthNbook
= rc
.right
- rc
.left
,
1007 heightNbook
= rc
.bottom
- rc
.top
;
1009 // there seems to be a bug in the implementation of TabCtrl_AdjustRect(): it
1010 // returns completely false values for multiline tab controls after the tabs
1011 // are added but before getting the first WM_SIZE (off by ~50 pixels, see
1013 // http://sf.net/tracker/index.php?func=detail&aid=645323&group_id=9863&atid=109863
1015 // and the only work around I could find was this ugly hack... without it
1016 // simply toggling the "multiline" checkbox in the notebook sample resulted
1017 // in a noticeable page displacement
1018 if ( HasFlag(wxNB_MULTILINE
) )
1020 // avoid an infinite recursion: we get another notification too!
1021 static bool s_isInOnSize
= false;
1023 if ( !s_isInOnSize
)
1025 s_isInOnSize
= true;
1026 SendMessage(GetHwnd(), WM_SIZE
, SIZE_RESTORED
,
1027 MAKELPARAM(rc
.right
, rc
.bottom
));
1028 s_isInOnSize
= false;
1033 // background bitmap size has changed, update the brush using it too
1035 #endif // wxUSE_UXTHEME
1037 TabCtrl_AdjustRect(GetHwnd(), false, &rc
);
1039 int width
= rc
.right
- rc
.left
,
1040 height
= rc
.bottom
- rc
.top
;
1041 size_t nCount
= m_pages
.Count();
1042 for ( size_t nPage
= 0; nPage
< nCount
; nPage
++ ) {
1043 wxNotebookPage
*pPage
= m_pages
[nPage
];
1044 pPage
->SetSize(rc
.left
, rc
.top
, width
, height
);
1048 // unless we had already repainted everything, we now need to refresh
1049 if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE
) )
1051 // invalidate areas not covered by pages
1052 RefreshRect(wxRect(0, 0, widthNbook
, rc
.top
), false);
1053 RefreshRect(wxRect(0, rc
.top
, rc
.left
, height
), false);
1054 RefreshRect(wxRect(0, rc
.bottom
, widthNbook
, heightNbook
- rc
.bottom
),
1056 RefreshRect(wxRect(rc
.right
, rc
.top
, widthNbook
- rc
.right
, height
),
1060 #if USE_NOTEBOOK_ANTIFLICKER
1061 // subclass the spin control used by the notebook to scroll pages to
1062 // prevent it from flickering on resize
1063 if ( !m_hasSubclassedUpdown
)
1065 // iterate over all child windows to find spin button
1066 for ( HWND child
= ::GetWindow(GetHwnd(), GW_CHILD
);
1068 child
= ::GetWindow(child
, GW_HWNDNEXT
) )
1070 wxWindow
*childWindow
= wxFindWinFromHandle((WXHWND
)child
);
1072 // see if it exists, if no wxWindow found then assume it's the spin
1076 // subclass the spin button to override WM_ERASEBKGND
1077 if ( !gs_wndprocNotebookSpinBtn
)
1078 gs_wndprocNotebookSpinBtn
= (WXFARPROC
)wxGetWindowProc(child
);
1080 wxSetWindowProc(child
, wxNotebookSpinBtnWndProc
);
1081 m_hasSubclassedUpdown
= true;
1086 #endif // USE_NOTEBOOK_ANTIFLICKER
1091 void wxNotebook::OnSelChange(wxNotebookEvent
& event
)
1093 // is it our tab control?
1094 if ( event
.GetEventObject() == this )
1096 UpdateSelection(event
.GetSelection());
1099 // we want to give others a chance to process this message as well
1103 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
1105 if ( event
.IsWindowChange() ) {
1107 AdvanceSelection(event
.GetDirection());
1110 // we get this event in 3 cases
1112 // a) one of our pages might have generated it because the user TABbed
1113 // out from it in which case we should propagate the event upwards and
1114 // our parent will take care of setting the focus to prev/next sibling
1118 // b) the parent panel wants to give the focus to us so that we
1119 // forward it to our selected page. We can't deal with this in
1120 // OnSetFocus() because we don't know which direction the focus came
1121 // from in this case and so can't choose between setting the focus to
1122 // first or last panel child
1126 // c) we ourselves (see MSWTranslateMessage) generated the event
1128 wxWindow
* const parent
= GetParent();
1130 // the wxObject* casts are required to avoid MinGW GCC 2.95.3 ICE
1131 const bool isFromParent
= event
.GetEventObject() == (wxObject
*) parent
;
1132 const bool isFromSelf
= event
.GetEventObject() == (wxObject
*) this;
1134 if ( isFromParent
|| isFromSelf
)
1136 // no, it doesn't come from child, case (b) or (c): forward to a
1137 // page but only if direction is backwards (TAB) or from ourselves,
1138 if ( m_nSelection
!= wxNOT_FOUND
&&
1139 (!event
.GetDirection() || isFromSelf
) )
1141 // so that the page knows that the event comes from it's parent
1142 // and is being propagated downwards
1143 event
.SetEventObject(this);
1145 wxWindow
*page
= m_pages
[m_nSelection
];
1146 if ( !page
->HandleWindowEvent(event
) )
1150 //else: page manages focus inside it itself
1152 else // otherwise set the focus to the notebook itself
1159 // it comes from our child, case (a), pass to the parent, but only
1160 // if the direction is forwards. Otherwise set the focus to the
1161 // notebook itself. The notebook is always the 'first' control of a
1163 if ( !event
.GetDirection() )
1169 event
.SetCurrentFocus(this);
1170 parent
->HandleWindowEvent(event
);
1178 bool wxNotebook::DoDrawBackground(WXHDC hDC
, wxWindow
*child
)
1180 wxUxThemeHandle
theme(child
? child
: this, L
"TAB");
1184 // get the notebook client rect (we're not interested in drawing tabs
1186 wxRect r
= GetPageSize();
1191 wxCopyRectToRECT(r
, rc
);
1193 // map rect to the coords of the window we're drawing in
1195 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1197 // we have the content area (page size), but we need to draw all of the
1198 // background for it to be aligned correctly
1199 wxUxThemeEngine::Get()->GetThemeBackgroundExtent
1208 wxUxThemeEngine::Get()->DrawThemeBackground
1221 WXHBRUSH
wxNotebook::QueryBgBitmap()
1223 wxRect r
= GetPageSize();
1227 WindowHDC
hDC(GetHwnd());
1228 MemoryHDC
hDCMem(hDC
);
1229 CompatibleBitmap
hBmp(hDC
, r
.x
+ r
.width
, r
.y
+ r
.height
);
1231 SelectInHDC
selectBmp(hDCMem
, hBmp
);
1233 if ( !DoDrawBackground((WXHDC
)(HDC
)hDCMem
) )
1236 return (WXHBRUSH
)::CreatePatternBrush(hBmp
);
1239 void wxNotebook::UpdateBgBrush()
1241 if ( m_hbrBackground
)
1242 ::DeleteObject((HBRUSH
)m_hbrBackground
);
1244 if ( !m_hasBgCol
&& wxUxThemeEngine::GetIfActive() )
1246 m_hbrBackground
= QueryBgBitmap();
1248 else // no themes or we've got user-defined solid colour
1250 m_hbrBackground
= NULL
;
1254 WXHBRUSH
wxNotebook::MSWGetBgBrushForChild(WXHDC hDC
, WXHWND hWnd
)
1256 if ( m_hbrBackground
)
1258 // before drawing with the background brush, we need to position it
1261 ::GetWindowRect((HWND
)hWnd
, &rc
);
1263 ::MapWindowPoints(NULL
, GetHwnd(), (POINT
*)&rc
, 1);
1265 if ( !::SetBrushOrgEx((HDC
)hDC
, -rc
.left
, -rc
.top
, NULL
) )
1267 wxLogLastError(_T("SetBrushOrgEx(notebook bg brush)"));
1270 return m_hbrBackground
;
1273 return wxNotebookBase::MSWGetBgBrushForChild(hDC
, hWnd
);
1276 bool wxNotebook::MSWPrintChild(WXHDC hDC
, wxWindow
*child
)
1278 // solid background colour overrides themed background drawing
1279 if ( !UseBgCol() && DoDrawBackground(hDC
, child
) )
1282 // If we're using a solid colour (for example if we've switched off
1283 // theming for this notebook), paint it
1286 wxRect r
= GetPageSize();
1291 wxCopyRectToRECT(r
, rc
);
1293 // map rect to the coords of the window we're drawing in
1295 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1297 wxBrush
brush(GetBackgroundColour());
1298 HBRUSH hbr
= GetHbrushOf(brush
);
1300 ::FillRect((HDC
) hDC
, &rc
, hbr
);
1305 return wxNotebookBase::MSWPrintChild(hDC
, child
);
1308 #endif // wxUSE_UXTHEME
1310 // Windows only: attempts to get colour for UX theme page background
1311 wxColour
wxNotebook::GetThemeBackgroundColour() const
1314 if (wxUxThemeEngine::Get())
1316 wxUxThemeHandle
hTheme((wxNotebook
*) this, L
"TAB");
1319 // This is total guesswork.
1320 // See PlatformSDK\Include\Tmschema.h for values.
1321 // JACS: can also use 9 (TABP_PANE)
1322 COLORREF themeColor
;
1323 bool success
= (S_OK
== wxUxThemeEngine::Get()->GetThemeColor(
1327 3821 /* FILLCOLORHINT */,
1330 return GetBackgroundColour();
1333 [DS] Workaround for WindowBlinds:
1334 Some themes return a near black theme color using FILLCOLORHINT,
1335 this makes notebook pages have an ugly black background and makes
1336 text (usually black) unreadable. Retry again with FILLCOLOR.
1338 This workaround potentially breaks appearance of some themes,
1339 but in practice it already fixes some themes.
1341 if (themeColor
== 1)
1343 wxUxThemeEngine::Get()->GetThemeColor(
1347 3802 /* FILLCOLOR */,
1351 wxColour colour
= wxRGBToColour(themeColor
);
1353 // Under Vista, the tab background colour is reported incorrectly.
1354 // So for the default theme at least, hard-code the colour to something
1355 // that will blend in.
1357 static int s_AeroStatus
= -1;
1358 if (s_AeroStatus
== -1)
1360 WCHAR szwThemeFile
[1024];
1361 WCHAR szwThemeColor
[256];
1362 if (S_OK
== wxUxThemeEngine::Get()->GetCurrentThemeName(szwThemeFile
, 1024, szwThemeColor
, 256, NULL
, 0))
1364 wxString
themeFile(szwThemeFile
), themeColor(szwThemeColor
);
1365 if (themeFile
.Find(wxT("Aero")) != -1 && themeColor
== wxT("NormalColor"))
1374 if (s_AeroStatus
== 1)
1375 colour
= wxColour(255, 255, 255);
1380 #endif // wxUSE_UXTHEME
1382 return GetBackgroundColour();
1385 // ----------------------------------------------------------------------------
1386 // wxNotebook base class virtuals
1387 // ----------------------------------------------------------------------------
1389 #if wxUSE_CONSTRAINTS
1391 // override these 2 functions to do nothing: everything is done in OnSize
1393 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse
))
1395 // don't set the sizes of the pages - their correct size is not yet known
1396 wxControl::SetConstraintSizes(false);
1399 bool wxNotebook::DoPhase(int WXUNUSED(nPhase
))
1404 #endif // wxUSE_CONSTRAINTS
1406 // ----------------------------------------------------------------------------
1407 // wxNotebook Windows message handlers
1408 // ----------------------------------------------------------------------------
1410 bool wxNotebook::MSWOnScroll(int orientation
, WXWORD nSBCode
,
1411 WXWORD pos
, WXHWND control
)
1413 // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
1418 return wxNotebookBase::MSWOnScroll(orientation
, nSBCode
, pos
, control
);
1421 bool wxNotebook::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
* result
)
1423 wxNotebookEvent
event(wxEVT_NULL
, m_windowId
);
1425 NMHDR
* hdr
= (NMHDR
*)lParam
;
1426 switch ( hdr
->code
) {
1428 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
);
1431 case TCN_SELCHANGING
:
1432 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
);
1436 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1439 event
.SetSelection(TabCtrl_GetCurSel(GetHwnd()));
1440 event
.SetOldSelection(m_nSelection
);
1441 event
.SetEventObject(this);
1442 event
.SetInt(idCtrl
);
1444 bool processed
= HandleWindowEvent(event
);
1445 *result
= !event
.IsAllowed();
1449 #endif // wxUSE_NOTEBOOK