]> git.saurik.com Git - wxWidgets.git/blob - src/generic/notebook.cpp
added wxListCtrl::GetSubItemRect() and subitem hit testing (patch 1476971)
[wxWidgets.git] / src / generic / notebook.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/notebook.cpp
3 // Purpose: generic implementation of wxNotebook
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 17/09/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #if wxUSE_NOTEBOOK
28
29 #include "wx/notebook.h"
30
31 #ifndef WX_PRECOMP
32 #include "wx/string.h"
33 #include "wx/log.h"
34 #include "wx/dcclient.h"
35 #include "wx/settings.h"
36 #endif
37
38 #include "wx/generic/imaglist.h"
39 #include "wx/generic/tabg.h"
40
41 // ----------------------------------------------------------------------------
42 // macros
43 // ----------------------------------------------------------------------------
44
45 // check that the page index is valid
46 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
47
48 // ----------------------------------------------------------------------------
49 // event table
50 // ----------------------------------------------------------------------------
51
52 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
53 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
54
55 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
56 EVT_NOTEBOOK_PAGE_CHANGED(wxID_ANY, wxNotebook::OnSelChange)
57 EVT_SIZE(wxNotebook::OnSize)
58 EVT_PAINT(wxNotebook::OnPaint)
59 EVT_MOUSE_EVENTS(wxNotebook::OnMouseEvent)
60 EVT_SET_FOCUS(wxNotebook::OnSetFocus)
61 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
62 END_EVENT_TABLE()
63
64 IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
65 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxCommandEvent)
66
67 // ============================================================================
68 // implementation
69 // ============================================================================
70
71 // ============================================================================
72 // Private class
73 // ============================================================================
74
75 WX_DECLARE_HASH_MAP(int, wxNotebookPage*, wxIntegerHash, wxIntegerEqual,
76 wxIntToNotebookPageHashMap);
77
78 WX_DECLARE_HASH_MAP(wxNotebookPage*, int, wxPointerHash, wxPointerEqual,
79 wxNotebookPageToIntHashMap);
80
81 // This reuses wxTabView to draw the tabs.
82 class WXDLLEXPORT wxNotebookTabView: public wxTabView
83 {
84 DECLARE_DYNAMIC_CLASS(wxNotebookTabView)
85 public:
86 wxNotebookTabView(wxNotebook* notebook, long style = wxTAB_STYLE_DRAW_BOX | wxTAB_STYLE_COLOUR_INTERIOR);
87 ~wxNotebookTabView(void);
88
89 // Called when a tab is activated
90 virtual void OnTabActivate(int activateId, int deactivateId);
91 // Allows vetoing
92 virtual bool OnTabPreActivate(int activateId, int deactivateId);
93
94 // map integer ids used by wxTabView to wxNotebookPage pointers
95 int GetId(wxNotebookPage *page);
96 wxNotebookPage *GetPage(int id) { return m_idToPage[id]; }
97
98 protected:
99 wxNotebook* m_notebook;
100
101 private:
102 wxIntToNotebookPageHashMap m_idToPage;
103 wxNotebookPageToIntHashMap m_pageToId;
104 int m_nextid;
105 };
106
107 static int GetPageId(wxTabView *tabview, wxNotebookPage *page)
108 {
109 return wx_static_cast(wxNotebookTabView*, tabview)->GetId(page);
110 }
111
112 // ----------------------------------------------------------------------------
113 // wxNotebook construction
114 // ----------------------------------------------------------------------------
115
116 // common part of all ctors
117 void wxNotebook::Init()
118 {
119 m_tabView = (wxNotebookTabView*) NULL;
120 m_nSelection = -1;
121 }
122
123 // default for dynamic class
124 wxNotebook::wxNotebook()
125 {
126 Init();
127 }
128
129 // the same arguments as for wxControl
130 wxNotebook::wxNotebook(wxWindow *parent,
131 wxWindowID id,
132 const wxPoint& pos,
133 const wxSize& size,
134 long style,
135 const wxString& name)
136 {
137 Init();
138
139 Create(parent, id, pos, size, style, name);
140 }
141
142 // Create() function
143 bool wxNotebook::Create(wxWindow *parent,
144 wxWindowID id,
145 const wxPoint& pos,
146 const wxSize& size,
147 long style,
148 const wxString& name)
149 {
150 // base init
151 SetName(name);
152
153 m_windowId = id == wxID_ANY ? NewControlId() : id;
154
155 if (!wxControl::Create(parent, id, pos, size, style|wxNO_BORDER, wxDefaultValidator, name))
156 return false;
157
158 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
159
160 SetTabView(new wxNotebookTabView(this));
161
162 return true;
163 }
164
165 // dtor
166 wxNotebook::~wxNotebook()
167 {
168 delete m_tabView;
169 }
170
171 // ----------------------------------------------------------------------------
172 // wxNotebook accessors
173 // ----------------------------------------------------------------------------
174 int wxNotebook::GetRowCount() const
175 {
176 // TODO
177 return 0;
178 }
179
180 int wxNotebook::SetSelection(size_t nPage)
181 {
182 wxASSERT( IS_VALID_PAGE(nPage) );
183
184 wxNotebookPage* pPage = GetPage(nPage);
185
186 m_tabView->SetTabSelection(GetPageId(m_tabView, pPage));
187
188 // TODO
189 return 0;
190 }
191
192 #if 0
193 void wxNotebook::AdvanceSelection(bool bForward)
194 {
195 int nSel = GetSelection();
196 int nMax = GetPageCount() - 1;
197 if ( bForward )
198 SetSelection(nSel == nMax ? 0 : nSel + 1);
199 else
200 SetSelection(nSel == 0 ? nMax : nSel - 1);
201 }
202 #endif
203
204 bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
205 {
206 wxASSERT( IS_VALID_PAGE(nPage) );
207
208 wxNotebookPage* page = GetPage(nPage);
209 if (page)
210 {
211 m_tabView->SetTabText(GetPageId(m_tabView, page), strText);
212 Refresh();
213 return true;
214 }
215
216 return false;
217 }
218
219 wxString wxNotebook::GetPageText(size_t nPage) const
220 {
221 wxASSERT( IS_VALID_PAGE(nPage) );
222
223 wxNotebookPage* page = ((wxNotebook*)this)->GetPage(nPage);
224 if (page)
225 return m_tabView->GetTabText(GetPageId(m_tabView, page));
226 else
227 return wxEmptyString;
228 }
229
230 int wxNotebook::GetPageImage(size_t WXUNUSED_UNLESS_DEBUG(nPage)) const
231 {
232 wxASSERT( IS_VALID_PAGE(nPage) );
233
234 // TODO
235 return 0;
236 }
237
238 bool wxNotebook::SetPageImage(size_t WXUNUSED_UNLESS_DEBUG(nPage),
239 int WXUNUSED(nImage))
240 {
241 wxASSERT( IS_VALID_PAGE(nPage) );
242
243 // TODO
244 return false;
245 }
246
247 // set the size (the same for all pages)
248 void wxNotebook::SetPageSize(const wxSize& WXUNUSED(size))
249 {
250 // TODO
251 }
252
253 // set the padding between tabs (in pixels)
254 void wxNotebook::SetPadding(const wxSize& WXUNUSED(padding))
255 {
256 // TODO
257 }
258
259 // set the size of the tabs for wxNB_FIXEDWIDTH controls
260 void wxNotebook::SetTabSize(const wxSize& WXUNUSED(sz))
261 {
262 // TODO
263 }
264
265 // ----------------------------------------------------------------------------
266 // wxNotebook operations
267 // ----------------------------------------------------------------------------
268
269 // remove one page from the notebook and delete it
270 bool wxNotebook::DeletePage(size_t nPage)
271 {
272 wxCHECK( IS_VALID_PAGE(nPage), false );
273
274 if (m_nSelection != -1)
275 {
276 m_pages[m_nSelection]->Show(false);
277 m_pages[m_nSelection]->Lower();
278 }
279
280 wxNotebookPage* pPage = GetPage(nPage);
281
282 m_tabView->RemoveTab(GetPageId(m_tabView, pPage));
283
284 m_pages.Remove(pPage);
285 delete pPage;
286
287 if (m_pages.GetCount() == 0)
288 {
289 m_nSelection = -1;
290 m_tabView->SetTabSelection(-1, false);
291 }
292 else if (m_nSelection > -1)
293 {
294 m_nSelection = -1;
295
296 m_tabView->SetTabSelection(GetPageId(m_tabView, GetPage(0)), false);
297
298 if (m_nSelection != 0)
299 ChangePage(-1, 0);
300 }
301
302 RefreshLayout(false);
303
304 return true;
305 }
306
307 bool wxNotebook::DeletePage(wxNotebookPage* page)
308 {
309 int pagePos = FindPagePosition(page);
310 if (pagePos > -1)
311 return DeletePage(pagePos);
312 else
313 return false;
314 }
315
316 bool wxNotebook::RemovePage(size_t nPage)
317 {
318 return DoRemovePage(nPage) != NULL;
319 }
320
321 // remove one page from the notebook
322 wxWindow* wxNotebook::DoRemovePage(size_t nPage)
323 {
324 wxCHECK( IS_VALID_PAGE(nPage), NULL );
325
326 m_pages[nPage]->Show(false);
327 // m_pages[nPage]->Lower();
328
329 wxNotebookPage* pPage = GetPage(nPage);
330
331 m_tabView->RemoveTab(GetPageId(m_tabView, pPage));
332
333 m_pages.Remove(pPage);
334
335 if (m_pages.GetCount() == 0)
336 {
337 m_nSelection = -1;
338 m_tabView->SetTabSelection(-1, true);
339 }
340 else if (m_nSelection > -1)
341 {
342 // Only change the selection if the page we
343 // deleted was the selection.
344 if (nPage == (size_t)m_nSelection)
345 {
346 m_nSelection = -1;
347 // Select the first tab. Generates a ChangePage.
348 m_tabView->SetTabSelection(0, true);
349 }
350 else
351 {
352 // We must adjust which tab we think is selected.
353 // If greater than the page we deleted, it must be moved down
354 // a notch.
355 if (size_t(m_nSelection) > nPage)
356 m_nSelection -- ;
357 }
358 }
359
360 RefreshLayout(false);
361
362 return pPage;
363 }
364
365 bool wxNotebook::RemovePage(wxNotebookPage* page)
366 {
367 int pagePos = FindPagePosition(page);
368 if (pagePos > -1)
369 return RemovePage(pagePos);
370 else
371 return false;
372 }
373
374 // Find the position of the wxNotebookPage, -1 if not found.
375 int wxNotebook::FindPagePosition(wxNotebookPage* page) const
376 {
377 size_t nPageCount = GetPageCount();
378 size_t nPage;
379 for ( nPage = 0; nPage < nPageCount; nPage++ )
380 if (m_pages[nPage] == page)
381 return nPage;
382 return -1;
383 }
384
385 // remove all pages
386 bool wxNotebook::DeleteAllPages()
387 {
388 m_tabView->ClearTabs(true);
389
390 size_t nPageCount = GetPageCount();
391 size_t nPage;
392 for ( nPage = 0; nPage < nPageCount; nPage++ )
393 delete m_pages[nPage];
394
395 m_pages.Clear();
396
397 return true;
398 }
399
400 // same as AddPage() but does it at given position
401 bool wxNotebook::InsertPage(size_t nPage,
402 wxNotebookPage *pPage,
403 const wxString& strText,
404 bool bSelect,
405 int WXUNUSED(imageId))
406 {
407 wxASSERT( pPage != NULL );
408 wxCHECK( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), false );
409
410 m_tabView->AddTab(GetPageId(m_tabView, pPage), strText);
411
412 if (!bSelect)
413 pPage->Show(false);
414
415 // save the pointer to the page
416 m_pages.Insert(pPage, nPage);
417
418 if (bSelect)
419 {
420 // This will cause ChangePage to be called, via OnSelPage
421
422 m_tabView->SetTabSelection(GetPageId(m_tabView, pPage), true);
423 }
424
425 // some page must be selected: either this one or the first one if there is
426 // still no selection
427 if ( m_nSelection == -1 )
428 ChangePage(-1, 0);
429
430 RefreshLayout(false);
431
432 return true;
433 }
434
435 // ----------------------------------------------------------------------------
436 // wxNotebook callbacks
437 // ----------------------------------------------------------------------------
438
439 // @@@ OnSize() is used for setting the font when it's called for the first
440 // time because doing it in ::Create() doesn't work (for unknown reasons)
441 void wxNotebook::OnSize(wxSizeEvent& event)
442 {
443 static bool s_bFirstTime = true;
444 if ( s_bFirstTime ) {
445 // TODO: any first-time-size processing.
446 s_bFirstTime = false;
447 }
448
449 RefreshLayout();
450
451 // Processing continues to next OnSize
452 event.Skip();
453 }
454
455 // This was supposed to cure the non-display of the notebook
456 // until the user resizes the window.
457 // What's going on?
458 void wxNotebook::OnInternalIdle()
459 {
460 wxWindow::OnInternalIdle();
461
462 #if 0
463 static bool s_bFirstTime = true;
464 if ( s_bFirstTime ) {
465 /*
466 wxSize sz(GetSize());
467 sz.x ++;
468 SetSize(sz);
469 sz.x --;
470 SetSize(sz);
471 */
472
473 /*
474 wxSize sz(GetSize());
475 wxSizeEvent sizeEvent(sz, GetId());
476 sizeEvent.SetEventObject(this);
477 GetEventHandler()->ProcessEvent(sizeEvent);
478 Refresh();
479 */
480 s_bFirstTime = false;
481 }
482 #endif
483 }
484
485 // Implementation: calculate the layout of the view rect
486 // and resize the children if required
487 bool wxNotebook::RefreshLayout(bool force)
488 {
489 if (m_tabView)
490 {
491 wxRect oldRect = m_tabView->GetViewRect();
492
493 int cw, ch;
494 GetClientSize(& cw, & ch);
495
496 int tabHeight = m_tabView->GetTotalTabHeight();
497 wxRect rect;
498 rect.x = 4;
499 rect.y = tabHeight + 4;
500 rect.width = cw - 8;
501 rect.height = ch - 4 - rect.y ;
502
503 m_tabView->SetViewRect(rect);
504
505 m_tabView->LayoutTabs();
506
507 // Need to do it a 2nd time to get the tab height with
508 // the new view width, since changing the view width changes the
509 // tab layout.
510 tabHeight = m_tabView->GetTotalTabHeight();
511 rect.x = 4;
512 rect.y = tabHeight + 4;
513 rect.width = cw - 8;
514 rect.height = ch - 4 - rect.y ;
515
516 m_tabView->SetViewRect(rect);
517
518 m_tabView->LayoutTabs();
519
520 if (!force && (rect == oldRect))
521 return false;
522
523 // fit the notebook page to the tab control's display area
524
525 size_t nCount = m_pages.Count();
526 for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
527 wxNotebookPage *pPage = m_pages[nPage];
528 wxRect clientRect = GetAvailableClientSize();
529 if (pPage->IsShown())
530 {
531 pPage->SetSize(clientRect.x, clientRect.y, clientRect.width, clientRect.height);
532 if ( pPage->GetAutoLayout() )
533 pPage->Layout();
534 }
535 }
536 Refresh();
537 }
538 return true;
539 }
540
541 void wxNotebook::OnSelChange(wxNotebookEvent& event)
542 {
543 // is it our tab control?
544 if ( event.GetEventObject() == this )
545 {
546 if (event.GetSelection() != m_nSelection)
547 ChangePage(event.GetOldSelection(), event.GetSelection());
548 }
549
550 // we want to give others a chance to process this message as well
551 event.Skip();
552 }
553
554 void wxNotebook::OnSetFocus(wxFocusEvent& event)
555 {
556 // set focus to the currently selected page if any
557 if ( m_nSelection != -1 )
558 m_pages[m_nSelection]->SetFocus();
559
560 event.Skip();
561 }
562
563 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
564 {
565 if ( event.IsWindowChange() ) {
566 // change pages
567 AdvanceSelection(event.GetDirection());
568 }
569 else {
570 // pass to the parent
571 if ( GetParent() ) {
572 event.SetCurrentFocus(this);
573 GetParent()->ProcessEvent(event);
574 }
575 }
576 }
577
578 // ----------------------------------------------------------------------------
579 // wxNotebook base class virtuals
580 // ----------------------------------------------------------------------------
581
582 // override these 2 functions to do nothing: everything is done in OnSize
583
584 void wxNotebook::SetConstraintSizes(bool /* recurse */)
585 {
586 // don't set the sizes of the pages - their correct size is not yet known
587 wxControl::SetConstraintSizes(false);
588 }
589
590 bool wxNotebook::DoPhase(int /* nPhase */)
591 {
592 return true;
593 }
594
595 void wxNotebook::Command(wxCommandEvent& WXUNUSED(event))
596 {
597 wxFAIL_MSG(wxT("wxNotebook::Command not implemented"));
598 }
599
600 // ----------------------------------------------------------------------------
601 // wxNotebook helper functions
602 // ----------------------------------------------------------------------------
603
604 // hide the currently active panel and show the new one
605 void wxNotebook::ChangePage(int nOldSel, int nSel)
606 {
607 // cout << "ChangePage: " << nOldSel << ", " << nSel << "\n";
608 wxASSERT( nOldSel != nSel ); // impossible
609
610 if ( nOldSel != -1 ) {
611 m_pages[nOldSel]->Show(false);
612 m_pages[nOldSel]->Lower();
613 }
614
615 wxNotebookPage *pPage = m_pages[nSel];
616
617 wxRect clientRect = GetAvailableClientSize();
618 pPage->SetSize(clientRect.x, clientRect.y, clientRect.width, clientRect.height);
619
620 Refresh();
621
622 pPage->Show(true);
623 pPage->Raise();
624 pPage->SetFocus();
625
626 m_nSelection = nSel;
627 }
628
629 void wxNotebook::OnMouseEvent(wxMouseEvent& event)
630 {
631 if (m_tabView)
632 m_tabView->OnEvent(event);
633 }
634
635 void wxNotebook::OnPaint(wxPaintEvent& WXUNUSED(event) )
636 {
637 wxPaintDC dc(this);
638 if (m_tabView)
639 m_tabView->Draw(dc);
640 }
641
642 wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const
643 {
644 // MBN: since the total tab height is really a function of the
645 // width, this should really call
646 // GetTotalTabHeightPretendingWidthIs(), but the current
647 // implementation will suffice, provided the wxNotebook has been
648 // created with a sensible initial width.
649 return wxSize( sizePage.x + 12,
650 sizePage.y + m_tabView->GetTotalTabHeight() + 6 + 4 );
651 }
652
653 wxRect wxNotebook::GetAvailableClientSize()
654 {
655 int cw, ch;
656 GetClientSize(& cw, & ch);
657
658 int tabHeight = m_tabView->GetTotalTabHeight();
659
660 // TODO: these margins should be configurable.
661 wxRect rect;
662 rect.x = 6;
663 rect.y = tabHeight + 6;
664 rect.width = cw - 12;
665 rect.height = ch - 4 - rect.y ;
666
667 return rect;
668 }
669
670 /*
671 * wxNotebookTabView
672 */
673
674 IMPLEMENT_CLASS(wxNotebookTabView, wxTabView)
675
676 wxNotebookTabView::wxNotebookTabView(wxNotebook *notebook, long style)
677 : wxTabView(style), m_nextid(1)
678 {
679 m_notebook = notebook;
680
681 m_notebook->SetTabView(this);
682
683 SetWindow(m_notebook);
684 }
685
686 wxNotebookTabView::~wxNotebookTabView(void)
687 {
688 }
689
690 int wxNotebookTabView::GetId(wxNotebookPage *page)
691 {
692 int& id = m_pageToId[page];
693
694 if (!id)
695 {
696 id = m_nextid++;
697 m_idToPage[id] = page;
698 }
699
700 return id;
701 }
702
703 // Called when a tab is activated
704 void wxNotebookTabView::OnTabActivate(int activateId, int deactivateId)
705 {
706 if (!m_notebook)
707 return;
708
709 wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, m_notebook->GetId());
710
711 // Translate from wxTabView's ids (which aren't position-dependent)
712 // to wxNotebook's (which are).
713 wxNotebookPage* pActive = GetPage(activateId);
714 wxNotebookPage* pDeactive = GetPage(deactivateId);
715
716 int activatePos = m_notebook->FindPagePosition(pActive);
717 int deactivatePos = m_notebook->FindPagePosition(pDeactive);
718
719 event.SetEventObject(m_notebook);
720 event.SetSelection(activatePos);
721 event.SetOldSelection(deactivatePos);
722 m_notebook->GetEventHandler()->ProcessEvent(event);
723 }
724
725 // Allows Vetoing
726 bool wxNotebookTabView::OnTabPreActivate(int activateId, int deactivateId)
727 {
728 bool retval = true;
729
730 if (m_notebook)
731 {
732 wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_notebook->GetId());
733
734 // Translate from wxTabView's ids (which aren't position-dependent)
735 // to wxNotebook's (which are).
736 wxNotebookPage* pActive = GetPage(activateId);
737 wxNotebookPage* pDeactive = GetPage(deactivateId);
738
739 int activatePos = m_notebook->FindPagePosition(pActive);
740 int deactivatePos = m_notebook->FindPagePosition(pDeactive);
741
742 event.SetEventObject(m_notebook);
743 event.SetSelection(activatePos);
744 event.SetOldSelection(deactivatePos);
745 if (m_notebook->GetEventHandler()->ProcessEvent(event))
746 {
747 retval = event.IsAllowed();
748 }
749 }
750 return retval;
751 }
752
753 #endif // wxUSE_NOTEBOOK