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

IKImageBrowserViewControlMBS.backgroundWasRightClickedWithEvent(e as NSEventMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Performs custom tasks when the user right-clicks the image browser view background.
Notes:
event: The event that invoked the method.

This method signals that the user either right-clicked the background or left-clicked it with the Alt key pressed. You can implement this method if you want to perform custom tasks at that time.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.cellWasDoubleClickedAtIndex(index as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Performs custom tasks when the user double-clicks an item in the image browser view.
Notes:
index: The index of the cell.

This method signals that the user double-clicked an item in the image browser view. You can implement this method if you want to perform custom tasks at that time.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.cellWasRightClickedAtIndex(index as Integer, e as NSEventMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Performs custom tasks when the user right-clicks an item in the image browser view.
Notes:
index: The index of the cell.
event: The event that invoked the method.

This method signals that the user either right-clicked an item in the browser or left-clicked the item with the Alt key pressed. You can implement this method if you want to perform custom tasks at that time.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.concludeDragOperation(sender as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 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

IKImageBrowserViewControlMBS.draggingEnded(sender as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 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

IKImageBrowserViewControlMBS.draggingEntered(sender as NSDraggingInfoMBS) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 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

IKImageBrowserViewControlMBS.draggingExited(sender as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Invoked when the dragged image exits the destination's bounds rectangle (in the case of a view object) or its frame rectangle (in the case of a window object).
Notes: sender: The object sending the message; use it to get details about the dragging operation.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.draggingSourceOperationMaskForLocal(flag as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Returns an integer bit mask indicating the types of dragging operations the source object will allow to be performed on the dragged image's data.
Notes:
(Deprecated in OS X v10.7. This method is informally deprecated. It is only called if the source does not implement the NSDraggingSource protocol methods. This method will be formally deprecated in a future OS release.)

isLocal: True indicates that the candidate destination object (the window or view over which the dragged image is currently poised) is in the same application as the source, while a false value indicates that the destination object is in a different application.

A mask, created by combining the dragging operations listed in the NSDragOperation section of NSDraggingInfo protocol reference using the C bitwise OR operator.If the source does not permit any dragging operations, it should return NSDragOperationNone.

If not implemented, the default value is NSDragOperationCopy | NSDragOperationLink | NSDragOperationGeneric | NSDragOperationPrivate.

Available in OS X v10.0 and later. Deprecated in OS X v10.7.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.draggingUpdated(sender as NSDraggingInfoMBS) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Invoked periodically as the image is held within the destination area, allowing modification of the dragging operation or mouse-pointer position.
Notes:
sender: The object sending the message; use it to get details about the dragging operation.

Returns 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.

For this to be invoked, the destination must have registered for the pasteboard data type involved in the drag operation. The messages continue until the image is either released or dragged out of the window or view.

This method provides the destination with an opportunity to modify the dragging operation depending on the position of the mouse pointer inside of the destination view or window object. For example, you may have several graphics or areas of text contained within the same view and wish to tailor the dragging operation, or to ignore the drag event completely, depending upon which object is underneath the mouse pointer at the time when the user releases the dragged image and the performDragOperation method is invoked.

You typically examine the contents of the pasteboard in the draggingEntered method, where this examination is performed only once, rather than in the draggingUpdated method, which is invoked multiple times.

Only one destination at a time receives a sequence of draggingUpdated messages. If the mouse pointer is within the bounds of two overlapping views that are both valid destinations, the uppermost view receives these messages until the image is either released or dragged out.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.EnableMenuItems
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 17.1 Yes Yes Yes No No
Function: The event where you can enable menu items.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.FrameChanged
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 17.1 Yes No No No No
Function: The event called when the frame changed.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.GotFocus
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 16.5 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

IKImageBrowserViewControlMBS.groupAtIndex(index as Integer) as Dictionary
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Returns the group at the specified index.
Notes:
index: The index of the group you want to retrieve.

Returns a dictionary that defines the group. The keys in this dictionary can be any of the following constants: IKImageBrowserGroupStyle, IKImageBrowserGroupBackgroundColorKey, IKImageBrowserGroupTitleKey, and IKImageBrowserGroupRangeKey. For more information on these constants, see IKImageBrowserView Class Reference.

This method is optional.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.itemAtIndex(index as Integer) as IKImageBrowserItemMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Returns an object for the item in an image browser view that corresponds to the specified index.
Notes:
index: The index of the item you want to retrieve.

Return an IKImageBrowserItem object.

Your data source must implement this method. The returned object must implement the required methods of the IKImageBrowserItem protocol.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.LostFocus
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 16.5 Yes No No No No
Function: The control lost focus.
Notes: This only fires if the control itself lost focus and not a sub control.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.MenuAction(HitItem as MenuItem) As Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 17.1 Yes No No No No
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.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 17.1 Yes No No No No
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.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.MouseDrag(x as Integer, y as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 17.1 Yes No No No No
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.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.MouseUp(x as Integer, y as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 17.1 Yes No No No No
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.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.moveItemsAtIndexes(indexes as NSIndexSetMBS, destinationIndex as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Signals that the specified items should be moved to the specified destination.
Notes:
indexes: The indexes of the items that should be reordered.
destinationIndex: The starting index of the destination the items should be moved to.

Returns true if successful; false otherwise.

This method is optional. It is invoked by the image browser view after Image Kit determines that a reordering operation should be applied. The data source should update itself by reordering its elements.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.numberOfGroups as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Returns the number of groups in an image browser view.
Notes:
Return the number of groups.

This method is optional.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.numberOfItems as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Returns the number of records managed by the data source object.
Notes:
Return the number of records managed by the image browser view.

Your data source must implement this method. An IKImageView object uses this method to determine how many cells it should create and display.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.performDragOperation(sender as NSDraggingInfoMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Invoked after the released image has been removed from the screen, signaling the receiver to import the pasteboard data.
Notes:
sender: The object sending the message; use it to get details about the dragging operation.

Returns if the destination accepts the data, it returns true; otherwise it returns false. The default is to return false.

For this method to be invoked, the previous prepareForDragOperation message must have returned true. The destination should implement this method to do the real work of importing the pasteboard data represented by the image.

If the sender object's animatesToDestination was set to true in prepareForDragOperation, then setup any animation to arrange space for the drag items to animate to. Also at this time, enumerate through the dragging items to set their destination frames and destination images.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.prepareForDragOperation(sender as NSDraggingInfoMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Invoked when the image is released, allowing the receiver to agree to or refuse drag operation.
Notes:
sender: The object sending the message; use it to get details about the dragging operation.

Return true if the receiver agrees to perform the drag operation and false if not.

This method is invoked only if the most recent draggingEntered or draggingUpdated event returned an acceptable drag-operation value.

If you want the drag items to animate from their current location on screen to their final location in your view, set the sender object's animatesToDestination property to true in your implementation of this event.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.removeItemsAtIndexes(indexes as NSIndexSetMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Signals that a remove operation should be applied to the specified items.
Notes:
indexes: The indexes of the items that should be removed.

This method is optional. It is invoked by the image browser after Image Kit determines that a remove operation should be applied. In response, the data source should update itself by removing the specified items.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.ScaleFactorChanged(NewFactor as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 17.1 Yes No No No No
Function: The backing store scale factor has changed.
Notes: Please invalidate any cached bitmaps or other relevant state.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.selectionDidChange
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Performs custom tasks when the selection changes.
Notes:
This method signals that the user changes the selection in the image browser view. You can implement this method if you want to perform custom tasks at that time.
Available in OS X v10.5 and later.

Feedback, Comments & Corrections

IKImageBrowserViewControlMBS.updateDraggingItemsForDrag(sender as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event ImageKit MBS AVFoundation Plugin 14.2 Yes No No No No
Function: Invoked when the dragging images should be changed.
Notes:
sender: The object sending the message; use this object to get details about the dragging operation.

While a destination may change the dragging images at any time, it is recommended to wait until this method is called before updating the dragging images.

This allows the system to delay changing the dragging images until it is likely that the user will drop on this destination. Otherwise, the dragging images will change too often during the drag which would be distracting to the user.

During enumerateDraggingItemsWithOptions you may set non-acceptable drag items images to nil to hide them or use the enumeration option of NSDraggingItemEnumerationClearNonenumeratedImages If there are items that you hide, then after enumeration, you need to set the numberOfValidItemsForDrop to the number of non-hidden drag items. However, if the valid item count is 0, then it is better to return NSDragOperationNone from your implementation of draggingEntered and, or draggingUpdated instead of hiding all drag items during enumeration.
Available in OS X v10.7 and later.

Feedback, Comments & Corrections

Next items

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




Links
MBS Xojo Plugins