Misc XRC format docs corrections.

[wxWidgets.git] / src / cocoa / listbox.mm

diff --git a/src/cocoa/listbox.mm b/src/cocoa/listbox.mm
index 4a00720bccbafee8b3d5d30e9d97e8cf9ba4f878..f75f35c0ab43bd7ca0999f6993985c5dea57d140 100644 (file)
--- a/src/cocoa/listbox.mm
+++ b/src/cocoa/listbox.mm
@@ -1,24 +1,89 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        cocoa/listbox.mm
+// Name:        src/cocoa/listbox.mm

 // Purpose:     wxListBox
 // Author:      David Elliott
 // Modified by:
 // Created:     2003/03/18
 // Purpose:     wxListBox
 // Author:      David Elliott
 // Modified by:
 // Created:     2003/03/18

-// RCS-ID:      $Id: 

 // Copyright:   (c) 2003 David Elliott
 // Copyright:   (c) 2003 David Elliott

-// Licence:    wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#include "wx/app.h"
+#include "wx/wxprec.h"
+
+#if wxUSE_LISTBOX
+

 #include "wx/listbox.h"
 #include "wx/listbox.h"

-#include "wx/log.h"

 
 

-#import <AppKit/NSView.h>
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/app.h"
+#endif //WX_PRECOMP
+
+#include "wx/cocoa/string.h"
+#include "wx/cocoa/autorelease.h"
+#include "wx/cocoa/ObjcRef.h"
+#include "wx/cocoa/private/scrollview.h"
+#include "wx/cocoa/NSTableDataSource.h"
+
+#import <Foundation/NSArray.h>
+#import <Foundation/NSEnumerator.h>
+#import <AppKit/NSTableView.h>
+#import <AppKit/NSTableColumn.h>
+#import <AppKit/NSScrollView.h>
+#import <AppKit/NSCell.h>
+  
+
+// ============================================================================
+// helper functions
+// ============================================================================
+
+static CGFloat _TableColumnMaxWidthForItems(NSTableColumn *tableColumn, NSArray *items)
+{
+    wxAutoNSAutoreleasePool pool;
+
+    NSCell *dataCell = [[[tableColumn dataCell] copy] autorelease];
+    CGFloat width = 0.0f;
+    NSEnumerator *itemEnum = [items objectEnumerator];
+    NSString *item;
+    while( (item = [itemEnum nextObject]) != nil )
+    {
+        [dataCell setStringValue: item];
+        NSSize itemSize = [dataCell cellSize];
+        CGFloat itemWidth = itemSize.width;
+        if(itemWidth > width)
+            width = itemWidth;
+    }
+    return width;
+}
+
+static void _SetWidthOfTableColumnToFitItems(NSTableColumn *tableColumn, NSArray *items)
+{
+    CGFloat width = _TableColumnMaxWidthForItems(tableColumn, items);
+    [tableColumn setWidth:width];
+    [tableColumn setMinWidth:width];
+}
+
+// ============================================================================
+// class wxListBox
+// ============================================================================

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControl)

 BEGIN_EVENT_TABLE(wxListBox, wxListBoxBase)
 END_EVENT_TABLE()
 BEGIN_EVENT_TABLE(wxListBox, wxListBoxBase)
 END_EVENT_TABLE()

