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"
36 #include "wx/imaglist.h"
37 #include "wx/sysopt.h"
39 #include "wx/msw/private.h"
40 #include "wx/msw/dc.h"
43 #include "wx/msw/winundef.h"
46 #include "wx/msw/uxtheme.h"
49 // ----------------------------------------------------------------------------
51 // ----------------------------------------------------------------------------
53 // check that the page index is valid
54 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
56 // you can set USE_NOTEBOOK_ANTIFLICKER to 0 for desktop Windows versions too
57 // to disable code whih results in flicker-less notebook redrawing at the
58 // expense of some extra GDI resource consumption
60 // notebooks are never resized under CE anyhow
61 #define USE_NOTEBOOK_ANTIFLICKER 0
63 #define USE_NOTEBOOK_ANTIFLICKER 1
66 // ----------------------------------------------------------------------------
68 // ----------------------------------------------------------------------------
70 // This is a work-around for missing defines in gcc-2.95 headers
72 #define TCS_RIGHT 0x0002
76 #define TCS_VERTICAL 0x0080
80 #define TCS_BOTTOM TCS_RIGHT
83 // ----------------------------------------------------------------------------
85 // ----------------------------------------------------------------------------
87 #if USE_NOTEBOOK_ANTIFLICKER
89 // the pointer to standard spin button wnd proc
90 static WXFARPROC gs_wndprocNotebookSpinBtn
= (WXFARPROC
)NULL
;
92 // the pointer to standard tab control wnd proc
93 static WXFARPROC gs_wndprocNotebook
= (WXFARPROC
)NULL
;
95 LRESULT APIENTRY _EXPORT
wxNotebookWndProc(HWND hwnd
,
100 #endif // USE_NOTEBOOK_ANTIFLICKER
102 // ----------------------------------------------------------------------------
104 // ----------------------------------------------------------------------------
106 static bool HasTroubleWithNonTopTabs()
108 const int verComCtl32
= wxApp::GetComCtl32Version();
110 // 600 is XP, 616 is Vista -- and both have a problem with tabs not on top
111 // (but don't just test for >= 600 as Microsoft might decide to fix it in
112 // later versions, who knows...)
113 return verComCtl32
>= 600 && verComCtl32
<= 616;
116 // ----------------------------------------------------------------------------
118 // ----------------------------------------------------------------------------
120 #include "wx/listimpl.cpp"
122 WX_DEFINE_LIST( wxNotebookPageInfoList
)
124 BEGIN_EVENT_TABLE(wxNotebook
, wxBookCtrlBase
)
125 EVT_SIZE(wxNotebook::OnSize
)
126 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
128 #if USE_NOTEBOOK_ANTIFLICKER
129 EVT_ERASE_BACKGROUND(wxNotebook::OnEraseBackground
)
130 EVT_PAINT(wxNotebook::OnPaint
)
131 #endif // USE_NOTEBOOK_ANTIFLICKER
134 #if wxUSE_EXTENDED_RTTI
135 WX_DEFINE_FLAGS( wxNotebookStyle
)
137 wxBEGIN_FLAGS( wxNotebookStyle
)
138 // new style border flags, we put them first to
139 // use them for streaming out
140 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
141 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
142 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
143 wxFLAGS_MEMBER(wxBORDER_RAISED
)
144 wxFLAGS_MEMBER(wxBORDER_STATIC
)
145 wxFLAGS_MEMBER(wxBORDER_NONE
)
147 // old style border flags
148 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
149 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
150 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
151 wxFLAGS_MEMBER(wxRAISED_BORDER
)
152 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
153 wxFLAGS_MEMBER(wxBORDER
)
155 // standard window styles
156 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
157 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
158 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
159 wxFLAGS_MEMBER(wxWANTS_CHARS
)
160 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
161 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
162 wxFLAGS_MEMBER(wxVSCROLL
)
163 wxFLAGS_MEMBER(wxHSCROLL
)
165 wxFLAGS_MEMBER(wxNB_FIXEDWIDTH
)
166 wxFLAGS_MEMBER(wxBK_DEFAULT
)
167 wxFLAGS_MEMBER(wxBK_TOP
)
168 wxFLAGS_MEMBER(wxBK_LEFT
)
169 wxFLAGS_MEMBER(wxBK_RIGHT
)
170 wxFLAGS_MEMBER(wxBK_BOTTOM
)
171 wxFLAGS_MEMBER(wxNB_NOPAGETHEME
)
172 wxFLAGS_MEMBER(wxNB_FLAT
)
174 wxEND_FLAGS( wxNotebookStyle
)
176 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebook
, wxBookCtrlBase
,"wx/notebook.h")
177 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebookPageInfo
, wxObject
, "wx/notebook.h" )
179 wxCOLLECTION_TYPE_INFO( wxNotebookPageInfo
* , wxNotebookPageInfoList
) ;
181 template<> void wxCollectionToVariantArray( wxNotebookPageInfoList
const &theList
, wxxVariantArray
&value
)
183 wxListCollectionToVariantArray
<wxNotebookPageInfoList::compatibility_iterator
>( theList
, value
) ;
186 wxBEGIN_PROPERTIES_TABLE(wxNotebook
)
187 wxEVENT_PROPERTY( PageChanging
, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
, wxBookCtrlEvent
)
188 wxEVENT_PROPERTY( PageChanged
, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
, wxBookCtrlEvent
)
190 wxPROPERTY_COLLECTION( PageInfos
, wxNotebookPageInfoList
, wxNotebookPageInfo
* , AddPageInfo
, GetPageInfos
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
191 wxPROPERTY_FLAGS( WindowStyle
, wxNotebookStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
192 wxEND_PROPERTIES_TABLE()
194 wxBEGIN_HANDLERS_TABLE(wxNotebook
)
195 wxEND_HANDLERS_TABLE()
197 wxCONSTRUCTOR_5( wxNotebook
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
200 wxBEGIN_PROPERTIES_TABLE(wxNotebookPageInfo
)
201 wxREADONLY_PROPERTY( Page
, wxNotebookPage
* , GetPage
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
202 wxREADONLY_PROPERTY( Text
, wxString
, GetText
, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
203 wxREADONLY_PROPERTY( Selected
, bool , GetSelected
, false, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
204 wxREADONLY_PROPERTY( ImageId
, int , GetImageId
, -1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
205 wxEND_PROPERTIES_TABLE()
207 wxBEGIN_HANDLERS_TABLE(wxNotebookPageInfo
)
208 wxEND_HANDLERS_TABLE()
210 wxCONSTRUCTOR_4( wxNotebookPageInfo
, wxNotebookPage
* , Page
, wxString
, Text
, bool , Selected
, int , ImageId
)
213 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
, wxBookCtrlBase
)
214 IMPLEMENT_DYNAMIC_CLASS(wxNotebookPageInfo
, wxObject
)
217 // ============================================================================
219 // ============================================================================
221 // ----------------------------------------------------------------------------
222 // wxNotebook construction
223 // ----------------------------------------------------------------------------
225 const wxNotebookPageInfoList
& wxNotebook::GetPageInfos() const
227 wxNotebookPageInfoList
* list
= const_cast< wxNotebookPageInfoList
* >( &m_pageInfos
) ;
228 WX_CLEAR_LIST( wxNotebookPageInfoList
, *list
) ;
229 for( size_t i
= 0 ; i
< GetPageCount() ; ++i
)
231 wxNotebookPageInfo
*info
= new wxNotebookPageInfo() ;
232 info
->Create( const_cast<wxNotebook
*>(this)->GetPage(i
) , GetPageText(i
) , GetSelection() == int(i
) , GetPageImage(i
) ) ;
233 list
->Append( info
) ;
238 // common part of all ctors
239 void wxNotebook::Init()
244 m_hbrBackground
= NULL
;
245 #endif // wxUSE_UXTHEME
247 #if USE_NOTEBOOK_ANTIFLICKER
248 m_hasSubclassedUpdown
= false;
249 #endif // USE_NOTEBOOK_ANTIFLICKER
252 // default for dynamic class
253 wxNotebook::wxNotebook()
258 // the same arguments as for wxControl
259 wxNotebook::wxNotebook(wxWindow
*parent
,
264 const wxString
& name
)
268 Create(parent
, id
, pos
, size
, style
, name
);
272 bool wxNotebook::Create(wxWindow
*parent
,
277 const wxString
& name
)
279 if ( (style
& wxBK_ALIGN_MASK
) == wxBK_DEFAULT
)
281 #if defined(__POCKETPC__)
282 style
|= wxBK_BOTTOM
| wxNB_FLAT
;
289 // Not sure why, but without this style, there is no border
290 // around the notebook tabs.
291 if (style
& wxNB_FLAT
)
292 style
|= wxBORDER_SUNKEN
;
296 // ComCtl32 notebook tabs simply don't work unless they're on top if we
297 // have uxtheme, we can work around it later (after control creation), but
298 // if we have been compiled without uxtheme support, we have to clear those
300 if ( HasTroubleWithNonTopTabs() )
302 style
&= ~(wxBK_BOTTOM
| wxBK_LEFT
| wxBK_RIGHT
);
304 #endif //wxUSE_UXTHEME
306 #if defined(__WINE__) && wxUSE_UNICODE
307 LPCTSTR className
= L
"SysTabControl32";
309 LPCTSTR className
= WC_TABCONTROL
;
312 #if USE_NOTEBOOK_ANTIFLICKER
313 // SysTabCtl32 class has natively CS_HREDRAW and CS_VREDRAW enabled and it
314 // causes horrible flicker when resizing notebook, so get rid of it by
315 // using a class without these styles (but otherwise identical to it)
316 if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE
) )
318 static ClassRegistrar s_clsNotebook
;
319 if ( !s_clsNotebook
.IsInitialized() )
321 // get a copy of standard class and modify it
324 if ( ::GetClassInfo(NULL
, WC_TABCONTROL
, &wc
) )
327 reinterpret_cast<WXFARPROC
>(wc
.lpfnWndProc
);
328 wc
.lpszClassName
= wxT("_wx_SysTabCtl32");
329 wc
.style
&= ~(CS_HREDRAW
| CS_VREDRAW
);
330 wc
.hInstance
= wxGetInstance();
331 wc
.lpfnWndProc
= wxNotebookWndProc
;
332 s_clsNotebook
.Register(wc
);
336 wxLogLastError(wxT("GetClassInfoEx(SysTabCtl32)"));
340 // use our custom class if available but fall back to the standard
341 // notebook if we failed to register it
342 if ( s_clsNotebook
.IsRegistered() )
344 // it's ok to use c_str() here as the static s_clsNotebook object
345 // has sufficiently long lifetime
346 className
= s_clsNotebook
.GetName().c_str();
349 #endif // USE_NOTEBOOK_ANTIFLICKER
351 if ( !CreateControl(parent
, id
, pos
, size
, style
| wxTAB_TRAVERSAL
,
352 wxDefaultValidator
, name
) )
355 if ( !MSWCreateControl(className
, wxEmptyString
, pos
, size
) )
359 if ( HasFlag(wxNB_NOPAGETHEME
) ||
360 wxSystemOptions::IsFalse(wxT("msw.notebook.themed-background")) )
362 SetBackgroundColour(GetThemeBackgroundColour());
364 else // use themed background by default
366 // create backing store
370 // comctl32.dll 6.0 doesn't support non-top tabs with visual styles (the
371 // control is simply not rendered correctly), so we disable themes
372 // if possible, otherwise we simply clear the styles.
373 if ( HasTroubleWithNonTopTabs() &&
374 (style
& (wxBK_BOTTOM
| wxBK_LEFT
| wxBK_RIGHT
)) )
376 // check if we use themes at all -- if we don't, we're still okay
377 if ( wxUxThemeEngine::GetIfActive() )
379 wxUxThemeEngine::GetIfActive()->SetWindowTheme(GetHwnd(), L
"", L
"");
381 // correct the background color for the new non-themed control
382 SetBackgroundColour(GetThemeBackgroundColour());
385 #endif // wxUSE_UXTHEME
387 // Undocumented hack to get flat notebook style
388 // In fact, we should probably only do this in some
389 // curcumstances, i.e. if we know we will have a border
390 // at the bottom (the tab control doesn't draw it itself)
391 #if defined(__POCKETPC__) || defined(__SMARTPHONE__)
392 if (HasFlag(wxNB_FLAT
))
394 SendMessage(GetHwnd(), CCM_SETVERSION
, COMCTL32_VERSION
, 0);
396 SetBackgroundColour(*wxWHITE
);
402 WXDWORD
wxNotebook::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
404 WXDWORD tabStyle
= wxControl::MSWGetStyle(style
, exstyle
);
406 tabStyle
|= WS_TABSTOP
| TCS_TABS
;
408 if ( style
& wxNB_MULTILINE
)
409 tabStyle
|= TCS_MULTILINE
;
410 if ( style
& wxNB_FIXEDWIDTH
)
411 tabStyle
|= TCS_FIXEDWIDTH
;
413 if ( style
& wxBK_BOTTOM
)
414 tabStyle
|= TCS_RIGHT
;
415 else if ( style
& wxBK_LEFT
)
416 tabStyle
|= TCS_VERTICAL
;
417 else if ( style
& wxBK_RIGHT
)
418 tabStyle
|= TCS_VERTICAL
| TCS_RIGHT
;
423 wxNotebook::~wxNotebook()
426 if ( m_hbrBackground
)
427 ::DeleteObject((HBRUSH
)m_hbrBackground
);
428 #endif // wxUSE_UXTHEME
431 // ----------------------------------------------------------------------------
432 // wxNotebook accessors
433 // ----------------------------------------------------------------------------
435 size_t wxNotebook::GetPageCount() const
438 wxASSERT( (int)m_pages
.Count() == TabCtrl_GetItemCount(GetHwnd()) );
440 return m_pages
.Count();
443 int wxNotebook::GetRowCount() const
445 return TabCtrl_GetRowCount(GetHwnd());
448 int wxNotebook::SetSelection(size_t nPage
)
450 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
452 if ( m_selection
== wxNOT_FOUND
|| nPage
!= (size_t)m_selection
)
454 if ( SendPageChangingEvent(nPage
) )
456 // program allows the page change
457 SendPageChangedEvent(m_selection
, nPage
);
459 UpdateSelection(nPage
);
461 TabCtrl_SetCurSel(GetHwnd(), nPage
);
468 void wxNotebook::UpdateSelection(int selNew
)
470 if ( m_selection
!= wxNOT_FOUND
)
471 m_pages
[m_selection
]->Show(false);
473 if ( selNew
!= wxNOT_FOUND
)
475 wxNotebookPage
*pPage
= m_pages
[selNew
];
479 // Changing the page should give the focus to it but, as per bug report
480 // http://sf.net/tracker/index.php?func=detail&aid=1150659&group_id=9863&atid=109863,
481 // we should not set the focus to it directly since it erroneously
482 // selects radio buttons and breaks keyboard handling for a notebook's
483 // scroll buttons. So give focus to the notebook and not the page.
485 // but don't do this is the notebook is hidden
486 if ( ::IsWindowVisible(GetHwnd()) )
489 m_selection
= selNew
;
492 int wxNotebook::ChangeSelection(size_t nPage
)
494 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
496 const int selOld
= m_selection
;
498 if ( m_selection
== wxNOT_FOUND
|| nPage
!= (size_t)m_selection
)
500 TabCtrl_SetCurSel(GetHwnd(), nPage
);
502 UpdateSelection(nPage
);
508 bool wxNotebook::SetPageText(size_t nPage
, const wxString
& strText
)
510 wxCHECK_MSG( IS_VALID_PAGE(nPage
), false, wxT("notebook page out of range") );
513 tcItem
.mask
= TCIF_TEXT
;
514 tcItem
.pszText
= (wxChar
*)strText
.wx_str();
516 if ( !HasFlag(wxNB_MULTILINE
) )
517 return TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
519 // multiline - we need to set new page size if a line is added or removed
520 int rows
= GetRowCount();
521 bool ret
= TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
523 if ( ret
&& rows
!= GetRowCount() )
525 const wxRect r
= GetPageSize();
526 const size_t count
= m_pages
.Count();
527 for ( size_t page
= 0; page
< count
; page
++ )
528 m_pages
[page
]->SetSize(r
);
534 wxString
wxNotebook::GetPageText(size_t nPage
) const
536 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxEmptyString
, wxT("notebook page out of range") );
540 tcItem
.mask
= TCIF_TEXT
;
541 tcItem
.pszText
= buf
;
542 tcItem
.cchTextMax
= WXSIZEOF(buf
);
545 if ( TabCtrl_GetItem(GetHwnd(), nPage
, &tcItem
) )
546 str
= tcItem
.pszText
;
551 int wxNotebook::GetPageImage(size_t nPage
) const
553 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
556 tcItem
.mask
= TCIF_IMAGE
;
558 return TabCtrl_GetItem(GetHwnd(), nPage
, &tcItem
) ? tcItem
.iImage
562 bool wxNotebook::SetPageImage(size_t nPage
, int nImage
)
564 wxCHECK_MSG( IS_VALID_PAGE(nPage
), false, wxT("notebook page out of range") );
567 tcItem
.mask
= TCIF_IMAGE
;
568 tcItem
.iImage
= nImage
;
570 return TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
573 void wxNotebook::SetImageList(wxImageList
* imageList
)
575 wxNotebookBase::SetImageList(imageList
);
579 (void) TabCtrl_SetImageList(GetHwnd(), GetHimagelistOf(imageList
));
583 // ----------------------------------------------------------------------------
584 // wxNotebook size settings
585 // ----------------------------------------------------------------------------
587 wxRect
wxNotebook::GetPageSize() const
592 ::GetClientRect(GetHwnd(), &rc
);
594 // This check is to work around a bug in TabCtrl_AdjustRect which will
595 // cause a crash on win2k or on XP with themes disabled if either
596 // wxNB_MULTILINE is used or tabs are placed on a side, if the rectangle
599 // The value of 20 is chosen arbitrarily but seems to work
600 if ( rc
.right
> 20 && rc
.bottom
> 20 )
602 TabCtrl_AdjustRect(GetHwnd(), false, &rc
);
604 wxCopyRECTToRect(rc
, r
);
610 void wxNotebook::SetPageSize(const wxSize
& size
)
612 // transform the page size into the notebook size
619 TabCtrl_AdjustRect(GetHwnd(), true, &rc
);
622 SetSize(rc
.right
- rc
.left
, rc
.bottom
- rc
.top
);
625 void wxNotebook::SetPadding(const wxSize
& padding
)
627 TabCtrl_SetPadding(GetHwnd(), padding
.x
, padding
.y
);
630 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
632 void wxNotebook::SetTabSize(const wxSize
& sz
)
634 ::SendMessage(GetHwnd(), TCM_SETITEMSIZE
, 0, MAKELPARAM(sz
.x
, sz
.y
));
637 wxSize
wxNotebook::CalcSizeFromPage(const wxSize
& sizePage
) const
639 // we can't use TabCtrl_AdjustRect here because it only works for wxNB_TOP
640 wxSize sizeTotal
= sizePage
;
643 if ( GetPageCount() > 0 )
646 TabCtrl_GetItemRect(GetHwnd(), 0, &rect
);
647 tabSize
.x
= rect
.right
- rect
.left
;
648 tabSize
.y
= rect
.bottom
- rect
.top
;
651 const int rows
= GetRowCount();
653 // add an extra margin in both directions
654 const int MARGIN
= 8;
657 sizeTotal
.x
+= MARGIN
;
658 sizeTotal
.y
+= tabSize
.y
* rows
+ MARGIN
;
660 else // horizontal layout
662 sizeTotal
.x
+= tabSize
.x
* rows
+ MARGIN
;
663 sizeTotal
.y
+= MARGIN
;
669 void wxNotebook::AdjustPageSize(wxNotebookPage
*page
)
671 wxCHECK_RET( page
, wxT("NULL page in wxNotebook::AdjustPageSize") );
673 const wxRect r
= GetPageSize();
680 // ----------------------------------------------------------------------------
681 // wxNotebook operations
682 // ----------------------------------------------------------------------------
684 // remove one page from the notebook, without deleting
685 wxNotebookPage
*wxNotebook::DoRemovePage(size_t nPage
)
687 wxNotebookPage
*pageRemoved
= wxNotebookBase::DoRemovePage(nPage
);
691 // hide the removed page to maintain the invariant that only the
692 // selected page is visible and others are hidden:
693 pageRemoved
->Show(false);
695 TabCtrl_DeleteItem(GetHwnd(), nPage
);
697 if ( m_pages
.IsEmpty() )
699 // no selection any more, the notebook becamse empty
700 m_selection
= wxNOT_FOUND
;
702 else // notebook still not empty
704 int selNew
= TabCtrl_GetCurSel(GetHwnd());
705 if ( selNew
!= wxNOT_FOUND
)
707 // No selection change, just refresh the current selection.
708 // Because it could be that the slection index changed
709 // we need to update it.
710 // Note: this does not mean the selection it self changed.
711 m_selection
= selNew
;
712 m_pages
[m_selection
]->Refresh();
714 else if (int(nPage
) == m_selection
)
716 // The selection was deleted.
718 // Determine new selection.
719 if (m_selection
== int(GetPageCount()))
720 selNew
= m_selection
- 1;
722 selNew
= m_selection
;
724 // m_selection must be always valid so reset it before calling
726 m_selection
= wxNOT_FOUND
;
727 SetSelection(selNew
);
731 wxFAIL
; // Windows did not behave ok.
739 bool wxNotebook::DeleteAllPages()
741 size_t nPageCount
= GetPageCount();
743 for ( nPage
= 0; nPage
< nPageCount
; nPage
++ )
744 delete m_pages
[nPage
];
748 TabCtrl_DeleteAllItems(GetHwnd());
750 m_selection
= wxNOT_FOUND
;
752 InvalidateBestSize();
756 // same as AddPage() but does it at given position
757 bool wxNotebook::InsertPage(size_t nPage
,
758 wxNotebookPage
*pPage
,
759 const wxString
& strText
,
763 wxCHECK_MSG( pPage
!= NULL
, false, wxT("NULL page in wxNotebook::InsertPage") );
764 wxCHECK_MSG( IS_VALID_PAGE(nPage
) || nPage
== GetPageCount(), false,
765 wxT("invalid index in wxNotebook::InsertPage") );
767 wxASSERT_MSG( pPage
->GetParent() == this,
768 wxT("notebook pages must have notebook as parent") );
770 // add a new tab to the control
771 // ----------------------------
773 // init all fields to 0
775 wxZeroMemory(tcItem
);
777 // set the image, if any
780 tcItem
.mask
|= TCIF_IMAGE
;
781 tcItem
.iImage
= imageId
;
785 if ( !strText
.empty() )
787 tcItem
.mask
|= TCIF_TEXT
;
788 tcItem
.pszText
= const_cast<wxChar
*>(strText
.wx_str());
791 // hide the page: unless it is selected, it shouldn't be shown (and if it
792 // is selected it will be shown later)
793 HWND hwnd
= GetWinHwnd(pPage
);
794 SetWindowLong(hwnd
, GWL_STYLE
, GetWindowLong(hwnd
, GWL_STYLE
) & ~WS_VISIBLE
);
796 // this updates internal flag too -- otherwise it would get out of sync
797 // with the real state
801 // fit the notebook page to the tab control's display area: this should be
802 // done before adding it to the notebook or TabCtrl_InsertItem() will
803 // change the notebooks size itself!
804 AdjustPageSize(pPage
);
806 // finally do insert it
807 if ( TabCtrl_InsertItem(GetHwnd(), nPage
, &tcItem
) == -1 )
809 wxLogError(wxT("Can't create the notebook page '%s'."), strText
.c_str());
814 // need to update the bg brush when the first page is added
815 // so the first panel gets the correct themed background
816 if ( m_pages
.empty() )
820 #endif // wxUSE_UXTHEME
823 // succeeded: save the pointer to the page
824 m_pages
.Insert(pPage
, nPage
);
826 // we may need to adjust the size again if the notebook size changed:
827 // normally this only happens for the first page we add (the tabs which
828 // hadn't been there before are now shown) but for a multiline notebook it
829 // can happen for any page at all as a new row could have been started
830 if ( m_pages
.GetCount() == 1 || HasFlag(wxNB_MULTILINE
) )
832 AdjustPageSize(pPage
);
835 // now deal with the selection
836 // ---------------------------
838 // if the inserted page is before the selected one, we must update the
839 // index of the selected page
840 if ( int(nPage
) <= m_selection
)
842 // one extra page added
846 DoSetSelectionAfterInsertion(nPage
, bSelect
);
848 InvalidateBestSize();
853 int wxNotebook::HitTest(const wxPoint
& pt
, long *flags
) const
855 TC_HITTESTINFO hitTestInfo
;
856 hitTestInfo
.pt
.x
= pt
.x
;
857 hitTestInfo
.pt
.y
= pt
.y
;
858 int item
= TabCtrl_HitTest(GetHwnd(), &hitTestInfo
);
864 if ((hitTestInfo
.flags
& TCHT_NOWHERE
) == TCHT_NOWHERE
)
865 *flags
|= wxBK_HITTEST_NOWHERE
;
866 if ((hitTestInfo
.flags
& TCHT_ONITEM
) == TCHT_ONITEM
)
867 *flags
|= wxBK_HITTEST_ONITEM
;
868 if ((hitTestInfo
.flags
& TCHT_ONITEMICON
) == TCHT_ONITEMICON
)
869 *flags
|= wxBK_HITTEST_ONICON
;
870 if ((hitTestInfo
.flags
& TCHT_ONITEMLABEL
) == TCHT_ONITEMLABEL
)
871 *flags
|= wxBK_HITTEST_ONLABEL
;
872 if ( item
== wxNOT_FOUND
&& GetPageSize().Contains(pt
) )
873 *flags
|= wxBK_HITTEST_ONPAGE
;
879 // ----------------------------------------------------------------------------
880 // flicker-less notebook redraw
881 // ----------------------------------------------------------------------------
883 #if USE_NOTEBOOK_ANTIFLICKER
885 // wnd proc for the spin button
886 LRESULT APIENTRY _EXPORT
wxNotebookSpinBtnWndProc(HWND hwnd
,
891 if ( message
== WM_ERASEBKGND
)
894 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebookSpinBtn
,
895 hwnd
, message
, wParam
, lParam
);
898 LRESULT APIENTRY _EXPORT
wxNotebookWndProc(HWND hwnd
,
903 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebook
,
904 hwnd
, message
, wParam
, lParam
);
907 void wxNotebook::OnEraseBackground(wxEraseEvent
& WXUNUSED(event
))
912 void wxNotebook::OnPaint(wxPaintEvent
& WXUNUSED(event
))
917 ::GetClientRect(GetHwnd(), &rc
);
918 wxBitmap
bmp(rc
.right
, rc
.bottom
);
919 memdc
.SelectObject(bmp
);
921 const wxLayoutDirection dir
= dc
.GetLayoutDirection();
922 memdc
.SetLayoutDirection(dir
);
924 // if there is no special brush just use the solid background colour
926 HBRUSH hbr
= (HBRUSH
)m_hbrBackground
;
933 brush
= wxBrush(GetBackgroundColour());
934 hbr
= GetHbrushOf(brush
);
937 wxMSWDCImpl
*impl
= (wxMSWDCImpl
*) memdc
.GetImpl();
939 ::FillRect(GetHdcOf(*impl
), &rc
, hbr
);
941 MSWDefWindowProc(WM_PAINT
, (WPARAM
)(impl
->GetHDC()), 0);
943 // For some reason in RTL mode, source offset has to be -1, otherwise the
944 // right border (physical) remains unpainted.
945 const wxCoord ofs
= dir
== wxLayout_RightToLeft
? -1 : 0;
946 dc
.Blit(ofs
, 0, rc
.right
, rc
.bottom
, &memdc
, ofs
, 0);
949 #endif // USE_NOTEBOOK_ANTIFLICKER
951 // ----------------------------------------------------------------------------
952 // wxNotebook callbacks
953 // ----------------------------------------------------------------------------
955 void wxNotebook::OnSize(wxSizeEvent
& event
)
957 if ( GetPageCount() == 0 )
959 // Prevents droppings on resize, but does cause some flicker
960 // when there are no pages.
968 // Without this, we can sometimes get droppings at the edges
969 // of a notebook, for example a notebook in a splitter window.
970 // This needs to be reconciled with the RefreshRect calls
971 // at the end of this function, which weren't enough to prevent
974 wxSize sz
= GetClientSize();
976 // Refresh right side
977 wxRect
rect(sz
.x
-4, 0, 4, sz
.y
);
980 // Refresh bottom side
981 rect
= wxRect(0, sz
.y
-4, sz
.x
, 4);
985 rect
= wxRect(0, 0, 4, sz
.y
);
988 #endif // !__WXWINCE__
990 // fit all the notebook pages to the tab control's display area
993 rc
.left
= rc
.top
= 0;
994 GetSize((int *)&rc
.right
, (int *)&rc
.bottom
);
996 // save the total size, we'll use it below
997 int widthNbook
= rc
.right
- rc
.left
,
998 heightNbook
= rc
.bottom
- rc
.top
;
1000 // there seems to be a bug in the implementation of TabCtrl_AdjustRect(): it
1001 // returns completely false values for multiline tab controls after the tabs
1002 // are added but before getting the first WM_SIZE (off by ~50 pixels, see
1004 // http://sf.net/tracker/index.php?func=detail&aid=645323&group_id=9863&atid=109863
1006 // and the only work around I could find was this ugly hack... without it
1007 // simply toggling the "multiline" checkbox in the notebook sample resulted
1008 // in a noticeable page displacement
1009 if ( HasFlag(wxNB_MULTILINE
) )
1011 // avoid an infinite recursion: we get another notification too!
1012 static bool s_isInOnSize
= false;
1014 if ( !s_isInOnSize
)
1016 s_isInOnSize
= true;
1017 SendMessage(GetHwnd(), WM_SIZE
, SIZE_RESTORED
,
1018 MAKELPARAM(rc
.right
, rc
.bottom
));
1019 s_isInOnSize
= false;
1022 // The best size depends on the number of rows of tabs, which can
1023 // change when the notepad is resized.
1024 InvalidateBestSize();
1028 // background bitmap size has changed, update the brush using it too
1030 #endif // wxUSE_UXTHEME
1032 TabCtrl_AdjustRect(GetHwnd(), false, &rc
);
1034 int width
= rc
.right
- rc
.left
,
1035 height
= rc
.bottom
- rc
.top
;
1036 size_t nCount
= m_pages
.Count();
1037 for ( size_t nPage
= 0; nPage
< nCount
; nPage
++ ) {
1038 wxNotebookPage
*pPage
= m_pages
[nPage
];
1039 pPage
->SetSize(rc
.left
, rc
.top
, width
, height
);
1043 // unless we had already repainted everything, we now need to refresh
1044 if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE
) )
1046 // invalidate areas not covered by pages
1047 RefreshRect(wxRect(0, 0, widthNbook
, rc
.top
), false);
1048 RefreshRect(wxRect(0, rc
.top
, rc
.left
, height
), false);
1049 RefreshRect(wxRect(0, rc
.bottom
, widthNbook
, heightNbook
- rc
.bottom
),
1051 RefreshRect(wxRect(rc
.right
, rc
.top
, widthNbook
- rc
.right
, height
),
1055 #if USE_NOTEBOOK_ANTIFLICKER
1056 // subclass the spin control used by the notebook to scroll pages to
1057 // prevent it from flickering on resize
1058 if ( !m_hasSubclassedUpdown
)
1060 // iterate over all child windows to find spin button
1061 for ( HWND child
= ::GetWindow(GetHwnd(), GW_CHILD
);
1063 child
= ::GetWindow(child
, GW_HWNDNEXT
) )
1065 wxWindow
*childWindow
= wxFindWinFromHandle((WXHWND
)child
);
1067 // see if it exists, if no wxWindow found then assume it's the spin
1071 // subclass the spin button to override WM_ERASEBKGND
1072 if ( !gs_wndprocNotebookSpinBtn
)
1073 gs_wndprocNotebookSpinBtn
= (WXFARPROC
)wxGetWindowProc(child
);
1075 wxSetWindowProc(child
, wxNotebookSpinBtnWndProc
);
1076 m_hasSubclassedUpdown
= true;
1081 #endif // USE_NOTEBOOK_ANTIFLICKER
1086 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
1088 if ( event
.IsWindowChange() ) {
1090 AdvanceSelection(event
.GetDirection());
1093 // we get this event in 3 cases
1095 // a) one of our pages might have generated it because the user TABbed
1096 // out from it in which case we should propagate the event upwards and
1097 // our parent will take care of setting the focus to prev/next sibling
1101 // b) the parent panel wants to give the focus to us so that we
1102 // forward it to our selected page. We can't deal with this in
1103 // OnSetFocus() because we don't know which direction the focus came
1104 // from in this case and so can't choose between setting the focus to
1105 // first or last panel child
1109 // c) we ourselves (see MSWTranslateMessage) generated the event
1111 wxWindow
* const parent
= GetParent();
1113 // the wxObject* casts are required to avoid MinGW GCC 2.95.3 ICE
1114 const bool isFromParent
= event
.GetEventObject() == (wxObject
*) parent
;
1115 const bool isFromSelf
= event
.GetEventObject() == (wxObject
*) this;
1116 const bool isForward
= event
.GetDirection();
1118 if ( isFromSelf
&& !isForward
)
1120 // focus is currently on notebook tab and should leave
1121 // it backwards (Shift-TAB)
1122 event
.SetCurrentFocus(this);
1123 parent
->HandleWindowEvent(event
);
1125 else if ( isFromParent
|| isFromSelf
)
1127 // no, it doesn't come from child, case (b) or (c): forward to a
1128 // page but only if entering notebook page (i.e. direction is
1129 // backwards (Shift-TAB) comething from out-of-notebook, or
1130 // direction is forward (TAB) from ourselves),
1131 if ( m_selection
!= wxNOT_FOUND
&&
1132 (!event
.GetDirection() || isFromSelf
) )
1134 // so that the page knows that the event comes from it's parent
1135 // and is being propagated downwards
1136 event
.SetEventObject(this);
1138 wxWindow
*page
= m_pages
[m_selection
];
1139 if ( !page
->HandleWindowEvent(event
) )
1143 //else: page manages focus inside it itself
1145 else // otherwise set the focus to the notebook itself
1152 // it comes from our child, case (a), pass to the parent, but only
1153 // if the direction is forwards. Otherwise set the focus to the
1154 // notebook itself. The notebook is always the 'first' control of a
1162 event
.SetCurrentFocus(this);
1163 parent
->HandleWindowEvent(event
);
1171 bool wxNotebook::DoDrawBackground(WXHDC hDC
, wxWindow
*child
)
1173 wxUxThemeHandle
theme(child
? child
: this, L
"TAB");
1177 // get the notebook client rect (we're not interested in drawing tabs
1179 wxRect r
= GetPageSize();
1184 wxCopyRectToRECT(r
, rc
);
1186 // map rect to the coords of the window we're drawing in
1188 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1190 // we have the content area (page size), but we need to draw all of the
1191 // background for it to be aligned correctly
1192 wxUxThemeEngine::Get()->GetThemeBackgroundExtent
1201 wxUxThemeEngine::Get()->DrawThemeBackground
1214 WXHBRUSH
wxNotebook::QueryBgBitmap()
1216 wxRect r
= GetPageSize();
1220 WindowHDC
hDC(GetHwnd());
1221 MemoryHDC
hDCMem(hDC
);
1222 CompatibleBitmap
hBmp(hDC
, r
.x
+ r
.width
, r
.y
+ r
.height
);
1224 SelectInHDC
selectBmp(hDCMem
, hBmp
);
1226 if ( !DoDrawBackground((WXHDC
)(HDC
)hDCMem
) )
1229 return (WXHBRUSH
)::CreatePatternBrush(hBmp
);
1232 void wxNotebook::UpdateBgBrush()
1234 if ( m_hbrBackground
)
1235 ::DeleteObject((HBRUSH
)m_hbrBackground
);
1237 if ( !m_hasBgCol
&& wxUxThemeEngine::GetIfActive() )
1239 m_hbrBackground
= QueryBgBitmap();
1241 else // no themes or we've got user-defined solid colour
1243 m_hbrBackground
= NULL
;
1247 WXHBRUSH
wxNotebook::MSWGetBgBrushForChild(WXHDC hDC
, wxWindow
*child
)
1249 if ( m_hbrBackground
)
1251 // before drawing with the background brush, we need to position it
1254 ::GetWindowRect(GetHwndOf(child
), &rc
);
1256 ::MapWindowPoints(NULL
, GetHwnd(), (POINT
*)&rc
, 1);
1258 if ( !::SetBrushOrgEx((HDC
)hDC
, -rc
.left
, -rc
.top
, NULL
) )
1260 wxLogLastError(wxT("SetBrushOrgEx(notebook bg brush)"));
1263 return m_hbrBackground
;
1266 return wxNotebookBase::MSWGetBgBrushForChild(hDC
, child
);
1269 bool wxNotebook::MSWPrintChild(WXHDC hDC
, wxWindow
*child
)
1271 // solid background colour overrides themed background drawing
1272 if ( !UseBgCol() && DoDrawBackground(hDC
, child
) )
1275 // If we're using a solid colour (for example if we've switched off
1276 // theming for this notebook), paint it
1279 wxRect r
= GetPageSize();
1284 wxCopyRectToRECT(r
, rc
);
1286 // map rect to the coords of the window we're drawing in
1288 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1290 wxBrush
brush(GetBackgroundColour());
1291 HBRUSH hbr
= GetHbrushOf(brush
);
1293 ::FillRect((HDC
) hDC
, &rc
, hbr
);
1298 return wxNotebookBase::MSWPrintChild(hDC
, child
);
1301 #endif // wxUSE_UXTHEME
1303 // Windows only: attempts to get colour for UX theme page background
1304 wxColour
wxNotebook::GetThemeBackgroundColour() const
1307 if (wxUxThemeEngine::Get())
1309 wxUxThemeHandle
hTheme((wxNotebook
*) this, L
"TAB");
1312 // This is total guesswork.
1313 // See PlatformSDK\Include\Tmschema.h for values.
1314 // JACS: can also use 9 (TABP_PANE)
1315 COLORREF themeColor
;
1316 bool success
= (S_OK
== wxUxThemeEngine::Get()->GetThemeColor(
1320 3821 /* FILLCOLORHINT */,
1323 return GetBackgroundColour();
1326 [DS] Workaround for WindowBlinds:
1327 Some themes return a near black theme color using FILLCOLORHINT,
1328 this makes notebook pages have an ugly black background and makes
1329 text (usually black) unreadable. Retry again with FILLCOLOR.
1331 This workaround potentially breaks appearance of some themes,
1332 but in practice it already fixes some themes.
1334 if (themeColor
== 1)
1336 wxUxThemeEngine::Get()->GetThemeColor(
1340 3802 /* FILLCOLOR */,
1344 wxColour colour
= wxRGBToColour(themeColor
);
1346 // Under Vista, the tab background colour is reported incorrectly.
1347 // So for the default theme at least, hard-code the colour to something
1348 // that will blend in.
1350 static int s_AeroStatus
= -1;
1351 if (s_AeroStatus
== -1)
1353 WCHAR szwThemeFile
[1024];
1354 WCHAR szwThemeColor
[256];
1355 if (S_OK
== wxUxThemeEngine::Get()->GetCurrentThemeName(szwThemeFile
, 1024, szwThemeColor
, 256, NULL
, 0))
1357 wxString
themeFile(szwThemeFile
), themeColor(szwThemeColor
);
1358 if (themeFile
.Find(wxT("Aero")) != -1 && themeColor
== wxT("NormalColor"))
1367 if (s_AeroStatus
== 1)
1368 colour
= wxColour(255, 255, 255);
1373 #endif // wxUSE_UXTHEME
1375 return GetBackgroundColour();
1378 // ----------------------------------------------------------------------------
1379 // wxNotebook base class virtuals
1380 // ----------------------------------------------------------------------------
1382 #if wxUSE_CONSTRAINTS
1384 // override these 2 functions to do nothing: everything is done in OnSize
1386 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse
))
1388 // don't set the sizes of the pages - their correct size is not yet known
1389 wxControl::SetConstraintSizes(false);
1392 bool wxNotebook::DoPhase(int WXUNUSED(nPhase
))
1397 #endif // wxUSE_CONSTRAINTS
1399 // ----------------------------------------------------------------------------
1400 // wxNotebook Windows message handlers
1401 // ----------------------------------------------------------------------------
1403 bool wxNotebook::MSWOnScroll(int orientation
, WXWORD nSBCode
,
1404 WXWORD pos
, WXHWND control
)
1406 // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
1411 return wxNotebookBase::MSWOnScroll(orientation
, nSBCode
, pos
, control
);
1414 bool wxNotebook::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
* result
)
1416 wxBookCtrlEvent
event(wxEVT_NULL
, m_windowId
);
1418 NMHDR
* hdr
= (NMHDR
*)lParam
;
1419 switch ( hdr
->code
) {
1421 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
);
1424 case TCN_SELCHANGING
:
1425 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
);
1429 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1432 event
.SetSelection(TabCtrl_GetCurSel(GetHwnd()));
1433 event
.SetOldSelection(m_selection
);
1434 event
.SetEventObject(this);
1435 event
.SetInt(idCtrl
);
1437 bool processed
= HandleWindowEvent(event
);
1438 if ( hdr
->code
== TCN_SELCHANGE
)
1439 UpdateSelection(event
.GetSelection());
1441 *result
= !event
.IsAllowed();
1445 #endif // wxUSE_NOTEBOOK