substitute '@b NB:' with '@note'; first partial revision of e*h headers; replace...

[wxWidgets.git] / src / mac / carbon / checklst.cpp

diff --git a/src/mac/carbon/checklst.cpp b/src/mac/carbon/checklst.cpp
index 77b77f2055a72f46aa1288c9f3aae066705e1a0c..5f0fecb5e2eb434db3128a4d12cf540b4a550c60 100644 (file)
--- a/src/mac/carbon/checklst.cpp
+++ b/src/mac/carbon/checklst.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        checklst.cpp
+// Name:        src/mac/carbon/checklst.cpp

 // Purpose:     implementation of wxCheckListBox class
 // Author:      Stefan Csomor
 // Modified by:
 // Purpose:     implementation of wxCheckListBox class
 // Author:      Stefan Csomor
 // Modified by:


@@ -8,242 +8,134 @@
 // Copyright:   (c) Stefan Csomor
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) Stefan Csomor
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////

+//
+// new DataBrowser-based version

 
 

-// ============================================================================
-// headers & declarations
-// ============================================================================
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "checklst.h"
-#endif

 
 #include "wx/wxprec.h"
 
 #if wxUSE_CHECKLISTBOX
 
 #include "wx/checklst.h"
 
 #include "wx/wxprec.h"
 
 #if wxUSE_CHECKLISTBOX
 
 #include "wx/checklst.h"

-#include "wx/arrstr.h"

 
 

-#include "wx/mac/uma.h"
-#include <Appearance.h>
+#ifndef WX_PRECOMP
+    #include "wx/arrstr.h"
+#endif

 
 

-// ============================================================================
-// implementation of wxCheckListBox
-// ============================================================================
+#include "wx/mac/uma.h"

 
 IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
 
 BEGIN_EVENT_TABLE(wxCheckListBox, wxListBox)
 END_EVENT_TABLE()
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
 
 BEGIN_EVENT_TABLE(wxCheckListBox, wxListBox)
 END_EVENT_TABLE()
 

-const short kTextColumnId = 1024 ;
-const short kCheckboxColumnId = 1025 ;
+class wxMacDataBrowserCheckListControl : public wxMacDataBrowserListControl , public wxMacCheckListControl
+{
+public:
+    wxMacDataBrowserCheckListControl( wxListBox *peer, const wxPoint& pos, const wxSize& size, long style );
+    wxMacDataBrowserCheckListControl() {}
+    virtual ~wxMacDataBrowserCheckListControl();
+
+    virtual wxMacDataItem* CreateItem();
+
+    virtual bool            MacIsChecked(unsigned int n) const;
+    virtual void            MacCheck(unsigned int n, bool bCheck = true);
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMacDataBrowserCheckListControl)
+};

 
 

-// new databrowser based version
+IMPLEMENT_DYNAMIC_CLASS( wxMacDataBrowserCheckListControl , wxMacDataBrowserListControl )

 
 

-// Listbox item

 void wxCheckListBox::Init()
 {
 }
 
 void wxCheckListBox::Init()
 {
 }
 

-bool wxCheckListBox::Create(wxWindow *parent,
-                            wxWindowID id,
-                            const wxPoint &pos,
-                            const wxSize &size,
-                            const wxArrayString& choices,
-                            long style,
-                            const wxValidator& validator,
-                            const wxString &name)
+bool wxCheckListBox::Create(
+    wxWindow *parent,
+    wxWindowID id,
+    const wxPoint &pos,
+    const wxSize &size,
+    const wxArrayString& choices,
+    long style,
+    const wxValidator& validator,
+    const wxString &name )

 {
 {

-    wxCArrayString chs(choices);
+    wxCArrayString chs( choices );

 
 

-    return Create(parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
-                  style, validator, name);
+    return Create( parent, id, pos, size, chs.GetCount(), chs.GetStrings(), style, validator, name );

 }
 
 }
 

