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 #include "wx/listimpl.cpp"
106 WX_DEFINE_LIST( wxNotebookPageInfoList
)
108 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
)
109 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
)
111 BEGIN_EVENT_TABLE(wxNotebook
, wxControl
)
112 EVT_NOTEBOOK_PAGE_CHANGED(wxID_ANY
, wxNotebook::OnSelChange
)
113 EVT_SIZE(wxNotebook::OnSize
)
114 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
116 #if USE_NOTEBOOK_ANTIFLICKER
117 EVT_ERASE_BACKGROUND(wxNotebook::OnEraseBackground
)
118 EVT_PAINT(wxNotebook::OnPaint
)
119 #endif // USE_NOTEBOOK_ANTIFLICKER
122 #if wxUSE_EXTENDED_RTTI
123 WX_DEFINE_FLAGS( wxNotebookStyle
)
125 wxBEGIN_FLAGS( wxNotebookStyle
)
126 // new style border flags, we put them first to
127 // use them for streaming out
128 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
129 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
130 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
131 wxFLAGS_MEMBER(wxBORDER_RAISED
)
132 wxFLAGS_MEMBER(wxBORDER_STATIC
)
133 wxFLAGS_MEMBER(wxBORDER_NONE
)
135 // old style border flags
136 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
137 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
138 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
139 wxFLAGS_MEMBER(wxRAISED_BORDER
)
140 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
141 wxFLAGS_MEMBER(wxBORDER
)
143 // standard window styles
144 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
145 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
146 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
147 wxFLAGS_MEMBER(wxWANTS_CHARS
)
148 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
149 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
150 wxFLAGS_MEMBER(wxVSCROLL
)
151 wxFLAGS_MEMBER(wxHSCROLL
)
153 wxFLAGS_MEMBER(wxNB_FIXEDWIDTH
)
154 wxFLAGS_MEMBER(wxBK_DEFAULT
)
155 wxFLAGS_MEMBER(wxBK_TOP
)
156 wxFLAGS_MEMBER(wxBK_LEFT
)
157 wxFLAGS_MEMBER(wxBK_RIGHT
)
158 wxFLAGS_MEMBER(wxBK_BOTTOM
)
159 wxFLAGS_MEMBER(wxNB_NOPAGETHEME
)
160 wxFLAGS_MEMBER(wxNB_FLAT
)
162 wxEND_FLAGS( wxNotebookStyle
)
164 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebook
, wxControl
,"wx/notebook.h")
165 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebookPageInfo
, wxObject
, "wx/notebook.h" )
167 wxCOLLECTION_TYPE_INFO( wxNotebookPageInfo
* , wxNotebookPageInfoList
) ;
169 template<> void wxCollectionToVariantArray( wxNotebookPageInfoList
const &theList
, wxxVariantArray
&value
)
171 wxListCollectionToVariantArray
<wxNotebookPageInfoList::compatibility_iterator
>( theList
, value
) ;
174 wxBEGIN_PROPERTIES_TABLE(wxNotebook
)
175 wxEVENT_PROPERTY( PageChanging
, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
, wxNotebookEvent
)
176 wxEVENT_PROPERTY( PageChanged
, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
, wxNotebookEvent
)
178 wxPROPERTY_COLLECTION( PageInfos
, wxNotebookPageInfoList
, wxNotebookPageInfo
* , AddPageInfo
, GetPageInfos
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
179 wxPROPERTY_FLAGS( WindowStyle
, wxNotebookStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
180 wxEND_PROPERTIES_TABLE()
182 wxBEGIN_HANDLERS_TABLE(wxNotebook
)
183 wxEND_HANDLERS_TABLE()
185 wxCONSTRUCTOR_5( wxNotebook
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
188 wxBEGIN_PROPERTIES_TABLE(wxNotebookPageInfo
)
189 wxREADONLY_PROPERTY( Page
, wxNotebookPage
* , GetPage
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
190 wxREADONLY_PROPERTY( Text
, wxString
, GetText
, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
191 wxREADONLY_PROPERTY( Selected
, bool , GetSelected
, false, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
192 wxREADONLY_PROPERTY( ImageId
, int , GetImageId
, -1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
193 wxEND_PROPERTIES_TABLE()
195 wxBEGIN_HANDLERS_TABLE(wxNotebookPageInfo
)
196 wxEND_HANDLERS_TABLE()
198 wxCONSTRUCTOR_4( wxNotebookPageInfo
, wxNotebookPage
* , Page
, wxString
, Text
, bool , Selected
, int , ImageId
)
201 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
, wxControl
)
202 IMPLEMENT_DYNAMIC_CLASS(wxNotebookPageInfo
, wxObject
)
204 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent
, wxNotifyEvent
)
206 // ============================================================================
208 // ============================================================================
210 // ----------------------------------------------------------------------------
211 // wxNotebook construction
212 // ----------------------------------------------------------------------------
214 const wxNotebookPageInfoList
& wxNotebook::GetPageInfos() const
216 wxNotebookPageInfoList
* list
= const_cast< wxNotebookPageInfoList
* >( &m_pageInfos
) ;
217 WX_CLEAR_LIST( wxNotebookPageInfoList
, *list
) ;
218 for( size_t i
= 0 ; i
< GetPageCount() ; ++i
)
220 wxNotebookPageInfo
*info
= new wxNotebookPageInfo() ;
221 info
->Create( const_cast<wxNotebook
*>(this)->GetPage(i
) , GetPageText(i
) , GetSelection() == int(i
) , GetPageImage(i
) ) ;
222 list
->Append( info
) ;
227 // common part of all ctors
228 void wxNotebook::Init()
234 m_hbrBackground
= NULL
;
235 #endif // wxUSE_UXTHEME
237 #if USE_NOTEBOOK_ANTIFLICKER
238 m_hasSubclassedUpdown
= false;
239 #endif // USE_NOTEBOOK_ANTIFLICKER
242 // default for dynamic class
243 wxNotebook::wxNotebook()
248 // the same arguments as for wxControl
249 wxNotebook::wxNotebook(wxWindow
*parent
,
254 const wxString
& name
)
258 Create(parent
, id
, pos
, size
, style
, name
);
262 bool wxNotebook::Create(wxWindow
*parent
,
267 const wxString
& name
)
269 if ( (style
& wxBK_ALIGN_MASK
) == wxBK_DEFAULT
)
271 #if defined(__POCKETPC__)
272 style
|= wxBK_BOTTOM
| wxNB_FLAT
;
279 // Not sure why, but without this style, there is no border
280 // around the notebook tabs.
281 if (style
& wxNB_FLAT
)
282 style
|= wxBORDER_SUNKEN
;
286 // ComCtl32 notebook tabs simply don't work unless they're on top if we have uxtheme, we can
287 // work around it later (after control creation), but if we don't have uxtheme, we have to clear
289 const int verComCtl32
= wxApp::GetComCtl32Version();
290 if ( verComCtl32
== 600 )
292 style
&= ~(wxBK_BOTTOM
| wxBK_LEFT
| wxBK_RIGHT
);
294 #endif //wxUSE_UXTHEME
296 LPCTSTR className
= WC_TABCONTROL
;
298 #if USE_NOTEBOOK_ANTIFLICKER
299 // SysTabCtl32 class has natively CS_HREDRAW and CS_VREDRAW enabled and it
300 // causes horrible flicker when resizing notebook, so get rid of it by
301 // using a class without these styles (but otherwise identical to it)
302 if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE
) )
304 static ClassRegistrar s_clsNotebook
;
305 if ( !s_clsNotebook
.IsInitialized() )
307 // get a copy of standard class and modify it
310 if ( ::GetClassInfo(NULL
, WC_TABCONTROL
, &wc
) )
313 wx_reinterpret_cast(WXFARPROC
, wc
.lpfnWndProc
);
314 wc
.lpszClassName
= wxT("_wx_SysTabCtl32");
315 wc
.style
&= ~(CS_HREDRAW
| CS_VREDRAW
);
316 wc
.hInstance
= wxGetInstance();
317 wc
.lpfnWndProc
= wxNotebookWndProc
;
318 s_clsNotebook
.Register(wc
);
322 wxLogLastError(_T("GetClassInfoEx(SysTabCtl32)"));
326 // use our custom class if available but fall back to the standard
327 // notebook if we failed to register it
328 if ( s_clsNotebook
.IsRegistered() )
330 // it's ok to use c_str() here as the static s_clsNotebook object
331 // has sufficiently long lifetime
332 className
= s_clsNotebook
.GetName().c_str();
335 #endif // USE_NOTEBOOK_ANTIFLICKER
337 if ( !CreateControl(parent
, id
, pos
, size
, style
| wxTAB_TRAVERSAL
,
338 wxDefaultValidator
, name
) )
341 if ( !MSWCreateControl(className
, wxEmptyString
, pos
, size
) )
345 if ( HasFlag(wxNB_NOPAGETHEME
) ||
346 wxSystemOptions::IsFalse(wxT("msw.notebook.themed-background")) )
348 SetBackgroundColour(GetThemeBackgroundColour());
350 else // use themed background by default
352 // create backing store
356 // comctl32.dll 6.0 doesn't support non-top tabs with visual styles (the
357 // control is simply not rendered correctly), so we disable themes
358 // if possible, otherwise we simply clear the styles.
359 // It's probably not possible to have UXTHEME without ComCtl32 6 or better, but lets
361 const int verComCtl32
= wxApp::GetComCtl32Version();
362 if ( verComCtl32
== 600 )
364 // check if we use themes at all -- if we don't, we're still okay
365 if ( wxUxThemeEngine::GetIfActive() && (style
& (wxBK_BOTTOM
|wxBK_LEFT
|wxBK_RIGHT
)))
367 wxUxThemeEngine::GetIfActive()->SetWindowTheme((HWND
)this->GetHandle(), L
"", L
"");
368 SetBackgroundColour(GetThemeBackgroundColour()); //correct the background color for the new non-themed control
371 #endif // wxUSE_UXTHEME
373 // Undocumented hack to get flat notebook style
374 // In fact, we should probably only do this in some
375 // curcumstances, i.e. if we know we will have a border
376 // at the bottom (the tab control doesn't draw it itself)
377 #if defined(__POCKETPC__) || defined(__SMARTPHONE__)
378 if (HasFlag(wxNB_FLAT
))
380 SendMessage(GetHwnd(), CCM_SETVERSION
, COMCTL32_VERSION
, 0);
382 SetBackgroundColour(*wxWHITE
);
388 WXDWORD
wxNotebook::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
390 WXDWORD tabStyle
= wxControl::MSWGetStyle(style
, exstyle
);
392 tabStyle
|= WS_TABSTOP
| TCS_TABS
;
394 if ( style
& wxNB_MULTILINE
)
395 tabStyle
|= TCS_MULTILINE
;
396 if ( style
& wxNB_FIXEDWIDTH
)
397 tabStyle
|= TCS_FIXEDWIDTH
;
399 if ( style
& wxBK_BOTTOM
)
400 tabStyle
|= TCS_RIGHT
;
401 else if ( style
& wxBK_LEFT
)
402 tabStyle
|= TCS_VERTICAL
;
403 else if ( style
& wxBK_RIGHT
)
404 tabStyle
|= TCS_VERTICAL
| TCS_RIGHT
;
409 // note that we never want to have the default WS_EX_CLIENTEDGE style
410 // as it looks too ugly for the notebooks
417 wxNotebook::~wxNotebook()
420 if ( m_hbrBackground
)
421 ::DeleteObject((HBRUSH
)m_hbrBackground
);
422 #endif // wxUSE_UXTHEME
425 // ----------------------------------------------------------------------------
426 // wxNotebook accessors
427 // ----------------------------------------------------------------------------
429 size_t wxNotebook::GetPageCount() const
432 wxASSERT( (int)m_pages
.Count() == TabCtrl_GetItemCount(GetHwnd()) );
434 return m_pages
.Count();
437 int wxNotebook::GetRowCount() const
439 return TabCtrl_GetRowCount(GetHwnd());
442 int wxNotebook::SetSelection(size_t nPage
)
444 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
446 if ( m_nSelection
== wxNOT_FOUND
|| nPage
!= (size_t)m_nSelection
)
448 if ( SendPageChangingEvent(nPage
) )
450 // program allows the page change
451 SendPageChangedEvent(m_nSelection
, nPage
);
453 TabCtrl_SetCurSel(GetHwnd(), nPage
);
460 void wxNotebook::UpdateSelection(size_t newsel
)
462 if ( m_nSelection
!= -1 )
463 m_pages
[m_nSelection
]->Show(false);
467 wxNotebookPage
*pPage
= m_pages
[newsel
];
471 // Changing the page should give the focus to it but, as per bug report
472 // http://sf.net/tracker/index.php?func=detail&aid=1150659&group_id=9863&atid=109863,
473 // we should not set the focus to it directly since it erroneously
474 // selects radio buttons and breaks keyboard handling for a notebook's
475 // scroll buttons. So give focus to the notebook and not the page.
477 // but don't do this is the notebook is hidden
478 if ( ::IsWindowVisible(GetHwnd()) )
481 m_nSelection
= newsel
;
484 int wxNotebook::ChangeSelection(size_t nPage
)
486 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
488 if ( int(nPage
) != m_nSelection
)
490 TabCtrl_SetCurSel(GetHwnd(), nPage
);
492 UpdateSelection(nPage
);
498 bool wxNotebook::SetPageText(size_t nPage
, const wxString
& strText
)
500 wxCHECK_MSG( IS_VALID_PAGE(nPage
), false, wxT("notebook page out of range") );
503 tcItem
.mask
= TCIF_TEXT
;
504 tcItem
.pszText
= (wxChar
*)strText
.c_str();
506 if ( !HasFlag(wxNB_MULTILINE
) )
507 return TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
509 // multiline - we need to set new page size if a line is added or removed
510 int rows
= GetRowCount();
511 bool ret
= TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
513 if ( ret
&& rows
!= GetRowCount() )
515 const wxRect r
= GetPageSize();
516 const size_t count
= m_pages
.Count();
517 for ( size_t page
= 0; page
< count
; page
++ )
518 m_pages
[page
]->SetSize(r
);
524 wxString
wxNotebook::GetPageText(size_t nPage
) const
526 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxEmptyString
, wxT("notebook page out of range") );
530 tcItem
.mask
= TCIF_TEXT
;
531 tcItem
.pszText
= buf
;
532 tcItem
.cchTextMax
= WXSIZEOF(buf
);
535 if ( TabCtrl_GetItem(GetHwnd(), nPage
, &tcItem
) )
536 str
= tcItem
.pszText
;
541 int wxNotebook::GetPageImage(size_t nPage
) const
543 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
546 tcItem
.mask
= TCIF_IMAGE
;
548 return TabCtrl_GetItem(GetHwnd(), nPage
, &tcItem
) ? tcItem
.iImage
: wxNOT_FOUND
;
551 bool wxNotebook::SetPageImage(size_t nPage
, int nImage
)
553 wxCHECK_MSG( IS_VALID_PAGE(nPage
), false, wxT("notebook page out of range") );
556 tcItem
.mask
= TCIF_IMAGE
;
557 tcItem
.iImage
= nImage
;
559 return TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
562 void wxNotebook::SetImageList(wxImageList
* imageList
)
564 wxNotebookBase::SetImageList(imageList
);
568 (void) TabCtrl_SetImageList(GetHwnd(), (HIMAGELIST
)imageList
->GetHIMAGELIST());
572 // ----------------------------------------------------------------------------
573 // wxNotebook size settings
574 // ----------------------------------------------------------------------------
576 wxRect
wxNotebook::GetPageSize() const
581 ::GetClientRect(GetHwnd(), &rc
);
583 // This check is to work around a bug in TabCtrl_AdjustRect which will
584 // cause a crash on win2k or on XP with themes disabled if either
585 // wxNB_MULTILINE is used or tabs are placed on a side, if the rectangle
588 // The value of 20 is chosen arbitrarily but seems to work
589 if ( rc
.right
> 20 && rc
.bottom
> 20 )
591 TabCtrl_AdjustRect(GetHwnd(), false, &rc
);
593 wxCopyRECTToRect(rc
, r
);
599 void wxNotebook::SetPageSize(const wxSize
& size
)
601 // transform the page size into the notebook size
608 TabCtrl_AdjustRect(GetHwnd(), true, &rc
);
611 SetSize(rc
.right
- rc
.left
, rc
.bottom
- rc
.top
);
614 void wxNotebook::SetPadding(const wxSize
& padding
)
616 TabCtrl_SetPadding(GetHwnd(), padding
.x
, padding
.y
);
619 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
621 void wxNotebook::SetTabSize(const wxSize
& sz
)
623 ::SendMessage(GetHwnd(), TCM_SETITEMSIZE
, 0, MAKELPARAM(sz
.x
, sz
.y
));
626 wxSize
wxNotebook::CalcSizeFromPage(const wxSize
& sizePage
) const
628 // we can't use TabCtrl_AdjustRect here because it only works for wxNB_TOP
629 wxSize sizeTotal
= sizePage
;
632 if ( GetPageCount() > 0 )
635 TabCtrl_GetItemRect(GetHwnd(), 0, &rect
);
636 tabSize
.x
= rect
.right
- rect
.left
;
637 tabSize
.y
= rect
.bottom
- rect
.top
;
640 // add an extra margin in both directions
641 const int MARGIN
= 8;
644 sizeTotal
.x
+= MARGIN
;
645 sizeTotal
.y
+= tabSize
.y
+ MARGIN
;
647 else // horizontal layout
649 sizeTotal
.x
+= tabSize
.x
+ MARGIN
;
650 sizeTotal
.y
+= MARGIN
;
656 void wxNotebook::AdjustPageSize(wxNotebookPage
*page
)
658 wxCHECK_RET( page
, _T("NULL page in wxNotebook::AdjustPageSize") );
660 const wxRect r
= GetPageSize();
667 // ----------------------------------------------------------------------------
668 // wxNotebook operations
669 // ----------------------------------------------------------------------------
671 // remove one page from the notebook, without deleting
672 wxNotebookPage
*wxNotebook::DoRemovePage(size_t nPage
)
674 wxNotebookPage
*pageRemoved
= wxNotebookBase::DoRemovePage(nPage
);
678 TabCtrl_DeleteItem(GetHwnd(), nPage
);
680 if ( m_pages
.IsEmpty() )
682 // no selection any more, the notebook becamse empty
685 else // notebook still not empty
687 int selNew
= TabCtrl_GetCurSel(GetHwnd());
690 // No selection change, just refresh the current selection.
691 // Because it could be that the slection index changed
692 // we need to update it.
693 // Note: this does not mean the selection it self changed.
694 m_nSelection
= selNew
;
695 m_pages
[m_nSelection
]->Refresh();
697 else if (int(nPage
) == m_nSelection
)
699 // The selection was deleted.
701 // Determine new selection.
702 if (m_nSelection
== int(GetPageCount()))
703 selNew
= m_nSelection
- 1;
705 selNew
= m_nSelection
;
707 // m_nSelection must be always valid so reset it before calling
710 SetSelection(selNew
);
714 wxFAIL
; // Windows did not behave ok.
722 bool wxNotebook::DeleteAllPages()
724 size_t nPageCount
= GetPageCount();
726 for ( nPage
= 0; nPage
< nPageCount
; nPage
++ )
727 delete m_pages
[nPage
];
731 TabCtrl_DeleteAllItems(GetHwnd());
735 InvalidateBestSize();
739 // same as AddPage() but does it at given position
740 bool wxNotebook::InsertPage(size_t nPage
,
741 wxNotebookPage
*pPage
,
742 const wxString
& strText
,
746 wxCHECK_MSG( pPage
!= NULL
, false, _T("NULL page in wxNotebook::InsertPage") );
747 wxCHECK_MSG( IS_VALID_PAGE(nPage
) || nPage
== GetPageCount(), false,
748 _T("invalid index in wxNotebook::InsertPage") );
750 wxASSERT_MSG( pPage
->GetParent() == this,
751 _T("notebook pages must have notebook as parent") );
753 // add a new tab to the control
754 // ----------------------------
756 // init all fields to 0
758 wxZeroMemory(tcItem
);
760 // set the image, if any
763 tcItem
.mask
|= TCIF_IMAGE
;
764 tcItem
.iImage
= imageId
;
768 if ( !strText
.empty() )
770 tcItem
.mask
|= TCIF_TEXT
;
771 tcItem
.pszText
= (wxChar
*)strText
.c_str(); // const_cast
774 // hide the page: unless it is selected, it shouldn't be shown (and if it
775 // is selected it will be shown later)
776 HWND hwnd
= GetWinHwnd(pPage
);
777 SetWindowLong(hwnd
, GWL_STYLE
, GetWindowLong(hwnd
, GWL_STYLE
) & ~WS_VISIBLE
);
779 // this updates internal flag too -- otherwise it would get out of sync
780 // with the real state
784 // fit the notebook page to the tab control's display area: this should be
785 // done before adding it to the notebook or TabCtrl_InsertItem() will
786 // change the notebooks size itself!
787 AdjustPageSize(pPage
);
789 // finally do insert it
790 if ( TabCtrl_InsertItem(GetHwnd(), nPage
, &tcItem
) == -1 )
792 wxLogError(wxT("Can't create the notebook page '%s'."), strText
.c_str());
797 // need to update the bg brush when the first page is added
798 // so the first panel gets the correct themed background
799 if ( m_pages
.empty() )
804 // succeeded: save the pointer to the page
805 m_pages
.Insert(pPage
, nPage
);
807 // we may need to adjust the size again if the notebook size changed:
808 // normally this only happens for the first page we add (the tabs which
809 // hadn't been there before are now shown) but for a multiline notebook it
810 // can happen for any page at all as a new row could have been started
811 if ( m_pages
.GetCount() == 1 || HasFlag(wxNB_MULTILINE
) )
813 AdjustPageSize(pPage
);
816 // now deal with the selection
817 // ---------------------------
819 // if the inserted page is before the selected one, we must update the
820 // index of the selected page
821 if ( int(nPage
) <= m_nSelection
)
823 // one extra page added
827 // some page should be selected: either this one or the first one if there
828 // is still no selection
832 else if ( m_nSelection
== -1 )
836 SetSelection(selNew
);
838 InvalidateBestSize();
843 int wxNotebook::HitTest(const wxPoint
& pt
, long *flags
) const
845 TC_HITTESTINFO hitTestInfo
;
846 hitTestInfo
.pt
.x
= pt
.x
;
847 hitTestInfo
.pt
.y
= pt
.y
;
848 int item
= TabCtrl_HitTest(GetHwnd(), &hitTestInfo
);
854 if ((hitTestInfo
.flags
& TCHT_NOWHERE
) == TCHT_NOWHERE
)
855 *flags
|= wxBK_HITTEST_NOWHERE
;
856 if ((hitTestInfo
.flags
& TCHT_ONITEM
) == TCHT_ONITEM
)
857 *flags
|= wxBK_HITTEST_ONITEM
;
858 if ((hitTestInfo
.flags
& TCHT_ONITEMICON
) == TCHT_ONITEMICON
)
859 *flags
|= wxBK_HITTEST_ONICON
;
860 if ((hitTestInfo
.flags
& TCHT_ONITEMLABEL
) == TCHT_ONITEMLABEL
)
861 *flags
|= wxBK_HITTEST_ONLABEL
;
862 if ( item
== wxNOT_FOUND
&& GetPageSize().Contains(pt
) )
863 *flags
|= wxBK_HITTEST_ONPAGE
;
869 // ----------------------------------------------------------------------------
870 // flicker-less notebook redraw
871 // ----------------------------------------------------------------------------
873 #if USE_NOTEBOOK_ANTIFLICKER
875 // wnd proc for the spin button
876 LRESULT APIENTRY _EXPORT
wxNotebookSpinBtnWndProc(HWND hwnd
,
881 if ( message
== WM_ERASEBKGND
)
884 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebookSpinBtn
,
885 hwnd
, message
, wParam
, lParam
);
888 LRESULT APIENTRY _EXPORT
wxNotebookWndProc(HWND hwnd
,
893 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebook
,
894 hwnd
, message
, wParam
, lParam
);
897 void wxNotebook::OnEraseBackground(wxEraseEvent
& WXUNUSED(event
))
902 void wxNotebook::OnPaint(wxPaintEvent
& WXUNUSED(event
))
907 ::GetClientRect(GetHwnd(), &rc
);
908 wxBitmap
bmp(rc
.right
, rc
.bottom
);
909 memdc
.SelectObject(bmp
);
911 // if there is no special brush just use the solid background colour
913 HBRUSH hbr
= (HBRUSH
)m_hbrBackground
;
920 brush
= wxBrush(GetBackgroundColour());
921 hbr
= GetHbrushOf(brush
);
924 ::FillRect(GetHdcOf(memdc
), &rc
, hbr
);
926 MSWDefWindowProc(WM_PAINT
, (WPARAM
)memdc
.GetHDC(), 0);
928 dc
.Blit(0, 0, rc
.right
, rc
.bottom
, &memdc
, 0, 0);
931 #endif // USE_NOTEBOOK_ANTIFLICKER
933 // ----------------------------------------------------------------------------
934 // wxNotebook callbacks
935 // ----------------------------------------------------------------------------
937 void wxNotebook::OnSize(wxSizeEvent
& event
)
939 if ( GetPageCount() == 0 )
941 // Prevents droppings on resize, but does cause some flicker
942 // when there are no pages.
950 // Without this, we can sometimes get droppings at the edges
951 // of a notebook, for example a notebook in a splitter window.
952 // This needs to be reconciled with the RefreshRect calls
953 // at the end of this function, which weren't enough to prevent
956 wxSize sz
= GetClientSize();
958 // Refresh right side
959 wxRect
rect(sz
.x
-4, 0, 4, sz
.y
);
962 // Refresh bottom side
963 rect
= wxRect(0, sz
.y
-4, sz
.x
, 4);
967 rect
= wxRect(0, 0, 4, sz
.y
);
970 #endif // !__WXWINCE__
972 // fit all the notebook pages to the tab control's display area
975 rc
.left
= rc
.top
= 0;
976 GetSize((int *)&rc
.right
, (int *)&rc
.bottom
);
978 // save the total size, we'll use it below
979 int widthNbook
= rc
.right
- rc
.left
,
980 heightNbook
= rc
.bottom
- rc
.top
;
982 // there seems to be a bug in the implementation of TabCtrl_AdjustRect(): it
983 // returns completely false values for multiline tab controls after the tabs
984 // are added but before getting the first WM_SIZE (off by ~50 pixels, see
986 // http://sf.net/tracker/index.php?func=detail&aid=645323&group_id=9863&atid=109863
988 // and the only work around I could find was this ugly hack... without it
989 // simply toggling the "multiline" checkbox in the notebook sample resulted
990 // in a noticeable page displacement
991 if ( HasFlag(wxNB_MULTILINE
) )
993 // avoid an infinite recursion: we get another notification too!
994 static bool s_isInOnSize
= false;
999 SendMessage(GetHwnd(), WM_SIZE
, SIZE_RESTORED
,
1000 MAKELPARAM(rc
.right
, rc
.bottom
));
1001 s_isInOnSize
= false;
1006 // background bitmap size has changed, update the brush using it too
1008 #endif // wxUSE_UXTHEME
1010 TabCtrl_AdjustRect(GetHwnd(), false, &rc
);
1012 int width
= rc
.right
- rc
.left
,
1013 height
= rc
.bottom
- rc
.top
;
1014 size_t nCount
= m_pages
.Count();
1015 for ( size_t nPage
= 0; nPage
< nCount
; nPage
++ ) {
1016 wxNotebookPage
*pPage
= m_pages
[nPage
];
1017 pPage
->SetSize(rc
.left
, rc
.top
, width
, height
);
1021 // unless we had already repainted everything, we now need to refresh
1022 if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE
) )
1024 // invalidate areas not covered by pages
1025 RefreshRect(wxRect(0, 0, widthNbook
, rc
.top
), false);
1026 RefreshRect(wxRect(0, rc
.top
, rc
.left
, height
), false);
1027 RefreshRect(wxRect(0, rc
.bottom
, widthNbook
, heightNbook
- rc
.bottom
),
1029 RefreshRect(wxRect(rc
.right
, rc
.top
, widthNbook
- rc
.right
, height
),
1033 #if USE_NOTEBOOK_ANTIFLICKER
1034 // subclass the spin control used by the notebook to scroll pages to
1035 // prevent it from flickering on resize
1036 if ( !m_hasSubclassedUpdown
)
1038 // iterate over all child windows to find spin button
1039 for ( HWND child
= ::GetWindow(GetHwnd(), GW_CHILD
);
1041 child
= ::GetWindow(child
, GW_HWNDNEXT
) )
1043 wxWindow
*childWindow
= wxFindWinFromHandle((WXHWND
)child
);
1045 // see if it exists, if no wxWindow found then assume it's the spin
1049 // subclass the spin button to override WM_ERASEBKGND
1050 if ( !gs_wndprocNotebookSpinBtn
)
1051 gs_wndprocNotebookSpinBtn
= (WXFARPROC
)wxGetWindowProc(child
);
1053 wxSetWindowProc(child
, wxNotebookSpinBtnWndProc
);
1054 m_hasSubclassedUpdown
= true;
1059 #endif // USE_NOTEBOOK_ANTIFLICKER
1064 void wxNotebook::OnSelChange(wxNotebookEvent
& event
)
1066 // is it our tab control?
1067 if ( event
.GetEventObject() == this )
1069 UpdateSelection(event
.GetSelection());
1072 // we want to give others a chance to process this message as well
1076 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
1078 if ( event
.IsWindowChange() ) {
1080 AdvanceSelection(event
.GetDirection());
1083 // we get this event in 3 cases
1085 // a) one of our pages might have generated it because the user TABbed
1086 // out from it in which case we should propagate the event upwards and
1087 // our parent will take care of setting the focus to prev/next sibling
1091 // b) the parent panel wants to give the focus to us so that we
1092 // forward it to our selected page. We can't deal with this in
1093 // OnSetFocus() because we don't know which direction the focus came
1094 // from in this case and so can't choose between setting the focus to
1095 // first or last panel child
1099 // c) we ourselves (see MSWTranslateMessage) generated the event
1101 wxWindow
* const parent
= GetParent();
1103 // the wxObject* casts are required to avoid MinGW GCC 2.95.3 ICE
1104 const bool isFromParent
= event
.GetEventObject() == (wxObject
*) parent
;
1105 const bool isFromSelf
= event
.GetEventObject() == (wxObject
*) this;
1107 if ( isFromParent
|| isFromSelf
)
1109 // no, it doesn't come from child, case (b) or (c): forward to a
1110 // page but only if direction is backwards (TAB) or from ourselves,
1111 if ( m_nSelection
!= -1 &&
1112 (!event
.GetDirection() || isFromSelf
) )
1114 // so that the page knows that the event comes from it's parent
1115 // and is being propagated downwards
1116 event
.SetEventObject(this);
1118 wxWindow
*page
= m_pages
[m_nSelection
];
1119 if ( !page
->GetEventHandler()->ProcessEvent(event
) )
1123 //else: page manages focus inside it itself
1125 else // otherwise set the focus to the notebook itself
1132 // it comes from our child, case (a), pass to the parent, but only
1133 // if the direction is forwards. Otherwise set the focus to the
1134 // notebook itself. The notebook is always the 'first' control of a
1136 if ( !event
.GetDirection() )
1142 event
.SetCurrentFocus(this);
1143 parent
->GetEventHandler()->ProcessEvent(event
);
1151 bool wxNotebook::DoDrawBackground(WXHDC hDC
, wxWindow
*child
)
1153 wxUxThemeHandle
theme(child
? child
: this, L
"TAB");
1157 // get the notebook client rect (we're not interested in drawing tabs
1159 wxRect r
= GetPageSize();
1164 wxCopyRectToRECT(r
, rc
);
1166 // map rect to the coords of the window we're drawing in
1168 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1170 // we have the content area (page size), but we need to draw all of the
1171 // background for it to be aligned correctly
1172 wxUxThemeEngine::Get()->GetThemeBackgroundExtent
1181 wxUxThemeEngine::Get()->DrawThemeBackground
1194 WXHBRUSH
wxNotebook::QueryBgBitmap()
1196 wxRect r
= GetPageSize();
1200 WindowHDC
hDC(GetHwnd());
1201 MemoryHDC
hDCMem(hDC
);
1202 CompatibleBitmap
hBmp(hDC
, r
.x
+ r
.width
, r
.y
+ r
.height
);
1204 SelectInHDC
selectBmp(hDCMem
, hBmp
);
1206 if ( !DoDrawBackground((WXHDC
)(HDC
)hDCMem
) )
1209 return (WXHBRUSH
)::CreatePatternBrush(hBmp
);
1212 void wxNotebook::UpdateBgBrush()
1214 if ( m_hbrBackground
)
1215 ::DeleteObject((HBRUSH
)m_hbrBackground
);
1217 if ( !m_hasBgCol
&& wxUxThemeEngine::GetIfActive() )
1219 m_hbrBackground
= QueryBgBitmap();
1221 else // no themes or we've got user-defined solid colour
1223 m_hbrBackground
= NULL
;
1227 WXHBRUSH
wxNotebook::MSWGetBgBrushForChild(WXHDC hDC
, WXHWND hWnd
)
1229 if ( m_hbrBackground
)
1231 // before drawing with the background brush, we need to position it
1234 ::GetWindowRect((HWND
)hWnd
, &rc
);
1236 ::MapWindowPoints(NULL
, GetHwnd(), (POINT
*)&rc
, 1);
1238 if ( !::SetBrushOrgEx((HDC
)hDC
, -rc
.left
, -rc
.top
, NULL
) )
1240 wxLogLastError(_T("SetBrushOrgEx(notebook bg brush)"));
1243 return m_hbrBackground
;
1246 return wxNotebookBase::MSWGetBgBrushForChild(hDC
, hWnd
);
1249 bool wxNotebook::MSWPrintChild(WXHDC hDC
, wxWindow
*child
)
1251 // solid background colour overrides themed background drawing
1252 if ( !UseBgCol() && DoDrawBackground(hDC
, child
) )
1255 // If we're using a solid colour (for example if we've switched off
1256 // theming for this notebook), paint it
1259 wxRect r
= GetPageSize();
1264 wxCopyRectToRECT(r
, rc
);
1266 // map rect to the coords of the window we're drawing in
1268 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1270 wxBrush
brush(GetBackgroundColour());
1271 HBRUSH hbr
= GetHbrushOf(brush
);
1273 ::FillRect((HDC
) hDC
, &rc
, hbr
);
1278 return wxNotebookBase::MSWPrintChild(hDC
, child
);
1281 #endif // wxUSE_UXTHEME
1283 // Windows only: attempts to get colour for UX theme page background
1284 wxColour
wxNotebook::GetThemeBackgroundColour() const
1287 if (wxUxThemeEngine::Get())
1289 wxUxThemeHandle
hTheme((wxNotebook
*) this, L
"TAB");
1292 // This is total guesswork.
1293 // See PlatformSDK\Include\Tmschema.h for values
1294 COLORREF themeColor
;
1295 wxUxThemeEngine::Get()->GetThemeColor(
1299 3821 /* FILLCOLORHINT */,
1303 [DS] Workaround for WindowBlinds:
1304 Some themes return a near black theme color using FILLCOLORHINT,
1305 this makes notebook pages have an ugly black background and makes
1306 text (usually black) unreadable. Retry again with FILLCOLOR.
1308 This workaround potentially breaks appearance of some themes,
1309 but in practice it already fixes some themes.
1311 if (themeColor
== 1)
1313 wxUxThemeEngine::Get()->GetThemeColor(
1317 3802 /* FILLCOLOR */,
1321 return wxRGBToColour(themeColor
);
1324 #endif // wxUSE_UXTHEME
1326 return GetBackgroundColour();
1329 // ----------------------------------------------------------------------------
1330 // wxNotebook base class virtuals
1331 // ----------------------------------------------------------------------------
1333 #if wxUSE_CONSTRAINTS
1335 // override these 2 functions to do nothing: everything is done in OnSize
1337 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse
))
1339 // don't set the sizes of the pages - their correct size is not yet known
1340 wxControl::SetConstraintSizes(false);
1343 bool wxNotebook::DoPhase(int WXUNUSED(nPhase
))
1348 #endif // wxUSE_CONSTRAINTS
1350 // ----------------------------------------------------------------------------
1351 // wxNotebook Windows message handlers
1352 // ----------------------------------------------------------------------------
1354 bool wxNotebook::MSWOnScroll(int orientation
, WXWORD nSBCode
,
1355 WXWORD pos
, WXHWND control
)
1357 // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
1362 return wxNotebookBase::MSWOnScroll(orientation
, nSBCode
, pos
, control
);
1365 bool wxNotebook::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
* result
)
1367 wxNotebookEvent
event(wxEVT_NULL
, m_windowId
);
1369 NMHDR
* hdr
= (NMHDR
*)lParam
;
1370 switch ( hdr
->code
) {
1372 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
);
1375 case TCN_SELCHANGING
:
1376 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
);
1380 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1383 event
.SetSelection(TabCtrl_GetCurSel(GetHwnd()));
1384 event
.SetOldSelection(m_nSelection
);
1385 event
.SetEventObject(this);
1386 event
.SetInt(idCtrl
);
1388 bool processed
= GetEventHandler()->ProcessEvent(event
);
1389 *result
= !event
.IsAllowed();
1393 #endif // wxUSE_NOTEBOOK