This is a (nearly complete) replacement for Xojo's ListBox control, for Mac OS X. It requires MBS Plugins 17.1 (March 9, 2017 or later) Advantages over Xojo's ListBox: • Uses Apple's native NSTableView control, with its proper appearance, hence... • Looks better in a Mac app. • Column resizing works better (observing minimum widths and showing a horizontal scrollbar when necessary). • Support column reordering. • Supports right-clicks (CMM clicks) on the headers. • Correct handling of multiple selected rows, including right-clicks. • Offers more customization options (e.g., you get extra Events from the NSTableView). • ConstructContextualMenu works as it should (i.e. for right clicks and ctrl-clicks). • Faster. • Open Source. Disadvantages: • Mac-only. • No custom drawing in cells via ...Paint events (but you can instead use NSGraphicsMBS functions). • No support for Database Binding. • Limited grid line options. • A few functions where a -1 parameter designates ALL rows or columns do not work (leading to an OutOfRangeException). To use it, copy the entire "ListBox_NSOutlineView" folder into your project, then change the Super class of your ListBox controls to ListBoxTV, and see if your project still compiles and runs. If you're using the CellBackgroundPaint or CellTextPaint events, see if you're only using it to change the color or font of the cells and text. See the note "Handling CellBackgroundPaint and CellTextPaint" for a solution.

The sortDescriptorsDidChange event is not implemented here because we handle sorting in the tableView's didClickTableColumn event, which is called after this event.

Initial author (Feb 2017): Thomas Tempelmann, tempelmann@gmail.com This code is free, i.e. no contributing author may claim rights (or copyright) on it. If you add new features, please send them back to Thomas for redistribution. Adding a test case for the new feature would be nice, too.

If you implement either of these events to draw custom text or images, they won't work, because the "g as Graphics" parameter will be nil (that's a limitation caused by Xojo Inc. because their Plugin API does not supply the needed code for making use of the Graphics class). If you only want to have a particular background or text color, you can instead preset them like this: myListbox.CellStyle (row, col).TextColor = ... myListbox.CellStyle (row, col).BackgroundColor = ...

Since the Xojo ListBox's ConstructContextualMenu event does not handle right clicks (or ctrl-clicks) correctly with multiple selections, you may have tried to ignore the event and instead handle such clicks in the MouseDown event by checking "IsContextualClick". You may still do that. But if you plan to use the ConstructContextualMenu, you need to set the ListBoxTV's control's UseContextualClickEvent property to True, e.g. right in the Window layout editor for the control, so that ConstructContextualMenu gets called as desired. You should do that (i.e. set UseContextualClickEvent=true and use ConstructContextualMenu) over checking for IsContextualClick in the MouseDown event in order to have proper behavior, especially when you allow multi-selection in the Listbox.

By default, the TableView is in NSCell mode, which works with a limited set of predefined layout choices. The code handling this layout is found in the ListBoxTV.willDisplayCell() event. Alternatively, you can supply your own layout by returning a custom NSViewMBS from the ListBoxTV.view() event. If the view() event is added, the willDisplayCell() event becomes unused automatically. So, if you experiment with returning an NSView and are not happy with it, you need to remove the view() event entirely again to revert to using the NSCell mode. As a simple example, here's how to put a button into every cell. Place the following code into the view() event: dim button as new NSButtonMBS button.Title = "Button" return button To add multiple views, see the forum: https://forum.xojo.com/49354-listboxtv-mbs-plugins

If you have a lot (thousands) of rows, the performance of Xojo's ListBox will notably decrease. With this ListBoxTV, you can prevent this. The solution is to not add your rows and cells beforehand, by using AddRow(), but instead just tell the Listbox how many rows you have. The TableView class will then show an adequate scrollbar for the entire number of rows, but will only ask you to provide the data for the rows and cells it currently shows in the window, which will be usually only a few dozen values. If the user scrolls the list, your code will then be asked again for only those new cells, and so on. To accomplish that, implement the ListBoxTVDataSource interface. Either implement them in a new class, or add them to your window or other class that you already maintain for your data. You do not need to add code for all its functions, which all begin with "DataSource_". Most of them you may leave empty, unless you want to support sorting, row dragging, column dragging or editing. Then set the listbox's DataSource property to your class that implements the ListBoxTVDataSource interface. The minimum you have to add code to are: • DataSource_ChildCount (rowItem as ListRowTV) as Integer Here you need to return the total number of rows you want to be able to show. If the list is hierarchical, then check the rowItem parameter - if it's nil, it means the root (top) level, so you'd return the number of rows at that level, otherwise the child count of the given ListRowTV node. • DataSource_ChildItem (rowItem as ListRowTV, index as Integer) as ListRowTV Here you need to return a ListRowTV object (or a subclass of it). Again, if rowItem is nil, you're at the root level. Otherwise, it's the node for one of your previously returned ListRowTV objects. This lets you build a tree of your hierarchical list. • DataSource_Cell (row as Integer, column as Integer) as ListCellTV This returns an object of type ListCellTV, which contains the Text property for the cell's display, as well as other properties such as Indentation, Alignment etc. If you want to keep it simple, return this: return new ListCellTV ("here goes the cell's text") • DataSource_RowItem (row as Integer) as ListBoxTV This has to return the row item for the currently visible listbox row. This means you have to be able to tell which ListRowTV appears at which row. If you have a flat list, this is equal to calling DataSource_ChildItem(nil, row). For a hierarchical list, you need to iterate over all shown rows, counting the visible children, until you reach the row in question. Now, whenever you know the listbox needs to be refreshed, i.e. it should call your DataSource_ChildCount(), DataSource_ChildItem() and DataSource_Cell() functions again, call the listbox's Reload() function.

Not working, yet: • EnableDragReorder does not work right, yet: DataSource_MoveRows can't distinguish whether one wants to insert into the last row of a folder or into the row following the folder's end. To fix that, not the dest row but the parent node and child index needs to be passed to it. • Row Insertion. • Font attributes (bold, italic) for entire list defaults and for individual cells. Anything else? Let me (TT) know!

Released Versions (oldest first) 1 - (16 Mar 2017) • Fixes Sort operation. • Makes all DataSource functions atomic, by using "#pragma DisableBackgroundTasks". 2 - (14 Aug 2018) • Fixes a bug in ListBoxTV.ListCount(), avoiding potentially outdated values. • Improvements to "row drag reorder" handling. • New methods BeginUpdates() and EndUpdates() for more efficient updating. • New: ListBoxTV.RemoveRow(). • Custom sorting implemented. • Various bug fixes. • New Note in ListBoxTV about NSView vs NSCell based TableView cells. 3 - (16 Aug 2018) • Should now work in 64 bit builds (by fixing NSRect struct usage) 4 - (18 Aug 2018) • Fixes the vertical scrollbar gap no matter what the System Preferences "General" / "Show scroll bars" is set to. 5 - (20 Aug 2018) • Fixes placement of the ContainerControl (in some circumstance, its original would get moved to negative offsets). • Can now add multiple columns in one AddRow() call. • Renames interface function DataSource_ItemCount() to DataSource_ChildCount().

This handles custom drawing for cells. Note: This only works for "normal" cells, not for Checkbox cells - they would need a different NSCell subclass implementation from MBS, which isn't available (yet).