-#if TARGET_API_MAC_OSX
-static pascal void DataBrowserItemNotificationProc(ControlRef browser, DataBrowserItemID itemID,
-    DataBrowserItemNotification message, DataBrowserItemDataRef itemData)
-#else
-static pascal  void DataBrowserItemNotificationProc(ControlRef browser, DataBrowserItemID itemID,
-    DataBrowserItemNotification message)
-#endif
+bool wxCheckListBox::Create(
+   wxWindow *parent,
+   wxWindowID id,
+   const wxPoint& pos,
+   const wxSize& size,
+   int n,
+   const wxString choices[],
+   long style,
+   const wxValidator& validator,
+   const wxString& name )

 {
 {

-    long ref = GetControlReference( browser ) ;
-    if ( ref )
-    {
-        wxCheckListBox* list = wxDynamicCast( (wxObject*) ref , wxCheckListBox ) ;
-        int i = itemID - 1 ;
-        if (i >= 0 && i < list->GetCount() )
-        {
-            bool trigger = false ;
-            wxCommandEvent event(
-                wxEVT_COMMAND_LISTBOX_SELECTED, list->GetId() );
-            switch( message )
-            {
-                case kDataBrowserItemDeselected :
-                    if ( list->HasMultipleSelection() )
-                        trigger = true ;
-                    break ;
-                case kDataBrowserItemSelected :
-                    trigger = true ;
-                    break ;
-                case kDataBrowserItemDoubleClicked :
-                    event.SetEventType(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED) ;
-                    trigger = true ;
-                    break ;
-                 default :
-                    break ;
-            }
+    m_macIsUserPane = false;

 
 

-            if ( trigger )
-            {
-                event.SetEventObject( list );
-                if ( list->HasClientObjectData() )
-                    event.SetClientObject( list->GetClientObject(i) );
-                else if ( list->HasClientUntypedData() )
-                    event.SetClientData( list->GetClientData(i) );
-                event.SetString( list->GetString(i) );
-                event.SetInt(i) ;
-                event.SetExtraLong( list->HasMultipleSelection() ? message == kDataBrowserItemSelected : TRUE );
-                wxPostEvent( list->GetEventHandler() , event ) ;
-                // direct notification is not always having the listbox GetSelection() having in synch with event
-                // list->GetEventHandler()->ProcessEvent(event) ;
-            }
-        }
-    }
-}
+    wxASSERT_MSG( !(style & wxLB_MULTIPLE) || !(style & wxLB_EXTENDED),
+                  wxT("only one of listbox selection modes can be specified") );

 
 

+    if ( !wxListBoxBase::Create( parent, id, pos, size, style & ~(wxHSCROLL | wxVSCROLL), validator, name ) )
+        return false;

 
 

-static pascal OSStatus ListBoxGetSetItemData(ControlRef browser,
-    DataBrowserItemID itemID, DataBrowserPropertyID property,
-    DataBrowserItemDataRef itemData, Boolean changeValue)
-{
-    OSStatus err = errDataBrowserPropertyNotSupported;
+    // this will be increased by our Append command
+    wxMacDataBrowserCheckListControl* control = new wxMacDataBrowserCheckListControl( this, pos, size, style );
+    // TODO CHECK control->SetClientDataType( m_clientDataItemsType );
+    m_peer = control;

 
 

-    if ( ! changeValue )
-    {
-        switch (property)
-        {
+    MacPostControlCreate(pos,size);

 
 

-            case kTextColumnId:
-            {
-                long ref = GetControlReference( browser ) ;
-                if ( ref )
-                {
-                    wxCheckListBox* list = wxDynamicCast( (wxObject*) ref , wxCheckListBox ) ;
-                    int i = itemID - 1 ;
-                    if (i >= 0 && i < list->GetCount() )
-                    {
-                        wxMacCFStringHolder cf( list->GetString(i) , list->GetFont().GetEncoding() ) ;
-                        verify_noerr( ::SetDataBrowserItemDataText( itemData , cf ) ) ;
-                        err = noErr ;
-                    }
-                }
-            }
-            break;
-            case kCheckboxColumnId :
-            {
-                long ref = GetControlReference( browser ) ;
-                if ( ref )
-                {
-                    wxCheckListBox* list = wxDynamicCast( (wxObject*) ref , wxCheckListBox ) ;
-                    int i = itemID - 1 ;
-                    if (i >= 0 && i < list->GetCount() )
-                    {
-                        verify_noerr( ::SetDataBrowserItemDataButtonValue( itemData , list->IsChecked( i ) ? kThemeButtonOn : kThemeButtonOff ) ) ;
-                        err = noErr ;
-                    }
-                }
-            }
-            break ;
-            case kDataBrowserItemIsEditableProperty:
-            {
-                err = ::SetDataBrowserItemDataBooleanValue(itemData, true);
-            }
-            break;
+    InsertItems( n , choices , 0 );

 
 

-            default:
-            break;
-        }
-    }
-    else
-    {
-        switch( property )
-        {
-            case kCheckboxColumnId :
-            {
-                long ref = GetControlReference( browser ) ;
-                if ( ref )
-                {
-                    wxCheckListBox* list = wxDynamicCast( (wxObject*) ref , wxCheckListBox ) ;
-                    int i = itemID - 1 ;
-                    if (i >= 0 && i < list->GetCount() )
-                    {
-                        // we have to change this behind the back, since Check() would be triggering another update round
-                        bool newVal = !list->IsChecked( i ) ;
-                        verify_noerr( ::SetDataBrowserItemDataButtonValue( itemData , newVal ? kThemeButtonOn : kThemeButtonOff ) ) ;
-                        err = noErr ;
-                        list->m_checks[ i ] = newVal ;
-
-                        wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, list->GetId());
-                        event.SetInt(i);
-                        event.SetEventObject(list);
-                        list->GetEventHandler()->ProcessEvent(event);
-                    }
-                }
+    // Needed because it is a wxControlWithItems
+    SetInitialSize( size );

 
 

-            }
-            break ;
+    return true;
+}

 
 

-            default :
-            break ;
-        }
-    }
+// ----------------------------------------------------------------------------
+// wxCheckListBox functions
+// ----------------------------------------------------------------------------

 
 

