Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

NSViewControlMBS.acceptsFirstMouse(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Overridden by subclasses to return true if the receiver should be sent a mouseDown event for an initial mouse-down event, false if not.
Notes:
The receiver can either return a value unconditionally or use the location of event e to determine whether or not it wants the event. The default implementation ignores the event and returns false.

Implement this event in a subclass to allow instances to respond to click-through. This allows the user to click on a view in an inactive window, activating the view with one click, instead of clicking first to make the window active and then clicking the view. Most view objects refuse a click-through attempt, so the event simply activates the window. Many control objects, however, such as instances of NSButton and NSSlider, do accept them, so the user can immediately manipulate the control without having to release the mouse button.

Feedback, Comments & Corrections

NSViewControlMBS.acceptsFirstResponder as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Whether to accept first responder.
Notes: Return true if your control can have the focus and false if not.

Feedback, Comments & Corrections

NSViewControlMBS.becomeFirstResponder as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Called when the object gets focus.
Notes: Return true to accept.

Feedback, Comments & Corrections

NSViewControlMBS.beginGestureWithEvent(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Informs the receiver that the user has begun a touch gesture.
Notes:
e: An event object representing the gesture beginning.
The event will be sent to the view under the touch in the key window.
Available in Mac OS X v10.6 and later.
Return true if you handled this event.

Feedback, Comments & Corrections

NSViewControlMBS.canBecomeKeyView as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Returns whether the receiver can become key view.
Notes: Returns true if the receiver can become key view, false otherwise.

Feedback, Comments & Corrections

NSViewControlMBS.Close
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: The event called when the custom view is destroyed.

Feedback, Comments & Corrections

NSViewControlMBS.concludeDragOperation(sender as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 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

NSViewControlMBS.draggingEnded(sender as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 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

NSViewControlMBS.draggingEntered(sender as NSDraggingInfoMBS) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 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

NSViewControlMBS.draggingExited(sender as NSDraggingInfoMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 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

NSViewControlMBS.draggingSessionEndedAtPoint(session as NSDraggingSessionMBS, screenPoint as NSPointMBS, operation as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Invoked when the dragging session has completed.
Notes:
session: The dragging session.
screenPoint: The point where the drag ended, in screen coordinates.
operation: The drag operation. See constants for drag operation types.

Available in OS X v10.7 and later.

Feedback, Comments & Corrections

NSViewControlMBS.draggingSessionMovedToPoint(session as NSDraggingSessionMBS, screenPoint as NSPointMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Invoked when the drag moves on the screen.
Notes:
session: The dragging session.
screenPoint: The point where the drag moved to, in screen coordinates.

Available in OS X v10.7 and later.

Feedback, Comments & Corrections

NSViewControlMBS.draggingSessionSourceOperationMaskForDraggingContext(session as NSDraggingSessionMBS, context as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Declares the types of operations the source allows to be performed. (required)
Notes:
session: The dragging session.
context: The dragging context. See NSDraggingContext constants for the supported values.

Return the appropriate dragging operation as defined in constants.

In the future Apple may provide more specific "within" values in the future. To account for this, for unrecognized localities, return the operation mask for the most specific context that you are concerned with.

Feedback, Comments & Corrections

NSViewControlMBS.draggingSessionWillBeginAtPoint(session as NSDraggingSessionMBS, screenPoint as NSPointMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Invoked when the drag will begin.
Notes:
session: The dragging session.
screenPoint: The point where the drag will begin, in screen coordinates.

Available in OS X v10.7 and later.

Feedback, Comments & Corrections

NSViewControlMBS.draggingUpdated(sender as NSDraggingInfoMBS) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 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.

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.

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

NSViewControlMBS.drawFocusRingMask(g as NSGraphicsMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Draw the focus ring mask for the view.
Notes:
If false is returned, the default method from NSView class runs.

This method provides the shape of the focus ring mask by drawing the focus ring mask. An implementation of this method should draw in the view's interior (bounds) coordinate space, that the focus ring style has been set (it will be set it to NSFocusRingOnly to capture the focus ring itself), and that the fill and stroke colors have been set to an arbitrary fully opaque color.

Subclasses that find the default behavior insufficient should only draw the focus ring shape.

The NSView default implementation of this method simply fills self.bounds.
Available in Mac OS X v10.7 and later.

Please use NSGraphicsMBS class for drawing.

Feedback, Comments & Corrections

NSViewControlMBS.DrawRect(g as NSGraphicsMBS, left as Double, top as Double, width as Double, height as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: The paint event with the rectangle which needs to be redrawn.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

NSViewControlMBS.endGestureWithEvent(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Informs the receiver that the user has ended a touch gesture.
Notes:
e: An event object representing the gesture end.
Available in Mac OS X v10.6 and later.
Return true if you handled this event.

Feedback, Comments & Corrections

NSViewControlMBS.focusRingMaskBounds as NSRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Returns the focus ring mask bounds.
Notes:
Return nil to run default NSView method.

Return a rectangle containing the mask in the view's interior (bounds) coordinate space.

The mask bounds allows the focus ring's overall size and position to be determined before it is drawn.
Subclasses must override this method if they require the display of a focus ring.
The NSView default implementation of this method simply returns NSRectMBS.Zero.

Note: The information provided by focusRingMaskBounds will enable Accessibility to identify selected subelements for zoom tracking, so it is important that this method provide a reasonably tight bounding box and that noteFocusRingMaskChanged is invoked as described.

Feedback, Comments & Corrections

NSViewControlMBS.ignoreModifierKeysForDraggingSession(session as NSDraggingSessionMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Returns whether the modifier keys will be ignored for this dragging session.
Notes:
session: The dragging session.

Return true if the modifier keys will be ignored, false otherwise.
Available in OS X v10.7 and later.

Feedback, Comments & Corrections

NSViewControlMBS.isOpaque as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Whether this view is opaque.

Feedback, Comments & Corrections

NSViewControlMBS.keyDown(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: One of the key events.
Notes:
Return true if you handled this event.
Please return true in becomeFirstResponder and acceptsFirstResponder, so your nsview can become first responder and receive key events.

Feedback, Comments & Corrections

NSViewControlMBS.keyUp(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: One of the key events.
Notes:
Return true if you handled this event.
Please return true in becomeFirstResponder and acceptsFirstResponder, so your nsview can become first responder and receive key events.

Feedback, Comments & Corrections

NSViewControlMBS.magnifyWithEvent(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Informs the receiver that the user has begun a pinch gesture.
Notes:
e: An event object representing the magnify gesture.
The event will be sent to the view under the touch in the key window.
Available in Mac OS X v10.6 and later.
Return true if you handled this event.

Feedback, Comments & Corrections

NSViewControlMBS.MenuAction(HitItem as MenuItem) As Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls 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

NSViewControlMBS.menuForEvent(e as NSEventMBS, defaultMenu as NSMenuMBS) as NSMenuMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: Overridden by subclasses to return a context-sensitive pop-up menu for a given mouse-down event.
Notes:
theEvent: An object representing a mouse-down event.
defaultMenu: The menu as constructed by super class.

The receiver can use information in the mouse event, such as its location over a particular element of the receiver, to determine what kind of menu to return. For example, a text object might display a text-editing menu when the cursor lies over text and a menu for changing graphics attributes when the cursor lies over an embedded image.

The default implementation returns the default menu.

Feedback, Comments & Corrections

NSViewControlMBS.mouseDown(e as NSEventMBS, x as Double, y as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: One of the mouse events.
Notes: Return true if you handled this event.

Feedback, Comments & Corrections

NSViewControlMBS.mouseDownCanMoveWindow as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Cocoa Controls MBS MacControls Plugin 15.0 Yes No No No No
Function: This event is called so you can decide what happens with mouse down.
Notes:
Return true if you do not need to handle a mouse down and it can pass through to superviews; False if you need to handle the mouse down.

This allows iApp-type applications to determine the region by which a window can be moved. By default, this method returns false if the view is opaque; otherwise, it returns true. Subclasses can override this method to return a different value.

Feedback, Comments & Corrections

Next items

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




Links
MBS Xojo Plugins