1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/mac/carbon/listbox.cpp
4 // Author: Stefan Csomor
8 // Copyright: (c) Stefan Csomor
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #include "wx/wxprec.h"
16 #include "wx/listbox.h"
19 #include "wx/dynarray.h"
24 #include "wx/button.h"
25 #include "wx/settings.h"
26 #include "wx/arrstr.h"
27 #include "wx/toplevel.h"
30 IMPLEMENT_DYNAMIC_CLASS(wxListBox
, wxControl
)
32 BEGIN_EVENT_TABLE(wxListBox
, wxControl
)
35 #include "wx/mac/uma.h"
36 #include "wx/dynarray.h"
38 // ============================================================================
39 // list box control implementation
40 // ============================================================================
42 wxListBox::wxListBox()
46 bool wxListBox::Create(
51 const wxArrayString
& choices
,
53 const wxValidator
& validator
,
54 const wxString
& name
)
56 wxCArrayString
chs(choices
);
59 parent
, id
, pos
, size
, chs
.GetCount(), chs
.GetStrings(),
60 style
, validator
, name
);
63 wxMacListControl
* wxListBox::GetPeer() const
65 return dynamic_cast<wxMacListControl
*>(m_peer
);
68 bool wxListBox::Create(
74 const wxString choices
[],
76 const wxValidator
& validator
,
77 const wxString
& name
)
79 m_macIsUserPane
= false;
81 wxASSERT_MSG( !(style
& wxLB_MULTIPLE
) || !(style
& wxLB_EXTENDED
),
82 wxT("only a single listbox selection mode can be specified") );
84 if ( !wxListBoxBase::Create( parent
, id
, pos
, size
, style
& ~(wxHSCROLL
| wxVSCROLL
), validator
, name
) )
87 wxMacDataBrowserListControl
* control
= new wxMacDataBrowserListControl( this, pos
, size
, style
);
88 control
->SetClientDataType( m_clientDataItemsType
);
91 MacPostControlCreate( pos
, size
);
93 InsertItems( n
, choices
, 0 );
95 // Needed because it is a wxControlWithItems
101 wxListBox::~wxListBox()
104 m_peer
->SetReference( 0 );
107 void wxListBox::FreeData()
109 GetPeer()->MacClear();
112 void wxListBox::DoSetFirstItem(int n
)
114 GetPeer()->MacScrollTo( n
);
117 void wxListBox::EnsureVisible(int n
)
119 GetPeer()->MacScrollTo( n
);
122 void wxListBox::Delete(unsigned int n
)
124 wxCHECK_RET( IsValid(n
), wxT("invalid index in wxListBox::Delete") );
126 GetPeer()->MacDelete( n
);
129 int wxListBox::DoAppend(const wxString
& item
)
131 InvalidateBestSize();
133 return GetPeer()->MacAppend( item
);
136 void wxListBox::DoSetItems(const wxArrayString
& choices
, void** clientData
)
140 unsigned int n
= choices
.GetCount();
142 for ( size_t i
= 0; i
< n
; ++i
)
146 Append( choices
[i
], clientData
[i
] );
149 Append( choices
[i
] );
154 int wxListBox::FindString(const wxString
& s
, bool bCase
) const
156 for ( size_t i
= 0; i
< GetCount(); ++ i
)
158 if (s
.IsSameAs( GetString( i
), bCase
) )
165 void wxListBox::Clear()
170 void wxListBox::DoSetSelection(int n
, bool select
)
172 wxCHECK_RET( n
== wxNOT_FOUND
|| IsValid(n
),
173 wxT("invalid index in wxListBox::SetSelection") );
175 if ( n
== wxNOT_FOUND
)
176 GetPeer()->MacDeselectAll();
178 GetPeer()->MacSetSelection( n
, select
, HasMultipleSelection() );
181 bool wxListBox::IsSelected(int n
) const
183 wxCHECK_MSG( IsValid(n
), false, wxT("invalid index in wxListBox::Selected") );
185 return GetPeer()->MacIsSelected( n
);
188 void *wxListBox::DoGetItemClientData(unsigned int n
) const
190 wxCHECK_MSG( IsValid(n
), NULL
, wxT("invalid index in wxListBox::GetClientData"));
191 return GetPeer()->MacGetClientData( n
);
194 wxClientData
*wxListBox::DoGetItemClientObject(unsigned int n
) const
196 return (wxClientData
*)DoGetItemClientData( n
);
199 void wxListBox::DoSetItemClientData(unsigned int n
, void *clientData
)
201 wxCHECK_RET( IsValid(n
), wxT("invalid index in wxListBox::SetClientData") );
202 GetPeer()->MacSetClientData( n
, clientData
);
205 void wxListBox::DoSetItemClientObject(unsigned int n
, wxClientData
* clientData
)
207 DoSetItemClientData(n
, clientData
);
210 // Return number of selections and an array of selected integers
211 int wxListBox::GetSelections(wxArrayInt
& aSelections
) const
213 return GetPeer()->MacGetSelections( aSelections
);
216 // Get single selection, for single choice list items
217 int wxListBox::GetSelection() const
219 return GetPeer()->MacGetSelection();
222 // Find string for position
223 wxString
wxListBox::GetString(unsigned int n
) const
225 wxCHECK_MSG( IsValid(n
), wxEmptyString
, wxT("invalid index in wxListBox::GetString") );
226 return GetPeer()->MacGetString(n
);
229 void wxListBox::DoInsertItems(const wxArrayString
& items
, unsigned int pos
)
231 wxCHECK_RET( IsValidInsert(pos
), wxT("invalid index in wxListBox::InsertItems") );
233 InvalidateBestSize();
235 GetPeer()->MacInsert( pos
, items
);
238 void wxListBox::SetString(unsigned int n
, const wxString
& s
)
240 GetPeer()->MacSetString( n
, s
);
243 wxSize
wxListBox::DoGetBestSize() const
245 int lbWidth
= 100; // some defaults
250 wxMacPortStateHelper
st( UMAGetWindowPort( (WindowRef
)MacGetTopLevelWindowRef() ) );
252 // TODO: clean this up
255 ::TextFont( m_font
.MacGetFontNum() );
256 ::TextSize( m_font
.MacGetFontSize() );
257 ::TextFace( m_font
.MacGetFontStyle() );
261 ::TextFont( kFontIDMonaco
);
266 // Find the widest line
267 for (unsigned int i
= 0; i
< GetCount(); i
++)
269 wxString
str( GetString( i
) );
272 Point bounds
= {0, 0};
275 // NB: what if m_font.Ok() == false ???
276 ::GetThemeTextDimensions(
277 wxMacCFStringHolder( str
, m_font
.GetEncoding() ),
278 kThemeCurrentPortFont
,
285 wLine
= ::TextWidth( str
.c_str(), 0, str
.length() );
288 lbWidth
= wxMax( lbWidth
, wLine
);
291 // Add room for the scrollbar
292 lbWidth
+= wxSystemSettings::GetMetric( wxSYS_VSCROLL_X
);
294 // And just a bit more
296 int cx
= ::TextWidth( "X", 0, 1 );
299 // don't make the listbox too tall (limit height to around 10 items)
300 // but don't make it too small neither
301 lbHeight
= wxMax( (cy
+ 4) * wxMin( wxMax( GetCount(), 3 ), 10 ), 70 );
304 return wxSize( lbWidth
, lbHeight
);
307 unsigned int wxListBox::GetCount() const
309 return GetPeer()->MacGetCount();
312 void wxListBox::Refresh(bool eraseBack
, const wxRect
*rect
)
314 wxControl::Refresh( eraseBack
, rect
);
317 // Some custom controls depend on this
318 /* static */ wxVisualAttributes
319 wxListBox::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
321 wxVisualAttributes attr
;
323 attr
.colFg
= wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT
);
324 attr
.colBg
= wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOX
);
325 attr
.font
= wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT
);
330 int wxListBox::DoListHitTest(const wxPoint
& inpoint
) const
334 // There are few reasons why this is complicated:
335 // 1) There is no native HitTest function for Mac
336 // 2) GetDataBrowserItemPartBounds only works on visible items
337 // 3) We can't do it through GetDataBrowserTableView[Item]RowHeight
338 // because what it returns is basically inaccurate in the context
339 // of the coordinates we want here, but we use this as a guess
340 // for where the first visible item lies
342 wxPoint point
= inpoint
;
344 // interestingly enough 10.2 (and below?) have GetDataBrowserItemPartBounds
345 // giving root window coordinates but 10.3 and above give client coordinates
346 // so we only compare using root window coordinates on 10.3 and up
347 if ( UMAGetSystemVersion() < 0x1030 )
348 MacClientToRootWindow(&point
.x
, &point
.y
);
350 // get column property ID (req. for call to itempartbounds)
351 DataBrowserTableViewColumnID colId
= 0;
352 err
= GetDataBrowserTableViewColumnProperty(m_peer
->GetControlRef(), 0, &colId
);
353 wxCHECK_MSG(err
== noErr
, wxNOT_FOUND
, wxT("Unexpected error from GetDataBrowserTableViewColumnProperty"));
355 // OK, first we need to find the first visible item we have -
356 // this will be the "low" for our binary search. There is no real
357 // easy way around this, as we will need to do a SLOW linear search
358 // until we find a visible item, but we can do a cheap calculation
359 // via the row height to speed things up a bit
360 UInt32 scrollx
, scrolly
;
361 err
= GetDataBrowserScrollPosition(m_peer
->GetControlRef(), &scrollx
, &scrolly
);
362 wxCHECK_MSG(err
== noErr
, wxNOT_FOUND
, wxT("Unexpected error from GetDataBrowserScrollPosition"));
365 err
= GetDataBrowserTableViewRowHeight(m_peer
->GetControlRef(), &height
);
366 wxCHECK_MSG(err
== noErr
, wxNOT_FOUND
, wxT("Unexpected error from GetDataBrowserTableViewRowHeight"));
368 // these indices are 0-based, as usual, so we need to add 1 to them when
369 // passing them to data browser functions which use 1-based indices
370 int low
= scrolly
/ height
,
371 high
= GetCount() - 1;
373 // search for the first visible item (note that the scroll guess above
374 // is the low bounds of where the item might lie so we only use that as a
375 // starting point - we should reach it within 1 or 2 iterations of the loop)
376 while ( low
<= high
)
379 err
= GetDataBrowserItemPartBounds(
380 m_peer
->GetControlRef(), low
+ 1, colId
,
381 kDataBrowserPropertyEnclosingPart
,
382 &bounds
); // note +1 to translate to Mac ID
386 // errDataBrowserItemNotFound is expected as it simply means that the
387 // item is not currently visible -- but other errors are not
388 wxCHECK_MSG( err
== errDataBrowserItemNotFound
, wxNOT_FOUND
,
389 wxT("Unexpected error from GetDataBrowserItemPartBounds") );
394 // NOW do a binary search for where the item lies, searching low again if
395 // we hit an item that isn't visible
396 while ( low
<= high
)
398 int mid
= (low
+ high
) / 2;
401 err
= GetDataBrowserItemPartBounds(
402 m_peer
->GetControlRef(), mid
+ 1, colId
,
403 kDataBrowserPropertyEnclosingPart
,
404 &bounds
); //note +1 to trans to mac id
405 wxCHECK_MSG( err
== noErr
|| err
== errDataBrowserItemNotFound
,
407 wxT("Unexpected error from GetDataBrowserItemPartBounds") );
409 if ( err
== errDataBrowserItemNotFound
)
411 // item not visible, attempt to find a visible one
415 else // visible item, do actual hitttest
417 // if point is within the bounds, return this item (since we assume
418 // all x coords of items are equal we only test the x coord in
420 if ((point
.x
>= bounds
.left
&& point
.x
<= bounds
.right
) &&
421 (point
.y
>= bounds
.top
&& point
.y
<= bounds
.bottom
) )
427 if ( point
.y
< bounds
.top
)
428 // index(bounds) greater then key(point)
431 // index(bounds) less then key(point)
439 // ============================================================================
440 // data browser based implementation
441 // ============================================================================
443 wxMacListBoxItem::wxMacListBoxItem()
448 wxMacListBoxItem::~wxMacListBoxItem()
452 void wxMacListBoxItem::Notification(wxMacDataItemBrowserControl
*owner
,
453 DataBrowserItemNotification message
,
454 DataBrowserItemDataRef itemData
) const
456 wxMacDataBrowserListControl
*lb
= dynamic_cast<wxMacDataBrowserListControl
*>(owner
);
458 // we want to depend on as little as possible to make sure tear-down of controls is safe
460 if ( message
== kDataBrowserItemRemoved
)
462 if ( lb
!= NULL
&& lb
->GetClientDataType() == wxClientData_Object
)
464 delete (wxClientData
*) (m_data
);
471 wxListBox
*list
= wxDynamicCast( owner
->GetPeer() , wxListBox
);
472 wxCHECK_RET( list
!= NULL
, wxT("Listbox expected"));
474 bool trigger
= false;
475 wxCommandEvent
event( wxEVT_COMMAND_LISTBOX_SELECTED
, list
->GetId() );
478 case kDataBrowserItemDeselected
:
479 if ( list
->HasMultipleSelection() )
480 trigger
= !lb
->IsSelectionSuppressed();
483 case kDataBrowserItemSelected
:
484 trigger
= !lb
->IsSelectionSuppressed();
487 case kDataBrowserItemDoubleClicked
:
488 event
.SetEventType( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
);
498 event
.SetEventObject( list
);
499 if ( list
->HasClientObjectData() )
500 event
.SetClientObject( (wxClientData
*) m_data
);
501 else if ( list
->HasClientUntypedData() )
502 event
.SetClientData( m_data
);
503 event
.SetString( m_label
);
504 event
.SetInt( owner
->GetLineFromItem( this ) );
505 event
.SetExtraLong( list
->HasMultipleSelection() ? message
== kDataBrowserItemSelected
: true );
507 // direct notification is not always having the listbox GetSelection()
508 // having in synch with event, so use wxPostEvent instead
509 // list->GetEventHandler()->ProcessEvent(event);
511 wxPostEvent( list
->GetEventHandler(), event
);
515 wxMacDataBrowserListControl::wxMacDataBrowserListControl( wxWindow
*peer
, const wxPoint
& pos
, const wxSize
& size
, long style
)
516 : wxMacDataItemBrowserControl( peer
, pos
, size
, style
)
518 OSStatus err
= noErr
;
519 m_clientDataItemsType
= wxClientData_None
;
520 if ( style
& wxLB_SORT
)
521 m_sortOrder
= SortOrder_Text_Ascending
;
523 DataBrowserSelectionFlags options
= kDataBrowserDragSelect
;
524 if ( style
& wxLB_MULTIPLE
)
526 options
|= kDataBrowserAlwaysExtendSelection
| kDataBrowserCmdTogglesSelection
;
528 else if ( style
& wxLB_EXTENDED
)
534 options
|= kDataBrowserSelectOnlyOne
;
536 err
= SetSelectionFlags( options
);
539 DataBrowserListViewColumnDesc columnDesc
;
540 columnDesc
.headerBtnDesc
.titleOffset
= 0;
541 columnDesc
.headerBtnDesc
.version
= kDataBrowserListViewLatestHeaderDesc
;
543 columnDesc
.headerBtnDesc
.btnFontStyle
.flags
=
544 kControlUseFontMask
| kControlUseJustMask
;
546 columnDesc
.headerBtnDesc
.btnContentInfo
.contentType
= kControlNoContent
;
547 columnDesc
.headerBtnDesc
.btnFontStyle
.just
= teFlushDefault
;
548 columnDesc
.headerBtnDesc
.btnFontStyle
.font
= kControlFontViewSystemFont
;
549 columnDesc
.headerBtnDesc
.btnFontStyle
.style
= normal
;
550 columnDesc
.headerBtnDesc
.titleString
= NULL
;
552 columnDesc
.headerBtnDesc
.minimumWidth
= 0;
553 columnDesc
.headerBtnDesc
.maximumWidth
= 10000;
555 columnDesc
.propertyDesc
.propertyID
= kTextColumnId
;
556 columnDesc
.propertyDesc
.propertyType
= kDataBrowserTextType
;
557 columnDesc
.propertyDesc
.propertyFlags
= kDataBrowserTableViewSelectionColumn
;
558 #if MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_2
559 columnDesc
.propertyDesc
.propertyFlags
|= kDataBrowserListViewTypeSelectColumn
;
562 verify_noerr( AddColumn( &columnDesc
, kDataBrowserListViewAppendColumn
) );
564 columnDesc
.headerBtnDesc
.minimumWidth
= 0;
565 columnDesc
.headerBtnDesc
.maximumWidth
= 0;
566 columnDesc
.propertyDesc
.propertyID
= kNumericOrderColumnId
;
567 columnDesc
.propertyDesc
.propertyType
= kDataBrowserPropertyRelevanceRankPart
;
568 columnDesc
.propertyDesc
.propertyFlags
= kDataBrowserTableViewSelectionColumn
;
569 #if MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_2
570 columnDesc
.propertyDesc
.propertyFlags
|= kDataBrowserListViewTypeSelectColumn
;
573 verify_noerr( AddColumn( &columnDesc
, kDataBrowserListViewAppendColumn
) );
575 SetDataBrowserSortProperty( m_controlRef
, kTextColumnId
);
576 if ( m_sortOrder
== SortOrder_Text_Ascending
)
578 SetDataBrowserSortProperty( m_controlRef
, kTextColumnId
);
579 SetDataBrowserSortOrder( m_controlRef
, kDataBrowserOrderIncreasing
);
583 SetDataBrowserSortProperty( m_controlRef
, kNumericOrderColumnId
);
584 SetDataBrowserSortOrder( m_controlRef
, kDataBrowserOrderIncreasing
);
587 verify_noerr( AutoSizeColumns() );
588 verify_noerr( SetHiliteStyle(kDataBrowserTableViewFillHilite
) );
589 verify_noerr( SetHeaderButtonHeight( 0 ) );
590 err
= SetHasScrollBars( (style
& wxHSCROLL
) != 0 , true );
592 // shouldn't be necessary anymore under 10.2
593 m_peer
->SetData( kControlNoPart
, kControlDataBrowserIncludesFrameAndFocusTag
, (Boolean
)false );
594 m_peer
->SetNeedsFocusRect( true );
598 wxMacDataBrowserListControl::~wxMacDataBrowserListControl()
602 wxWindow
* wxMacDataBrowserListControl::GetPeer() const
604 return wxDynamicCast( wxMacControl::GetPeer() , wxWindow
);
607 wxMacDataItem
* wxMacDataBrowserListControl::CreateItem()
609 return new wxMacListBoxItem();
614 // in case we need that one day
616 // ============================================================================
617 // HIView owner-draw-based implementation
618 // ============================================================================
620 static pascal void ListBoxDrawProc(
621 ControlRef browser
, DataBrowserItemID item
, DataBrowserPropertyID property
,
622 DataBrowserItemState itemState
, const Rect
*itemRect
, SInt16 depth
, Boolean isColorDevice
)
624 CFStringRef cfString
;
625 ThemeDrawingState themeState
;
628 GetThemeDrawingState( &themeState
);
629 cfString
= CFStringCreateWithFormat( NULL
, NULL
, CFSTR("Row %d"), item
);
631 // In this sample we handle the "selected" state; all others fall through to our "active" state
632 if ( itemState
== kDataBrowserItemIsSelected
)
634 ThemeBrush colorBrushID
;
636 // TODO: switch over to wxSystemSettingsNative::GetColour() when kThemeBrushSecondaryHighlightColor
637 // is incorporated Panther DB starts using kThemeBrushSecondaryHighlightColor
638 // for inactive browser highlighting
639 Gestalt( gestaltSystemVersion
, &systemVersion
);
640 if ( (systemVersion
>= 0x00001030) && !IsControlActive( browser
) )
641 colorBrushID
= kThemeBrushSecondaryHighlightColor
;
643 colorBrushID
= kThemeBrushPrimaryHighlightColor
;
645 // First paint the hilite rect, then the text on top
646 SetThemePen( colorBrushID
, 32, true );
647 PaintRect( itemRect
);
648 SetThemeDrawingState( themeState
, false );
651 DrawThemeTextBox( cfString
, kThemeApplicationFont
, kThemeStateActive
, true, itemRect
, teFlushDefault
, NULL
);
652 SetThemeDrawingState( themeState
, true );
654 if ( cfString
!= NULL
)
655 CFRelease( cfString
);
661 #endif // wxUSE_LISTBOX