1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: 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 ///////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "notebook.h"
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
27 #include "wx/string.h"
31 #include "wx/imaglist.h"
33 #include "wx/control.h"
34 #include "wx/notebook.h"
37 #include "wx/msw/private.h"
39 // Windows standard headers
41 #error "wxNotebook is only supported Windows 95 and above"
44 #include <windowsx.h> // for SetWindowFont
46 #ifdef __GNUWIN32_OLD__
47 #include "wx/msw/gnuwin32/extra.h"
50 #if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
54 #include "wx/msw/winundef.h"
57 #include "wx/msw/uxtheme.h"
59 #include "wx/radiobut.h"
60 #include "wx/radiobox.h"
61 #include "wx/checkbox.h"
62 #include "wx/bmpbuttn.h"
63 #include "wx/statline.h"
64 #include "wx/statbox.h"
65 #include "wx/stattext.h"
66 #include "wx/slider.h"
67 #include "wx/scrolwin.h"
71 // ----------------------------------------------------------------------------
73 // ----------------------------------------------------------------------------
75 // check that the page index is valid
76 #define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((nPage) < GetPageCount()))
79 #define m_hwnd (HWND)GetHWND()
81 // ----------------------------------------------------------------------------
83 // ----------------------------------------------------------------------------
85 // This is a work-around for missing defines in gcc-2.95 headers
87 #define TCS_RIGHT 0x0002
91 #define TCS_VERTICAL 0x0080
95 #define TCS_BOTTOM TCS_RIGHT
98 // ----------------------------------------------------------------------------
100 // ----------------------------------------------------------------------------
102 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
)
103 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
)
105 BEGIN_EVENT_TABLE(wxNotebook
, wxControl
)
106 EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange
)
108 EVT_SIZE(wxNotebook::OnSize
)
110 EVT_SET_FOCUS(wxNotebook::OnSetFocus
)
112 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
115 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
, wxControl
)
116 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent
, wxNotifyEvent
)
118 // ============================================================================
120 // ============================================================================
122 // ----------------------------------------------------------------------------
123 // wxNotebook construction
124 // ----------------------------------------------------------------------------
126 // common part of all ctors
127 void wxNotebook::Init()
133 // default for dynamic class
134 wxNotebook::wxNotebook()
139 // the same arguments as for wxControl
140 wxNotebook::wxNotebook(wxWindow
*parent
,
145 const wxString
& name
)
149 Create(parent
, id
, pos
, size
, style
, name
);
153 bool wxNotebook::Create(wxWindow
*parent
,
158 const wxString
& name
)
160 // Does ComCtl32 support non-top tabs?
161 int verComCtl32
= wxApp::GetComCtl32Version();
162 if ( verComCtl32
< 470 || verComCtl32
>= 600 )
164 if (style
& wxNB_BOTTOM
)
165 style
&= ~wxNB_BOTTOM
;
167 if (style
& wxNB_LEFT
)
170 if (style
& wxNB_RIGHT
)
171 style
&= ~wxNB_RIGHT
;
174 if ( !CreateControl(parent
, id
, pos
, size
, style
| wxTAB_TRAVERSAL
,
175 wxDefaultValidator
, name
) )
178 if ( !MSWCreateControl(WC_TABCONTROL
, wxEmptyString
, pos
, size
) )
181 SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE
)));
186 WXDWORD
wxNotebook::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
188 WXDWORD tabStyle
= wxControl::MSWGetStyle(style
, exstyle
);
190 tabStyle
|= WS_TABSTOP
| TCS_TABS
;
192 if ( style
& wxNB_MULTILINE
)
193 tabStyle
|= TCS_MULTILINE
;
194 if ( style
& wxNB_FIXEDWIDTH
)
195 tabStyle
|= TCS_FIXEDWIDTH
;
197 if ( style
& wxNB_BOTTOM
)
198 tabStyle
|= TCS_RIGHT
;
199 else if ( style
& wxNB_LEFT
)
200 tabStyle
|= TCS_VERTICAL
;
201 else if ( style
& wxNB_RIGHT
)
202 tabStyle
|= TCS_VERTICAL
| TCS_RIGHT
;
207 // note that we never want to have the default WS_EX_CLIENTEDGE style
208 // as it looks too ugly for the notebooks
215 // ----------------------------------------------------------------------------
216 // wxNotebook accessors
217 // ----------------------------------------------------------------------------
219 int wxNotebook::GetPageCount() const
222 wxASSERT( (int)m_pages
.Count() == TabCtrl_GetItemCount(m_hwnd
) );
224 return m_pages
.Count();
227 int wxNotebook::GetRowCount() const
229 return TabCtrl_GetRowCount(m_hwnd
);
232 int wxNotebook::SetSelection(int nPage
)
234 wxCHECK_MSG( IS_VALID_PAGE(nPage
), -1, wxT("notebook page out of range") );
236 if ( nPage
!= m_nSelection
)
238 wxNotebookEvent
event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
, m_windowId
);
239 event
.SetSelection(nPage
);
240 event
.SetOldSelection(m_nSelection
);
241 event
.SetEventObject(this);
242 if ( !GetEventHandler()->ProcessEvent(event
) || event
.IsAllowed() )
244 // program allows the page change
245 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
);
246 (void)GetEventHandler()->ProcessEvent(event
);
248 TabCtrl_SetCurSel(m_hwnd
, nPage
);
255 bool wxNotebook::SetPageText(int nPage
, const wxString
& strText
)
257 wxCHECK_MSG( IS_VALID_PAGE(nPage
), FALSE
, wxT("notebook page out of range") );
260 tcItem
.mask
= TCIF_TEXT
;
261 tcItem
.pszText
= (wxChar
*)strText
.c_str();
263 return TabCtrl_SetItem(m_hwnd
, nPage
, &tcItem
) != 0;
266 wxString
wxNotebook::GetPageText(int nPage
) const
268 wxCHECK_MSG( IS_VALID_PAGE(nPage
), wxEmptyString
, wxT("notebook page out of range") );
272 tcItem
.mask
= TCIF_TEXT
;
273 tcItem
.pszText
= buf
;
274 tcItem
.cchTextMax
= WXSIZEOF(buf
);
277 if ( TabCtrl_GetItem(m_hwnd
, nPage
, &tcItem
) )
278 str
= tcItem
.pszText
;
283 int wxNotebook::GetPageImage(int nPage
) const
285 wxCHECK_MSG( IS_VALID_PAGE(nPage
), -1, wxT("notebook page out of range") );
288 tcItem
.mask
= TCIF_IMAGE
;
290 return TabCtrl_GetItem(m_hwnd
, nPage
, &tcItem
) ? tcItem
.iImage
: -1;
293 bool wxNotebook::SetPageImage(int nPage
, int nImage
)
295 wxCHECK_MSG( IS_VALID_PAGE(nPage
), FALSE
, wxT("notebook page out of range") );
298 tcItem
.mask
= TCIF_IMAGE
;
299 tcItem
.iImage
= nImage
;
301 return TabCtrl_SetItem(m_hwnd
, nPage
, &tcItem
) != 0;
304 void wxNotebook::SetImageList(wxImageList
* imageList
)
306 wxNotebookBase::SetImageList(imageList
);
310 TabCtrl_SetImageList(m_hwnd
, (HIMAGELIST
)imageList
->GetHIMAGELIST());
314 // ----------------------------------------------------------------------------
315 // wxNotebook size settings
316 // ----------------------------------------------------------------------------
318 void wxNotebook::SetPageSize(const wxSize
& size
)
320 // transform the page size into the notebook size
327 TabCtrl_AdjustRect(GetHwnd(), TRUE
, &rc
);
330 SetSize(rc
.right
- rc
.left
, rc
.bottom
- rc
.top
);
333 void wxNotebook::SetPadding(const wxSize
& padding
)
335 TabCtrl_SetPadding(GetHwnd(), padding
.x
, padding
.y
);
338 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
340 void wxNotebook::SetTabSize(const wxSize
& sz
)
342 ::SendMessage(GetHwnd(), TCM_SETITEMSIZE
, 0, MAKELPARAM(sz
.x
, sz
.y
));
345 wxSize
wxNotebook::CalcSizeFromPage(const wxSize
& sizePage
) const
347 wxSize sizeTotal
= sizePage
;
349 // We need to make getting tab size part of the wxWindows API.
350 wxSize
tabSize(0, 0);
351 if (GetPageCount() > 0)
354 TabCtrl_GetItemRect((HWND
) GetHWND(), 0, & rect
);
355 tabSize
.x
= rect
.right
- rect
.left
;
356 tabSize
.y
= rect
.bottom
- rect
.top
;
358 if ( HasFlag(wxNB_LEFT
) || HasFlag(wxNB_RIGHT
) )
360 sizeTotal
.x
+= tabSize
.x
+ 7;
366 sizeTotal
.y
+= tabSize
.y
+ 7;
372 void wxNotebook::AdjustPageSize(wxNotebookPage
*page
)
374 wxCHECK_RET( page
, _T("NULL page in wxNotebook::AdjustPageSize") );
380 // get the page size from the notebook size
381 GetSize((int *)&rc
.right
, (int *)&rc
.bottom
);
382 TabCtrl_AdjustRect(m_hwnd
, FALSE
, &rc
);
384 page
->SetSize(rc
.left
, rc
.top
, rc
.right
- rc
.left
, rc
.bottom
- rc
.top
);
387 // ----------------------------------------------------------------------------
388 // wxNotebook operations
389 // ----------------------------------------------------------------------------
391 // remove one page from the notebook, without deleting
392 wxNotebookPage
*wxNotebook::DoRemovePage(int nPage
)
394 wxNotebookPage
*pageRemoved
= wxNotebookBase::DoRemovePage(nPage
);
398 TabCtrl_DeleteItem(m_hwnd
, nPage
);
400 if ( m_pages
.IsEmpty() )
402 // no selection any more, the notebook becamse empty
405 else // notebook still not empty
407 // change the selected page if it was deleted or became invalid
409 if ( m_nSelection
== GetPageCount() )
411 // last page deleted, make the new last page the new selection
412 selNew
= m_nSelection
- 1;
414 else if ( nPage
<= m_nSelection
)
416 // we must show another page, even if it has the same index
417 selNew
= m_nSelection
;
419 else // nothing changes for the currently selected page
423 // we still must refresh the current page: this needs to be done
424 // for some unknown reason if the tab control shows the up-down
425 // control (i.e. when there are too many pages) -- otherwise after
426 // deleting a page nothing at all is shown
427 m_pages
[m_nSelection
]->Refresh();
432 // m_nSelection must be always valid so reset it before calling
435 SetSelection(selNew
);
443 bool wxNotebook::DeleteAllPages()
445 int nPageCount
= GetPageCount();
447 for ( nPage
= 0; nPage
< nPageCount
; nPage
++ )
448 delete m_pages
[nPage
];
452 TabCtrl_DeleteAllItems(m_hwnd
);
459 // same as AddPage() but does it at given position
460 bool wxNotebook::InsertPage(int nPage
,
461 wxNotebookPage
*pPage
,
462 const wxString
& strText
,
466 wxCHECK_MSG( pPage
!= NULL
, FALSE
, _T("NULL page in wxNotebook::InsertPage") );
467 wxCHECK_MSG( IS_VALID_PAGE(nPage
) || nPage
== GetPageCount(), FALSE
,
468 _T("invalid index in wxNotebook::InsertPage") );
470 wxASSERT_MSG( pPage
->GetParent() == this,
471 _T("notebook pages must have notebook as parent") );
473 #if wxUSE_UXTHEME && wxUSE_UXTHEME_AUTO
474 // Automatically apply the theme background,
475 // changing the colour of the panel to match the
476 // tab page colour. This won't work well with all
477 // themes but it's a start.
478 if (wxUxThemeEngine::Get() && pPage
->IsKindOf(CLASSINFO(wxPanel
)))
480 ApplyThemeBackground(pPage
, GetThemeBackgroundColour());
484 // add a new tab to the control
485 // ----------------------------
487 // init all fields to 0
489 wxZeroMemory(tcItem
);
491 // set the image, if any
494 tcItem
.mask
|= TCIF_IMAGE
;
495 tcItem
.iImage
= imageId
;
499 if ( !strText
.IsEmpty() )
501 tcItem
.mask
|= TCIF_TEXT
;
502 tcItem
.pszText
= (wxChar
*)strText
.c_str(); // const_cast
505 // fit the notebook page to the tab control's display area: this should be
506 // done before adding it to the notebook or TabCtrl_InsertItem() will
507 // change the notebooks size itself!
508 AdjustPageSize(pPage
);
510 // finally do insert it
511 if ( TabCtrl_InsertItem(m_hwnd
, nPage
, &tcItem
) == -1 )
513 wxLogError(wxT("Can't create the notebook page '%s'."), strText
.c_str());
518 // succeeded: save the pointer to the page
519 m_pages
.Insert(pPage
, nPage
);
521 // for the first page (only) we need to adjust the size again because the
522 // notebook size changed: the tabs which hadn't been there before are now
524 if ( m_pages
.GetCount() == 1 )
526 AdjustPageSize(pPage
);
529 // hide the page: unless it is selected, it shouldn't be shown (and if it
530 // is selected it will be shown later)
531 HWND hwnd
= GetWinHwnd(pPage
);
532 SetWindowLong(hwnd
, GWL_STYLE
, GetWindowLong(hwnd
, GWL_STYLE
) & ~WS_VISIBLE
);
534 // this updates internal flag too -- otherwise it would get out of sync
535 // with the real state
539 // now deal with the selection
540 // ---------------------------
542 // if the inserted page is before the selected one, we must update the
543 // index of the selected page
544 if ( nPage
<= m_nSelection
)
546 // one extra page added
550 // some page should be selected: either this one or the first one if there
551 // is still no selection
555 else if ( m_nSelection
== -1 )
559 SetSelection(selNew
);
564 int wxNotebook::HitTest(const wxPoint
& pt
, long *flags
) const
566 TC_HITTESTINFO hitTestInfo
;
567 hitTestInfo
.pt
.x
= pt
.x
;
568 hitTestInfo
.pt
.y
= pt
.y
;
569 int item
= TabCtrl_HitTest(GetHwnd(), &hitTestInfo
);
575 if ((hitTestInfo
.flags
& TCHT_NOWHERE
) == TCHT_NOWHERE
)
576 *flags
|= wxNB_HITTEST_NOWHERE
;
577 if ((hitTestInfo
.flags
& TCHT_ONITEM
) == TCHT_ONITEM
)
578 *flags
|= wxNB_HITTEST_ONITEM
;
579 if ((hitTestInfo
.flags
& TCHT_ONITEMICON
) == TCHT_ONITEMICON
)
580 *flags
|= wxNB_HITTEST_ONICON
;
581 if ((hitTestInfo
.flags
& TCHT_ONITEMLABEL
) == TCHT_ONITEMLABEL
)
582 *flags
|= wxNB_HITTEST_ONLABEL
;
589 // ----------------------------------------------------------------------------
590 // wxNotebook callbacks
591 // ----------------------------------------------------------------------------
593 void wxNotebook::OnSize(wxSizeEvent
& event
)
595 // fit the notebook page to the tab control's display area
597 rc
.left
= rc
.top
= 0;
598 GetSize((int *)&rc
.right
, (int *)&rc
.bottom
);
600 TabCtrl_AdjustRect(m_hwnd
, FALSE
, &rc
);
602 int width
= rc
.right
- rc
.left
,
603 height
= rc
.bottom
- rc
.top
;
604 size_t nCount
= m_pages
.Count();
605 for ( size_t nPage
= 0; nPage
< nCount
; nPage
++ ) {
606 wxNotebookPage
*pPage
= m_pages
[nPage
];
607 pPage
->SetSize(rc
.left
, rc
.top
, width
, height
);
613 void wxNotebook::OnSelChange(wxNotebookEvent
& event
)
615 // is it our tab control?
616 if ( event
.GetEventObject() == this )
618 int sel
= event
.GetOldSelection();
620 m_pages
[sel
]->Show(FALSE
);
622 sel
= event
.GetSelection();
625 wxNotebookPage
*pPage
= m_pages
[sel
];
633 // we want to give others a chance to process this message as well
637 void wxNotebook::OnSetFocus(wxFocusEvent
& event
)
639 // this function is only called when the focus is explicitly set (i.e. from
640 // the program) to the notebook - in this case we don't need the
641 // complicated OnNavigationKey() logic because the programmer knows better
644 // set focus to the currently selected page if any
645 if ( m_nSelection
!= -1 )
646 m_pages
[m_nSelection
]->SetFocus();
651 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
653 if ( event
.IsWindowChange() ) {
655 AdvanceSelection(event
.GetDirection());
658 // we get this event in 2 cases
660 // a) one of our pages might have generated it because the user TABbed
661 // out from it in which case we should propagate the event upwards and
662 // our parent will take care of setting the focus to prev/next sibling
666 // b) the parent panel wants to give the focus to us so that we
667 // forward it to our selected page. We can't deal with this in
668 // OnSetFocus() because we don't know which direction the focus came
669 // from in this case and so can't choose between setting the focus to
670 // first or last panel child
672 wxWindow
*parent
= GetParent();
673 if ( event
.GetEventObject() == parent
)
675 // no, it doesn't come from child, case (b): forward to a page
676 if ( m_nSelection
!= -1 )
678 // so that the page knows that the event comes from it's parent
679 // and is being propagated downwards
680 event
.SetEventObject(this);
682 wxWindow
*page
= m_pages
[m_nSelection
];
683 if ( !page
->GetEventHandler()->ProcessEvent(event
) )
687 //else: page manages focus inside it itself
691 // we have no pages - still have to give focus to _something_
697 // it comes from our child, case (a), pass to the parent
699 event
.SetCurrentFocus(this);
700 parent
->GetEventHandler()->ProcessEvent(event
);
706 // ----------------------------------------------------------------------------
707 // wxNotebook base class virtuals
708 // ----------------------------------------------------------------------------
710 #if wxUSE_CONSTRAINTS
712 // override these 2 functions to do nothing: everything is done in OnSize
714 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse
))
716 // don't set the sizes of the pages - their correct size is not yet known
717 wxControl::SetConstraintSizes(FALSE
);
720 bool wxNotebook::DoPhase(int WXUNUSED(nPhase
))
725 #endif // wxUSE_CONSTRAINTS
727 // ----------------------------------------------------------------------------
728 // wxNotebook Windows message handlers
729 // ----------------------------------------------------------------------------
731 bool wxNotebook::MSWOnScroll(int orientation
, WXWORD nSBCode
,
732 WXWORD pos
, WXHWND control
)
734 // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
739 return wxNotebookBase::MSWOnScroll(orientation
, nSBCode
, pos
, control
);
742 bool wxNotebook::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
* result
)
744 wxNotebookEvent
event(wxEVT_NULL
, m_windowId
);
746 NMHDR
* hdr
= (NMHDR
*)lParam
;
747 switch ( hdr
->code
) {
749 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
);
752 case TCN_SELCHANGING
:
753 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
);
757 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
760 event
.SetSelection(TabCtrl_GetCurSel(m_hwnd
));
761 event
.SetOldSelection(m_nSelection
);
762 event
.SetEventObject(this);
763 event
.SetInt(idCtrl
);
765 bool processed
= GetEventHandler()->ProcessEvent(event
);
766 *result
= !event
.IsAllowed();
770 // Windows only: attempts to get colour for UX theme page background
771 wxColour
wxNotebook::GetThemeBackgroundColour()
774 if (wxUxThemeEngine::Get())
776 WXHTHEME hTheme
= wxUxThemeEngine::Get()->m_pfnOpenThemeData(GetHWND(), L
"TAB");
779 // This is total guesswork.
780 // See PlatformSDK\Include\Tmschema.h for values
782 wxUxThemeEngine::Get()->
783 m_pfnGetThemeColor(hTheme
,
786 3821, /* FILLCOLORHINT */
789 wxUxThemeEngine::Get()->m_pfnCloseThemeData(hTheme
);
791 wxColour
colour(GetRValue(themeColor
), GetGValue(themeColor
), GetBValue(themeColor
));
796 return GetBackgroundColour();
799 // Windows only: attempts to apply the UX theme page background to this page
800 void wxNotebook::ApplyThemeBackground(wxWindow
* window
, const wxColour
& colour
)
803 // Don't set the background for buttons since this will
804 // switch it into ownerdraw mode
805 if (window
->IsKindOf(CLASSINFO(wxButton
)) && !window
->IsKindOf(CLASSINFO(wxBitmapButton
)))
806 // This is essential, otherwise you'll see dark grey
807 // corners in the buttons.
808 ((wxButton
*)window
)->wxControl::SetBackgroundColour(colour
);
809 else if (window
->IsKindOf(CLASSINFO(wxStaticText
)) ||
810 window
->IsKindOf(CLASSINFO(wxStaticBox
)) ||
811 window
->IsKindOf(CLASSINFO(wxStaticLine
)) ||
812 window
->IsKindOf(CLASSINFO(wxRadioButton
)) ||
813 window
->IsKindOf(CLASSINFO(wxRadioBox
)) ||
814 window
->IsKindOf(CLASSINFO(wxCheckBox
)) ||
815 window
->IsKindOf(CLASSINFO(wxBitmapButton
)) ||
816 window
->IsKindOf(CLASSINFO(wxSlider
)) ||
817 window
->IsKindOf(CLASSINFO(wxPanel
)) ||
818 (window
->IsKindOf(CLASSINFO(wxNotebook
)) && (window
!= this)) ||
819 window
->IsKindOf(CLASSINFO(wxScrolledWindow
))
822 window
->SetBackgroundColour(colour
);
825 for ( wxWindowList::Node
*node
= window
->GetChildren().GetFirst(); node
; node
= node
->GetNext() )
827 wxWindow
*child
= node
->GetData();
828 ApplyThemeBackground(child
, colour
);
833 #endif // wxUSE_NOTEBOOK