]> git.saurik.com Git - wxWidgets.git/blob - src/mac/notebmac.cpp
attempt to tame composite data objects
[wxWidgets.git] / src / mac / notebmac.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: notebook.cpp
3 // Purpose: implementation of wxNotebook
4 // Author: Stefan Csomor
5 // Modified by:
6 // Created: 1998-01-01
7 // RCS-ID: $Id$
8 // Copyright: (c) Stefan Csomor
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifdef __GNUG__
13 #pragma implementation "notebook.h"
14 #endif
15
16 // ============================================================================
17 // declarations
18 // ============================================================================
19
20 // ----------------------------------------------------------------------------
21 // headers
22 // ----------------------------------------------------------------------------
23 #include "wx/app.h"
24 #include "wx/string.h"
25 #include "wx/log.h"
26 #include "wx/imaglist.h"
27 #include "wx/image.h"
28 #include "wx/notebook.h"
29 #include "wx/mac/uma.h"
30 // ----------------------------------------------------------------------------
31 // macros
32 // ----------------------------------------------------------------------------
33
34 // check that the page index is valid
35 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
36
37
38 // ----------------------------------------------------------------------------
39 // event table
40 // ----------------------------------------------------------------------------
41
42 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
43 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
44
45 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
46 EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
47 EVT_MOUSE_EVENTS(wxNotebook::OnMouse)
48
49 EVT_SIZE(wxNotebook::OnSize)
50 EVT_SET_FOCUS(wxNotebook::OnSetFocus)
51 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
52 END_EVENT_TABLE()
53
54 IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
55 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxCommandEvent)
56
57 // ============================================================================
58 // implementation
59 // ============================================================================
60
61 // The Appearance Manager docs show using tab controls in either edge to edge
62 // mode, or inset. I think edge to edge conforms better to the other ports,
63 // and inset mode is better accomplished with space around the wxNotebook rather
64 // than within it. --Robin
65
66 // CS : had to switch off tight spacing due to 10.3 problems
67 #define wxMAC_EDGE_TO_EDGE 0
68
69 static inline int wxMacTabMargin(long nbStyle, long side)
70 {
71 static int tabMargin = -1;
72 static int otherMargin = -1;
73
74 if ( tabMargin == -1)
75 {
76 if ( UMAHasAquaLayout() )
77 {
78 tabMargin = 26; // From Appearance Manager docs for small tab control dimensions
79 #if wxMAC_EDGE_TO_EDGE
80 otherMargin = 0;
81 #else
82 otherMargin = 20;
83 #endif
84 }
85 else
86 {
87 tabMargin = 30;
88 #if wxMAC_EDGE_TO_EDGE
89 otherMargin = 0;
90 #else
91 otherMargin = 16;
92 #endif
93 }
94 }
95
96 // If the style matches the side asked for then return the tab margin,
97 // but we have to special case wxNB_TOP since it is zero...
98 if ( side == wxNB_TOP)
99 {
100 if ( nbStyle != 0 && nbStyle & (wxNB_LEFT|wxNB_RIGHT|wxNB_BOTTOM))
101 {
102 return otherMargin;
103 }
104 else
105 {
106 return tabMargin;
107 }
108 }
109 else if ( nbStyle & side)
110 return tabMargin;
111 else
112 return otherMargin;
113 }
114
115 static inline int wxMacTabLeftMargin(long style)
116 {
117 return wxMacTabMargin(style, wxNB_LEFT);
118 }
119
120 static inline int wxMacTabTopMargin(long style)
121 {
122 return wxMacTabMargin(style, wxNB_TOP);
123 }
124
125 static inline int wxMacTabRightMargin(long style)
126 {
127 return wxMacTabMargin(style, wxNB_RIGHT);
128 }
129
130 static inline int wxMacTabBottomMargin(long style)
131 {
132 return wxMacTabMargin(style, wxNB_BOTTOM);
133 }
134
135 // ----------------------------------------------------------------------------
136 // wxNotebook construction
137 // ----------------------------------------------------------------------------
138
139 // common part of all ctors
140 void wxNotebook::Init()
141 {
142 if ( UMAHasAquaLayout() )
143 {
144 // Should these depend on wxMAC_EDGE_TO_EDGE too?
145 m_macHorizontalBorder = 7;
146 m_macVerticalBorder = 8;
147 }
148
149 m_nSelection = -1;
150 }
151
152 // default for dynamic class
153 wxNotebook::wxNotebook()
154 {
155 Init();
156 }
157
158 // the same arguments as for wxControl
159 wxNotebook::wxNotebook(wxWindow *parent,
160 wxWindowID id,
161 const wxPoint& pos,
162 const wxSize& size,
163 long style,
164 const wxString& name)
165 {
166 Init();
167
168 Create(parent, id, pos, size, style, name);
169 }
170
171 // Create() function
172 bool wxNotebook::Create(wxWindow *parent,
173 wxWindowID id,
174 const wxPoint& pos,
175 const wxSize& size,
176 long style,
177 const wxString& name)
178 {
179 if ( !wxNotebookBase::Create(parent, id, pos, size, style, name) )
180 return false;
181
182 Rect bounds ;
183 Str255 title ;
184
185 MacPreControlCreate( parent , id , wxEmptyString , pos , size ,style, wxDefaultValidator , name , &bounds , title ) ;
186
187 int tabstyle = kControlTabSmallNorthProc ;
188 if ( HasFlag(wxNB_LEFT) )
189 tabstyle = kControlTabSmallWestProc ;
190 else if ( HasFlag( wxNB_RIGHT ) )
191 tabstyle = kControlTabSmallEastProc ;
192 else if ( HasFlag( wxNB_BOTTOM ) )
193 tabstyle = kControlTabSmallSouthProc ;
194
195
196 m_macControl = ::NewControl( MAC_WXHWND(parent->MacGetRootWindow()) , &bounds , title , false , 0 , 0 , 1,
197 tabstyle , (long) this ) ;
198
199 MacPostControlCreate() ;
200 return TRUE ;
201 }
202
203 // dtor
204 wxNotebook::~wxNotebook()
205 {
206 }
207
208 // ----------------------------------------------------------------------------
209 // wxNotebook accessors
210 // ----------------------------------------------------------------------------
211
212 void wxNotebook::SetPadding(const wxSize& padding)
213 {
214 // unsupported by OS
215 }
216
217 void wxNotebook::SetTabSize(const wxSize& sz)
218 {
219 // unsupported by OS
220 }
221
222 void wxNotebook::SetPageSize(const wxSize& size)
223 {
224 SetSize( CalcSizeFromPage( size ) );
225 }
226
227 wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const
228 {
229 wxSize sizeTotal = sizePage;
230 sizeTotal.x += 2 * m_macHorizontalBorder + wxMacTabLeftMargin(GetWindowStyle()) +
231 wxMacTabRightMargin(GetWindowStyle()) ;
232 sizeTotal.y += 2 * m_macVerticalBorder + wxMacTabTopMargin(GetWindowStyle()) +
233 wxMacTabBottomMargin(GetWindowStyle()) ;
234
235 return sizeTotal;
236 }
237
238 wxSize wxNotebook::DoGetBestSize() const
239 {
240 // calculate the max page size
241 wxSize size(0, 0);
242
243 size_t count = GetPageCount();
244 if ( count )
245 {
246 for ( size_t n = 0; n < count; n++ )
247 {
248 wxSize sizePage = m_pages[n]->GetSize();
249
250 if ( size.x < sizePage.x )
251 size.x = sizePage.x;
252 if ( size.y < sizePage.y )
253 size.y = sizePage.y;
254 }
255 }
256 else // no pages
257 {
258 // use some arbitrary default size
259 size.x =
260 size.y = 100;
261 }
262
263 return CalcSizeFromPage(size);
264 }
265
266 int wxNotebook::SetSelection(size_t nPage)
267 {
268 wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
269
270 if ( int(nPage) != m_nSelection )
271 {
272 wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
273 event.SetSelection(nPage);
274 event.SetOldSelection(m_nSelection);
275 event.SetEventObject(this);
276 if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
277 {
278 // program allows the page change
279 event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
280 (void)GetEventHandler()->ProcessEvent(event);
281
282 ChangePage(m_nSelection, nPage);
283 }
284 }
285
286 return m_nSelection;
287 }
288
289 bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
290 {
291 wxASSERT( IS_VALID_PAGE(nPage) );
292
293 wxNotebookPage *page = m_pages[nPage];
294 page->SetLabel(strText);
295 MacSetupTabs();
296
297 return true;
298 }
299
300 wxString wxNotebook::GetPageText(size_t nPage) const
301 {
302 wxASSERT( IS_VALID_PAGE(nPage) );
303
304 wxNotebookPage *page = m_pages[nPage];
305 return page->GetLabel();
306 }
307
308 int wxNotebook::GetPageImage(size_t nPage) const
309 {
310 wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, _T("invalid notebook page") );
311
312 return m_images[nPage];
313 }
314
315 bool wxNotebook::SetPageImage(size_t nPage, int nImage)
316 {
317 wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, _T("invalid notebook page") );
318
319 wxCHECK_MSG( m_imageList && nImage < m_imageList->GetImageCount(), FALSE,
320 _T("invalid image index in SetPageImage()") );
321
322 if ( nImage != m_images[nPage] )
323 {
324 // if the item didn't have an icon before or, on the contrary, did have
325 // it but has lost it now, its size will change - but if the icon just
326 // changes, it won't
327 m_images[nPage] = nImage;
328
329 MacSetupTabs() ;
330 }
331
332 return TRUE;
333 }
334
335 // ----------------------------------------------------------------------------
336 // wxNotebook operations
337 // ----------------------------------------------------------------------------
338
339 // remove one page from the notebook, without deleting the window
340 wxNotebookPage* wxNotebook::DoRemovePage(size_t nPage)
341 {
342 wxCHECK( IS_VALID_PAGE(nPage), NULL );
343 wxNotebookPage* page = m_pages[nPage] ;
344 m_pages.RemoveAt(nPage);
345
346 MacSetupTabs();
347
348 if(m_nSelection >= (int)GetPageCount()) {
349 m_nSelection = GetPageCount() - 1;
350 }
351 if(m_nSelection >= 0) {
352 m_pages[m_nSelection]->Show(true);
353 }
354 return page;
355 }
356
357 // remove all pages
358 bool wxNotebook::DeleteAllPages()
359 {
360 WX_CLEAR_ARRAY(m_pages) ;
361 MacSetupTabs();
362 m_nSelection = -1 ;
363 return TRUE;
364 }
365
366
367 // same as AddPage() but does it at given position
368 bool wxNotebook::InsertPage(size_t nPage,
369 wxNotebookPage *pPage,
370 const wxString& strText,
371 bool bSelect,
372 int imageId)
373 {
374 if ( !wxNotebookBase::InsertPage(nPage, pPage, strText, bSelect, imageId) )
375 return false;
376
377 wxASSERT_MSG( pPage->GetParent() == this,
378 _T("notebook pages must have notebook as parent") );
379
380 // don't show pages by default (we'll need to adjust their size first)
381 pPage->Show( false ) ;
382
383 pPage->SetLabel(strText);
384
385 m_images.Insert(imageId, nPage);
386
387 MacSetupTabs();
388
389 wxRect rect = GetPageRect() ;
390 pPage->SetSize(rect);
391 if ( pPage->GetAutoLayout() ) {
392 pPage->Layout();
393 }
394
395
396 // now deal with the selection
397 // ---------------------------
398
399 // if the inserted page is before the selected one, we must update the
400 // index of the selected page
401
402 if ( int(nPage) <= m_nSelection )
403 {
404 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 ) ;
407 }
408
409 // some page should be selected: either this one or the first one if there
410 // is still no selection
411 int selNew = -1;
412 if ( bSelect )
413 selNew = nPage;
414 else if ( m_nSelection == -1 )
415 selNew = 0;
416
417 if ( selNew != -1 )
418 SetSelection(selNew);
419
420 return true;
421 }
422
423 /* Added by Mark Newsam
424 * When a page is added or deleted to the notebook this function updates
425 * information held in the m_macControl so that it matches the order
426 * the user would expect.
427 */
428 void wxNotebook::MacSetupTabs()
429 {
430 SetControl32BitMaximum( (ControlHandle) m_macControl , GetPageCount() ) ;
431
432 wxNotebookPage *page;
433 ControlTabInfoRec info;
434
435 const size_t countPages = GetPageCount();
436 for(size_t ii = 0; ii < countPages; ii++)
437 {
438 page = m_pages[ii];
439 info.version = 0;
440 info.iconSuiteID = 0;
441 wxMacStringToPascal( page->GetLabel() , info.name ) ;
442
443 SetControlData( (ControlHandle) m_macControl, ii+1, kControlTabInfoTag,
444 sizeof( ControlTabInfoRec) , (char*) &info ) ;
445 SetTabEnabled( (ControlHandle) m_macControl , ii+1 , true ) ;
446 #if TARGET_CARBON
447 if ( GetImageList() && GetPageImage(ii) >= 0 && UMAGetSystemVersion() >= 0x1020 )
448 {
449 // tab controls only support very specific types of images, therefore we are doing an odyssee
450 // accross the icon worlds (even Apple DTS did not find a shorter path)
451 // in order not to pollute the icon registry we put every icon into (OSType) 1 and immediately
452 // afterwards Unregister it (IconRef is ref counted, so it will stay on the tab even if we
453 // unregister it) in case this will ever lead to having the same icon everywhere add some kind
454 // of static counter
455 const wxBitmap* bmap = GetImageList()->GetBitmap( GetPageImage(ii ) ) ;
456 if ( bmap )
457 {
458 wxBitmap scaledBitmap ;
459 if ( bmap->GetWidth() != 16 || bmap->GetHeight() != 16 )
460 {
461 scaledBitmap = wxBitmap( bmap->ConvertToImage().Scale(16,16) ) ;
462 bmap = &scaledBitmap ;
463 }
464 ControlButtonContentInfo info ;
465 wxMacCreateBitmapButton( &info , *bmap , kControlContentPictHandle) ;
466 IconFamilyHandle iconFamily = (IconFamilyHandle) NewHandle(0) ;
467 OSErr err = SetIconFamilyData( iconFamily, 'PICT' , (Handle) info.u.picture ) ;
468 wxASSERT_MSG( err == noErr , wxT("Error when adding bitmap") ) ;
469 IconRef iconRef ;
470 err = RegisterIconRefFromIconFamily( 'WXNG' , (OSType) 1, iconFamily, &iconRef ) ;
471 wxASSERT_MSG( err == noErr , wxT("Error when adding bitmap") ) ;
472 info.contentType = kControlContentIconRef ;
473 info.u.iconRef = iconRef ;
474 SetControlData( (ControlHandle) m_macControl, ii+1,kControlTabImageContentTag,
475 sizeof( info ), (Ptr)&info );
476 wxASSERT_MSG( err == noErr , wxT("Error when setting icon on tab") ) ;
477 if ( UMAGetSystemVersion() < 0x1030 )
478 {
479 UnregisterIconRef( 'WXNG' , (OSType) 1 ) ;
480 }
481
482 ReleaseIconRef( iconRef ) ;
483 DisposeHandle( (Handle) iconFamily ) ;
484 }
485 }
486 #endif
487 }
488 Rect bounds;
489 GetControlBounds((ControlHandle)m_macControl, &bounds);
490 InvalWindowRect((WindowRef)MacGetRootWindow(), &bounds);
491 }
492
493 wxRect wxNotebook::GetPageRect() const
494 {
495 // fit the notebook page to the tab control's display area
496 int w, h;
497 GetSize(&w, &h);
498
499 return wxRect(
500 wxMacTabLeftMargin(GetWindowStyle()) + m_macHorizontalBorder,
501 wxMacTabTopMargin(GetWindowStyle()) + m_macVerticalBorder,
502 w - wxMacTabLeftMargin(GetWindowStyle()) - wxMacTabRightMargin(GetWindowStyle()) - 2*m_macHorizontalBorder,
503 h - wxMacTabTopMargin(GetWindowStyle()) - wxMacTabBottomMargin(GetWindowStyle()) - 2*m_macVerticalBorder);
504 }
505 // ----------------------------------------------------------------------------
506 // wxNotebook callbacks
507 // ----------------------------------------------------------------------------
508
509 // @@@ OnSize() is used for setting the font when it's called for the first
510 // time because doing it in ::Create() doesn't work (for unknown reasons)
511 void wxNotebook::OnSize(wxSizeEvent& event)
512 {
513
514 unsigned int nCount = m_pages.Count();
515 wxRect rect = GetPageRect() ;
516 for ( unsigned int nPage = 0; nPage < nCount; nPage++ ) {
517 wxNotebookPage *pPage = m_pages[nPage];
518 pPage->SetSize(rect);
519 if ( pPage->GetAutoLayout() ) {
520 pPage->Layout();
521 }
522 }
523
524 // Processing continues to next OnSize
525 event.Skip();
526 }
527
528 void wxNotebook::OnSelChange(wxNotebookEvent& event)
529 {
530 // is it our tab control?
531 if ( event.GetEventObject() == this )
532 ChangePage(event.GetOldSelection(), event.GetSelection());
533
534 // we want to give others a chance to process this message as well
535 event.Skip();
536 }
537
538 void wxNotebook::OnSetFocus(wxFocusEvent& event)
539 {
540 // set focus to the currently selected page if any
541 if ( m_nSelection != -1 )
542 m_pages[m_nSelection]->SetFocus();
543
544 event.Skip();
545 }
546
547 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
548 {
549 if ( event.IsWindowChange() ) {
550 // change pages
551 AdvanceSelection(event.GetDirection());
552 }
553 else {
554 // we get this event in 2 cases
555 //
556 // a) one of our pages might have generated it because the user TABbed
557 // out from it in which case we should propagate the event upwards and
558 // our parent will take care of setting the focus to prev/next sibling
559 //
560 // or
561 //
562 // b) the parent panel wants to give the focus to us so that we
563 // forward it to our selected page. We can't deal with this in
564 // OnSetFocus() because we don't know which direction the focus came
565 // from in this case and so can't choose between setting the focus to
566 // first or last panel child
567 wxWindow *parent = GetParent();
568 // the cast is here to fic a GCC ICE
569 if ( ((wxWindow*)event.GetEventObject()) == parent )
570 {
571 // no, it doesn't come from child, case (b): forward to a page
572 if ( m_nSelection != -1 )
573 {
574 // so that the page knows that the event comes from it's parent
575 // and is being propagated downwards
576 event.SetEventObject(this);
577
578 wxWindow *page = m_pages[m_nSelection];
579 if ( !page->GetEventHandler()->ProcessEvent(event) )
580 {
581 page->SetFocus();
582 }
583 //else: page manages focus inside it itself
584 }
585 else
586 {
587 // we have no pages - still have to give focus to _something_
588 SetFocus();
589 }
590 }
591 else
592 {
593 // it comes from our child, case (a), pass to the parent
594 if ( parent ) {
595 event.SetCurrentFocus(this);
596 parent->GetEventHandler()->ProcessEvent(event);
597 }
598 }
599 }
600 }
601
602 // ----------------------------------------------------------------------------
603 // wxNotebook base class virtuals
604 // ----------------------------------------------------------------------------
605
606 #if wxUSE_CONSTRAINTS
607
608 // override these 2 functions to do nothing: everything is done in OnSize
609
610 void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))
611 {
612 // don't set the sizes of the pages - their correct size is not yet known
613 wxControl::SetConstraintSizes(FALSE);
614 }
615
616 bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
617 {
618 return TRUE;
619 }
620
621 #endif // wxUSE_CONSTRAINTS
622
623 void wxNotebook::Command(wxCommandEvent& event)
624 {
625 wxFAIL_MSG(wxT("wxNotebook::Command not implemented"));
626 }
627
628 // ----------------------------------------------------------------------------
629 // wxNotebook helper functions
630 // ----------------------------------------------------------------------------
631
632 // hide the currently active panel and show the new one
633 void wxNotebook::ChangePage(int nOldSel, int nSel)
634 {
635 if ( nOldSel != -1 )
636 {
637 m_pages[nOldSel]->Show(FALSE);
638 }
639
640 if ( nSel != -1 )
641 {
642 wxNotebookPage *pPage = m_pages[nSel];
643 pPage->Show(TRUE);
644 pPage->SetFocus();
645 }
646
647 m_nSelection = nSel;
648 SetControl32BitValue( (ControlHandle) m_macControl , m_nSelection + 1 ) ;
649 }
650
651
652 void wxNotebook::OnMouse( wxMouseEvent &event )
653 {
654 if ( (ControlHandle) m_macControl == NULL )
655 {
656 event.Skip() ;
657 return ;
658 }
659
660 if (event.GetEventType() == wxEVT_LEFT_DOWN || event.GetEventType() == wxEVT_LEFT_DCLICK )
661 {
662 int x = event.m_x ;
663 int y = event.m_y ;
664
665 MacClientToRootWindow( &x , &y ) ;
666
667 ControlHandle control ;
668 Point localwhere ;
669 SInt16 controlpart ;
670
671 localwhere.h = x ;
672 localwhere.v = y ;
673
674 short modifiers = 0;
675
676 if ( !event.m_leftDown && !event.m_rightDown )
677 modifiers |= btnState ;
678
679 if ( event.m_shiftDown )
680 modifiers |= shiftKey ;
681
682 if ( event.m_controlDown )
683 modifiers |= controlKey ;
684
685 if ( event.m_altDown )
686 modifiers |= optionKey ;
687
688 if ( event.m_metaDown )
689 modifiers |= cmdKey ;
690
691 control = (ControlHandle) m_macControl ;
692 if ( control && ::IsControlActive( control ) )
693 {
694 {
695 wxNotebookEvent changing(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId,
696 ::GetControl32BitValue(control) - 1, m_nSelection);
697 changing.SetEventObject(this);
698 GetEventHandler()->ProcessEvent(changing);
699
700 if(changing.IsAllowed())
701 {
702 controlpart = ::HandleControlClick(control, localwhere, modifiers,
703 (ControlActionUPP) -1);
704 wxTheApp->s_lastMouseDown = 0 ;
705
706 wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, m_windowId,
707 ::GetControl32BitValue(control) - 1, m_nSelection);
708 event.SetEventObject(this);
709
710 GetEventHandler()->ProcessEvent(event);
711 }
712 }
713 }
714 }
715 }
716
717
718 void wxNotebook::MacHandleControlClick( WXWidget control , wxInt16 controlpart , bool WXUNUSED( mouseStillDown ) )
719 {
720 #if 0
721 wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, m_windowId , ::GetControl32BitValue((ControlHandle)m_macControl) - 1, m_nSelection);
722 event.SetEventObject(this);
723
724 ProcessEvent(event);
725 #endif
726 }
727