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_NOTEBOOK_PAGE_CHANGED(wxID_ANY
, wxNotebook::OnSelChange
)
126 EVT_SIZE(wxNotebook::OnSize
)
127 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
129 #if USE_NOTEBOOK_ANTIFLICKER
130 EVT_ERASE_BACKGROUND(wxNotebook::OnEraseBackground
)
131 EVT_PAINT(wxNotebook::OnPaint
)
132 #endif // USE_NOTEBOOK_ANTIFLICKER
135 #if wxUSE_EXTENDED_RTTI
136 WX_DEFINE_FLAGS( wxNotebookStyle
)
138 wxBEGIN_FLAGS( wxNotebookStyle
)
139 // new style border flags, we put them first to
140 // use them for streaming out
141 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
142 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
143 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
144 wxFLAGS_MEMBER(wxBORDER_RAISED
)
145 wxFLAGS_MEMBER(wxBORDER_STATIC
)
146 wxFLAGS_MEMBER(wxBORDER_NONE
)
148 // old style border flags
149 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
150 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
151 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
152 wxFLAGS_MEMBER(wxRAISED_BORDER
)
153 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
154 wxFLAGS_MEMBER(wxBORDER
)
156 // standard window styles
157 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
158 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
159 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
160 wxFLAGS_MEMBER(wxWANTS_CHARS
)
161 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
162 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
163 wxFLAGS_MEMBER(wxVSCROLL
)
164 wxFLAGS_MEMBER(wxHSCROLL
)
166 wxFLAGS_MEMBER(wxNB_FIXEDWIDTH
)
167 wxFLAGS_MEMBER(wxBK_DEFAULT
)
168 wxFLAGS_MEMBER(wxBK_TOP
)
169 wxFLAGS_MEMBER(wxBK_LEFT
)
170 wxFLAGS_MEMBER(wxBK_RIGHT
)
171 wxFLAGS_MEMBER(wxBK_BOTTOM
)
172 wxFLAGS_MEMBER(wxNB_NOPAGETHEME
)
173 wxFLAGS_MEMBER(wxNB_FLAT
)
175 wxEND_FLAGS( wxNotebookStyle
)
177 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebook
, wxBookCtrlBase
,"wx/notebook.h")
178 IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebookPageInfo
, wxObject
, "wx/notebook.h" )
180 wxCOLLECTION_TYPE_INFO( wxNotebookPageInfo
* , wxNotebookPageInfoList
) ;
182 template<> void wxCollectionToVariantArray( wxNotebookPageInfoList
const &theList
, wxxVariantArray
&value
)
184 wxListCollectionToVariantArray
<wxNotebookPageInfoList::compatibility_iterator
>( theList
, value
) ;
187 wxBEGIN_PROPERTIES_TABLE(wxNotebook
)
188 wxEVENT_PROPERTY( PageChanging
, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
, wxBookCtrlEvent
)
189 wxEVENT_PROPERTY( PageChanged
, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
, wxBookCtrlEvent
)
191 wxPROPERTY_COLLECTION( PageInfos
, wxNotebookPageInfoList
, wxNotebookPageInfo
* , AddPageInfo
, GetPageInfos
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
192 wxPROPERTY_FLAGS( WindowStyle
, wxNotebookStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
193 wxEND_PROPERTIES_TABLE()
195 wxBEGIN_HANDLERS_TABLE(wxNotebook
)
196 wxEND_HANDLERS_TABLE()
198 wxCONSTRUCTOR_5( wxNotebook
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
201 wxBEGIN_PROPERTIES_TABLE(wxNotebookPageInfo
)
202 wxREADONLY_PROPERTY( Page
, wxNotebookPage
* , GetPage
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
203 wxREADONLY_PROPERTY( Text
, wxString
, GetText
, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
204 wxREADONLY_PROPERTY( Selected
, bool , GetSelected
, false, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
205 wxREADONLY_PROPERTY( ImageId
, int , GetImageId
, -1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
206 wxEND_PROPERTIES_TABLE()
208 wxBEGIN_HANDLERS_TABLE(wxNotebookPageInfo
)
209 wxEND_HANDLERS_TABLE()
211 wxCONSTRUCTOR_4( wxNotebookPageInfo
, wxNotebookPage
* , Page
, wxString
, Text
, bool , Selected
, int , ImageId
)
214 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
, wxBookCtrlBase
)
215 IMPLEMENT_DYNAMIC_CLASS(wxNotebookPageInfo
, wxObject
)
218 // ============================================================================
220 // ============================================================================
222 // ----------------------------------------------------------------------------
223 // wxNotebook construction
224 // ----------------------------------------------------------------------------
226 const wxNotebookPageInfoList
& wxNotebook::GetPageInfos() const
228 wxNotebookPageInfoList
* list
= const_cast< wxNotebookPageInfoList
* >( &m_pageInfos
) ;
229 WX_CLEAR_LIST( wxNotebookPageInfoList
, *list
) ;
230 for( size_t i
= 0 ; i
< GetPageCount() ; ++i
)
232 wxNotebookPageInfo
*info
= new wxNotebookPageInfo() ;
233 info
->Create( const_cast<wxNotebook
*>(this)->GetPage(i
) , GetPageText(i
) , GetSelection() == int(i
) , GetPageImage(i
) ) ;
234 list
->Append( info
) ;
239 // common part of all ctors
240 void wxNotebook::Init()
243 m_nSelection
= wxNOT_FOUND
;
246 m_hbrBackground
= NULL
;
247 #endif // wxUSE_UXTHEME
249 #if USE_NOTEBOOK_ANTIFLICKER
250 m_hasSubclassedUpdown
= false;
251 #endif // USE_NOTEBOOK_ANTIFLICKER
254 // default for dynamic class
255 wxNotebook::wxNotebook()
260 // the same arguments as for wxControl
261 wxNotebook::wxNotebook(wxWindow
*parent
,
266 const wxString
& name
)
270 Create(parent
, id
, pos
, size
, style
, name
);
274 bool wxNotebook::Create(wxWindow
*parent
,
279 const wxString
& name
)
281 if ( (style
& wxBK_ALIGN_MASK
) == wxBK_DEFAULT
)
283 #if defined(__POCKETPC__)
284 style
|= wxBK_BOTTOM
| wxNB_FLAT
;
291 // Not sure why, but without this style, there is no border
292 // around the notebook tabs.
293 if (style
& wxNB_FLAT
)
294 style
|= wxBORDER_SUNKEN
;
298 // ComCtl32 notebook tabs simply don't work unless they're on top if we
299 // have uxtheme, we can work around it later (after control creation), but
300 // if we have been compiled without uxtheme support, we have to clear those
302 if ( HasTroubleWithNonTopTabs() )
304 style
&= ~(wxBK_BOTTOM
| wxBK_LEFT
| wxBK_RIGHT
);
306 #endif //wxUSE_UXTHEME
308 #if defined(__WINE__) && wxUSE_UNICODE
309 LPCTSTR className
= L
"SysTabControl32";
311 LPCTSTR className
= WC_TABCONTROL
;
314 #if USE_NOTEBOOK_ANTIFLICKER
315 // SysTabCtl32 class has natively CS_HREDRAW and CS_VREDRAW enabled and it
316 // causes horrible flicker when resizing notebook, so get rid of it by
317 // using a class without these styles (but otherwise identical to it)
318 if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE
) )
320 static ClassRegistrar s_clsNotebook
;
321 if ( !s_clsNotebook
.IsInitialized() )
323 // get a copy of standard class and modify it
326 if ( ::GetClassInfo(NULL
, WC_TABCONTROL
, &wc
) )
329 reinterpret_cast<WXFARPROC
>(wc
.lpfnWndProc
);
330 wc
.lpszClassName
= wxT("_wx_SysTabCtl32");
331 wc
.style
&= ~(CS_HREDRAW
| CS_VREDRAW
);
332 wc
.hInstance
= wxGetInstance();
333 wc
.lpfnWndProc
= wxNotebookWndProc
;
334 s_clsNotebook
.Register(wc
);
338 wxLogLastError(wxT("GetClassInfoEx(SysTabCtl32)"));
342 // use our custom class if available but fall back to the standard
343 // notebook if we failed to register it
344 if ( s_clsNotebook
.IsRegistered() )
346 // it's ok to use c_str() here as the static s_clsNotebook object
347 // has sufficiently long lifetime
348 className
= s_clsNotebook
.GetName().c_str();
351 #endif // USE_NOTEBOOK_ANTIFLICKER
353 if ( !CreateControl(parent
, id
, pos
, size
, style
| wxTAB_TRAVERSAL
,
354 wxDefaultValidator
, name
) )
357 if ( !MSWCreateControl(className
, wxEmptyString
, pos
, size
) )
361 if ( HasFlag(wxNB_NOPAGETHEME
) ||
362 wxSystemOptions::IsFalse(wxT("msw.notebook.themed-background")) )
364 SetBackgroundColour(GetThemeBackgroundColour());
366 else // use themed background by default
368 // create backing store
372 // comctl32.dll 6.0 doesn't support non-top tabs with visual styles (the
373 // control is simply not rendered correctly), so we disable themes
374 // if possible, otherwise we simply clear the styles.
375 if ( HasTroubleWithNonTopTabs() &&
376 (style
& (wxBK_BOTTOM
| wxBK_LEFT
| wxBK_RIGHT
)) )
378 // check if we use themes at all -- if we don't, we're still okay
379 if ( wxUxThemeEngine::GetIfActive() )
381 wxUxThemeEngine::GetIfActive()->SetWindowTheme(GetHwnd(), L
"", L
"");
383 // correct the background color for the new non-themed control
384 SetBackgroundColour(GetThemeBackgroundColour());
387 #endif // wxUSE_UXTHEME
389 // Undocumented hack to get flat notebook style
390 // In fact, we should probably only do this in some
391 // curcumstances, i.e. if we know we will have a border
392 // at the bottom (the tab control doesn't draw it itself)
393 #if defined(__POCKETPC__) || defined(__SMARTPHONE__)
394 if (HasFlag(wxNB_FLAT
))
396 SendMessage(GetHwnd(), CCM_SETVERSION
, COMCTL32_VERSION
, 0);
398 SetBackgroundColour(*wxWHITE
);
404 WXDWORD
wxNotebook::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
406 WXDWORD tabStyle
= wxControl::MSWGetStyle(style
, exstyle
);
408 tabStyle
|= WS_TABSTOP
| TCS_TABS
;
410 if ( style
& wxNB_MULTILINE
)
411 tabStyle
|= TCS_MULTILINE
;
412 if ( style
& wxNB_FIXEDWIDTH
)
413 tabStyle
|= TCS_FIXEDWIDTH
;
415 if ( style
& wxBK_BOTTOM
)
416 tabStyle
|= TCS_RIGHT
;
417 else if ( style
& wxBK_LEFT
)
418 tabStyle
|= TCS_VERTICAL
;
419 else if ( style
& wxBK_RIGHT
)
420 tabStyle
|= TCS_VERTICAL
| TCS_RIGHT
;
425 wxNotebook::~wxNotebook()
428 if ( m_hbrBackground
)
429 ::DeleteObject((HBRUSH
)m_hbrBackground
);
430 #endif // wxUSE_UXTHEME
433 // ----------------------------------------------------------------------------
434 // wxNotebook accessors
435 // ----------------------------------------------------------------------------
437 size_t wxNotebook::GetPageCount() const
440 wxASSERT( (int)m_pages
.Count() == TabCtrl_GetItemCount(GetHwnd()) );
442 return m_pages
.Count();
445 int wxNotebook::GetRowCount() const
447 return TabCtrl_GetRowCount(GetHwnd());
450 int wxNotebook::SetSelection(size_t nPage
)
452 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
454 if ( m_nSelection
== wxNOT_FOUND
|| nPage
!= (size_t)m_nSelection
)
456 if ( SendPageChangingEvent(nPage
) )
458 // program allows the page change
459 SendPageChangedEvent(m_nSelection
, nPage
);
461 TabCtrl_SetCurSel(GetHwnd(), nPage
);
468 void wxNotebook::UpdateSelection(int selNew
)
470 if ( m_nSelection
!= wxNOT_FOUND
)
471 m_pages
[m_nSelection
]->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_nSelection
= 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_nSelection
;
498 if ( m_nSelection
== wxNOT_FOUND
|| nPage
!= (size_t)m_nSelection
)
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 TabCtrl_DeleteItem(GetHwnd(), nPage
);
693 if ( m_pages
.IsEmpty() )
695 // no selection any more, the notebook becamse empty
696 m_nSelection
= wxNOT_FOUND
;
698 else // notebook still not empty
700 int selNew
= TabCtrl_GetCurSel(GetHwnd());
701 if ( selNew
!= wxNOT_FOUND
)
703 // No selection change, just refresh the current selection.
704 // Because it could be that the slection index changed
705 // we need to update it.
706 // Note: this does not mean the selection it self changed.
707 m_nSelection
= selNew
;
708 m_pages
[m_nSelection
]->Refresh();
710 else if (int(nPage
) == m_nSelection
)
712 // The selection was deleted.
714 // Determine new selection.
715 if (m_nSelection
== int(GetPageCount()))
716 selNew
= m_nSelection
- 1;
718 selNew
= m_nSelection
;
720 // m_nSelection must be always valid so reset it before calling
722 m_nSelection
= wxNOT_FOUND
;
723 SetSelection(selNew
);
727 wxFAIL
; // Windows did not behave ok.
735 bool wxNotebook::DeleteAllPages()
737 size_t nPageCount
= GetPageCount();
739 for ( nPage
= 0; nPage
< nPageCount
; nPage
++ )
740 delete m_pages
[nPage
];
744 TabCtrl_DeleteAllItems(GetHwnd());
746 m_nSelection
= wxNOT_FOUND
;
748 InvalidateBestSize();
752 // same as AddPage() but does it at given position
753 bool wxNotebook::InsertPage(size_t nPage
,
754 wxNotebookPage
*pPage
,
755 const wxString
& strText
,
759 wxCHECK_MSG( pPage
!= NULL
, false, wxT("NULL page in wxNotebook::InsertPage") );
760 wxCHECK_MSG( IS_VALID_PAGE(nPage
) || nPage
== GetPageCount(), false,
761 wxT("invalid index in wxNotebook::InsertPage") );
763 wxASSERT_MSG( pPage
->GetParent() == this,
764 wxT("notebook pages must have notebook as parent") );
766 // add a new tab to the control
767 // ----------------------------
769 // init all fields to 0
771 wxZeroMemory(tcItem
);
773 // set the image, if any
776 tcItem
.mask
|= TCIF_IMAGE
;
777 tcItem
.iImage
= imageId
;
781 if ( !strText
.empty() )
783 tcItem
.mask
|= TCIF_TEXT
;
784 tcItem
.pszText
= (wxChar
*)strText
.wx_str(); // const_cast
787 // hide the page: unless it is selected, it shouldn't be shown (and if it
788 // is selected it will be shown later)
789 HWND hwnd
= GetWinHwnd(pPage
);
790 SetWindowLong(hwnd
, GWL_STYLE
, GetWindowLong(hwnd
, GWL_STYLE
) & ~WS_VISIBLE
);
792 // this updates internal flag too -- otherwise it would get out of sync
793 // with the real state
797 // fit the notebook page to the tab control's display area: this should be
798 // done before adding it to the notebook or TabCtrl_InsertItem() will
799 // change the notebooks size itself!
800 AdjustPageSize(pPage
);
802 // finally do insert it
803 if ( TabCtrl_InsertItem(GetHwnd(), nPage
, &tcItem
) == -1 )
805 wxLogError(wxT("Can't create the notebook page '%s'."), strText
.c_str());
810 // need to update the bg brush when the first page is added
811 // so the first panel gets the correct themed background
812 if ( m_pages
.empty() )
816 #endif // wxUSE_UXTHEME
819 // succeeded: save the pointer to the page
820 m_pages
.Insert(pPage
, nPage
);
822 // also ensure that the notebook background is used for its pages by making
823 // them transparent: this ensures that MSWGetBgBrush() queries the notebook
824 // for the background brush to be used for erasing them
825 if ( wxPanel
*panel
= wxDynamicCast(pPage
, wxPanel
) )
827 panel
->MSWSetTransparentBackground();
830 // we may need to adjust the size again if the notebook size changed:
831 // normally this only happens for the first page we add (the tabs which
832 // hadn't been there before are now shown) but for a multiline notebook it
833 // can happen for any page at all as a new row could have been started
834 if ( m_pages
.GetCount() == 1 || HasFlag(wxNB_MULTILINE
) )
836 AdjustPageSize(pPage
);
839 // now deal with the selection
840 // ---------------------------
842 // if the inserted page is before the selected one, we must update the
843 // index of the selected page
844 if ( int(nPage
) <= m_nSelection
)
846 // one extra page added
850 // some page should be selected: either this one or the first one if there
851 // is still no selection
852 int selNew
= wxNOT_FOUND
;
855 else if ( m_nSelection
== wxNOT_FOUND
)
858 if ( selNew
!= wxNOT_FOUND
)
859 SetSelection(selNew
);
861 InvalidateBestSize();
866 int wxNotebook::HitTest(const wxPoint
& pt
, long *flags
) const
868 TC_HITTESTINFO hitTestInfo
;
869 hitTestInfo
.pt
.x
= pt
.x
;
870 hitTestInfo
.pt
.y
= pt
.y
;
871 int item
= TabCtrl_HitTest(GetHwnd(), &hitTestInfo
);
877 if ((hitTestInfo
.flags
& TCHT_NOWHERE
) == TCHT_NOWHERE
)
878 *flags
|= wxBK_HITTEST_NOWHERE
;
879 if ((hitTestInfo
.flags
& TCHT_ONITEM
) == TCHT_ONITEM
)
880 *flags
|= wxBK_HITTEST_ONITEM
;
881 if ((hitTestInfo
.flags
& TCHT_ONITEMICON
) == TCHT_ONITEMICON
)
882 *flags
|= wxBK_HITTEST_ONICON
;
883 if ((hitTestInfo
.flags
& TCHT_ONITEMLABEL
) == TCHT_ONITEMLABEL
)
884 *flags
|= wxBK_HITTEST_ONLABEL
;
885 if ( item
== wxNOT_FOUND
&& GetPageSize().Contains(pt
) )
886 *flags
|= wxBK_HITTEST_ONPAGE
;
892 // ----------------------------------------------------------------------------
893 // flicker-less notebook redraw
894 // ----------------------------------------------------------------------------
896 #if USE_NOTEBOOK_ANTIFLICKER
898 // wnd proc for the spin button
899 LRESULT APIENTRY _EXPORT
wxNotebookSpinBtnWndProc(HWND hwnd
,
904 if ( message
== WM_ERASEBKGND
)
907 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebookSpinBtn
,
908 hwnd
, message
, wParam
, lParam
);
911 LRESULT APIENTRY _EXPORT
wxNotebookWndProc(HWND hwnd
,
916 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebook
,
917 hwnd
, message
, wParam
, lParam
);
920 void wxNotebook::OnEraseBackground(wxEraseEvent
& WXUNUSED(event
))
925 void wxNotebook::OnPaint(wxPaintEvent
& WXUNUSED(event
))
930 ::GetClientRect(GetHwnd(), &rc
);
931 wxBitmap
bmp(rc
.right
, rc
.bottom
);
932 memdc
.SelectObject(bmp
);
934 const wxLayoutDirection dir
= dc
.GetLayoutDirection();
935 memdc
.SetLayoutDirection(dir
);
937 // if there is no special brush just use the solid background colour
939 HBRUSH hbr
= (HBRUSH
)m_hbrBackground
;
946 brush
= wxBrush(GetBackgroundColour());
947 hbr
= GetHbrushOf(brush
);
950 wxMSWDCImpl
*impl
= (wxMSWDCImpl
*) memdc
.GetImpl();
952 ::FillRect(GetHdcOf(*impl
), &rc
, hbr
);
954 MSWDefWindowProc(WM_PAINT
, (WPARAM
)(impl
->GetHDC()), 0);
956 // For some reason in RTL mode, source offset has to be -1, otherwise the
957 // right border (physical) remains unpainted.
958 const wxCoord ofs
= dir
== wxLayout_RightToLeft
? -1 : 0;
959 dc
.Blit(ofs
, 0, rc
.right
, rc
.bottom
, &memdc
, ofs
, 0);
962 #endif // USE_NOTEBOOK_ANTIFLICKER
964 // ----------------------------------------------------------------------------
965 // wxNotebook callbacks
966 // ----------------------------------------------------------------------------
968 void wxNotebook::OnSize(wxSizeEvent
& event
)
970 if ( GetPageCount() == 0 )
972 // Prevents droppings on resize, but does cause some flicker
973 // when there are no pages.
981 // Without this, we can sometimes get droppings at the edges
982 // of a notebook, for example a notebook in a splitter window.
983 // This needs to be reconciled with the RefreshRect calls
984 // at the end of this function, which weren't enough to prevent
987 wxSize sz
= GetClientSize();
989 // Refresh right side
990 wxRect
rect(sz
.x
-4, 0, 4, sz
.y
);
993 // Refresh bottom side
994 rect
= wxRect(0, sz
.y
-4, sz
.x
, 4);
998 rect
= wxRect(0, 0, 4, sz
.y
);
1001 #endif // !__WXWINCE__
1003 // fit all the notebook pages to the tab control's display area
1006 rc
.left
= rc
.top
= 0;
1007 GetSize((int *)&rc
.right
, (int *)&rc
.bottom
);
1009 // save the total size, we'll use it below
1010 int widthNbook
= rc
.right
- rc
.left
,
1011 heightNbook
= rc
.bottom
- rc
.top
;
1013 // there seems to be a bug in the implementation of TabCtrl_AdjustRect(): it
1014 // returns completely false values for multiline tab controls after the tabs
1015 // are added but before getting the first WM_SIZE (off by ~50 pixels, see
1017 // http://sf.net/tracker/index.php?func=detail&aid=645323&group_id=9863&atid=109863
1019 // and the only work around I could find was this ugly hack... without it
1020 // simply toggling the "multiline" checkbox in the notebook sample resulted
1021 // in a noticeable page displacement
1022 if ( HasFlag(wxNB_MULTILINE
) )
1024 // avoid an infinite recursion: we get another notification too!
1025 static bool s_isInOnSize
= false;
1027 if ( !s_isInOnSize
)
1029 s_isInOnSize
= true;
1030 SendMessage(GetHwnd(), WM_SIZE
, SIZE_RESTORED
,
1031 MAKELPARAM(rc
.right
, rc
.bottom
));
1032 s_isInOnSize
= false;
1035 // The best size depends on the number of rows of tabs, which can
1036 // change when the notepad is resized.
1037 InvalidateBestSize();
1041 // background bitmap size has changed, update the brush using it too
1043 #endif // wxUSE_UXTHEME
1045 TabCtrl_AdjustRect(GetHwnd(), false, &rc
);
1047 int width
= rc
.right
- rc
.left
,
1048 height
= rc
.bottom
- rc
.top
;
1049 size_t nCount
= m_pages
.Count();
1050 for ( size_t nPage
= 0; nPage
< nCount
; nPage
++ ) {
1051 wxNotebookPage
*pPage
= m_pages
[nPage
];
1052 pPage
->SetSize(rc
.left
, rc
.top
, width
, height
);
1056 // unless we had already repainted everything, we now need to refresh
1057 if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE
) )
1059 // invalidate areas not covered by pages
1060 RefreshRect(wxRect(0, 0, widthNbook
, rc
.top
), false);
1061 RefreshRect(wxRect(0, rc
.top
, rc
.left
, height
), false);
1062 RefreshRect(wxRect(0, rc
.bottom
, widthNbook
, heightNbook
- rc
.bottom
),
1064 RefreshRect(wxRect(rc
.right
, rc
.top
, widthNbook
- rc
.right
, height
),
1068 #if USE_NOTEBOOK_ANTIFLICKER
1069 // subclass the spin control used by the notebook to scroll pages to
1070 // prevent it from flickering on resize
1071 if ( !m_hasSubclassedUpdown
)
1073 // iterate over all child windows to find spin button
1074 for ( HWND child
= ::GetWindow(GetHwnd(), GW_CHILD
);
1076 child
= ::GetWindow(child
, GW_HWNDNEXT
) )
1078 wxWindow
*childWindow
= wxFindWinFromHandle((WXHWND
)child
);
1080 // see if it exists, if no wxWindow found then assume it's the spin
1084 // subclass the spin button to override WM_ERASEBKGND
1085 if ( !gs_wndprocNotebookSpinBtn
)
1086 gs_wndprocNotebookSpinBtn
= (WXFARPROC
)wxGetWindowProc(child
);
1088 wxSetWindowProc(child
, wxNotebookSpinBtnWndProc
);
1089 m_hasSubclassedUpdown
= true;
1094 #endif // USE_NOTEBOOK_ANTIFLICKER
1099 void wxNotebook::OnSelChange(wxBookCtrlEvent
& event
)
1101 // is it our tab control?
1102 if ( event
.GetEventObject() == this )
1104 UpdateSelection(event
.GetSelection());
1107 // we want to give others a chance to process this message as well
1111 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
1113 if ( event
.IsWindowChange() ) {
1115 AdvanceSelection(event
.GetDirection());
1118 // we get this event in 3 cases
1120 // a) one of our pages might have generated it because the user TABbed
1121 // out from it in which case we should propagate the event upwards and
1122 // our parent will take care of setting the focus to prev/next sibling
1126 // b) the parent panel wants to give the focus to us so that we
1127 // forward it to our selected page. We can't deal with this in
1128 // OnSetFocus() because we don't know which direction the focus came
1129 // from in this case and so can't choose between setting the focus to
1130 // first or last panel child
1134 // c) we ourselves (see MSWTranslateMessage) generated the event
1136 wxWindow
* const parent
= GetParent();
1138 // the wxObject* casts are required to avoid MinGW GCC 2.95.3 ICE
1139 const bool isFromParent
= event
.GetEventObject() == (wxObject
*) parent
;
1140 const bool isFromSelf
= event
.GetEventObject() == (wxObject
*) this;
1141 const bool isForward
= event
.GetDirection();
1143 if ( isFromSelf
&& !isForward
)
1145 // focus is currently on notebook tab and should leave
1146 // it backwards (Shift-TAB)
1147 event
.SetCurrentFocus(this);
1148 parent
->HandleWindowEvent(event
);
1150 else if ( isFromParent
|| isFromSelf
)
1152 // no, it doesn't come from child, case (b) or (c): forward to a
1153 // page but only if entering notebook page (i.e. direction is
1154 // backwards (Shift-TAB) comething from out-of-notebook, or
1155 // direction is forward (TAB) from ourselves),
1156 if ( m_nSelection
!= wxNOT_FOUND
&&
1157 (!event
.GetDirection() || isFromSelf
) )
1159 // so that the page knows that the event comes from it's parent
1160 // and is being propagated downwards
1161 event
.SetEventObject(this);
1163 wxWindow
*page
= m_pages
[m_nSelection
];
1164 if ( !page
->HandleWindowEvent(event
) )
1168 //else: page manages focus inside it itself
1170 else // otherwise set the focus to the notebook itself
1177 // it comes from our child, case (a), pass to the parent, but only
1178 // if the direction is forwards. Otherwise set the focus to the
1179 // notebook itself. The notebook is always the 'first' control of a
1187 event
.SetCurrentFocus(this);
1188 parent
->HandleWindowEvent(event
);
1196 bool wxNotebook::DoDrawBackground(WXHDC hDC
, wxWindow
*child
)
1198 wxUxThemeHandle
theme(child
? child
: this, L
"TAB");
1202 // get the notebook client rect (we're not interested in drawing tabs
1204 wxRect r
= GetPageSize();
1209 wxCopyRectToRECT(r
, rc
);
1211 // map rect to the coords of the window we're drawing in
1213 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1215 // we have the content area (page size), but we need to draw all of the
1216 // background for it to be aligned correctly
1217 wxUxThemeEngine::Get()->GetThemeBackgroundExtent
1226 wxUxThemeEngine::Get()->DrawThemeBackground
1239 WXHBRUSH
wxNotebook::QueryBgBitmap()
1241 wxRect r
= GetPageSize();
1245 WindowHDC
hDC(GetHwnd());
1246 MemoryHDC
hDCMem(hDC
);
1247 CompatibleBitmap
hBmp(hDC
, r
.x
+ r
.width
, r
.y
+ r
.height
);
1249 SelectInHDC
selectBmp(hDCMem
, hBmp
);
1251 if ( !DoDrawBackground((WXHDC
)(HDC
)hDCMem
) )
1254 return (WXHBRUSH
)::CreatePatternBrush(hBmp
);
1257 void wxNotebook::UpdateBgBrush()
1259 if ( m_hbrBackground
)
1260 ::DeleteObject((HBRUSH
)m_hbrBackground
);
1262 if ( !m_hasBgCol
&& wxUxThemeEngine::GetIfActive() )
1264 m_hbrBackground
= QueryBgBitmap();
1266 else // no themes or we've got user-defined solid colour
1268 m_hbrBackground
= NULL
;
1272 WXHBRUSH
wxNotebook::MSWGetBgBrushForChild(WXHDC hDC
, wxWindow
*child
)
1274 if ( m_hbrBackground
)
1276 // before drawing with the background brush, we need to position it
1279 ::GetWindowRect(GetHwndOf(child
), &rc
);
1281 ::MapWindowPoints(NULL
, GetHwnd(), (POINT
*)&rc
, 1);
1283 if ( !::SetBrushOrgEx((HDC
)hDC
, -rc
.left
, -rc
.top
, NULL
) )
1285 wxLogLastError(wxT("SetBrushOrgEx(notebook bg brush)"));
1288 return m_hbrBackground
;
1291 return wxNotebookBase::MSWGetBgBrushForChild(hDC
, child
);
1294 bool wxNotebook::MSWPrintChild(WXHDC hDC
, wxWindow
*child
)
1296 // solid background colour overrides themed background drawing
1297 if ( !UseBgCol() && DoDrawBackground(hDC
, child
) )
1300 // If we're using a solid colour (for example if we've switched off
1301 // theming for this notebook), paint it
1304 wxRect r
= GetPageSize();
1309 wxCopyRectToRECT(r
, rc
);
1311 // map rect to the coords of the window we're drawing in
1313 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1315 wxBrush
brush(GetBackgroundColour());
1316 HBRUSH hbr
= GetHbrushOf(brush
);
1318 ::FillRect((HDC
) hDC
, &rc
, hbr
);
1323 return wxNotebookBase::MSWPrintChild(hDC
, child
);
1326 #endif // wxUSE_UXTHEME
1328 // Windows only: attempts to get colour for UX theme page background
1329 wxColour
wxNotebook::GetThemeBackgroundColour() const
1332 if (wxUxThemeEngine::Get())
1334 wxUxThemeHandle
hTheme((wxNotebook
*) this, L
"TAB");
1337 // This is total guesswork.
1338 // See PlatformSDK\Include\Tmschema.h for values.
1339 // JACS: can also use 9 (TABP_PANE)
1340 COLORREF themeColor
;
1341 bool success
= (S_OK
== wxUxThemeEngine::Get()->GetThemeColor(
1345 3821 /* FILLCOLORHINT */,
1348 return GetBackgroundColour();
1351 [DS] Workaround for WindowBlinds:
1352 Some themes return a near black theme color using FILLCOLORHINT,
1353 this makes notebook pages have an ugly black background and makes
1354 text (usually black) unreadable. Retry again with FILLCOLOR.
1356 This workaround potentially breaks appearance of some themes,
1357 but in practice it already fixes some themes.
1359 if (themeColor
== 1)
1361 wxUxThemeEngine::Get()->GetThemeColor(
1365 3802 /* FILLCOLOR */,
1369 wxColour colour
= wxRGBToColour(themeColor
);
1371 // Under Vista, the tab background colour is reported incorrectly.
1372 // So for the default theme at least, hard-code the colour to something
1373 // that will blend in.
1375 static int s_AeroStatus
= -1;
1376 if (s_AeroStatus
== -1)
1378 WCHAR szwThemeFile
[1024];
1379 WCHAR szwThemeColor
[256];
1380 if (S_OK
== wxUxThemeEngine::Get()->GetCurrentThemeName(szwThemeFile
, 1024, szwThemeColor
, 256, NULL
, 0))
1382 wxString
themeFile(szwThemeFile
), themeColor(szwThemeColor
);
1383 if (themeFile
.Find(wxT("Aero")) != -1 && themeColor
== wxT("NormalColor"))
1392 if (s_AeroStatus
== 1)
1393 colour
= wxColour(255, 255, 255);
1398 #endif // wxUSE_UXTHEME
1400 return GetBackgroundColour();
1403 // ----------------------------------------------------------------------------
1404 // wxNotebook base class virtuals
1405 // ----------------------------------------------------------------------------
1407 #if wxUSE_CONSTRAINTS
1409 // override these 2 functions to do nothing: everything is done in OnSize
1411 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse
))
1413 // don't set the sizes of the pages - their correct size is not yet known
1414 wxControl::SetConstraintSizes(false);
1417 bool wxNotebook::DoPhase(int WXUNUSED(nPhase
))
1422 #endif // wxUSE_CONSTRAINTS
1424 // ----------------------------------------------------------------------------
1425 // wxNotebook Windows message handlers
1426 // ----------------------------------------------------------------------------
1428 bool wxNotebook::MSWOnScroll(int orientation
, WXWORD nSBCode
,
1429 WXWORD pos
, WXHWND control
)
1431 // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
1436 return wxNotebookBase::MSWOnScroll(orientation
, nSBCode
, pos
, control
);
1439 bool wxNotebook::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
* result
)
1441 wxBookCtrlEvent
event(wxEVT_NULL
, m_windowId
);
1443 NMHDR
* hdr
= (NMHDR
*)lParam
;
1444 switch ( hdr
->code
) {
1446 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
);
1449 case TCN_SELCHANGING
:
1450 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
);
1454 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1457 event
.SetSelection(TabCtrl_GetCurSel(GetHwnd()));
1458 event
.SetOldSelection(m_nSelection
);
1459 event
.SetEventObject(this);
1460 event
.SetInt(idCtrl
);
1462 bool processed
= HandleWindowEvent(event
);
1463 *result
= !event
.IsAllowed();
1467 #endif // wxUSE_NOTEBOOK