Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

NSOutlineControlMBS.acceptDrop(info as NSDraggingInfoMBS, item as NSOutlineViewItemMBS, index as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Returns a Boolean value that indicates whether a drop operation was successful.
Notes:
info: An object that contains more information about this dragging operation.
item: The parent of the item over which the cursor was placed when the mouse button was released.
index: The index of the child of item over which the cursor was placed when the mouse button was released.

Return true if the drop operation was successful, otherwise false.

The data source should incorporate the data from the dragging pasteboard in the implementation of this method. You can get the data for the drop operation from info using the draggingPasteboard method.
The return value indicates success or failure of the drag operation to the system.

Feedback, Comments & Corrections

NSOutlineControlMBS.BoundsChanged
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: The event called when the bounds, but not the frame, changed.

Feedback, Comments & Corrections

NSOutlineControlMBS.childOfItem(index as Integer, item as NSOutlineViewItemMBS) as NSOutlineViewItemMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Returns the child item at the specified index of a given item.
Notes:
index: The index of the child item from item to return.
item: An item in the data source.

Return the child item at index of item. If item is nil, returns the appropriate child item of the root object.

Children of a given parent item are accessed sequentially. In order for the collapsed state of the outline view to remain consistent when it is reloaded you must always return the same object for a specified child and item.

Do not call reloadData from this method.

This event is called very frequently, so it must be efficient.

Feedback, Comments & Corrections

NSOutlineControlMBS.ColumnDidMove(notification as NSNotificationMBS, OldColumn as Integer, NewColumn as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Invoked whenever the user moves a column in the outline view.

Feedback, Comments & Corrections

NSOutlineControlMBS.ColumnDidResize(notification as NSNotificationMBS, tableColumn as NSTableColumnMBS, OldWidth as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Invoked whenever the user resizes a column in the outline view.

Feedback, Comments & Corrections

NSOutlineControlMBS.concludeDragOperation(info as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Invoked when the dragging operation is complete, signaling the receiver to perform any necessary clean-up.
Notes:
sender: The object sending the message; use it to get details about the dragging operation.

For this method to be invoked, the previous performDragOperation must have returned true.

The destination implements this method to perform any tidying up that it needs to do, such as updating its visual representation now that it has incorporated the dragged data. This message is the last message sent from sender to the destination during a dragging session.

If the sender object's animatesToDestination property was set to true in prepareForDragOperation, then the drag image is still visible. At this point you should draw the final visual representation in the view. When this method returns, the drag image is removed form the screen. If your final visual representation matches the visual representation in the drag, this is a seamless transition.

Feedback, Comments & Corrections

NSOutlineControlMBS.dataCell(tableColumn as NSTableColumnMBS, item as NSOutlineViewItemMBS) as NSCellMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Returns the cell to use in a given column for a given item.
Notes:
tableColumn: The table column for which the cell is required. This value may be nil.
item: The item for which the cell is required.

Return the cell to use in column tableColumn for item item, or nil. The cell must properly implement copyWithZone (since it may be copied by by the outline view).

You can return a different data cell for any particular combination of table column and item, or a cell that will be used for the entire row (a full-width cell). If tableColumn is non-nil, you should return a cell. Typically, you should default to returning the result from [tableColumn dataCellForRow:row].
When each row (identified by the item) is being drawn, this method is first called with a nil value for tableColumn. At this time, you can return a cell that is used to draw the entire row, acting like a group. If you do return a cell for the nil table column, your implementations of the other corresponding data source and delegate methods must be prepared to be invoked with a nil value for tableColumn. If do not return a cell for the nil table column, the method is called once for each column in the outline view, as usual.

Feedback, Comments & Corrections

NSOutlineControlMBS.didAddRowView(rowView as NSTableRowViewMBS, row as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Implemented to know when a new row view is added to the table.
Notes:
rowView: The new row view.
row: The row to which the view was added.

This evemt is for NSView-based outline views. At this point, you can choose to add in extra views or modify any properties on rowView.

Feedback, Comments & Corrections

NSOutlineControlMBS.didClickTableColumn(tableColumn as NSTableColumnMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Sent at the time the mouse button subsequently goes up in outlineView and tableColumn has been “clicked” without having been dragged anywhere.

Feedback, Comments & Corrections

NSOutlineControlMBS.didDragTableColumn(tableColumn as NSTableColumnMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Sent at the time the mouse button goes up in outlineView and tableColumn has been dragged during the time the mouse button was down.

Feedback, Comments & Corrections

NSOutlineControlMBS.didRemoveRowView(rowView as NSTableRowViewMBS, row as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Implemented to know when a row view is removed from the table
Notes:
rowView: The row view that was removed.
row: The number of the row that was removed due to being moved offscreen, or -1 if the row was removed from the table so it is no longer valid.

The removed rowView may be reused by the table, so any additionally inserted views should be removed at this point.

Feedback, Comments & Corrections

NSOutlineControlMBS.didTile
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: The tableview did tile.
Notes: The internal tile function properly sizes the table view and its header view and marks it as needing display.

Feedback, Comments & Corrections

NSOutlineControlMBS.DoubleClick
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: The mouse made a double click.

Feedback, Comments & Corrections

NSOutlineControlMBS.draggingEnded(info as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Implement this event to be notified when a drag operation ends in some other destination.
Notes:
sender: The object sending the message; use it to get details about the dragging operation.
This method might be used by a destination doing auto-expansion in order to collapse any auto-expands.

Feedback, Comments & Corrections

NSOutlineControlMBS.draggingExited(info as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Invoked when the dragged image enters destination bounds or frame; delegate returns dragging operation to perform.
Notes:
sender: The object sending the message; use it to get details about the dragging operation.

Return one (and only one) of the dragging operation constants described in NSDragOperation in the NSDraggingInfo reference. The default return value (if this method is not implemented by the destination) is the value returned by the previous draggingEntered message.

Invoked when a dragged image enters the destination but only if the destination has registered for the pasteboard data type involved in the drag operation. Specifically, this method is invoked when the mouse pointer enters the destination's bounds rectangle (if it is a view object) or its frame rectangle (if it is a window object).

This method must return a value that indicates which dragging operation the destination will perform when the image is released. In deciding which dragging operation to return, the method should evaluate the overlap between both the dragging operations allowed by the source (obtained from sender with the draggingSourceOperationMask method) and the dragging operations and pasteboard data types the destination itself supports.

If none of the operations is appropriate, this method should return NSDragOperationNone (this is the default response if the method is not implemented by the destination). A destination will still receive draggingUpdated and draggingExited even if NSDragOperationNone is returned by this method.

Feedback, Comments & Corrections

NSOutlineControlMBS.draggingSessionEnded(session as NSDraggingSessionMBS, screenPoint as NSPointMBS, operation as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Implement this method to know when the given dragging session has ended.
Notes:
session: The dragging session that ended.
screenPoint: The point onscreen at which the drag ended.
operation: A mask specifying the types of drag operations permitted by the dragging source.

You can implement this optional delegate method to know when the dragging source operation ended at a specific location, such as the trash (by checking for an operation of NSDragOperationDelete).

Feedback, Comments & Corrections

NSOutlineControlMBS.draggingSessionWillBegin(session as NSDraggingSessionMBS, screenPoint as NSPointMBS, draggedItems() as NSOutlineViewItemMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Implement this method know when the given dragging session is about to begin and potentially modify the dragging session.
Notes:
session: The dragging session that is about to begin.
screenPoint: The point onscreen at which the drag is to begin.
draggedItems: A array of items to be dragged, excluding items for which pasteboardWriterForItem returns nil.

The draggedItems array directly matches the pasteboard writer array used to begin the dragging session with the NSView method beginDraggingSessionWithItems. Hence, the order is deterministic, and can be used in acceptDrop when enumerating the NSDraggingInfo protocol's pasteboard classes.

Feedback, Comments & Corrections

NSOutlineControlMBS.EnableMenuItems
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: The event where you can enable menu items.

Feedback, Comments & Corrections

NSOutlineControlMBS.FrameChanged
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: The event called when the frame changed.

Feedback, Comments & Corrections

NSOutlineControlMBS.GotFocus
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: The control itself got focus.
Notes: This only fires if the control itself got focus and not a sub control.

Feedback, Comments & Corrections

NSOutlineControlMBS.heightOfRowByItem(item as NSOutlineViewItemMBS) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Returns the height in points of the row containing item.
Notes:
item: The row item.

Return the height of the row.

Values returned by this method should not include intercell spacing and must be greater than 0.
Implement this event to support an outline view with varying row heights.

For large tables in particular, you should make sure that this method is efficient. NSOutlineView may cache the values this method returns, so if you would like to change a row's height make sure to invalidate the row height by calling noteHeightOfRowsWithIndexesChanged. NSOutlineView automatically invalidates its entire row height cache in reloadData and noteNumberOfRowsChanged.

If you call viewAtColumn or rowViewAtRow within your implementation of this method, an exception is thrown.

To avoid the possibility of a hang due to unexpected recursion, don’t call geometry-calculating methods such as bounds, rectOfColumn, or any NSTableView method that calls tile within your implementation of this method.

Feedback, Comments & Corrections

NSOutlineControlMBS.isGroupItem(item as NSOutlineViewItemMBS) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Returns a Boolean that indicates whether a given row should be drawn in the “group row” style.
Notes:
item: An item in the outline view.

Return true to indicate a particular row should have the "group row" style drawn for that row, otherwise false.

If the cell in that row is an instance of NSTextFieldCell and contains only a string value, the “group row” style attributes are automatically applied for that cell.

Feedback, Comments & Corrections

NSOutlineControlMBS.isItemExpandable(item as NSOutlineViewItemMBS) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Returns a Boolean value that indicates whether the a given item is expandable.
Notes:
item: An item in the data source.

Returns true if item can be expanded to display its children, otherwise NO.

This method may be called quite often, so it must be efficient.

Do not call reloadData from this method.

Feedback, Comments & Corrections

NSOutlineControlMBS.ItemDidCollapse(notification as NSNotificationMBS, item as NSOutlineViewItemMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Invoked when the did collapse notification is posted—that is, whenever the user collapses an item in the outline view.

Feedback, Comments & Corrections

NSOutlineControlMBS.ItemDidExpand(notification as NSNotificationMBS, item as NSOutlineViewItemMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Invoked when notification is posted—that is, whenever the user expands an item in the outline view.

Feedback, Comments & Corrections

NSOutlineControlMBS.itemForPersistentObject(PersistentObject as Variant) as NSOutlineViewItemMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Invoked by outlineView to return the item for the archived object.
Notes:
object: An archived representation of an item in outlineView's data source.

Return the unarchived item corresponding to object. If the item is an archived object, this method may return the object.

When the outline view is restoring the saved expanded items, this method is called for each expanded item, to translate the archived object to an outline view item.

You must implement this method if you are automatically saving expanded items (that is, if autosaveExpandedItems returns true).

Feedback, Comments & Corrections

NSOutlineControlMBS.ItemWillCollapse(notification as NSNotificationMBS, item as NSOutlineViewItemMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Invoked when notification is posted—that is, whenever the user is about to collapse an item in the outline view.

Feedback, Comments & Corrections

NSOutlineControlMBS.ItemWillExpand(notification as NSNotificationMBS, item as NSOutlineViewItemMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Invoked when notification is posted—that is, whenever the user is about to expand an item in the outline view.

Feedback, Comments & Corrections

NSOutlineControlMBS.LeftMouseDown(e as NSEventMBS) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS CocoaControls Plugin 17.1 Yes No No No No
Function: Informs the receiver that the user has pressed the left mouse button.
Notes: This event is called before the normal event processing from Xojo happens. So return true to hide event from Xojo runtime.

Feedback, Comments & Corrections

Next items

The items on this page are in the following plugins: MBS CocoaControls Plugin.




Links
MBS Xojo PDF Plugins