1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: implementation of wxNotebook
4 // Author: Stefan Csomor
8 // Copyright: (c) Stefan Csomor
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #include "wx/string.h"
22 #include "wx/imaglist.h"
24 #include "wx/notebook.h"
25 #include "wx/mac/uma.h"
26 // ----------------------------------------------------------------------------
28 // ----------------------------------------------------------------------------
30 // check that the page index is valid
31 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
34 // ----------------------------------------------------------------------------
36 // ----------------------------------------------------------------------------
38 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
)
39 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
)
41 BEGIN_EVENT_TABLE(wxNotebook
, wxControl
)
42 EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange
)
43 EVT_MOUSE_EVENTS(wxNotebook::OnMouse
)
45 EVT_SIZE(wxNotebook::OnSize
)
46 EVT_SET_FOCUS(wxNotebook::OnSetFocus
)
47 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
50 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
, wxControl
)
51 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent
, wxCommandEvent
)
53 // ============================================================================
55 // ============================================================================
57 // The Appearance Manager docs show using tab controls in either edge to edge
58 // mode, or inset. I think edge to edge conforms better to the other ports,
59 // and inset mode is better accomplished with space around the wxNotebook rather
60 // than within it. --Robin
62 // CS : had to switch off tight spacing due to 10.3 problems
63 #define wxMAC_EDGE_TO_EDGE 0
65 static inline int wxMacTabMargin(long nbStyle
, long side
)
67 static int tabMargin
= -1;
68 static int otherMargin
= -1;
72 if ( UMAHasAquaLayout() )
74 tabMargin
= 26; // From Appearance Manager docs for small tab control dimensions
75 #if wxMAC_EDGE_TO_EDGE
79 // JACS - this seems fine on 10.3; 20 is way too much
86 #if wxMAC_EDGE_TO_EDGE
94 // If the style matches the side asked for then return the tab margin,
95 // but we have to special case wxNB_TOP since it is zero...
96 if ( side
== wxNB_TOP
)
98 if ( nbStyle
!= 0 && nbStyle
& (wxNB_LEFT
|wxNB_RIGHT
|wxNB_BOTTOM
))
107 else if ( nbStyle
& side
)
113 static inline int wxMacTabLeftMargin(long style
)
115 return wxMacTabMargin(style
, wxNB_LEFT
);
118 static inline int wxMacTabTopMargin(long style
)
120 return wxMacTabMargin(style
, wxNB_TOP
);
123 static inline int wxMacTabRightMargin(long style
)
125 return wxMacTabMargin(style
, wxNB_RIGHT
);
128 static inline int wxMacTabBottomMargin(long style
)
130 return wxMacTabMargin(style
, wxNB_BOTTOM
);
133 // ----------------------------------------------------------------------------
134 // wxNotebook construction
135 // ----------------------------------------------------------------------------
137 // common part of all ctors
138 void wxNotebook::Init()
140 if ( UMAHasAquaLayout() )
142 // Should these depend on wxMAC_EDGE_TO_EDGE too?
143 m_macHorizontalBorder
= 7;
144 m_macVerticalBorder
= 8;
150 // default for dynamic class
151 wxNotebook::wxNotebook()
156 // the same arguments as for wxControl
157 wxNotebook::wxNotebook(wxWindow
*parent
,
162 const wxString
& name
)
166 Create(parent
, id
, pos
, size
, style
, name
);
170 bool wxNotebook::Create(wxWindow
*parent
,
175 const wxString
& name
)
177 if ( !wxNotebookBase::Create(parent
, id
, pos
, size
, style
, name
) )
183 MacPreControlCreate( parent
, id
, wxEmptyString
, pos
, size
,style
, wxDefaultValidator
, name
, &bounds
, title
) ;
185 int tabstyle
= kControlTabSmallNorthProc
;
186 if ( HasFlag(wxNB_LEFT
) )
187 tabstyle
= kControlTabSmallWestProc
;
188 else if ( HasFlag( wxNB_RIGHT
) )
189 tabstyle
= kControlTabSmallEastProc
;
190 else if ( HasFlag( wxNB_BOTTOM
) )
191 tabstyle
= kControlTabSmallSouthProc
;
194 m_macControl
= (WXWidget
) ::NewControl( MAC_WXHWND(parent
->MacGetRootWindow()) , &bounds
, title
, false , 0 , 0 , 1,
195 tabstyle
, (long) this ) ;
197 MacPostControlCreate() ;
202 wxNotebook::~wxNotebook()
206 // ----------------------------------------------------------------------------
207 // wxNotebook accessors
208 // ----------------------------------------------------------------------------
210 void wxNotebook::SetPadding(const wxSize
& padding
)
215 void wxNotebook::SetTabSize(const wxSize
& sz
)
220 void wxNotebook::SetPageSize(const wxSize
& size
)
222 SetSize( CalcSizeFromPage( size
) );
225 wxSize
wxNotebook::CalcSizeFromPage(const wxSize
& sizePage
) const
227 wxSize sizeTotal
= sizePage
;
228 sizeTotal
.x
+= 2 * m_macHorizontalBorder
+ wxMacTabLeftMargin(GetWindowStyle()) +
229 wxMacTabRightMargin(GetWindowStyle()) ;
230 sizeTotal
.y
+= 2 * m_macVerticalBorder
+ wxMacTabTopMargin(GetWindowStyle()) +
231 wxMacTabBottomMargin(GetWindowStyle()) ;
236 wxSize
wxNotebook::DoGetBestSize() const
238 // calculate the max page size
241 size_t count
= GetPageCount();
244 for ( size_t n
= 0; n
< count
; n
++ )
246 wxSize sizePage
= m_pages
[n
]->GetSize();
248 if ( size
.x
< sizePage
.x
)
250 if ( size
.y
< sizePage
.y
)
256 // use some arbitrary default size
261 return CalcSizeFromPage(size
);
264 int wxNotebook::SetSelection(size_t nPage
)
266 wxCHECK_MSG( IS_VALID_PAGE(nPage
), -1, wxT("notebook page out of range") );
268 if ( int(nPage
) != m_nSelection
)
270 wxNotebookEvent
event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
, m_windowId
);
271 event
.SetSelection(nPage
);
272 event
.SetOldSelection(m_nSelection
);
273 event
.SetEventObject(this);
274 if ( !GetEventHandler()->ProcessEvent(event
) || event
.IsAllowed() )
276 // program allows the page change
277 event
.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
);
278 (void)GetEventHandler()->ProcessEvent(event
);
280 ChangePage(m_nSelection
, nPage
);
287 bool wxNotebook::SetPageText(size_t nPage
, const wxString
& strText
)
289 wxASSERT( IS_VALID_PAGE(nPage
) );
291 wxNotebookPage
*page
= m_pages
[nPage
];
292 page
->SetLabel(strText
);
298 wxString
wxNotebook::GetPageText(size_t nPage
) const
300 wxASSERT( IS_VALID_PAGE(nPage
) );
302 wxNotebookPage
*page
= m_pages
[nPage
];
303 return page
->GetLabel();
306 int wxNotebook::GetPageImage(size_t nPage
) const
308 wxCHECK_MSG( IS_VALID_PAGE(nPage
), -1, _T("invalid notebook page") );
310 return m_images
[nPage
];
313 bool wxNotebook::SetPageImage(size_t nPage
, int nImage
)
315 wxCHECK_MSG( IS_VALID_PAGE(nPage
), FALSE
, _T("invalid notebook page") );
317 wxCHECK_MSG( m_imageList
&& nImage
< m_imageList
->GetImageCount(), FALSE
,
318 _T("invalid image index in SetPageImage()") );
320 if ( nImage
!= m_images
[nPage
] )
322 // if the item didn't have an icon before or, on the contrary, did have
323 // it but has lost it now, its size will change - but if the icon just
325 m_images
[nPage
] = nImage
;
333 // ----------------------------------------------------------------------------
334 // wxNotebook operations
335 // ----------------------------------------------------------------------------
337 // remove one page from the notebook, without deleting the window
338 wxNotebookPage
* wxNotebook::DoRemovePage(size_t nPage
)
340 wxCHECK( IS_VALID_PAGE(nPage
), NULL
);
341 wxNotebookPage
* page
= m_pages
[nPage
] ;
342 m_pages
.RemoveAt(nPage
);
346 if(m_nSelection
>= (int)GetPageCount()) {
347 m_nSelection
= GetPageCount() - 1;
349 if(m_nSelection
>= 0) {
350 m_pages
[m_nSelection
]->Show(true);
352 InvalidateBestSize();
357 bool wxNotebook::DeleteAllPages()
359 WX_CLEAR_ARRAY(m_pages
) ;
362 InvalidateBestSize();
367 // same as AddPage() but does it at given position
368 bool wxNotebook::InsertPage(size_t nPage
,
369 wxNotebookPage
*pPage
,
370 const wxString
& strText
,
374 if ( !wxNotebookBase::InsertPage(nPage
, pPage
, strText
, bSelect
, imageId
) )
377 wxASSERT_MSG( pPage
->GetParent() == this,
378 _T("notebook pages must have notebook as parent") );
380 // don't show pages by default (we'll need to adjust their size first)
381 pPage
->Show( false ) ;
383 pPage
->SetLabel(strText
);
385 m_images
.Insert(imageId
, nPage
);
389 wxRect rect
= GetPageRect() ;
390 pPage
->SetSize(rect
);
391 if ( pPage
->GetAutoLayout() ) {
396 // now deal with the selection
397 // ---------------------------
399 // if the inserted page is before the selected one, we must update the
400 // index of the selected page
402 if ( int(nPage
) <= m_nSelection
)
405 // while this still is the same page showing, we need to update the tabs
406 SetControl32BitValue( (ControlHandle
) m_macControl
, m_nSelection
+ 1 ) ;
409 // some page should be selected: either this one or the first one if there
410 // is still no selection
414 else if ( m_nSelection
== -1 )
418 SetSelection(selNew
);
420 InvalidateBestSize();
424 /* Added by Mark Newsam
425 * When a page is added or deleted to the notebook this function updates
426 * information held in the m_macControl so that it matches the order
427 * the user would expect.
429 void wxNotebook::MacSetupTabs()
431 SetControl32BitMaximum( (ControlHandle
) m_macControl
, GetPageCount() ) ;
433 wxNotebookPage
*page
;
434 ControlTabInfoRec info
;
436 const size_t countPages
= GetPageCount();
437 for(size_t ii
= 0; ii
< countPages
; ii
++)
441 info
.iconSuiteID
= 0;
442 wxMacStringToPascal( page
->GetLabel() , info
.name
) ;
444 SetControlData( (ControlHandle
) m_macControl
, ii
+1, kControlTabInfoTag
,
445 sizeof( ControlTabInfoRec
) , (char*) &info
) ;
446 SetTabEnabled( (ControlHandle
) m_macControl
, ii
+1 , true ) ;
448 if ( GetImageList() && GetPageImage(ii
) >= 0 && UMAGetSystemVersion() >= 0x1020 )
450 // tab controls only support very specific types of images, therefore we are doing an odyssee
451 // accross the icon worlds (even Apple DTS did not find a shorter path)
452 // in order not to pollute the icon registry we put every icon into (OSType) 1 and immediately
453 // afterwards Unregister it (IconRef is ref counted, so it will stay on the tab even if we
454 // unregister it) in case this will ever lead to having the same icon everywhere add some kind
456 const wxBitmap
* bmap
= GetImageList()->GetBitmapPtr( GetPageImage(ii
) ) ;
459 wxBitmap scaledBitmap
;
460 if ( bmap
->GetWidth() != 16 || bmap
->GetHeight() != 16 )
462 scaledBitmap
= wxBitmap( bmap
->ConvertToImage().Scale(16,16) ) ;
463 bmap
= &scaledBitmap
;
465 ControlButtonContentInfo info
;
466 wxMacCreateBitmapButton( &info
, *bmap
, kControlContentPictHandle
) ;
467 IconFamilyHandle iconFamily
= (IconFamilyHandle
) NewHandle(0) ;
468 OSErr err
= SetIconFamilyData( iconFamily
, 'PICT' , (Handle
) info
.u
.picture
) ;
469 wxASSERT_MSG( err
== noErr
, wxT("Error when adding bitmap") ) ;
471 err
= RegisterIconRefFromIconFamily( 'WXNG' , (OSType
) 1, iconFamily
, &iconRef
) ;
472 wxASSERT_MSG( err
== noErr
, wxT("Error when adding bitmap") ) ;
473 info
.contentType
= kControlContentIconRef
;
474 info
.u
.iconRef
= iconRef
;
475 SetControlData( (ControlHandle
) m_macControl
, ii
+1,kControlTabImageContentTag
,
476 sizeof( info
), (Ptr
)&info
);
477 wxASSERT_MSG( err
== noErr
, wxT("Error when setting icon on tab") ) ;
478 if ( UMAGetSystemVersion() < 0x1030 )
480 UnregisterIconRef( 'WXNG' , (OSType
) 1 ) ;
483 ReleaseIconRef( iconRef
) ;
484 DisposeHandle( (Handle
) iconFamily
) ;
490 GetControlBounds((ControlHandle
)m_macControl
, &bounds
);
491 InvalWindowRect((WindowRef
)MacGetRootWindow(), &bounds
);
494 wxRect
wxNotebook::GetPageRect() const
496 // fit the notebook page to the tab control's display area
501 wxMacTabLeftMargin(GetWindowStyle()) + m_macHorizontalBorder
,
502 wxMacTabTopMargin(GetWindowStyle()) + m_macVerticalBorder
,
503 w
- wxMacTabLeftMargin(GetWindowStyle()) - wxMacTabRightMargin(GetWindowStyle()) - 2*m_macHorizontalBorder
,
504 h
- wxMacTabTopMargin(GetWindowStyle()) - wxMacTabBottomMargin(GetWindowStyle()) - 2*m_macVerticalBorder
);
506 // ----------------------------------------------------------------------------
507 // wxNotebook callbacks
508 // ----------------------------------------------------------------------------
510 // @@@ OnSize() is used for setting the font when it's called for the first
511 // time because doing it in ::Create() doesn't work (for unknown reasons)
512 void wxNotebook::OnSize(wxSizeEvent
& event
)
515 unsigned int nCount
= m_pages
.Count();
516 wxRect rect
= GetPageRect() ;
517 for ( unsigned int nPage
= 0; nPage
< nCount
; nPage
++ ) {
518 wxNotebookPage
*pPage
= m_pages
[nPage
];
519 pPage
->SetSize(rect
);
520 if ( pPage
->GetAutoLayout() ) {
525 // Processing continues to next OnSize
529 void wxNotebook::OnSelChange(wxNotebookEvent
& event
)
531 // is it our tab control?
532 if ( event
.GetEventObject() == this )
533 ChangePage(event
.GetOldSelection(), event
.GetSelection());
535 // we want to give others a chance to process this message as well
539 void wxNotebook::OnSetFocus(wxFocusEvent
& event
)
541 // set focus to the currently selected page if any
542 if ( m_nSelection
!= -1 )
543 m_pages
[m_nSelection
]->SetFocus();
548 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
550 if ( event
.IsWindowChange() ) {
552 AdvanceSelection(event
.GetDirection());
555 // we get this event in 2 cases
557 // a) one of our pages might have generated it because the user TABbed
558 // out from it in which case we should propagate the event upwards and
559 // our parent will take care of setting the focus to prev/next sibling
563 // b) the parent panel wants to give the focus to us so that we
564 // forward it to our selected page. We can't deal with this in
565 // OnSetFocus() because we don't know which direction the focus came
566 // from in this case and so can't choose between setting the focus to
567 // first or last panel child
568 wxWindow
*parent
= GetParent();
569 // the cast is here to fic a GCC ICE
570 if ( ((wxWindow
*)event
.GetEventObject()) == parent
)
572 // no, it doesn't come from child, case (b): forward to a page
573 if ( m_nSelection
!= -1 )
575 // so that the page knows that the event comes from it's parent
576 // and is being propagated downwards
577 event
.SetEventObject(this);
579 wxWindow
*page
= m_pages
[m_nSelection
];
580 if ( !page
->GetEventHandler()->ProcessEvent(event
) )
584 //else: page manages focus inside it itself
588 // we have no pages - still have to give focus to _something_
594 // it comes from our child, case (a), pass to the parent
596 event
.SetCurrentFocus(this);
597 parent
->GetEventHandler()->ProcessEvent(event
);
603 // ----------------------------------------------------------------------------
604 // wxNotebook base class virtuals
605 // ----------------------------------------------------------------------------
607 #if wxUSE_CONSTRAINTS
609 // override these 2 functions to do nothing: everything is done in OnSize
611 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse
))
613 // don't set the sizes of the pages - their correct size is not yet known
614 wxControl::SetConstraintSizes(FALSE
);
617 bool wxNotebook::DoPhase(int WXUNUSED(nPhase
))
622 #endif // wxUSE_CONSTRAINTS
624 void wxNotebook::Command(wxCommandEvent
& event
)
626 wxFAIL_MSG(wxT("wxNotebook::Command not implemented"));
629 // ----------------------------------------------------------------------------
630 // wxNotebook helper functions
631 // ----------------------------------------------------------------------------
633 // hide the currently active panel and show the new one
634 void wxNotebook::ChangePage(int nOldSel
, int nSel
)
638 m_pages
[nOldSel
]->Show(FALSE
);
643 wxNotebookPage
*pPage
= m_pages
[nSel
];
649 SetControl32BitValue( (ControlHandle
) m_macControl
, m_nSelection
+ 1 ) ;
653 void wxNotebook::OnMouse( wxMouseEvent
&event
)
655 if ( (ControlHandle
) m_macControl
== NULL
)
661 if (event
.GetEventType() == wxEVT_LEFT_DOWN
|| event
.GetEventType() == wxEVT_LEFT_DCLICK
)
666 MacClientToRootWindow( &x
, &y
) ;
668 ControlHandle control
;
677 if ( !event
.m_leftDown
&& !event
.m_rightDown
)
678 modifiers
|= btnState
;
680 if ( event
.m_shiftDown
)
681 modifiers
|= shiftKey
;
683 if ( event
.m_controlDown
)
684 modifiers
|= controlKey
;
686 if ( event
.m_altDown
)
687 modifiers
|= optionKey
;
689 if ( event
.m_metaDown
)
690 modifiers
|= cmdKey
;
692 control
= (ControlHandle
) m_macControl
;
693 if ( control
&& ::IsControlActive( control
) )
696 wxNotebookEvent
changing(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
, m_windowId
,
697 ::GetControl32BitValue(control
) - 1, m_nSelection
);
698 changing
.SetEventObject(this);
699 GetEventHandler()->ProcessEvent(changing
);
701 if(changing
.IsAllowed())
703 controlpart
= ::HandleControlClick(control
, localwhere
, modifiers
,
704 (ControlActionUPP
) -1);
705 wxTheApp
->s_lastMouseDown
= 0 ;
707 wxNotebookEvent
event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
, m_windowId
,
708 ::GetControl32BitValue(control
) - 1, m_nSelection
);
709 event
.SetEventObject(this);
711 GetEventHandler()->ProcessEvent(event
);
719 void wxNotebook::MacHandleControlClick( WXWidget control
, wxInt16 controlpart
, bool WXUNUSED( mouseStillDown
) )
722 wxNotebookEvent
event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
, m_windowId
, ::GetControl32BitValue((ControlHandle
)m_macControl
) - 1, m_nSelection
);
723 event
.SetEventObject(this);