MBS Xojo Developer Conference and Training
Join us from 3rd to 6th May 2017 in Berlin, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

NSOutlineControlMBS.LeftMouseDragged(e as NSEventMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Informs the receiver that the user has moved the mouse with the left button pressed.
Notes: This event is called before the normal event processing from Xojo happens. So return true to hide event from Xojo runtime.
NSOutlineControlMBS.LeftMouseUp(e as NSEventMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Informs the receiver that the user has released 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.
NSOutlineControlMBS.LostFocus
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: The control lost focus.
Notes: This only fires if the control itself lost focus and not a sub control.
NSOutlineControlMBS.MenuAction(HitItem as MenuItem) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Called when a menuitem is choosen.
Notes: This allows the control to react on its relevant menu items. Please return true if you handled it or false to give others a chance.
NSOutlineControlMBS.MouseDown(x as Integer, y as Integer, Modifiers as Integer) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: The mouse button was pressed inside the control’s region at the location passed in to x, y.
Notes:
The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the Control.
Return True if you are going to handle the MouseDown. In such a case:
  • The Action event, if any, will not execute and the state of the object will not change.
  • You will receive the MouseDrag and MouseUp events.
If you return False, the system handles the MouseDown so the above event handlers do not get called.
NSOutlineControlMBS.mouseDownInHeaderOfTableColumn(tableColumn as NSTableColumnMBS)
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Event sent whenever the mouse button is clicked in outlineView while the cursor is in a column header tableColumn.
NSOutlineControlMBS.MouseDrag(x as Integer, y as Integer)
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: This event fires continuously after the mouse button was pressed inside the Control.
Notes:
Mouse location is local to the control passed in to x, y.
As this event is fired continuously (hundreds of time per second), it is your responsibility to determine if the mouse has really moved.
NSOutlineControlMBS.MouseUp(x as Integer, y as Integer)
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: The mouse button was released.
Notes: Use the x and y parameters to determine if the mouse button was released within the control's boundaries.
NSOutlineControlMBS.namesOfPromisedFilesDroppedAtDestination(dropDestination as folderItem, DraggedItems() as NSOutlineViewItemMBS) as string()
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Returns an array of filenames for the created files that the receiver promises to create.
Notes:
dropDestination: The drop location where the files are created.
items: The items being dragged.

Returns an array of filenames (not full paths) for the created files that the receiver promises to create.

For more information on file promise dragging, see documentation on the NSDraggingSource protocol and namesOfPromisedFilesDroppedAtDestination.
NSOutlineControlMBS.nextTypeSelectMatchFromItem(startItem as NSOutlineViewItemMBS, endItem as NSOutlineViewItemMBS, searchString as String) as NSOutlineViewItemMBS
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Returns the first item that matches the searchString from within the range of startItem to endItem.
Notes:
startItem: The first item to search.
endItem: The item before which to stop searching. It is possible for endItem to be less than startItem if the search will wrap.
searchString: The string for which to search.

Returns the first item—from within the range of startItem to endItem—that matches the searchString, or nil if there is no match.

Implement this method if you want to control how type selection works. You should include startItem as a possible match, but do not include endItem.
It is not necessary to implement this event in order to support type select.
NSOutlineControlMBS.numberOfChildrenOfItem(item as NSOutlineViewItemMBS) as Integer
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Returns the number of child items encompassed by a given item.
Notes:
item: An item in the data source.

Returns the number of child items encompassed by item. If item is nil, this method should return the number of children for the top-level item.

The numberOfChildrenOfItem method is called very frequently, so it must be efficient.

Do not call reloadData from this method.
NSOutlineControlMBS.objectValue(tableColumn as NSTableColumnMBS, item as NSOutlineViewItemMBS) as Variant
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Invoked by outlineView to return the data object associated with the specified item.
Notes:
tableColumn: A column in outlineView.
item: An item in the data source in the specified tableColumn of the view.

Returns the item is located in the specified tableColumn of the view.

Do not call reloadData from this method.
NSOutlineControlMBS.OtherMouseDown(e as NSEventMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Informs the receiver that the user has pressed a mouse button other than the left or right one.
Notes: This event is called before the normal event processing from Xojo happens. So return true to hide event from Xojo runtime.
NSOutlineControlMBS.OtherMouseDragged(e as NSEventMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Informs the receiver that the user has moved the mouse with a button other than the left or right button pressed.
Notes: This event is called before the normal event processing from Xojo happens. So return true to hide event from Xojo runtime.
NSOutlineControlMBS.OtherMouseUp(e as NSEventMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Informs the receiver that the user has released a mouse button other than the left or right button.
Notes: This event is called before the normal event processing from Xojo happens. So return true to hide event from Xojo runtime.
NSOutlineControlMBS.pasteboardWriterForItem(item as NSOutlineViewItemMBS) as NSPasteboardItemMBS
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Implement this method to enable the table to be an NSDraggingSource that supports dragging multiple items.
Notes:
item: The item for which to return a pasteboard writer.

Returns a NSPasteboardItem object.

If this method is implemented, then writeItems is not called.
NSOutlineControlMBS.persistentObjectForItem(item as NSOutlineViewItemMBS) as Variant
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Invoked by outlineView to return an archived object for item.
Notes:
item: The item for which to return an archived object.

Returns an archived representation of item. If the item is an archived object, this method may return the item.

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

You must implement this method if you are automatically saving expanded items (that is, if autosaveExpandedItems returns true).
NSOutlineControlMBS.RightMouseDown(e as NSEventMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Informs the view that the user has pressed the right mouse button.
Notes: This event is called before the normal event processing from Xojo happens. So return true to hide event from Xojo runtime.
NSOutlineControlMBS.RightMouseDragged(e as NSEventMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Informs the receiver that the user has moved the mouse with the right button pressed .
Notes: This event is called before the normal event processing from Xojo happens. So return true to hide event from Xojo runtime.
NSOutlineControlMBS.RightMouseUp(e as NSEventMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Informs the receiver that the user has released the right mouse button.
Notes: This event is called before the normal event processing from Xojo happens. So return true to hide event from Xojo runtime.
NSOutlineControlMBS.rowViewForItem(item as NSOutlineViewItemMBS) as NSTableRowViewMBS
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Implement this method to return a custom NSTableRowView for a particular item.
Notes:
item: The item displayed by the returned table row view.

Return an instance or subclass of NSTableRowView. If nil is returned, a NSTableRowView instance is created and used.

This method, if implemented, is only invoked for NSView-based outline views.
NSOutlineControlMBS.ScaleFactorChanged(NewFactor as Double)
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: The backing store scale factor has changed.
Notes: Please invalidate any cached bitmaps or other relevant state.
NSOutlineControlMBS.SelectionDidChange(notification as NSNotificationMBS)
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Invoked when the selection did change notification is posted—that is, immediately after the outline view’s selection has changed.
NSOutlineControlMBS.selectionIndexesForProposedSelection(proposedSelectionIndexes as NSIndexSetMBS) as NSIndexSetMBS
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Invoked to allow the delegate to modify the proposed selection.
Notes:
proposedSelectionIndexes: An index set containing the indexes of the proposed selection.
Return an NSIndexSet instance containing the indexes of the new selection. Return proposedSelectionIndexes if the proposed selection is acceptable, or the value of the table view’s existing selection to avoid changing the selection.

This method may be called multiple times with one new index added to the existing selection to find out if a particular index can be selected when the user is extending the selection with the keyboard or mouse.

Implementation of this method is optional. If implemented, this method will be called instead of willDisplayOutlineCell.

If not implemented or returns nil, the plugin will return proposedSelectionIndexes.
NSOutlineControlMBS.SelectionIsChanging(notification as NSNotificationMBS)
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Invoked when notification is posted—that is, whenever the outline view’s selection changes.
NSOutlineControlMBS.selectionShouldChangeInOutlineView as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Returns a Boolean value that indicates whether the outline view should change its selection.
Notes:
Return true to permit outlineView to change its selection (typically a row being edited), false to deny permission.

For example, if the user is editing a cell and enters an improper value, the delegate can prevent the user from selecting or editing any other cells until a proper value has been entered into the original cell. You can implement this method for complex validation of edited rows based on the values of any of their cells.
NSOutlineControlMBS.setObjectValue(tableColumn as NSTableColumnMBS, item as NSOutlineViewItemMBS, value as Variant)
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Set the data object for a given item in a given column.
Notes:
object: The new value for the item.
tableColumn: A column in outlineView.
item: An item in the data source in the specified tableColumn of the view.

The item is located in the specified tableColumn of the view.

Do not call reloadData from this method.
NSOutlineControlMBS.shouldCollapseAutoExpandedItemsForDeposited(deposited as Boolean, superResult as Boolean) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Returns a Boolean value that indicates whether auto-expanded items should return to their original collapsed state.
Notes:
deposited: If true, the drop terminated successfully; if false the drop failed.

Return true if auto-expanded items should return to their original collapsed state; otherwise false.

Implement this event to provide custom behavior. If the target of a drop is not auto-expanded (by hovering long enough) the drop target still gets expanded after a successful drop unless this method returns true. The default implementation returns false after a successful drop.
This method is called in a variety of situations. For example, it is called shortly after the acceptDrop method is called and also if the drag exits the outline view (exiting the view is treated the same as a failed drop). The return value of the acceptDrop method determines the incoming value of the deposited parameter.
NSOutlineControlMBS.shouldCollapseItem(item as NSOutlineViewItemMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Returns a Boolean value that indicates whether the outline view should collapse a given item.
Notes:
item: The item that should collapse.

Return true to permit outlineView to collapse item, false to deny permission.

You can implement this method to disallow collapsing of specific items. For example, if the first row of your outline view should not be collapsed, your delegate method could contain this line of code:

return rowForItem(item ) <> 0
NSOutlineControlMBS.shouldEdit(tableColumn as NSTableColumnMBS, item as NSOutlineViewItemMBS) as Boolean
event, Cocoa Controls, MBS CocoaControls Plugin (NSOutlineView), control NSOutlineControlMBS,
Plugin version: 17.1, Mac: Yes, Win: No, Linux: No, Console & Web: No, Feedback.

Function: Returns a Boolean value that indicates whether the outline view should allow editing of a given item in a given table column.
Notes:
tableColumn: The table column.
item: The item.

Returns true to permit outlineView to edit the cell specified by tableColumn and item, false to deny permission.
If this method returns true, the cell may still not be editable—for example, if you have set up a custom NSTextFieldCell as a data cell, it must return true for isEditable to allow editing.

You can implement this method to disallow editing of specific cells.

Previous items Next items

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




Links
Bilder aus Nickenich