]> git.saurik.com Git - wxWidgets.git/blame - src/msw/notebook.cpp
Also allow key events for Shift-Tab when wxWANTS_CHARS style is used
[wxWidgets.git] / src / msw / notebook.cpp
CommitLineData
88310e2e
VZ
1///////////////////////////////////////////////////////////////////////////////
2// Name: msw/notebook.cpp
3// Purpose: implementation of wxNotebook
4// Author: Vadim Zeitlin
907f37b3 5// Modified by:
88310e2e
VZ
6// Created: 11.06.98
7// RCS-ID: $Id$
8// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
6c9a19aa 9// Licence: wxWindows licence
88310e2e
VZ
10///////////////////////////////////////////////////////////////////////////////
11
14f355c2 12#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
a3b46648 13#pragma implementation "notebook.h"
88310e2e
VZ
14#endif
15
16// For compilers that support precompilation, includes "wx.h".
17#include "wx/wxprec.h"
18
19#ifdef __BORLANDC__
1e6feb95 20 #pragma hdrstop
88310e2e
VZ
21#endif
22
1e6feb95
VZ
23#if wxUSE_NOTEBOOK
24
88310e2e
VZ
25// wxWindows
26#ifndef WX_PRECOMP
3096bd2f 27 #include "wx/string.h"
88310e2e
VZ
28#endif // WX_PRECOMP
29
3096bd2f
VZ
30#include "wx/log.h"
31#include "wx/imaglist.h"
32#include "wx/event.h"
33#include "wx/control.h"
34#include "wx/notebook.h"
04eb05b0 35#include "wx/app.h"
88310e2e 36
3096bd2f 37#include "wx/msw/private.h"
88310e2e
VZ
38
39// Windows standard headers
40#ifndef __WIN95__
2432b92d 41 #error "wxNotebook is only supported Windows 95 and above"
88310e2e
VZ
42#endif //Win95
43
aaab7c01
VZ
44#include <windowsx.h> // for SetWindowFont
45
b39dbf34
JS
46#ifdef __GNUWIN32_OLD__
47 #include "wx/msw/gnuwin32/extra.h"
65fd5cb0 48#endif
57c208c5 49
b39dbf34 50#if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
c42404a5 51 #include <commctrl.h>
88310e2e
VZ
52#endif
53
85b43fbf
JS
54#include "wx/msw/winundef.h"
55
56#if wxUSE_UXTHEME
57#include "wx/msw/uxtheme.h"
58
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"
68#include "wx/panel.h"
69#endif
70
88310e2e
VZ
71// ----------------------------------------------------------------------------
72// macros
73// ----------------------------------------------------------------------------
74
75// check that the page index is valid
8d34bf5c 76#define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
88310e2e
VZ
77
78// hide the ugly cast
79#define m_hwnd (HWND)GetHWND()
80
74b31181
VZ
81// ----------------------------------------------------------------------------
82// constants
83// ----------------------------------------------------------------------------
84
85// This is a work-around for missing defines in gcc-2.95 headers
86#ifndef TCS_RIGHT
87 #define TCS_RIGHT 0x0002
88#endif
89
90#ifndef TCS_VERTICAL
91 #define TCS_VERTICAL 0x0080
92#endif
93
94#ifndef TCS_BOTTOM
95 #define TCS_BOTTOM TCS_RIGHT
96#endif
97
88310e2e
VZ
98// ----------------------------------------------------------------------------
99// event table
100// ----------------------------------------------------------------------------
101
51741307
SC
102#include <wx/listimpl.cpp>
103
104WX_DEFINE_LIST( wxNotebookPageInfoList ) ;
105
2e4df4bf
VZ
106DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
107DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
108
d9317fd4 109BEGIN_EVENT_TABLE(wxNotebook, wxControl)
88310e2e
VZ
110 EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
111
9026ad85 112 EVT_SIZE(wxNotebook::OnSize)
42e69d6b 113
88310e2e 114 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
d9317fd4 115END_EVENT_TABLE()
88310e2e 116
51596bcb 117#if wxUSE_EXTENDED_RTTI
bc9fb572
JS
118WX_DEFINE_FLAGS( wxNotebookStyle )
119
3ff066a4 120wxBEGIN_FLAGS( wxNotebookStyle )
bc9fb572
JS
121 // new style border flags, we put them first to
122 // use them for streaming out
3ff066a4
SC
123 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
124 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
125 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
126 wxFLAGS_MEMBER(wxBORDER_RAISED)
127 wxFLAGS_MEMBER(wxBORDER_STATIC)
128 wxFLAGS_MEMBER(wxBORDER_NONE)
bc9fb572
JS
129
130 // old style border flags
3ff066a4
SC
131 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
132 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
133 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
134 wxFLAGS_MEMBER(wxRAISED_BORDER)
135 wxFLAGS_MEMBER(wxSTATIC_BORDER)
cb0afb26 136 wxFLAGS_MEMBER(wxBORDER)
bc9fb572
JS
137
138 // standard window styles
3ff066a4
SC
139 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
140 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
141 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
142 wxFLAGS_MEMBER(wxWANTS_CHARS)
cb0afb26 143 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
3ff066a4
SC
144 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
145 wxFLAGS_MEMBER(wxVSCROLL)
146 wxFLAGS_MEMBER(wxHSCROLL)
147
148 wxFLAGS_MEMBER(wxNB_FIXEDWIDTH)
149 wxFLAGS_MEMBER(wxNB_LEFT)
150 wxFLAGS_MEMBER(wxNB_RIGHT)
151 wxFLAGS_MEMBER(wxNB_BOTTOM)
152
153wxEND_FLAGS( wxNotebookStyle )
51741307 154
51596bcb 155IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebook, wxControl,"wx/notebook.h")
51741307
SC
156IMPLEMENT_DYNAMIC_CLASS_XTI(wxNotebookPageInfo, wxObject , "wx/notebook.h" )
157
3ff066a4 158wxCOLLECTION_TYPE_INFO( wxNotebookPageInfo * , wxNotebookPageInfoList ) ;
51596bcb 159
f0a126fe
SC
160template<> void wxCollectionToVariantArray( wxNotebookPageInfoList const &theList, wxxVariantArray &value)
161{
0c6b0084 162 wxListCollectionToVariantArray<wxNotebookPageInfoList::compatibility_iterator>( theList , value ) ;
f0a126fe
SC
163}
164
3ff066a4
SC
165wxBEGIN_PROPERTIES_TABLE(wxNotebook)
166 wxEVENT_PROPERTY( PageChanging , wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING , wxNotebookEvent )
167 wxEVENT_PROPERTY( PageChanged , wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED , wxNotebookEvent )
c5ca409b 168
3ff066a4
SC
169 wxPROPERTY_COLLECTION( PageInfos , wxNotebookPageInfoList , wxNotebookPageInfo* , AddPageInfo , GetPageInfos , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
170 wxPROPERTY_FLAGS( WindowStyle , wxNotebookStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
171wxEND_PROPERTIES_TABLE()
51596bcb 172
3ff066a4
SC
173wxBEGIN_HANDLERS_TABLE(wxNotebook)
174wxEND_HANDLERS_TABLE()
51596bcb 175
3ff066a4 176wxCONSTRUCTOR_5( wxNotebook , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle)
51596bcb 177
51741307 178
3ff066a4
SC
179wxBEGIN_PROPERTIES_TABLE(wxNotebookPageInfo)
180 wxREADONLY_PROPERTY( Page , wxNotebookPage* , GetPage , , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
181 wxREADONLY_PROPERTY( Text , wxString , GetText , wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
182 wxREADONLY_PROPERTY( Selected , bool , GetSelected , false, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
183 wxREADONLY_PROPERTY( ImageId , int , GetImageId , -1 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
184wxEND_PROPERTIES_TABLE()
51741307 185
3ff066a4
SC
186wxBEGIN_HANDLERS_TABLE(wxNotebookPageInfo)
187wxEND_HANDLERS_TABLE()
51741307 188
3ff066a4 189wxCONSTRUCTOR_4( wxNotebookPageInfo , wxNotebookPage* , Page , wxString , Text , bool , Selected , int , ImageId )
51741307 190
51596bcb 191#else
d9317fd4 192IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
51741307 193IMPLEMENT_DYNAMIC_CLASS(wxNotebookPageInfo, wxObject )
51596bcb 194#endif
d9317fd4 195IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
88310e2e
VZ
196
197// ============================================================================
198// implementation
199// ============================================================================
200
201// ----------------------------------------------------------------------------
202// wxNotebook construction
203// ----------------------------------------------------------------------------
204
51741307
SC
205const wxNotebookPageInfoList& wxNotebook::GetPageInfos() const
206{
207 wxNotebookPageInfoList* list = const_cast< wxNotebookPageInfoList* >( &m_pageInfos ) ;
208 WX_CLEAR_LIST( wxNotebookPageInfoList , *list ) ;
34a0c9f4 209 for( size_t i = 0 ; i < GetPageCount() ; ++i )
51741307
SC
210 {
211 wxNotebookPageInfo *info = new wxNotebookPageInfo() ;
34a0c9f4 212 info->Create( const_cast<wxNotebook*>(this)->GetPage(i) , GetPageText(i) , GetSelection() == int(i) , GetPageImage(i) ) ;
51741307
SC
213 list->Append( info ) ;
214 }
215 return m_pageInfos ;
216}
217
88310e2e
VZ
218// common part of all ctors
219void wxNotebook::Init()
220{
1e6feb95 221 m_imageList = NULL;
88310e2e
VZ
222 m_nSelection = -1;
223}
224
225// default for dynamic class
226wxNotebook::wxNotebook()
227{
228 Init();
229}
230
231// the same arguments as for wxControl
232wxNotebook::wxNotebook(wxWindow *parent,
8b9518ee 233 wxWindowID id,
88310e2e
VZ
234 const wxPoint& pos,
235 const wxSize& size,
8b9518ee 236 long style,
88310e2e
VZ
237 const wxString& name)
238{
239 Init();
240
241 Create(parent, id, pos, size, style, name);
242}
243
244// Create() function
245bool wxNotebook::Create(wxWindow *parent,
8b9518ee 246 wxWindowID id,
88310e2e
VZ
247 const wxPoint& pos,
248 const wxSize& size,
8b9518ee 249 long style,
88310e2e
VZ
250 const wxString& name)
251{
04eb05b0
JS
252 // Does ComCtl32 support non-top tabs?
253 int verComCtl32 = wxApp::GetComCtl32Version();
254 if ( verComCtl32 < 470 || verComCtl32 >= 600 )
255 {
256 if (style & wxNB_BOTTOM)
257 style &= ~wxNB_BOTTOM;
258
259 if (style & wxNB_LEFT)
260 style &= ~wxNB_LEFT;
261
262 if (style & wxNB_RIGHT)
263 style &= ~wxNB_RIGHT;
264 }
265
6dd16e4f
VZ
266 if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL,
267 wxDefaultValidator, name) )
b8bdaa7c 268 return false;
88310e2e 269
fda7962d 270 if ( !MSWCreateControl(WC_TABCONTROL, wxEmptyString, pos, size) )
b8bdaa7c 271 return false;
907f37b3 272
0df3fbd7
VZ
273 SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));
274
b8bdaa7c 275 return true;
0df3fbd7
VZ
276}
277
278WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const
279{
280 WXDWORD tabStyle = wxControl::MSWGetStyle(style, exstyle);
281
282 tabStyle |= WS_TABSTOP | TCS_TABS;
283
2b5f62a0 284 if ( style & wxNB_MULTILINE )
0df3fbd7
VZ
285 tabStyle |= TCS_MULTILINE;
286 if ( style & wxNB_FIXEDWIDTH )
287 tabStyle |= TCS_FIXEDWIDTH;
288
289 if ( style & wxNB_BOTTOM )
290 tabStyle |= TCS_RIGHT;
291 else if ( style & wxNB_LEFT )
292 tabStyle |= TCS_VERTICAL;
293 else if ( style & wxNB_RIGHT )
294 tabStyle |= TCS_VERTICAL | TCS_RIGHT;
295
296 // ex style
297 if ( exstyle )
298 {
299 // note that we never want to have the default WS_EX_CLIENTEDGE style
300 // as it looks too ugly for the notebooks
301 *exstyle = 0;
302 }
303
304 return tabStyle;
88310e2e
VZ
305}
306
88310e2e
VZ
307// ----------------------------------------------------------------------------
308// wxNotebook accessors
309// ----------------------------------------------------------------------------
07b8d7ec 310
8d34bf5c 311size_t wxNotebook::GetPageCount() const
88310e2e
VZ
312{
313 // consistency check
1e6feb95 314 wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) );
88310e2e 315
1e6feb95 316 return m_pages.Count();
88310e2e
VZ
317}
318
319int wxNotebook::GetRowCount() const
320{
321 return TabCtrl_GetRowCount(m_hwnd);
322}
323
8d34bf5c 324int wxNotebook::SetSelection(size_t nPage)
88310e2e 325{
223d09f6 326 wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
88310e2e 327
34a0c9f4 328 if ( int(nPage) != m_nSelection )
2b5f62a0
VZ
329 {
330 wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
331 event.SetSelection(nPage);
332 event.SetOldSelection(m_nSelection);
333 event.SetEventObject(this);
334 if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
335 {
336 // program allows the page change
337 event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
338 (void)GetEventHandler()->ProcessEvent(event);
339
340 TabCtrl_SetCurSel(m_hwnd, nPage);
341 }
342 }
88310e2e 343
2b5f62a0 344 return m_nSelection;
88310e2e
VZ
345}
346
8d34bf5c 347bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
88310e2e 348{
b8bdaa7c 349 wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") );
88310e2e
VZ
350
351 TC_ITEM tcItem;
352 tcItem.mask = TCIF_TEXT;
837e5743 353 tcItem.pszText = (wxChar *)strText.c_str();
88310e2e
VZ
354
355 return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
356}
357
8d34bf5c 358wxString wxNotebook::GetPageText(size_t nPage) const
88310e2e 359{
fda7962d 360 wxCHECK_MSG( IS_VALID_PAGE(nPage), wxEmptyString, wxT("notebook page out of range") );
88310e2e 361
837e5743 362 wxChar buf[256];
88310e2e
VZ
363 TC_ITEM tcItem;
364 tcItem.mask = TCIF_TEXT;
365 tcItem.pszText = buf;
366 tcItem.cchTextMax = WXSIZEOF(buf);
367
368 wxString str;
369 if ( TabCtrl_GetItem(m_hwnd, nPage, &tcItem) )
370 str = tcItem.pszText;
371
372 return str;
373}
374
8d34bf5c 375int wxNotebook::GetPageImage(size_t nPage) const
88310e2e 376{
223d09f6 377 wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
88310e2e
VZ
378
379 TC_ITEM tcItem;
380 tcItem.mask = TCIF_IMAGE;
381
382 return TabCtrl_GetItem(m_hwnd, nPage, &tcItem) ? tcItem.iImage : -1;
383}
384
8d34bf5c 385bool wxNotebook::SetPageImage(size_t nPage, int nImage)
88310e2e 386{
b8bdaa7c 387 wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("notebook page out of range") );
88310e2e
VZ
388
389 TC_ITEM tcItem;
390 tcItem.mask = TCIF_IMAGE;
391 tcItem.iImage = nImage;
392
393 return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
394}
395
396void wxNotebook::SetImageList(wxImageList* imageList)
907f37b3 397{
07b8d7ec
VZ
398 wxNotebookBase::SetImageList(imageList);
399
400 if ( imageList )
1e6feb95 401 {
07b8d7ec 402 TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
1e6feb95 403 }
b656febd
VS
404}
405
d9506e77
VZ
406// ----------------------------------------------------------------------------
407// wxNotebook size settings
408// ----------------------------------------------------------------------------
409
410void wxNotebook::SetPageSize(const wxSize& size)
411{
412 // transform the page size into the notebook size
413 RECT rc;
414 rc.left =
415 rc.top = 0;
416 rc.right = size.x;
417 rc.bottom = size.y;
418
b8bdaa7c 419 TabCtrl_AdjustRect(GetHwnd(), true, &rc);
d9506e77
VZ
420
421 // and now set it
422 SetSize(rc.right - rc.left, rc.bottom - rc.top);
423}
424
425void wxNotebook::SetPadding(const wxSize& padding)
426{
427 TabCtrl_SetPadding(GetHwnd(), padding.x, padding.y);
428}
42e69d6b
VZ
429
430// Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
431// style.
432void wxNotebook::SetTabSize(const wxSize& sz)
433{
434 ::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y));
435}
436
2ce7af35
JS
437wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const
438{
439 wxSize sizeTotal = sizePage;
440
441 // We need to make getting tab size part of the wxWindows API.
442 wxSize tabSize(0, 0);
443 if (GetPageCount() > 0)
444 {
445 RECT rect;
446 TabCtrl_GetItemRect((HWND) GetHWND(), 0, & rect);
447 tabSize.x = rect.right - rect.left;
448 tabSize.y = rect.bottom - rect.top;
449 }
450 if ( HasFlag(wxNB_LEFT) || HasFlag(wxNB_RIGHT) )
451 {
452 sizeTotal.x += tabSize.x + 7;
453 sizeTotal.y += 7;
454 }
455 else
456 {
457 sizeTotal.x += 7;
458 sizeTotal.y += tabSize.y + 7;
459 }
460
461 return sizeTotal;
462}
463
2015f2b3
VZ
464void wxNotebook::AdjustPageSize(wxNotebookPage *page)
465{
466 wxCHECK_RET( page, _T("NULL page in wxNotebook::AdjustPageSize") );
467
468 RECT rc;
469 rc.left =
470 rc.top = 0;
471
472 // get the page size from the notebook size
473 GetSize((int *)&rc.right, (int *)&rc.bottom);
b8bdaa7c 474 TabCtrl_AdjustRect(m_hwnd, false, &rc);
2015f2b3
VZ
475
476 page->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
477}
478
88310e2e
VZ
479// ----------------------------------------------------------------------------
480// wxNotebook operations
481// ----------------------------------------------------------------------------
482
621793f4 483// remove one page from the notebook, without deleting
8d34bf5c 484wxNotebookPage *wxNotebook::DoRemovePage(size_t nPage)
621793f4 485{
df7145da
VZ
486 wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage);
487 if ( !pageRemoved )
488 return NULL;
621793f4 489
df7145da 490 TabCtrl_DeleteItem(m_hwnd, nPage);
621793f4 491
df7145da
VZ
492 if ( m_pages.IsEmpty() )
493 {
494 // no selection any more, the notebook becamse empty
495 m_nSelection = -1;
496 }
497 else // notebook still not empty
498 {
623f5f70
JS
499 int selNew = TabCtrl_GetCurSel(m_hwnd);
500 if (selNew != -1)
df7145da 501 {
623f5f70
JS
502 // No selection change, just refresh the current selection.
503 // Because it could be that the slection index changed
504 // we need to update it.
505 // Note: this does not mean the selection it self changed.
506 m_nSelection = selNew;
507 m_pages[m_nSelection]->Refresh();
df7145da 508 }
623f5f70 509 else if (int(nPage) == m_nSelection)
43a997b6 510 {
623f5f70
JS
511 // The selection was deleted.
512
513 // Determine new selection.
514 if (m_nSelection == int(GetPageCount()))
515 selNew = m_nSelection - 1;
516 else
517 selNew = m_nSelection;
518
43a997b6
VZ
519 // m_nSelection must be always valid so reset it before calling
520 // SetSelection()
521 m_nSelection = -1;
522 SetSelection(selNew);
523 }
623f5f70
JS
524 else
525 {
526 wxFAIL; // Windows did not behave ok.
527 }
df7145da 528 }
47f12f58 529
df7145da 530 return pageRemoved;
621793f4
JS
531}
532
88310e2e
VZ
533// remove all pages
534bool wxNotebook::DeleteAllPages()
535{
8d34bf5c
VZ
536 size_t nPageCount = GetPageCount();
537 size_t nPage;
88310e2e 538 for ( nPage = 0; nPage < nPageCount; nPage++ )
1e6feb95 539 delete m_pages[nPage];
88310e2e 540
1e6feb95 541 m_pages.Clear();
88310e2e 542
907f37b3
VZ
543 TabCtrl_DeleteAllItems(m_hwnd);
544
47f12f58
JS
545 m_nSelection = -1;
546
b8bdaa7c 547 return true;
88310e2e
VZ
548}
549
88310e2e 550// same as AddPage() but does it at given position
8d34bf5c 551bool wxNotebook::InsertPage(size_t nPage,
88310e2e
VZ
552 wxNotebookPage *pPage,
553 const wxString& strText,
554 bool bSelect,
555 int imageId)
556{
b8bdaa7c
VZ
557 wxCHECK_MSG( pPage != NULL, false, _T("NULL page in wxNotebook::InsertPage") );
558 wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), false,
22f3361e 559 _T("invalid index in wxNotebook::InsertPage") );
88310e2e 560
efa14cf2
VZ
561 wxASSERT_MSG( pPage->GetParent() == this,
562 _T("notebook pages must have notebook as parent") );
43427087 563
85b43fbf 564#if wxUSE_UXTHEME && wxUSE_UXTHEME_AUTO
b8bdaa7c
VZ
565 static bool g_TestedForTheme = false;
566 static bool g_UseTheme = false;
c02e5a31
JS
567 if (!g_TestedForTheme)
568 {
569 int commCtrlVersion = wxTheApp->GetComCtl32Version() ;
570
571 g_UseTheme = (commCtrlVersion >= 600);
b8bdaa7c 572 g_TestedForTheme = true;
c02e5a31
JS
573 }
574
85b43fbf
JS
575 // Automatically apply the theme background,
576 // changing the colour of the panel to match the
577 // tab page colour. This won't work well with all
578 // themes but it's a start.
c02e5a31 579 if (g_UseTheme && wxUxThemeEngine::Get() && pPage->IsKindOf(CLASSINFO(wxPanel)))
85b43fbf
JS
580 {
581 ApplyThemeBackground(pPage, GetThemeBackgroundColour());
582 }
583#endif
584
22f3361e
VZ
585 // add a new tab to the control
586 // ----------------------------
58a8ab88 587
22f3361e
VZ
588 // init all fields to 0
589 TC_ITEM tcItem;
590 wxZeroMemory(tcItem);
58a8ab88 591
22f3361e
VZ
592 // set the image, if any
593 if ( imageId != -1 )
594 {
595 tcItem.mask |= TCIF_IMAGE;
596 tcItem.iImage = imageId;
597 }
88310e2e 598
22f3361e
VZ
599 // and the text
600 if ( !strText.IsEmpty() )
601 {
602 tcItem.mask |= TCIF_TEXT;
603 tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
604 }
43427087 605
22f3361e
VZ
606 // fit the notebook page to the tab control's display area: this should be
607 // done before adding it to the notebook or TabCtrl_InsertItem() will
608 // change the notebooks size itself!
2015f2b3 609 AdjustPageSize(pPage);
43427087 610
22f3361e 611 // finally do insert it
2015f2b3
VZ
612 if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 )
613 {
22f3361e 614 wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
88310e2e 615
b8bdaa7c 616 return false;
22f3361e 617 }
88310e2e 618
22f3361e
VZ
619 // succeeded: save the pointer to the page
620 m_pages.Insert(pPage, nPage);
42e69d6b 621
2015f2b3
VZ
622 // for the first page (only) we need to adjust the size again because the
623 // notebook size changed: the tabs which hadn't been there before are now
624 // shown
625 if ( m_pages.GetCount() == 1 )
626 {
627 AdjustPageSize(pPage);
628 }
629
22f3361e
VZ
630 // hide the page: unless it is selected, it shouldn't be shown (and if it
631 // is selected it will be shown later)
632 HWND hwnd = GetWinHwnd(pPage);
633 SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);
0398b1d6 634
22f3361e
VZ
635 // this updates internal flag too -- otherwise it would get out of sync
636 // with the real state
b8bdaa7c 637 pPage->Show(false);
43427087 638
96d37807 639
22f3361e
VZ
640 // now deal with the selection
641 // ---------------------------
642
643 // if the inserted page is before the selected one, we must update the
644 // index of the selected page
34a0c9f4 645 if ( int(nPage) <= m_nSelection )
22f3361e
VZ
646 {
647 // one extra page added
648 m_nSelection++;
649 }
650
651 // some page should be selected: either this one or the first one if there
652 // is still no selection
653 int selNew = -1;
654 if ( bSelect )
655 selNew = nPage;
656 else if ( m_nSelection == -1 )
657 selNew = 0;
658
659 if ( selNew != -1 )
660 SetSelection(selNew);
661
b8bdaa7c 662 return true;
88310e2e
VZ
663}
664
e450aa69 665int wxNotebook::HitTest(const wxPoint& pt, long *flags) const
ef094fa0
JS
666{
667 TC_HITTESTINFO hitTestInfo;
668 hitTestInfo.pt.x = pt.x;
669 hitTestInfo.pt.y = pt.y;
e450aa69 670 int item = TabCtrl_HitTest(GetHwnd(), &hitTestInfo);
ef094fa0 671
e450aa69
VZ
672 if ( flags )
673 {
674 *flags = 0;
675
676 if ((hitTestInfo.flags & TCHT_NOWHERE) == TCHT_NOWHERE)
677 *flags |= wxNB_HITTEST_NOWHERE;
678 if ((hitTestInfo.flags & TCHT_ONITEM) == TCHT_ONITEM)
679 *flags |= wxNB_HITTEST_ONITEM;
680 if ((hitTestInfo.flags & TCHT_ONITEMICON) == TCHT_ONITEMICON)
681 *flags |= wxNB_HITTEST_ONICON;
682 if ((hitTestInfo.flags & TCHT_ONITEMLABEL) == TCHT_ONITEMLABEL)
683 *flags |= wxNB_HITTEST_ONLABEL;
684 }
ef094fa0
JS
685
686 return item;
687}
688
e450aa69 689
88310e2e
VZ
690// ----------------------------------------------------------------------------
691// wxNotebook callbacks
692// ----------------------------------------------------------------------------
693
9026ad85 694void wxNotebook::OnSize(wxSizeEvent& event)
88310e2e 695{
b5c3b538
VZ
696 // fit the notebook page to the tab control's display area
697 RECT rc;
698 rc.left = rc.top = 0;
699 GetSize((int *)&rc.right, (int *)&rc.bottom);
700
b8bdaa7c 701 TabCtrl_AdjustRect(m_hwnd, false, &rc);
4b7f2165
VZ
702
703 int width = rc.right - rc.left,
704 height = rc.bottom - rc.top;
1e6feb95 705 size_t nCount = m_pages.Count();
c86f1403 706 for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
1e6feb95 707 wxNotebookPage *pPage = m_pages[nPage];
4b7f2165 708 pPage->SetSize(rc.left, rc.top, width, height);
b5c3b538
VZ
709 }
710
88310e2e
VZ
711 event.Skip();
712}
713
714void wxNotebook::OnSelChange(wxNotebookEvent& event)
715{
716 // is it our tab control?
717 if ( event.GetEventObject() == this )
5d1d2d46 718 {
5d1d2d46
VZ
719 int sel = event.GetOldSelection();
720 if ( sel != -1 )
b8bdaa7c 721 m_pages[sel]->Show(false);
0398b1d6 722
5d1d2d46
VZ
723 sel = event.GetSelection();
724 if ( sel != -1 )
725 {
1e6feb95 726 wxNotebookPage *pPage = m_pages[sel];
b8bdaa7c 727 pPage->Show(true);
1d5b3bf0
VZ
728 pPage->SetFocus();
729
730 // If the newly focused window is not a child of the new page,
731 // SetFocus was not successful and the notebook itself should be
732 // focused
733 wxWindow *currentFocus = FindFocus();
734 wxWindow *startFocus = currentFocus;
735 while ( currentFocus && currentFocus != pPage && currentFocus != this )
736 currentFocus = currentFocus->GetParent();
737
738 if ( startFocus == pPage || currentFocus != pPage )
739 SetFocus();
740
741 }
742 else // no pages in the notebook, give the focus to itself
743 {
744 SetFocus();
5d1d2d46 745 }
0398b1d6 746
5d1d2d46
VZ
747 m_nSelection = sel;
748 }
88310e2e
VZ
749
750 // we want to give others a chance to process this message as well
751 event.Skip();
752}
753
b8bdaa7c 754bool wxNotebook::MSWTranslateMessage(WXMSG *wxmsg)
88310e2e 755{
b8bdaa7c 756 const MSG * const msg = (MSG *)wxmsg;
88310e2e 757
1d5b3bf0
VZ
758 // intercept TAB, CTRL+TAB and CTRL+SHIFT+TAB for processing by wxNotebook.
759 // TAB will be passed to the currently selected page, CTRL+TAB and
760 // CTRL+SHIFT+TAB will be processed by the notebook itself. do not
761 // intercept SHIFT+TAB. This goes to the parent of the notebook which will
762 // process it.
b8bdaa7c
VZ
763 if ( msg->message == WM_KEYDOWN && msg->wParam == VK_TAB &&
764 msg->hwnd == m_hwnd &&
1d5b3bf0 765 (wxIsCtrlDown() || !wxIsShiftDown()) )
b8bdaa7c
VZ
766 {
767 return MSWProcessMessage(wxmsg);
768 }
d9506e77 769
b8bdaa7c 770 return false;
88310e2e
VZ
771}
772
773void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
774{
d9506e77
VZ
775 if ( event.IsWindowChange() ) {
776 // change pages
777 AdvanceSelection(event.GetDirection());
778 }
779 else {
b8bdaa7c 780 // we get this event in 3 cases
d9506e77
VZ
781 //
782 // a) one of our pages might have generated it because the user TABbed
783 // out from it in which case we should propagate the event upwards and
784 // our parent will take care of setting the focus to prev/next sibling
785 //
786 // or
787 //
788 // b) the parent panel wants to give the focus to us so that we
789 // forward it to our selected page. We can't deal with this in
790 // OnSetFocus() because we don't know which direction the focus came
791 // from in this case and so can't choose between setting the focus to
792 // first or last panel child
b8bdaa7c
VZ
793 //
794 // or
795 //
796 // c) we ourselves (see MSWTranslateMessage) generated the event
797 //
798 wxWindow * const parent = GetParent();
799
800 const bool isFromParent = event.GetEventObject() == parent;
801 const bool isFromSelf = event.GetEventObject() == this;
802
803 if ( isFromParent || isFromSelf )
d9506e77 804 {
b8bdaa7c
VZ
805 // no, it doesn't come from child, case (b) or (c): forward to a
806 // page but only if direction is backwards (TAB) or from ourselves,
807 if ( m_nSelection != -1 &&
808 (!event.GetDirection() || isFromSelf) )
d9506e77
VZ
809 {
810 // so that the page knows that the event comes from it's parent
811 // and is being propagated downwards
812 event.SetEventObject(this);
813
1e6feb95 814 wxWindow *page = m_pages[m_nSelection];
d9506e77
VZ
815 if ( !page->GetEventHandler()->ProcessEvent(event) )
816 {
817 page->SetFocus();
818 }
819 //else: page manages focus inside it itself
820 }
b8bdaa7c 821 else // otherwise set the focus to the notebook itself
d9506e77 822 {
d9506e77
VZ
823 SetFocus();
824 }
825 }
826 else
827 {
b8bdaa7c
VZ
828 // it comes from our child, case (a), pass to the parent, but only
829 // if the direction is forwards. Otherwise set the focus to the
830 // notebook itself. The notebook is always the 'first' control of a
831 // page.
832 if ( !event.GetDirection() )
833 {
834 SetFocus();
835 }
836 else if ( parent )
837 {
d9506e77
VZ
838 event.SetCurrentFocus(this);
839 parent->GetEventHandler()->ProcessEvent(event);
840 }
841 }
88310e2e 842 }
88310e2e
VZ
843}
844
845// ----------------------------------------------------------------------------
846// wxNotebook base class virtuals
847// ----------------------------------------------------------------------------
b5c3b538 848
0b481c72
VZ
849#if wxUSE_CONSTRAINTS
850
b5c3b538
VZ
851// override these 2 functions to do nothing: everything is done in OnSize
852
4b7f2165 853void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
b5c3b538
VZ
854{
855 // don't set the sizes of the pages - their correct size is not yet known
b8bdaa7c 856 wxControl::SetConstraintSizes(false);
b5c3b538
VZ
857}
858
4b7f2165 859bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
b5c3b538 860{
b8bdaa7c 861 return true;
b5c3b538
VZ
862}
863
0b481c72
VZ
864#endif // wxUSE_CONSTRAINTS
865
0df3fbd7
VZ
866// ----------------------------------------------------------------------------
867// wxNotebook Windows message handlers
868// ----------------------------------------------------------------------------
869
870bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode,
871 WXWORD pos, WXHWND control)
872{
873 // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
874 // up-down control
875 if ( control )
b8bdaa7c 876 return false;
0df3fbd7
VZ
877
878 return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
879}
880
a23fd0e1 881bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
88310e2e 882{
93a19f17 883 wxNotebookEvent event(wxEVT_NULL, m_windowId);
88310e2e
VZ
884
885 NMHDR* hdr = (NMHDR *)lParam;
886 switch ( hdr->code ) {
887 case TCN_SELCHANGE:
888 event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
889 break;
890
891 case TCN_SELCHANGING:
892 event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING);
893 break;
894
fd3f686c 895 default:
a23fd0e1 896 return wxControl::MSWOnNotify(idCtrl, lParam, result);
88310e2e
VZ
897 }
898
93a19f17
VZ
899 event.SetSelection(TabCtrl_GetCurSel(m_hwnd));
900 event.SetOldSelection(m_nSelection);
88310e2e 901 event.SetEventObject(this);
a23fd0e1 902 event.SetInt(idCtrl);
88310e2e 903
fd3f686c
VZ
904 bool processed = GetEventHandler()->ProcessEvent(event);
905 *result = !event.IsAllowed();
906 return processed;
88310e2e
VZ
907}
908
85b43fbf
JS
909// Windows only: attempts to get colour for UX theme page background
910wxColour wxNotebook::GetThemeBackgroundColour()
911{
912#if wxUSE_UXTHEME
913 if (wxUxThemeEngine::Get())
914 {
2142d7ba 915 wxUxThemeHandle hTheme(this, L"TAB");
85b43fbf
JS
916 if (hTheme)
917 {
918 // This is total guesswork.
919 // See PlatformSDK\Include\Tmschema.h for values
920 COLORREF themeColor;
2142d7ba
VZ
921 wxUxThemeEngine::Get()->GetThemeColor
922 (
923 hTheme,
924 10 /* TABP_BODY */,
925 1 /* NORMAL */,
926 3821, /* FILLCOLORHINT */
927 & themeColor
928 );
85b43fbf
JS
929
930 wxColour colour(GetRValue(themeColor), GetGValue(themeColor), GetBValue(themeColor));
931 return colour;
932 }
933 }
2142d7ba
VZ
934#endif // wxUSE_UXTHEME
935
85b43fbf
JS
936 return GetBackgroundColour();
937}
938
939// Windows only: attempts to apply the UX theme page background to this page
840015f0 940#if wxUSE_UXTHEME
85b43fbf 941void wxNotebook::ApplyThemeBackground(wxWindow* window, const wxColour& colour)
840015f0
MB
942#else
943void wxNotebook::ApplyThemeBackground(wxWindow*, const wxColour&)
944#endif
85b43fbf
JS
945{
946#if wxUSE_UXTHEME
947 // Don't set the background for buttons since this will
948 // switch it into ownerdraw mode
949 if (window->IsKindOf(CLASSINFO(wxButton)) && !window->IsKindOf(CLASSINFO(wxBitmapButton)))
950 // This is essential, otherwise you'll see dark grey
951 // corners in the buttons.
952 ((wxButton*)window)->wxControl::SetBackgroundColour(colour);
953 else if (window->IsKindOf(CLASSINFO(wxStaticText)) ||
954 window->IsKindOf(CLASSINFO(wxStaticBox)) ||
955 window->IsKindOf(CLASSINFO(wxStaticLine)) ||
956 window->IsKindOf(CLASSINFO(wxRadioButton)) ||
957 window->IsKindOf(CLASSINFO(wxRadioBox)) ||
958 window->IsKindOf(CLASSINFO(wxCheckBox)) ||
959 window->IsKindOf(CLASSINFO(wxBitmapButton)) ||
960 window->IsKindOf(CLASSINFO(wxSlider)) ||
961 window->IsKindOf(CLASSINFO(wxPanel)) ||
962 (window->IsKindOf(CLASSINFO(wxNotebook)) && (window != this)) ||
963 window->IsKindOf(CLASSINFO(wxScrolledWindow))
964 )
965 {
966 window->SetBackgroundColour(colour);
967 }
968
fc10daf3 969 for ( wxWindowList::compatibility_iterator node = window->GetChildren().GetFirst(); node; node = node->GetNext() )
85b43fbf
JS
970 {
971 wxWindow *child = node->GetData();
972 ApplyThemeBackground(child, colour);
973 }
974#endif
975}
976
ffafd8a5 977#if wxUSE_UXTHEME
c02e5a31
JS
978long wxNotebook::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
979{
b8bdaa7c 980 static bool g_TestedForTheme = false;
ffafd8a5 981 static bool g_supportsThemes = false;
c02e5a31
JS
982 switch ( nMsg )
983 {
984 case WM_ERASEBKGND:
985 {
986 if (!g_TestedForTheme)
987 {
988 int commCtrlVersion = wxTheApp->GetComCtl32Version() ;
989
ffafd8a5 990 g_supportsThemes = (commCtrlVersion >= 600);
b8bdaa7c 991 g_TestedForTheme = true;
c02e5a31
JS
992 }
993
ffafd8a5 994 // If currently an XP theme is active, it seems we can get away
c02e5a31 995 // with not drawing a background, which reduces flicker.
ffafd8a5
DS
996 if (g_supportsThemes)
997 {
998 wxUxThemeEngine *p = wxUxThemeEngine::Get();
999 if (p && p->IsThemeActive() )
1000 {
1001 return true;
1002 }
1003 }
c02e5a31
JS
1004 }
1005 }
1006
1007 return wxControl::MSWWindowProc(nMsg, wParam, lParam);
1008}
ffafd8a5 1009#endif // #if wxUSE_UXTHEME
c02e5a31 1010
1e6feb95 1011#endif // wxUSE_NOTEBOOK