-    return err;
-}
-bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
-                       const wxPoint& pos,
-                       const wxSize& size,
-                       int n, const wxString choices[],
-                       long style,
-                       const wxValidator& validator,
-                       const wxString& name)
+bool wxCheckListBox::IsChecked(unsigned int item) const

 {
 {

-    m_macIsUserPane = false ;
-
-    wxASSERT_MSG( !(style & wxLB_MULTIPLE) || !(style & wxLB_EXTENDED),
-                  _T("only one of listbox selection modes can be specified") );
+    wxCHECK_MSG( IsValid(item), false,
+                 wxT("invalid index in wxCheckListBox::IsChecked") );

 
 

-    if ( !wxListBoxBase::Create(parent, id, pos, size, style & ~(wxHSCROLL|wxVSCROLL), validator, name) )
-        return false;
+    return GetPeer()->MacIsChecked( item );
+}

 
 

-    m_noItems = 0 ; // this will be increased by our append command
-    m_selected = 0;
+void wxCheckListBox::Check(unsigned int item, bool check)
+{
+    wxCHECK_RET( IsValid(item),
+                 wxT("invalid index in wxCheckListBox::Check") );

 
 

-    Rect bounds = wxMacGetBoundsForControl( this , pos , size ) ;
+    bool isChecked = GetPeer()->MacIsChecked( item );
+    if ( check != isChecked )
+    {
+        GetPeer()->MacCheck( item , check );
+    }
+}

 
 

-    m_peer = new wxMacControl(this) ;
-    verify_noerr( ::CreateDataBrowserControl( MAC_WXHWND(parent->MacGetTopLevelWindowRef()), &bounds, kDataBrowserListView , m_peer->GetControlRefAddr() ) );
+wxMacCheckListControl* wxCheckListBox::GetPeer() const
+{
+    wxMacDataBrowserCheckListControl *lb = wxDynamicCast(m_peer,wxMacDataBrowserCheckListControl);
+    return lb ? wx_static_cast(wxMacCheckListControl*,lb) : 0 ;
+}

 
 

+const short kCheckboxColumnId = 1026;

 
 

-    DataBrowserSelectionFlags  options = kDataBrowserDragSelect ;
-    if ( style & wxLB_MULTIPLE )
-    {
-        options += kDataBrowserAlwaysExtendSelection + kDataBrowserCmdTogglesSelection  ;
-    }
-    else if ( style & wxLB_EXTENDED )
-    {
-        // default behaviour
-    }
-    else
-    {
-        options += kDataBrowserSelectOnlyOne ;
-    }
-    verify_noerr(m_peer->SetSelectionFlags( options ) );
+wxMacDataBrowserCheckListControl::wxMacDataBrowserCheckListControl( wxListBox *peer, const wxPoint& pos, const wxSize& size, long style)
+    : wxMacDataBrowserListControl( peer, pos, size, style )
+{
+    OSStatus err = noErr;

 
 

-    DataBrowserListViewColumnDesc columnDesc ;
+    DataBrowserListViewColumnDesc columnDesc;

     columnDesc.headerBtnDesc.titleOffset = 0;
     columnDesc.headerBtnDesc.version = kDataBrowserListViewLatestHeaderDesc;
 
     columnDesc.headerBtnDesc.titleOffset = 0;
     columnDesc.headerBtnDesc.version = kDataBrowserListViewLatestHeaderDesc;
 


@@ -254,145 +146,128 @@ bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
     columnDesc.headerBtnDesc.btnFontStyle.just = teFlushDefault;
     columnDesc.headerBtnDesc.btnFontStyle.font = kControlFontViewSystemFont;
     columnDesc.headerBtnDesc.btnFontStyle.style = normal;
     columnDesc.headerBtnDesc.btnFontStyle.just = teFlushDefault;
     columnDesc.headerBtnDesc.btnFontStyle.font = kControlFontViewSystemFont;
     columnDesc.headerBtnDesc.btnFontStyle.style = normal;

-    columnDesc.headerBtnDesc.titleString = NULL ; // CFSTR( "" );
+    columnDesc.headerBtnDesc.titleString = NULL;

 
 

-    // check column
-
-    columnDesc.headerBtnDesc.minimumWidth = 30 ;
+    columnDesc.headerBtnDesc.minimumWidth = 30;

     columnDesc.headerBtnDesc.maximumWidth = 30;
 
     columnDesc.propertyDesc.propertyID = kCheckboxColumnId;
     columnDesc.propertyDesc.propertyType = kDataBrowserCheckboxType;
     columnDesc.headerBtnDesc.maximumWidth = 30;
 
     columnDesc.propertyDesc.propertyID = kCheckboxColumnId;
     columnDesc.propertyDesc.propertyType = kDataBrowserCheckboxType;

-    columnDesc.propertyDesc.propertyFlags = kDataBrowserPropertyIsMutable | kDataBrowserTableViewSelectionColumn |
-                                            kDataBrowserDefaultPropertyFlags;
-    verify_noerr( m_peer->AddListViewColumn( &columnDesc, kDataBrowserListViewAppendColumn) ) ;
-
-    // text column
+    columnDesc.propertyDesc.propertyFlags =
+        kDataBrowserPropertyIsMutable
+        | kDataBrowserTableViewSelectionColumn
+        | kDataBrowserDefaultPropertyFlags;

 
 

-    columnDesc.headerBtnDesc.minimumWidth = 0;
-    columnDesc.headerBtnDesc.maximumWidth = 10000;
-
-    columnDesc.propertyDesc.propertyID = kTextColumnId;
-    columnDesc.propertyDesc.propertyType = kDataBrowserTextType;
-    columnDesc.propertyDesc.propertyFlags = kDataBrowserTableViewSelectionColumn
-#if MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_2
-     | kDataBrowserListViewTypeSelectColumn
-#endif
-    ;
-
-
-    verify_noerr( m_peer->AddListViewColumn( &columnDesc, kDataBrowserListViewAppendColumn) ) ;
-
-    verify_noerr( m_peer->AutoSizeListViewColumns() ) ;
-    verify_noerr( m_peer->SetHasScrollBars( false , true ) ) ;
-    verify_noerr( m_peer->SetTableViewHiliteStyle( kDataBrowserTableViewFillHilite  ) ) ;
-    verify_noerr( m_peer->SetListViewHeaderBtnHeight(0 ) ) ;
+    err = AddColumn( &columnDesc, 0 );
+    verify_noerr( err );
+}

 
 

-    DataBrowserCallbacks callbacks ;
-    callbacks.version = kDataBrowserLatestCallbacks;
-    InitDataBrowserCallbacks(&callbacks);
-    callbacks.u.v1.itemDataCallback = NewDataBrowserItemDataUPP(ListBoxGetSetItemData);
-    callbacks.u.v1.itemNotificationCallback =
-#if TARGET_API_MAC_OSX
-        (DataBrowserItemNotificationUPP) NewDataBrowserItemNotificationWithItemUPP(DataBrowserItemNotificationProc) ;
-#else
-        NewDataBrowserItemNotificationUPP(DataBrowserItemNotificationProc) ;
-#endif
-    m_peer->SetCallbacks( &callbacks);
+wxMacDataBrowserCheckListControl::~wxMacDataBrowserCheckListControl()
+{

 
 

-#if 0
-    // shouldn't be necessary anymore under 10.2
-    m_peer->SetData( kControlNoPart, kControlDataBrowserIncludesFrameAndFocusTag, (Boolean) false ) ;
-    m_peer->SetNeedsFocusRect( true ) ;
-#endif
+}

 
 

-    MacPostControlCreate(pos,size) ;
+class wxMacCheckListBoxItem : public wxMacListBoxItem
+{
+public :
+    wxMacCheckListBoxItem()
+    {
+        m_isChecked = false;
+    }

 
 

-    for ( int i = 0 ; i < n ; i++ )
+    virtual ~wxMacCheckListBoxItem()

     {
     {

-        Append( choices[i] ) ;

     }
 
     }
 

-    SetBestSize(size);   // Needed because it is a wxControlWithItems
+    virtual OSStatus GetSetData( wxMacDataItemBrowserControl *owner ,
+        DataBrowserPropertyID property,
+        DataBrowserItemDataRef itemData,
+        bool changeValue )
+    {
+        OSStatus err = errDataBrowserPropertyNotSupported;

 
 

-    return true;
-}
+        wxCheckListBox *checklist = wxDynamicCast( owner->GetPeer() , wxCheckListBox );
+        wxCHECK_MSG( checklist != NULL , errDataBrowserPropertyNotSupported , wxT("wxCheckListBox expected"));

 
 

-// ----------------------------------------------------------------------------
-// wxCheckListBox functions
-// ----------------------------------------------------------------------------
+        if ( !changeValue )
+        {
+            switch (property)
+            {
+                case kCheckboxColumnId:
+                    verify_noerr(SetDataBrowserItemDataButtonValue( itemData, m_isChecked ? kThemeButtonOn : kThemeButtonOff ));
+                    err = noErr;
+                    break;
+
+                case kDataBrowserItemIsEditableProperty:
+                    verify_noerr(SetDataBrowserItemDataBooleanValue( itemData, true ));
+                    err = noErr;
+                    break;
+
+                default:
+                    break;
+            }
+        }
+        else
+        {
+            switch (property)
+            {
+            case kCheckboxColumnId:
+                {
+                    // we have to change this behind the back, since Check() would be triggering another update round
+                    bool newVal = !m_isChecked;
+                    verify_noerr(SetDataBrowserItemDataButtonValue( itemData, newVal ? kThemeButtonOn : kThemeButtonOff ));
+                    m_isChecked = newVal;
+                    err = noErr;
+
+                    wxCommandEvent event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, checklist->GetId() );
+                    event.SetInt( owner->GetLineFromItem( this ) );
+                    event.SetEventObject( checklist );
+                    checklist->HandleWindowEvent( event );
+                }
+                break;

 
 

-bool wxCheckListBox::IsChecked(size_t item) const
-{
-    wxCHECK_MSG( item < m_checks.GetCount(), false,
-                 _T("invalid index in wxCheckListBox::IsChecked") );
+            default:
+                break;
+            }
+        }

 
 

-    return m_checks[item] != 0;
-}
+        if ( err == errDataBrowserPropertyNotSupported )
+            err = wxMacListBoxItem::GetSetData( owner , property, itemData , changeValue);

 
 

-void wxCheckListBox::Check(size_t item, bool check)
-{
-    wxCHECK_RET( item < m_checks.GetCount(),
-                 _T("invalid index in wxCheckListBox::Check") );
+        return err;
+    }

 
 

-    bool isChecked = m_checks[item] != 0;
-    if ( check != isChecked )
+    void Check( bool check )

     {
     {

-        m_checks[item] = check;
-        UInt32 id = item + 1 ;
-        verify_noerr( m_peer->UpdateItems(kDataBrowserNoItem , 1 , &id , kDataBrowserItemNoProperty , kDataBrowserItemNoProperty ) ) ;
+        m_isChecked = check;
+    }
+    bool IsChecked() const
+    {
+         return m_isChecked;

     }
     }

-}

 
 

