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 ( int(nPage
) != m_nSelection
)
448 wxNotebookEvent
event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
, m_windowId
);
449 event
.SetSelection(nPage
);
450 event
.SetOldSelection(m_nSelection
);
451 event
.SetEventObject(this);
452 if ( !GetEventHandler()->ProcessEvent(event
) || event
.IsAllowed() )
454 // program allows the page change
455 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
);
456 (void)GetEventHandler()->ProcessEvent(event
);
458 TabCtrl_SetCurSel(GetHwnd(), nPage
);
465 void wxNotebook::UpdateSelection(size_t newsel
)
467 if ( m_nSelection
!= -1 )
468 m_pages
[m_nSelection
]->Show(false);
472 wxNotebookPage
*pPage
= m_pages
[newsel
];
476 // Changing the page should give the focus to it but, as per bug report
477 // http://sf.net/tracker/index.php?func=detail&aid=1150659&group_id=9863&atid=109863,
478 // we should not set the focus to it directly since it erroneously
479 // selects radio buttons and breaks keyboard handling for a notebook's
480 // scroll buttons. So give focus to the notebook and not the page.
482 // but don't do this is the notebook is hidden
483 if ( ::IsWindowVisible(GetHwnd()) )
486 m_nSelection
= newsel
;
489 int wxNotebook::ChangeSelection(size_t nPage
)
491 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
493 if ( int(nPage
) != m_nSelection
)
495 TabCtrl_SetCurSel(GetHwnd(), nPage
);
497 UpdateSelection(nPage
);
503 bool wxNotebook::SetPageText(size_t nPage
, const wxString
& strText
)
505 wxCHECK_MSG( IS_VALID_PAGE(nPage
), false, wxT("notebook page out of range") );
508 tcItem
.mask
= TCIF_TEXT
;
509 tcItem
.pszText
= (wxChar
*)strText
.c_str();
511 if ( !HasFlag(wxNB_MULTILINE
) )
512 return TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
514 // multiline - we need to set new page size if a line is added or removed
515 int rows
= GetRowCount();
516 bool ret
= TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
518 if ( ret
&& rows
!= GetRowCount() )
520 const wxRect r
= GetPageSize();
521 const size_t count
= m_pages
.Count();
522 for ( size_t page
= 0; page
< count
; page
++ )
523 m_pages
[page
]->SetSize(r
);
529 wxString
wxNotebook::GetPageText(size_t nPage
) const
531 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxEmptyString
, wxT("notebook page out of range") );
535 tcItem
.mask
= TCIF_TEXT
;
536 tcItem
.pszText
= buf
;
537 tcItem
.cchTextMax
= WXSIZEOF(buf
);
540 if ( TabCtrl_GetItem(GetHwnd(), nPage
, &tcItem
) )
541 str
= tcItem
.pszText
;
546 int wxNotebook::GetPageImage(size_t nPage
) const
548 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxNOT_FOUND
, wxT("notebook page out of range") );
551 tcItem
.mask
= TCIF_IMAGE
;
553 return TabCtrl_GetItem(GetHwnd(), nPage
, &tcItem
) ? tcItem
.iImage
: wxNOT_FOUND
;
556 bool wxNotebook::SetPageImage(size_t nPage
, int nImage
)
558 wxCHECK_MSG( IS_VALID_PAGE(nPage
), false, wxT("notebook page out of range") );
561 tcItem
.mask
= TCIF_IMAGE
;
562 tcItem
.iImage
= nImage
;
564 return TabCtrl_SetItem(GetHwnd(), nPage
, &tcItem
) != 0;
567 void wxNotebook::SetImageList(wxImageList
* imageList
)
569 wxNotebookBase::SetImageList(imageList
);
573 (void) TabCtrl_SetImageList(GetHwnd(), (HIMAGELIST
)imageList
->GetHIMAGELIST());
577 // ----------------------------------------------------------------------------
578 // wxNotebook size settings
579 // ----------------------------------------------------------------------------
581 wxRect
wxNotebook::GetPageSize() const
586 ::GetClientRect(GetHwnd(), &rc
);
588 // This check is to work around a bug in TabCtrl_AdjustRect which will
589 // cause a crash on win2k or on XP with themes disabled if either
590 // wxNB_MULTILINE is used or tabs are placed on a side, if the rectangle
593 // The value of 20 is chosen arbitrarily but seems to work
594 if ( rc
.right
> 20 && rc
.bottom
> 20 )
596 TabCtrl_AdjustRect(GetHwnd(), false, &rc
);
598 wxCopyRECTToRect(rc
, r
);
604 void wxNotebook::SetPageSize(const wxSize
& size
)
606 // transform the page size into the notebook size
613 TabCtrl_AdjustRect(GetHwnd(), true, &rc
);
616 SetSize(rc
.right
- rc
.left
, rc
.bottom
- rc
.top
);
619 void wxNotebook::SetPadding(const wxSize
& padding
)
621 TabCtrl_SetPadding(GetHwnd(), padding
.x
, padding
.y
);
624 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
626 void wxNotebook::SetTabSize(const wxSize
& sz
)
628 ::SendMessage(GetHwnd(), TCM_SETITEMSIZE
, 0, MAKELPARAM(sz
.x
, sz
.y
));
631 wxSize
wxNotebook::CalcSizeFromPage(const wxSize
& sizePage
) const
633 // we can't use TabCtrl_AdjustRect here because it only works for wxNB_TOP
634 wxSize sizeTotal
= sizePage
;
637 if ( GetPageCount() > 0 )
640 TabCtrl_GetItemRect(GetHwnd(), 0, &rect
);
641 tabSize
.x
= rect
.right
- rect
.left
;
642 tabSize
.y
= rect
.bottom
- rect
.top
;
645 // add an extra margin in both directions
646 const int MARGIN
= 8;
649 sizeTotal
.x
+= MARGIN
;
650 sizeTotal
.y
+= tabSize
.y
+ MARGIN
;
652 else // horizontal layout
654 sizeTotal
.x
+= tabSize
.x
+ MARGIN
;
655 sizeTotal
.y
+= MARGIN
;
661 void wxNotebook::AdjustPageSize(wxNotebookPage
*page
)
663 wxCHECK_RET( page
, _T("NULL page in wxNotebook::AdjustPageSize") );
665 const wxRect r
= GetPageSize();
672 // ----------------------------------------------------------------------------
673 // wxNotebook operations
674 // ----------------------------------------------------------------------------
676 // remove one page from the notebook, without deleting
677 wxNotebookPage
*wxNotebook::DoRemovePage(size_t nPage
)
679 wxNotebookPage
*pageRemoved
= wxNotebookBase::DoRemovePage(nPage
);
683 TabCtrl_DeleteItem(GetHwnd(), nPage
);
685 if ( m_pages
.IsEmpty() )
687 // no selection any more, the notebook becamse empty
690 else // notebook still not empty
692 int selNew
= TabCtrl_GetCurSel(GetHwnd());
695 // No selection change, just refresh the current selection.
696 // Because it could be that the slection index changed
697 // we need to update it.
698 // Note: this does not mean the selection it self changed.
699 m_nSelection
= selNew
;
700 m_pages
[m_nSelection
]->Refresh();
702 else if (int(nPage
) == m_nSelection
)
704 // The selection was deleted.
706 // Determine new selection.
707 if (m_nSelection
== int(GetPageCount()))
708 selNew
= m_nSelection
- 1;
710 selNew
= m_nSelection
;
712 // m_nSelection must be always valid so reset it before calling
715 SetSelection(selNew
);
719 wxFAIL
; // Windows did not behave ok.
727 bool wxNotebook::DeleteAllPages()
729 size_t nPageCount
= GetPageCount();
731 for ( nPage
= 0; nPage
< nPageCount
; nPage
++ )
732 delete m_pages
[nPage
];
736 TabCtrl_DeleteAllItems(GetHwnd());
740 InvalidateBestSize();
744 // same as AddPage() but does it at given position
745 bool wxNotebook::InsertPage(size_t nPage
,
746 wxNotebookPage
*pPage
,
747 const wxString
& strText
,
751 wxCHECK_MSG( pPage
!= NULL
, false, _T("NULL page in wxNotebook::InsertPage") );
752 wxCHECK_MSG( IS_VALID_PAGE(nPage
) || nPage
== GetPageCount(), false,
753 _T("invalid index in wxNotebook::InsertPage") );
755 wxASSERT_MSG( pPage
->GetParent() == this,
756 _T("notebook pages must have notebook as parent") );
758 // add a new tab to the control
759 // ----------------------------
761 // init all fields to 0
763 wxZeroMemory(tcItem
);
765 // set the image, if any
768 tcItem
.mask
|= TCIF_IMAGE
;
769 tcItem
.iImage
= imageId
;
773 if ( !strText
.empty() )
775 tcItem
.mask
|= TCIF_TEXT
;
776 tcItem
.pszText
= (wxChar
*)strText
.c_str(); // const_cast
779 // hide the page: unless it is selected, it shouldn't be shown (and if it
780 // is selected it will be shown later)
781 HWND hwnd
= GetWinHwnd(pPage
);
782 SetWindowLong(hwnd
, GWL_STYLE
, GetWindowLong(hwnd
, GWL_STYLE
) & ~WS_VISIBLE
);
784 // this updates internal flag too -- otherwise it would get out of sync
785 // with the real state
789 // fit the notebook page to the tab control's display area: this should be
790 // done before adding it to the notebook or TabCtrl_InsertItem() will
791 // change the notebooks size itself!
792 AdjustPageSize(pPage
);
794 // finally do insert it
795 if ( TabCtrl_InsertItem(GetHwnd(), nPage
, &tcItem
) == -1 )
797 wxLogError(wxT("Can't create the notebook page '%s'."), strText
.c_str());
802 // need to update the bg brush when the first page is added
803 // so the first panel gets the correct themed background
804 if ( m_pages
.empty() )
809 // succeeded: save the pointer to the page
810 m_pages
.Insert(pPage
, nPage
);
812 // we may need to adjust the size again if the notebook size changed:
813 // normally this only happens for the first page we add (the tabs which
814 // hadn't been there before are now shown) but for a multiline notebook it
815 // can happen for any page at all as a new row could have been started
816 if ( m_pages
.GetCount() == 1 || HasFlag(wxNB_MULTILINE
) )
818 AdjustPageSize(pPage
);
821 // now deal with the selection
822 // ---------------------------
824 // if the inserted page is before the selected one, we must update the
825 // index of the selected page
826 if ( int(nPage
) <= m_nSelection
)
828 // one extra page added
832 // some page should be selected: either this one or the first one if there
833 // is still no selection
837 else if ( m_nSelection
== -1 )
841 SetSelection(selNew
);
843 InvalidateBestSize();
848 int wxNotebook::HitTest(const wxPoint
& pt
, long *flags
) const
850 TC_HITTESTINFO hitTestInfo
;
851 hitTestInfo
.pt
.x
= pt
.x
;
852 hitTestInfo
.pt
.y
= pt
.y
;
853 int item
= TabCtrl_HitTest(GetHwnd(), &hitTestInfo
);
859 if ((hitTestInfo
.flags
& TCHT_NOWHERE
) == TCHT_NOWHERE
)
860 *flags
|= wxBK_HITTEST_NOWHERE
;
861 if ((hitTestInfo
.flags
& TCHT_ONITEM
) == TCHT_ONITEM
)
862 *flags
|= wxBK_HITTEST_ONITEM
;
863 if ((hitTestInfo
.flags
& TCHT_ONITEMICON
) == TCHT_ONITEMICON
)
864 *flags
|= wxBK_HITTEST_ONICON
;
865 if ((hitTestInfo
.flags
& TCHT_ONITEMLABEL
) == TCHT_ONITEMLABEL
)
866 *flags
|= wxBK_HITTEST_ONLABEL
;
867 if ( item
== wxNOT_FOUND
&& GetPageSize().Contains(pt
) )
868 *flags
|= wxBK_HITTEST_ONPAGE
;
874 // ----------------------------------------------------------------------------
875 // flicker-less notebook redraw
876 // ----------------------------------------------------------------------------
878 #if USE_NOTEBOOK_ANTIFLICKER
880 // wnd proc for the spin button
881 LRESULT APIENTRY _EXPORT
wxNotebookSpinBtnWndProc(HWND hwnd
,
886 if ( message
== WM_ERASEBKGND
)
889 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebookSpinBtn
,
890 hwnd
, message
, wParam
, lParam
);
893 LRESULT APIENTRY _EXPORT
wxNotebookWndProc(HWND hwnd
,
898 return ::CallWindowProc(CASTWNDPROC gs_wndprocNotebook
,
899 hwnd
, message
, wParam
, lParam
);
902 void wxNotebook::OnEraseBackground(wxEraseEvent
& WXUNUSED(event
))
907 void wxNotebook::OnPaint(wxPaintEvent
& WXUNUSED(event
))
912 ::GetClientRect(GetHwnd(), &rc
);
913 wxBitmap
bmp(rc
.right
, rc
.bottom
);
914 memdc
.SelectObject(bmp
);
916 // if there is no special brush just use the solid background colour
918 HBRUSH hbr
= (HBRUSH
)m_hbrBackground
;
925 brush
= wxBrush(GetBackgroundColour());
926 hbr
= GetHbrushOf(brush
);
929 ::FillRect(GetHdcOf(memdc
), &rc
, hbr
);
931 MSWDefWindowProc(WM_PAINT
, (WPARAM
)memdc
.GetHDC(), 0);
933 dc
.Blit(0, 0, rc
.right
, rc
.bottom
, &memdc
, 0, 0);
936 #endif // USE_NOTEBOOK_ANTIFLICKER
938 // ----------------------------------------------------------------------------
939 // wxNotebook callbacks
940 // ----------------------------------------------------------------------------
942 void wxNotebook::OnSize(wxSizeEvent
& event
)
944 if ( GetPageCount() == 0 )
946 // Prevents droppings on resize, but does cause some flicker
947 // when there are no pages.
955 // Without this, we can sometimes get droppings at the edges
956 // of a notebook, for example a notebook in a splitter window.
957 // This needs to be reconciled with the RefreshRect calls
958 // at the end of this function, which weren't enough to prevent
961 wxSize sz
= GetClientSize();
963 // Refresh right side
964 wxRect
rect(sz
.x
-4, 0, 4, sz
.y
);
967 // Refresh bottom side
968 rect
= wxRect(0, sz
.y
-4, sz
.x
, 4);
972 rect
= wxRect(0, 0, 4, sz
.y
);
975 #endif // !__WXWINCE__
977 // fit all the notebook pages to the tab control's display area
980 rc
.left
= rc
.top
= 0;
981 GetSize((int *)&rc
.right
, (int *)&rc
.bottom
);
983 // save the total size, we'll use it below
984 int widthNbook
= rc
.right
- rc
.left
,
985 heightNbook
= rc
.bottom
- rc
.top
;
987 // there seems to be a bug in the implementation of TabCtrl_AdjustRect(): it
988 // returns completely false values for multiline tab controls after the tabs
989 // are added but before getting the first WM_SIZE (off by ~50 pixels, see
991 // http://sf.net/tracker/index.php?func=detail&aid=645323&group_id=9863&atid=109863
993 // and the only work around I could find was this ugly hack... without it
994 // simply toggling the "multiline" checkbox in the notebook sample resulted
995 // in a noticeable page displacement
996 if ( HasFlag(wxNB_MULTILINE
) )
998 // avoid an infinite recursion: we get another notification too!
999 static bool s_isInOnSize
= false;
1001 if ( !s_isInOnSize
)
1003 s_isInOnSize
= true;
1004 SendMessage(GetHwnd(), WM_SIZE
, SIZE_RESTORED
,
1005 MAKELPARAM(rc
.right
, rc
.bottom
));
1006 s_isInOnSize
= false;
1011 // background bitmap size has changed, update the brush using it too
1013 #endif // wxUSE_UXTHEME
1015 TabCtrl_AdjustRect(GetHwnd(), false, &rc
);
1017 int width
= rc
.right
- rc
.left
,
1018 height
= rc
.bottom
- rc
.top
;
1019 size_t nCount
= m_pages
.Count();
1020 for ( size_t nPage
= 0; nPage
< nCount
; nPage
++ ) {
1021 wxNotebookPage
*pPage
= m_pages
[nPage
];
1022 pPage
->SetSize(rc
.left
, rc
.top
, width
, height
);
1026 // unless we had already repainted everything, we now need to refresh
1027 if ( !HasFlag(wxFULL_REPAINT_ON_RESIZE
) )
1029 // invalidate areas not covered by pages
1030 RefreshRect(wxRect(0, 0, widthNbook
, rc
.top
), false);
1031 RefreshRect(wxRect(0, rc
.top
, rc
.left
, height
), false);
1032 RefreshRect(wxRect(0, rc
.bottom
, widthNbook
, heightNbook
- rc
.bottom
),
1034 RefreshRect(wxRect(rc
.right
, rc
.top
, widthNbook
- rc
.right
, height
),
1038 #if USE_NOTEBOOK_ANTIFLICKER
1039 // subclass the spin control used by the notebook to scroll pages to
1040 // prevent it from flickering on resize
1041 if ( !m_hasSubclassedUpdown
)
1043 // iterate over all child windows to find spin button
1044 for ( HWND child
= ::GetWindow(GetHwnd(), GW_CHILD
);
1046 child
= ::GetWindow(child
, GW_HWNDNEXT
) )
1048 wxWindow
*childWindow
= wxFindWinFromHandle((WXHWND
)child
);
1050 // see if it exists, if no wxWindow found then assume it's the spin
1054 // subclass the spin button to override WM_ERASEBKGND
1055 if ( !gs_wndprocNotebookSpinBtn
)
1056 gs_wndprocNotebookSpinBtn
= (WXFARPROC
)wxGetWindowProc(child
);
1058 wxSetWindowProc(child
, wxNotebookSpinBtnWndProc
);
1059 m_hasSubclassedUpdown
= true;
1064 #endif // USE_NOTEBOOK_ANTIFLICKER
1069 void wxNotebook::OnSelChange(wxNotebookEvent
& event
)
1071 // is it our tab control?
1072 if ( event
.GetEventObject() == this )
1074 UpdateSelection(event
.GetSelection());
1077 // we want to give others a chance to process this message as well
1081 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
1083 if ( event
.IsWindowChange() ) {
1085 AdvanceSelection(event
.GetDirection());
1088 // we get this event in 3 cases
1090 // a) one of our pages might have generated it because the user TABbed
1091 // out from it in which case we should propagate the event upwards and
1092 // our parent will take care of setting the focus to prev/next sibling
1096 // b) the parent panel wants to give the focus to us so that we
1097 // forward it to our selected page. We can't deal with this in
1098 // OnSetFocus() because we don't know which direction the focus came
1099 // from in this case and so can't choose between setting the focus to
1100 // first or last panel child
1104 // c) we ourselves (see MSWTranslateMessage) generated the event
1106 wxWindow
* const parent
= GetParent();
1108 // the wxObject* casts are required to avoid MinGW GCC 2.95.3 ICE
1109 const bool isFromParent
= event
.GetEventObject() == (wxObject
*) parent
;
1110 const bool isFromSelf
= event
.GetEventObject() == (wxObject
*) this;
1112 if ( isFromParent
|| isFromSelf
)
1114 // no, it doesn't come from child, case (b) or (c): forward to a
1115 // page but only if direction is backwards (TAB) or from ourselves,
1116 if ( m_nSelection
!= -1 &&
1117 (!event
.GetDirection() || isFromSelf
) )
1119 // so that the page knows that the event comes from it's parent
1120 // and is being propagated downwards
1121 event
.SetEventObject(this);
1123 wxWindow
*page
= m_pages
[m_nSelection
];
1124 if ( !page
->GetEventHandler()->ProcessEvent(event
) )
1128 //else: page manages focus inside it itself
1130 else // otherwise set the focus to the notebook itself
1137 // it comes from our child, case (a), pass to the parent, but only
1138 // if the direction is forwards. Otherwise set the focus to the
1139 // notebook itself. The notebook is always the 'first' control of a
1141 if ( !event
.GetDirection() )
1147 event
.SetCurrentFocus(this);
1148 parent
->GetEventHandler()->ProcessEvent(event
);
1156 bool wxNotebook::DoDrawBackground(WXHDC hDC
, wxWindow
*child
)
1158 wxUxThemeHandle
theme(child
? child
: this, L
"TAB");
1162 // get the notebook client rect (we're not interested in drawing tabs
1164 wxRect r
= GetPageSize();
1169 wxCopyRectToRECT(r
, rc
);
1171 // map rect to the coords of the window we're drawing in
1173 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1175 // we have the content area (page size), but we need to draw all of the
1176 // background for it to be aligned correctly
1177 wxUxThemeEngine::Get()->GetThemeBackgroundExtent
1186 wxUxThemeEngine::Get()->DrawThemeBackground
1199 WXHBRUSH
wxNotebook::QueryBgBitmap()
1201 wxRect r
= GetPageSize();
1205 WindowHDC
hDC(GetHwnd());
1206 MemoryHDC
hDCMem(hDC
);
1207 CompatibleBitmap
hBmp(hDC
, r
.x
+ r
.width
, r
.y
+ r
.height
);
1209 SelectInHDC
selectBmp(hDCMem
, hBmp
);
1211 if ( !DoDrawBackground((WXHDC
)(HDC
)hDCMem
) )
1214 return (WXHBRUSH
)::CreatePatternBrush(hBmp
);
1217 void wxNotebook::UpdateBgBrush()
1219 if ( m_hbrBackground
)
1220 ::DeleteObject((HBRUSH
)m_hbrBackground
);
1222 if ( !m_hasBgCol
&& wxUxThemeEngine::GetIfActive() )
1224 m_hbrBackground
= QueryBgBitmap();
1226 else // no themes or we've got user-defined solid colour
1228 m_hbrBackground
= NULL
;
1232 WXHBRUSH
wxNotebook::MSWGetBgBrushForChild(WXHDC hDC
, WXHWND hWnd
)
1234 if ( m_hbrBackground
)
1236 // before drawing with the background brush, we need to position it
1239 ::GetWindowRect((HWND
)hWnd
, &rc
);
1241 ::MapWindowPoints(NULL
, GetHwnd(), (POINT
*)&rc
, 1);
1243 if ( !::SetBrushOrgEx((HDC
)hDC
, -rc
.left
, -rc
.top
, NULL
) )
1245 wxLogLastError(_T("SetBrushOrgEx(notebook bg brush)"));
1248 return m_hbrBackground
;
1251 return wxNotebookBase::MSWGetBgBrushForChild(hDC
, hWnd
);
1254 bool wxNotebook::MSWPrintChild(WXHDC hDC
, wxWindow
*child
)
1256 // solid background colour overrides themed background drawing
1257 if ( !UseBgCol() && DoDrawBackground(hDC
, child
) )
1260 // If we're using a solid colour (for example if we've switched off
1261 // theming for this notebook), paint it
1264 wxRect r
= GetPageSize();
1269 wxCopyRectToRECT(r
, rc
);
1271 // map rect to the coords of the window we're drawing in
1273 ::MapWindowPoints(GetHwnd(), GetHwndOf(child
), (POINT
*)&rc
, 2);
1275 wxBrush
brush(GetBackgroundColour());
1276 HBRUSH hbr
= GetHbrushOf(brush
);
1278 ::FillRect((HDC
) hDC
, &rc
, hbr
);
1283 return wxNotebookBase::MSWPrintChild(hDC
, child
);
1286 #endif // wxUSE_UXTHEME
1288 // Windows only: attempts to get colour for UX theme page background
1289 wxColour
wxNotebook::GetThemeBackgroundColour() const
1292 if (wxUxThemeEngine::Get())
1294 wxUxThemeHandle
hTheme((wxNotebook
*) this, L
"TAB");
1297 // This is total guesswork.
1298 // See PlatformSDK\Include\Tmschema.h for values
1299 COLORREF themeColor
;
1300 wxUxThemeEngine::Get()->GetThemeColor(
1304 3821 /* FILLCOLORHINT */,
1308 [DS] Workaround for WindowBlinds:
1309 Some themes return a near black theme color using FILLCOLORHINT,
1310 this makes notebook pages have an ugly black background and makes
1311 text (usually black) unreadable. Retry again with FILLCOLOR.
1313 This workaround potentially breaks appearance of some themes,
1314 but in practice it already fixes some themes.
1316 if (themeColor
== 1)
1318 wxUxThemeEngine::Get()->GetThemeColor(
1322 3802 /* FILLCOLOR */,
1326 return wxRGBToColour(themeColor
);
1329 #endif // wxUSE_UXTHEME
1331 return GetBackgroundColour();
1334 // ----------------------------------------------------------------------------
1335 // wxNotebook base class virtuals
1336 // ----------------------------------------------------------------------------
1338 #if wxUSE_CONSTRAINTS
1340 // override these 2 functions to do nothing: everything is done in OnSize
1342 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse
))
1344 // don't set the sizes of the pages - their correct size is not yet known
1345 wxControl::SetConstraintSizes(false);
1348 bool wxNotebook::DoPhase(int WXUNUSED(nPhase
))
1353 #endif // wxUSE_CONSTRAINTS
1355 // ----------------------------------------------------------------------------
1356 // wxNotebook Windows message handlers
1357 // ----------------------------------------------------------------------------
1359 bool wxNotebook::MSWOnScroll(int orientation
, WXWORD nSBCode
,
1360 WXWORD pos
, WXHWND control
)
1362 // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
1367 return wxNotebookBase::MSWOnScroll(orientation
, nSBCode
, pos
, control
);
1370 bool wxNotebook::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
* result
)
1372 wxNotebookEvent
event(wxEVT_NULL
, m_windowId
);
1374 NMHDR
* hdr
= (NMHDR
*)lParam
;
1375 switch ( hdr
->code
) {
1377 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
);
1380 case TCN_SELCHANGING
:
1381 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
);
1385 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1388 event
.SetSelection(TabCtrl_GetCurSel(GetHwnd()));
1389 event
.SetOldSelection(m_nSelection
);
1390 event
.SetEventObject(this);
1391 event
.SetInt(idCtrl
);
1393 bool processed
= GetEventHandler()->ProcessEvent(event
);
1394 *result
= !event
.IsAllowed();
1398 #endif // wxUSE_NOTEBOOK