1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/notebook.cpp
3 // Purpose: generic implementation of wxNotebook
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #include "wx/notebook.h"
32 #include "wx/string.h"
34 #include "wx/dcclient.h"
35 #include "wx/settings.h"
38 #include "wx/generic/imaglist.h"
39 #include "wx/generic/tabg.h"
41 // ----------------------------------------------------------------------------
43 // ----------------------------------------------------------------------------
45 // check that the page index is valid
46 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
48 // ----------------------------------------------------------------------------
50 // ----------------------------------------------------------------------------
52 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
)
53 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
)
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
)
64 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
, wxControl
)
65 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent
, wxCommandEvent
)
67 // ============================================================================
69 // ============================================================================
71 // ============================================================================
73 // ============================================================================
75 WX_DECLARE_HASH_MAP(int, wxNotebookPage
*, wxIntegerHash
, wxIntegerEqual
,
76 wxIntToNotebookPageHashMap
);
78 WX_DECLARE_HASH_MAP(wxNotebookPage
*, int, wxPointerHash
, wxPointerEqual
,
79 wxNotebookPageToIntHashMap
);
81 // This reuses wxTabView to draw the tabs.
82 class WXDLLEXPORT wxNotebookTabView
: public wxTabView
84 DECLARE_DYNAMIC_CLASS(wxNotebookTabView
)
86 wxNotebookTabView(wxNotebook
* notebook
, long style
= wxTAB_STYLE_DRAW_BOX
| wxTAB_STYLE_COLOUR_INTERIOR
);
87 ~wxNotebookTabView(void);
89 // Called when a tab is activated
90 virtual void OnTabActivate(int activateId
, int deactivateId
);
92 virtual bool OnTabPreActivate(int activateId
, int deactivateId
);
94 // map integer ids used by wxTabView to wxNotebookPage pointers
95 int GetId(wxNotebookPage
*page
);
96 wxNotebookPage
*GetPage(int id
) { return m_idToPage
[id
]; }
99 wxNotebook
* m_notebook
;
102 wxIntToNotebookPageHashMap m_idToPage
;
103 wxNotebookPageToIntHashMap m_pageToId
;
107 static int GetPageId(wxTabView
*tabview
, wxNotebookPage
*page
)
109 return wx_static_cast(wxNotebookTabView
*, tabview
)->GetId(page
);
112 // ----------------------------------------------------------------------------
113 // wxNotebook construction
114 // ----------------------------------------------------------------------------
116 // common part of all ctors
117 void wxNotebook::Init()
119 m_tabView
= (wxNotebookTabView
*) NULL
;
123 // default for dynamic class
124 wxNotebook::wxNotebook()
129 // the same arguments as for wxControl
130 wxNotebook::wxNotebook(wxWindow
*parent
,
135 const wxString
& name
)
139 Create(parent
, id
, pos
, size
, style
, name
);
143 bool wxNotebook::Create(wxWindow
*parent
,
148 const wxString
& name
)
153 if ( (style
& wxBK_ALIGN_MASK
) == wxBK_DEFAULT
)
156 m_windowId
= id
== wxID_ANY
? NewControlId() : id
;
158 if (!wxControl::Create(parent
, id
, pos
, size
, style
|wxNO_BORDER
, wxDefaultValidator
, name
))
161 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
));
163 SetTabView(new wxNotebookTabView(this));
169 wxNotebook::~wxNotebook()
174 // ----------------------------------------------------------------------------
175 // wxNotebook accessors
176 // ----------------------------------------------------------------------------
177 int wxNotebook::GetRowCount() const
183 int wxNotebook::SetSelection(size_t nPage
)
185 wxASSERT( IS_VALID_PAGE(nPage
) );
187 wxNotebookPage
* pPage
= GetPage(nPage
);
189 m_tabView
->SetTabSelection(GetPageId(m_tabView
, pPage
));
196 void wxNotebook::AdvanceSelection(bool bForward
)
198 int nSel
= GetSelection();
199 int nMax
= GetPageCount() - 1;
201 SetSelection(nSel
== nMax
? 0 : nSel
+ 1);
203 SetSelection(nSel
== 0 ? nMax
: nSel
- 1);
207 bool wxNotebook::SetPageText(size_t nPage
, const wxString
& strText
)
209 wxASSERT( IS_VALID_PAGE(nPage
) );
211 wxNotebookPage
* page
= GetPage(nPage
);
214 m_tabView
->SetTabText(GetPageId(m_tabView
, page
), strText
);
222 wxString
wxNotebook::GetPageText(size_t nPage
) const
224 wxASSERT( IS_VALID_PAGE(nPage
) );
226 wxNotebookPage
* page
= ((wxNotebook
*)this)->GetPage(nPage
);
228 return m_tabView
->GetTabText(GetPageId(m_tabView
, page
));
230 return wxEmptyString
;
233 int wxNotebook::GetPageImage(size_t WXUNUSED_UNLESS_DEBUG(nPage
)) const
235 wxASSERT( IS_VALID_PAGE(nPage
) );
241 bool wxNotebook::SetPageImage(size_t WXUNUSED_UNLESS_DEBUG(nPage
),
242 int WXUNUSED(nImage
))
244 wxASSERT( IS_VALID_PAGE(nPage
) );
250 // set the size (the same for all pages)
251 void wxNotebook::SetPageSize(const wxSize
& WXUNUSED(size
))
256 // set the padding between tabs (in pixels)
257 void wxNotebook::SetPadding(const wxSize
& WXUNUSED(padding
))
262 // set the size of the tabs for wxNB_FIXEDWIDTH controls
263 void wxNotebook::SetTabSize(const wxSize
& WXUNUSED(sz
))
268 // ----------------------------------------------------------------------------
269 // wxNotebook operations
270 // ----------------------------------------------------------------------------
272 // remove one page from the notebook and delete it
273 bool wxNotebook::DeletePage(size_t nPage
)
275 wxCHECK( IS_VALID_PAGE(nPage
), false );
277 if (m_nSelection
!= -1)
279 m_pages
[m_nSelection
]->Show(false);
280 m_pages
[m_nSelection
]->Lower();
283 wxNotebookPage
* pPage
= GetPage(nPage
);
285 m_tabView
->RemoveTab(GetPageId(m_tabView
, pPage
));
287 m_pages
.Remove(pPage
);
290 if (m_pages
.GetCount() == 0)
293 m_tabView
->SetTabSelection(-1, false);
295 else if (m_nSelection
> -1)
299 m_tabView
->SetTabSelection(GetPageId(m_tabView
, GetPage(0)), false);
301 if (m_nSelection
!= 0)
305 RefreshLayout(false);
310 bool wxNotebook::DeletePage(wxNotebookPage
* page
)
312 int pagePos
= FindPagePosition(page
);
314 return DeletePage(pagePos
);
319 bool wxNotebook::RemovePage(size_t nPage
)
321 return DoRemovePage(nPage
) != NULL
;
324 // remove one page from the notebook
325 wxWindow
* wxNotebook::DoRemovePage(size_t nPage
)
327 wxCHECK( IS_VALID_PAGE(nPage
), NULL
);
329 m_pages
[nPage
]->Show(false);
330 // m_pages[nPage]->Lower();
332 wxNotebookPage
* pPage
= GetPage(nPage
);
334 m_tabView
->RemoveTab(GetPageId(m_tabView
, pPage
));
336 m_pages
.Remove(pPage
);
338 if (m_pages
.GetCount() == 0)
341 m_tabView
->SetTabSelection(-1, true);
343 else if (m_nSelection
> -1)
345 // Only change the selection if the page we
346 // deleted was the selection.
347 if (nPage
== (size_t)m_nSelection
)
350 // Select the first tab. Generates a ChangePage.
351 m_tabView
->SetTabSelection(0, true);
355 // We must adjust which tab we think is selected.
356 // If greater than the page we deleted, it must be moved down
358 if (size_t(m_nSelection
) > nPage
)
363 RefreshLayout(false);
368 bool wxNotebook::RemovePage(wxNotebookPage
* page
)
370 int pagePos
= FindPagePosition(page
);
372 return RemovePage(pagePos
);
377 // Find the position of the wxNotebookPage, -1 if not found.
378 int wxNotebook::FindPagePosition(wxNotebookPage
* page
) const
380 size_t nPageCount
= GetPageCount();
382 for ( nPage
= 0; nPage
< nPageCount
; nPage
++ )
383 if (m_pages
[nPage
] == page
)
389 bool wxNotebook::DeleteAllPages()
391 m_tabView
->ClearTabs(true);
393 size_t nPageCount
= GetPageCount();
395 for ( nPage
= 0; nPage
< nPageCount
; nPage
++ )
396 delete m_pages
[nPage
];
403 // same as AddPage() but does it at given position
404 bool wxNotebook::InsertPage(size_t nPage
,
405 wxNotebookPage
*pPage
,
406 const wxString
& strText
,
408 int WXUNUSED(imageId
))
410 wxASSERT( pPage
!= NULL
);
411 wxCHECK( IS_VALID_PAGE(nPage
) || nPage
== GetPageCount(), false );
413 m_tabView
->AddTab(GetPageId(m_tabView
, pPage
), strText
);
418 // save the pointer to the page
419 m_pages
.Insert(pPage
, nPage
);
423 // This will cause ChangePage to be called, via OnSelPage
425 m_tabView
->SetTabSelection(GetPageId(m_tabView
, pPage
), true);
428 // some page must be selected: either this one or the first one if there is
429 // still no selection
430 if ( m_nSelection
== -1 )
433 RefreshLayout(false);
438 // ----------------------------------------------------------------------------
439 // wxNotebook callbacks
440 // ----------------------------------------------------------------------------
442 // @@@ OnSize() is used for setting the font when it's called for the first
443 // time because doing it in ::Create() doesn't work (for unknown reasons)
444 void wxNotebook::OnSize(wxSizeEvent
& event
)
446 static bool s_bFirstTime
= true;
447 if ( s_bFirstTime
) {
448 // TODO: any first-time-size processing.
449 s_bFirstTime
= false;
454 // Processing continues to next OnSize
458 // This was supposed to cure the non-display of the notebook
459 // until the user resizes the window.
461 void wxNotebook::OnInternalIdle()
463 wxWindow::OnInternalIdle();
466 static bool s_bFirstTime
= true;
467 if ( s_bFirstTime
) {
469 wxSize sz(GetSize());
477 wxSize sz(GetSize());
478 wxSizeEvent sizeEvent(sz, GetId());
479 sizeEvent.SetEventObject(this);
480 GetEventHandler()->ProcessEvent(sizeEvent);
483 s_bFirstTime
= false;
488 // Implementation: calculate the layout of the view rect
489 // and resize the children if required
490 bool wxNotebook::RefreshLayout(bool force
)
494 wxRect oldRect
= m_tabView
->GetViewRect();
497 GetClientSize(& cw
, & ch
);
499 int tabHeight
= m_tabView
->GetTotalTabHeight();
502 rect
.y
= tabHeight
+ 4;
504 rect
.height
= ch
- 4 - rect
.y
;
506 m_tabView
->SetViewRect(rect
);
508 m_tabView
->LayoutTabs();
510 // Need to do it a 2nd time to get the tab height with
511 // the new view width, since changing the view width changes the
513 tabHeight
= m_tabView
->GetTotalTabHeight();
515 rect
.y
= tabHeight
+ 4;
517 rect
.height
= ch
- 4 - rect
.y
;
519 m_tabView
->SetViewRect(rect
);
521 m_tabView
->LayoutTabs();
523 if (!force
&& (rect
== oldRect
))
526 // fit the notebook page to the tab control's display area
528 size_t nCount
= m_pages
.Count();
529 for ( size_t nPage
= 0; nPage
< nCount
; nPage
++ ) {
530 wxNotebookPage
*pPage
= m_pages
[nPage
];
531 wxRect clientRect
= GetAvailableClientSize();
532 if (pPage
->IsShown())
534 pPage
->SetSize(clientRect
.x
, clientRect
.y
, clientRect
.width
, clientRect
.height
);
535 if ( pPage
->GetAutoLayout() )
544 void wxNotebook::OnSelChange(wxNotebookEvent
& event
)
546 // is it our tab control?
547 if ( event
.GetEventObject() == this )
549 if (event
.GetSelection() != m_nSelection
)
550 ChangePage(event
.GetOldSelection(), event
.GetSelection());
553 // we want to give others a chance to process this message as well
557 void wxNotebook::OnSetFocus(wxFocusEvent
& event
)
559 // set focus to the currently selected page if any
560 if ( m_nSelection
!= -1 )
561 m_pages
[m_nSelection
]->SetFocus();
566 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
568 if ( event
.IsWindowChange() ) {
570 AdvanceSelection(event
.GetDirection());
573 // pass to the parent
575 event
.SetCurrentFocus(this);
576 GetParent()->ProcessEvent(event
);
581 // ----------------------------------------------------------------------------
582 // wxNotebook base class virtuals
583 // ----------------------------------------------------------------------------
585 // override these 2 functions to do nothing: everything is done in OnSize
587 void wxNotebook::SetConstraintSizes(bool /* recurse */)
589 // don't set the sizes of the pages - their correct size is not yet known
590 wxControl::SetConstraintSizes(false);
593 bool wxNotebook::DoPhase(int /* nPhase */)
598 void wxNotebook::Command(wxCommandEvent
& WXUNUSED(event
))
600 wxFAIL_MSG(wxT("wxNotebook::Command not implemented"));
603 // ----------------------------------------------------------------------------
604 // wxNotebook helper functions
605 // ----------------------------------------------------------------------------
607 // hide the currently active panel and show the new one
608 void wxNotebook::ChangePage(int nOldSel
, int nSel
)
610 // cout << "ChangePage: " << nOldSel << ", " << nSel << "\n";
611 wxASSERT( nOldSel
!= nSel
); // impossible
613 if ( nOldSel
!= -1 ) {
614 m_pages
[nOldSel
]->Show(false);
615 m_pages
[nOldSel
]->Lower();
618 wxNotebookPage
*pPage
= m_pages
[nSel
];
620 wxRect clientRect
= GetAvailableClientSize();
621 pPage
->SetSize(clientRect
.x
, clientRect
.y
, clientRect
.width
, clientRect
.height
);
632 void wxNotebook::OnMouseEvent(wxMouseEvent
& event
)
635 m_tabView
->OnEvent(event
);
638 void wxNotebook::OnPaint(wxPaintEvent
& WXUNUSED(event
) )
645 wxSize
wxNotebook::CalcSizeFromPage(const wxSize
& sizePage
) const
647 // MBN: since the total tab height is really a function of the
648 // width, this should really call
649 // GetTotalTabHeightPretendingWidthIs(), but the current
650 // implementation will suffice, provided the wxNotebook has been
651 // created with a sensible initial width.
652 return wxSize( sizePage
.x
+ 12,
653 sizePage
.y
+ m_tabView
->GetTotalTabHeight() + 6 + 4 );
656 wxRect
wxNotebook::GetAvailableClientSize()
659 GetClientSize(& cw
, & ch
);
661 int tabHeight
= m_tabView
->GetTotalTabHeight();
663 // TODO: these margins should be configurable.
666 rect
.y
= tabHeight
+ 6;
667 rect
.width
= cw
- 12;
668 rect
.height
= ch
- 4 - rect
.y
;
677 IMPLEMENT_CLASS(wxNotebookTabView
, wxTabView
)
679 wxNotebookTabView::wxNotebookTabView(wxNotebook
*notebook
, long style
)
680 : wxTabView(style
), m_nextid(1)
682 m_notebook
= notebook
;
684 m_notebook
->SetTabView(this);
686 SetWindow(m_notebook
);
689 wxNotebookTabView::~wxNotebookTabView(void)
693 int wxNotebookTabView::GetId(wxNotebookPage
*page
)
695 int& id
= m_pageToId
[page
];
700 m_idToPage
[id
] = page
;
706 // Called when a tab is activated
707 void wxNotebookTabView::OnTabActivate(int activateId
, int deactivateId
)
712 wxNotebookEvent
event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
, m_notebook
->GetId());
714 // Translate from wxTabView's ids (which aren't position-dependent)
715 // to wxNotebook's (which are).
716 wxNotebookPage
* pActive
= GetPage(activateId
);
717 wxNotebookPage
* pDeactive
= GetPage(deactivateId
);
719 int activatePos
= m_notebook
->FindPagePosition(pActive
);
720 int deactivatePos
= m_notebook
->FindPagePosition(pDeactive
);
722 event
.SetEventObject(m_notebook
);
723 event
.SetSelection(activatePos
);
724 event
.SetOldSelection(deactivatePos
);
725 m_notebook
->GetEventHandler()->ProcessEvent(event
);
729 bool wxNotebookTabView::OnTabPreActivate(int activateId
, int deactivateId
)
735 wxNotebookEvent
event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
, m_notebook
->GetId());
737 // Translate from wxTabView's ids (which aren't position-dependent)
738 // to wxNotebook's (which are).
739 wxNotebookPage
* pActive
= GetPage(activateId
);
740 wxNotebookPage
* pDeactive
= GetPage(deactivateId
);
742 int activatePos
= m_notebook
->FindPagePosition(pActive
);
743 int deactivatePos
= m_notebook
->FindPagePosition(pDeactive
);
745 event
.SetEventObject(m_notebook
);
746 event
.SetSelection(activatePos
);
747 event
.SetOldSelection(deactivatePos
);
748 if (m_notebook
->GetEventHandler()->ProcessEvent(event
))
750 retval
= event
.IsAllowed();
756 #endif // wxUSE_NOTEBOOK