-// ----------------------------------------------------------------------------
-// methods forwarded to wxCheckListBox
-// ----------------------------------------------------------------------------
+protected :
+    bool        m_isChecked;
+};

 
 

-void wxCheckListBox::Delete(int n)
+wxMacDataItem* wxMacDataBrowserCheckListControl::CreateItem()

 {
 {

-    wxCHECK_RET( n < GetCount(), _T("invalid index in wxCheckListBox::Delete") );
-
-    wxListBox::Delete(n);
-
-    m_checks.RemoveAt(n);
+    return new wxMacCheckListBoxItem();

 }
 
 }
 

-int wxCheckListBox::DoAppend(const wxString& item)
+void wxMacDataBrowserCheckListControl::MacCheck( unsigned int n, bool bCheck)

 {
 {

-    int pos = wxListBox::DoAppend(item);
-
-    // the item is initially unchecked
-    m_checks.Insert(false, pos);
-
-    return pos;
+    wxMacCheckListBoxItem* item = wx_static_cast(wxMacCheckListBoxItem*, GetItemFromLine( n) );
+    item->Check( bCheck);
+    UpdateItem(wxMacDataBrowserRootContainer, item , kCheckboxColumnId);

 }
 
 }
 

-void wxCheckListBox::DoInsertItems(const wxArrayString& items, int pos)
+bool wxMacDataBrowserCheckListControl::MacIsChecked( unsigned int n) const

 {
 {

-    wxListBox::DoInsertItems(items, pos);
-
-    size_t count = items.GetCount();
-    for ( size_t n = 0; n < count; n++ )
-    {
-        m_checks.Insert(false, pos + n);
-    }
+    wxMacCheckListBoxItem * item = wx_static_cast( wxMacCheckListBoxItem*, GetItemFromLine( n ) );
+    return item->IsChecked();

 }
 
 }
 

-void wxCheckListBox::DoSetItems(const wxArrayString& items, void **clientData)
-{
-    // call it first as it does DoClear()
-    wxListBox::DoSetItems(items, clientData);

 
 

-    size_t count = items.GetCount();
-    for ( size_t n = 0; n < count; n++ )
-    {
-        m_checks.Add(false);
-    }
-}
-
-void wxCheckListBox::DoClear()
-{
-    m_checks.Empty();
-}

 
 #endif // wxUSE_CHECKLISTBOX
 
 #endif // wxUSE_CHECKLISTBOX