-// WX_IMPLEMENT_COCOA_OWNER(wxListBox,NSButton,NSControl,NSView)
+WX_IMPLEMENT_COCOA_OWNER(wxListBox,NSTableView,NSControl,NSView)
+
+bool wxListBox::Create(wxWindow *parent, wxWindowID winid,
+            const wxPoint& pos,
+            const wxSize& size,
+            const wxArrayString& choices,
+            long style,
+            const wxValidator& validator,
+            const wxString& name)
+{
+    wxCArrayString chs(choices);
+
+    return Create(parent, winid, pos, size, chs.GetCount(), chs.GetStrings(),
+                  style, validator, name);
+}

 
 bool wxListBox::Create(wxWindow *parent, wxWindowID winid,
             const wxPoint& pos,
 
 bool wxListBox::Create(wxWindow *parent, wxWindowID winid,
             const wxPoint& pos,


@@ -28,111 +93,262 @@ bool wxListBox::Create(wxWindow *parent, wxWindowID winid,
             const wxValidator& validator,
             const wxString& name)
 {
             const wxValidator& validator,
             const wxString& name)
 {

+/*
+wxLB_SINGLE
+Single-selection list.
+
+wxLB_MULTIPLE
+Multiple-selection list: the user can toggle multiple items on and off.
+
+wxLB_EXTENDED
+Extended-selection list: the user can select multiple items using the SHIFT key and the mouse or special key combinations.
+
+wxLB_HSCROLL
+Create horizontal scrollbar if contents are too wide (Windows only).
+
+wxLB_ALWAYS_SB
+Always show a vertical scrollbar.
+
+wxLB_NEEDED_SB
+Only create a vertical scrollbar if needed.
+
+wxLB_SORT
+The listbox contents are sorted in alphabetical order.
+*/
+    wxAutoNSAutoreleasePool pool;

     if(!CreateControl(parent,winid,pos,size,style,validator,name))
         return false;
 
     if(!CreateControl(parent,winid,pos,size,style,validator,name))
         return false;
 

-    SetNSView([[NSView alloc] initWithFrame: NSMakeRect(10,10,20,20)]);
+    // Provide the data
+    m_cocoaItems = wxGCSafeRetain([NSMutableArray arrayWithCapacity:n]);
+    for(int i=0; i < n; i++)
+    {
+        [m_cocoaItems addObject: wxNSStringWithWxString(choices[i])];
+    }
+    // Remove everything
+    m_itemClientData.Clear();
+    // Initialize n elements to NULL
+    m_itemClientData.SetCount(n,NULL);
+
+    SetNSTableView([[NSTableView alloc] initWithFrame: MakeDefaultNSRect(size)]);

     [m_cocoaNSView release];
     [m_cocoaNSView release];

+    [GetNSTableView() setHeaderView: nil];
+
+    // Set up the data source
+    m_cocoaDataSource = [[WX_GET_OBJC_CLASS(wxCocoaNSTableDataSource) alloc] init];
+    [GetNSTableView() setDataSource:m_cocoaDataSource];

 
 

+    // Add the single column
+    NSTableColumn *tableColumn = [[NSTableColumn alloc] initWithIdentifier:nil];
+    [GetNSTableView() addTableColumn: tableColumn];
+    // By default, entries should not be editable
+    [tableColumn setEditable:NO];
+    [tableColumn release];
+
+    [GetNSTableView() sizeToFit];
+    // Finish

     if(m_parent)
         m_parent->CocoaAddChild(this);
     if(m_parent)
         m_parent->CocoaAddChild(this);

+    // NSTableView does WEIRD things with sizes.  Wrapping it in an
+    // NSScrollView seems to be the only reasonable solution.
+    CocoaCreateNSScrollView();
+    SetInitialFrameRect(pos,size);
+
+    if ((style & wxLB_NEEDED_SB) || (style & wxLB_ALWAYS_SB))
+    {
+        [m_wxCocoaScrollView->GetNSScrollView() setHasVerticalScroller: YES];
+    }
+
+    if (style & wxLB_HSCROLL)
+    {
+        [m_wxCocoaScrollView->GetNSScrollView() setHasHorizontalScroller: YES];
+    }
+
+    // We can't set auto-hiding individually for horizontal/vertical scrollers,
+    // so we have settled on always allowing hiding for both unless the vertical
+    // setting is "always show".
+    if (((style & wxLB_NEEDED_SB) || (style & wxLB_HSCROLL)) && !(style & wxLB_ALWAYS_SB))
+    {
+        if ([m_wxCocoaScrollView->GetNSScrollView() respondsToSelector:@selector(setAutohidesScrollers:)])
+        {
+            [m_wxCocoaScrollView->GetNSScrollView() setAutohidesScrollers: YES];
+        }
+    }
+
+    // Set up extended/multiple selection flags
+    if ((style & wxLB_EXTENDED) || (style & wxLB_MULTIPLE))
+        //diff is that mult requires shift down for multi selection
+        [GetNSTableView() setAllowsMultipleSelection:true];
+
+    [GetNSTableView() setAllowsColumnSelection:false];
+    _SetWidthOfTableColumnToFitItems(tableColumn, m_cocoaItems);

     return true;
 }
 
     return true;
 }
 

-wxListBox::~wxListBox()
+wxSize wxListBox::DoGetBestSize() const

 {
 {

-    CocoaRemoveFromParent();
-    SetNSView(NULL);
+    wxSize size = wxControlWithItems::DoGetBestSize();
+    // Limit best size to 100x100. It can be smaller if none of the items are very
+    // wide or if there aren't many items, but anything bigger than 100x100 ought
+    // to be asked for by the programmer. The 100x100 size is based on being barely
+    // enough for a scroller to be usable.
+    if(size.GetWidth() > 100)
+        size.SetWidth(100);
+    if(size.GetHeight() > 100)
+        size.SetHeight(100);
+    return size;

 }
 
 }
 

-// pure virtuals from wxListBoxBase
-bool wxListBox::IsSelected(int n) const
+wxListBox::~wxListBox()

 {
 {

-    return false;
+    [GetNSTableView() setDataSource: nil];
+    [m_cocoaDataSource release];
+    wxGCSafeRelease(m_cocoaItems);
+    m_cocoaItems = nil;
+    DisassociateNSTableView(GetNSTableView());

 }
 
 }
 

-void wxListBox::SetSelection(int n, bool select)
+bool wxListBox::_WxCocoa_GetNeedsUpdate()

 {
 {

+    return m_needsUpdate;

 }
 
 }
 

-int wxListBox::GetSelections(wxArrayInt& aSelections) const
+void wxListBox::_WxCocoa_SetNeedsUpdate(bool needsUpdate)

 {
 {

-    return 0;
+    m_needsUpdate = needsUpdate;

 }
 
 }
 

-void wxListBox::DoInsertItems(const wxArrayString& items, int pos)
+void wxListBox::OnInternalIdle()

 {
 {

+    wxControlWithItems::OnInternalIdle();
+    if(_WxCocoa_GetNeedsUpdate())
+    {
+        _SetWidthOfTableColumnToFitItems([[GetNSTableView() tableColumns] objectAtIndex:0], m_cocoaItems);
+        [GetNSTableView() tile];
+        [GetNSTableView() reloadData];
+        _WxCocoa_SetNeedsUpdate(false);
+    }

 }
 
 }
 

-void wxListBox::DoSetItems(const wxArrayString& items, void **clientData)
+int wxListBox::CocoaDataSource_numberOfRows()

 {
 {

+    return [m_cocoaItems count];

 }
 
 }
 

-void wxListBox::DoSetFirstItem(int n)
+struct objc_object* wxListBox::CocoaDataSource_objectForTableColumn(
+        WX_NSTableColumn tableColumn, int rowIndex)

 {
 {

+    return [m_cocoaItems objectAtIndex:rowIndex];

 }
 
 }
 

+// pure virtuals from wxListBoxBase
+bool wxListBox::IsSelected(int n) const
+{
+    return [GetNSTableView() isRowSelected: n];
+}

 
 

-// pure virtuals from wxItemContainer
-    // deleting items
-void wxListBox::Clear()
+void wxListBox::DoSetSelection(int n, bool select)

 {
 {

+    if(select)
+        [GetNSTableView() selectRow: n byExtendingSelection:NO];
+    else
+        [GetNSTableView() deselectRow: n];

 }
 
 }
 

-void wxListBox::Delete(int n)
+int wxListBox::GetSelections(wxArrayInt& aSelections) const

 {
 {

+    aSelections.Clear();
+    NSEnumerator *enumerator = [GetNSTableView() selectedRowEnumerator];
+    while(NSNumber *num = [enumerator nextObject])
+    {
+        aSelections.Add([num intValue]);
+    }
+    return [GetNSTableView() numberOfSelectedRows];

 }
 
 }
 

-    // accessing strings
-int wxListBox::GetCount() const
+int wxListBox::DoInsertItems(const wxArrayStringsAdapter & items, unsigned int pos, void **clientData, wxClientDataType type)

 {
 {

-    return 0;
+    wxAutoNSAutoreleasePool pool;
+
+    const unsigned int numItems = items.GetCount();
+    for ( unsigned int i = 0; i < numItems; ++i, ++pos )
+    {
+        [m_cocoaItems insertObject: wxNSStringWithWxString(items[i])
+            atIndex: pos];
+        m_itemClientData.Insert(NULL, pos);
+        AssignNewItemClientData(pos, clientData, i, type);
+    }
+
+    _WxCocoa_SetNeedsUpdate(true);
+    return pos - 1;

 }
 
 }
 

-wxString wxListBox::GetString(int n) const
+void wxListBox::DoSetFirstItem(int n)

 {
 {

-    return wxEmptyString;
+    [m_cocoaItems exchangeObjectAtIndex:0 withObjectAtIndex:n];
+    void* pOld = m_itemClientData[n];
+    m_itemClientData[n] = m_itemClientData[0];
+    m_itemClientData[0] = pOld;
+    _WxCocoa_SetNeedsUpdate(true);

 }
 
 }
 

-void wxListBox::SetString(int n, const wxString& s)
+
+// pure virtuals from wxItemContainer
+    // deleting items
+void wxListBox::DoClear()

 {
 {

+    [m_cocoaItems removeAllObjects];
+    m_itemClientData.Clear();
+    _WxCocoa_SetNeedsUpdate(true);

 }
 
 }
 

-int wxListBox::FindString(const wxString& s) const
+void wxListBox::DoDeleteOneItem(unsigned int n)

 {
 {

-    return 0;
+    [m_cocoaItems removeObjectAtIndex:n];
+    m_itemClientData.RemoveAt(n);
+    _WxCocoa_SetNeedsUpdate(true);

 }
 
 }
 

-    // selection
-void wxListBox::Select(int n)
+    // accessing strings
+unsigned int wxListBox::GetCount() const

 {
 {

+    return (unsigned int)[m_cocoaItems count];

 }
 
 }
 

-int wxListBox::GetSelection() const
+wxString wxListBox::GetString(unsigned int n) const

 {
 {

-    return 0;
+    return wxStringWithNSString([m_cocoaItems objectAtIndex:n]);

 }
 
 }
 

-int wxListBox::DoAppend(const wxString& item)
+void wxListBox::SetString(unsigned int n, const wxString& s)

 {
 {

-    return 0;
+    wxAutoNSAutoreleasePool pool;
+    [m_cocoaItems removeObjectAtIndex:n];
+    [m_cocoaItems insertObject: wxNSStringWithWxString(s) atIndex: n];
+    _WxCocoa_SetNeedsUpdate(true);

 }
 
 }
 

-void wxListBox::DoSetItemClientData(int n, void* clientData)
+int wxListBox::FindString(const wxString& s, bool bCase) const

 {
 {

+    // FIXME: use wxItemContainerImmutable::FindString for bCase parameter
+    wxAutoNSAutoreleasePool pool;
+    return [m_cocoaItems indexOfObject:wxNSStringWithWxString(s)];

 }
 
 }
 

-void* wxListBox::DoGetItemClientData(int n) const
+    // selection
+int wxListBox::GetSelection() const

 {
 {

-    return NULL;
+    return [GetNSTableView() selectedRow];

 }
 
 }
 

-void wxListBox::DoSetItemClientObject(int n, wxClientData* clientData)
+void wxListBox::DoSetItemClientData(unsigned int n, void* clientData)

 {
 {

+    m_itemClientData[n] = clientData;

 }
 
 }
 

-wxClientData* wxListBox::DoGetItemClientObject(int n) const
+void* wxListBox::DoGetItemClientData(unsigned int n) const

 {
 {

-    return NULL;
+    return m_itemClientData[n];

 }
 
 }
 

+#endif // wxUSE_LISTBOX