Platforms to show: All Mac Windows Linux Cross-Platform

Back to DesktopMapKitViewControlMBS control.

Next items

DesktopMapKitViewControlMBS.annotationViewDidChangeDragState(mapView as MKMapViewMBS, annotationView as MKAnnotationViewMBS, newState as Integer, oldState as Integer)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells the control that the drag state of one of its annotation views changed.
Notes:
mapView: The map view containing the annotation view.
annotationView: The annotation view whose drag state changed.
newState: The new drag state of the annotation view.
oldState: The previous drag state of the annotation view.

The drag state typically changes in response to user interactions with the annotation view. However, the annotation view itself is responsible for changing that state as well.
DesktopMapKitViewControlMBS.beginGestureWithEvent(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ 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.
DesktopMapKitViewControlMBS.BoundsChanged
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: The event called when the bounds, but not the frame, changed.
DesktopMapKitViewControlMBS.Closing
Type Topic Version
event MapKit 21.5
Function:
The control is about to close.
In older Xojo versions, this event is named Close.
DesktopMapKitViewControlMBS.ClusterAnnotationForMemberAnnotations(mapView as MKMapViewMBS, memberAnnotations() as MKAnnotationMBS) as MKClusterAnnotationMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Asks you to provide a cluster annotation object for the specified annotations.
Notes:
mapView: The map view containing the specified annotations.
memberAnnotations: The annotations to be clustered together. The returned MKClusterAnnotation object must include the specific annotations in this parameter.

Return the cluster annotation object.

Use this method to customize the cluster annotations displayed on your map. Normally, MapKit creates cluster annotation objects automatically when one or more annotations with the same cluster identifier are too close together. However, you can implement this method and return a custom cluster annotation object for the specified set of annotations.
DesktopMapKitViewControlMBS.ConstructContextualMenu(base as DesktopMenuItem, x as Integer, y as Integer) As Boolean
Type Topic Version
event MapKit 22.1
Function: This event is called when it is appropriate to display a contextual menu for the control.
DesktopMapKitViewControlMBS.ContextualMenuItemSelected(selectedItem As DesktopMenuItem) As Boolean
Type Topic Version
event MapKit 21.5
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.
DesktopMapKitViewControlMBS.didAddAnnotationViews(mapView as MKMapViewMBS, AnnotationViews() as MKAnnotationViewMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells the control that one or more annotation views were added to the map.
Notes:
mapView: The map view that added the annotation views.
views: An array of MKAnnotationView objects representing the views that were added.

By the time this method is called, the specified views are already added to the map.
DesktopMapKitViewControlMBS.DidAddOverlayRenderers(mapView as MKMapViewMBS, renderers() as MKOverlayRendererMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells you that one or more renderer objects were added to the map.
Notes:
mapView: The map view that added the renderer objects.
renderers: The renderer objects that were added.

The map view adds renderer objects when it needs them to draw their contents, which might be prior to those contents appearing onscreen. It calls this method to let you know that the renderer is active and in use. By the time this method is called, the specified renderers have already been added to the map.
DesktopMapKitViewControlMBS.didAddOverlayViews(mapView as MKMapViewMBS, overlayViews() as NSViewMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: The event to inform you about added overlay views.
DesktopMapKitViewControlMBS.didDeselectAnnotationView(mapView as MKMapViewMBS, view as MKAnnotationViewMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells the control that one of its annotation views was deselected.
Notes:
mapView: The map view containing the annotation view.
view: The annotation view that was deselected.

You can use this method to track changes in the selection state of annotation views.
DesktopMapKitViewControlMBS.didFailLoadingMap(mapView as MKMapViewMBS, error as NSErrorMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells the control that the specified view was unable to load the map data.
Notes:
mapView: The map view that started the load operation.
error: The reason that the map data could not be loaded.

This method might be called in situations where the device does not have access to the network or is unable to load the map data for some reason. It may also be called if a request for additional map tiles comes in while a previous request for tiles is still pending. You can use this message to notify the user that the map data is unavailable.
DesktopMapKitViewControlMBS.didFailToLocateUserWithError(mapView as MKMapViewMBS, error as NSErrorMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells the control that an attempt to locate the user's position failed.
Notes:
mapView: The map view that is tracking the user's location.
error: An error object containing the reason why location tracking failed.
DesktopMapKitViewControlMBS.didFinishLoadingMap(mapView as MKMapViewMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells the control that the specified map view successfully loaded the needed map data.
Notes:
mapView: The map view that started the load operation.

This method is called when the map tiles associated with the current request have been loaded. Map tiles are requested when a new visible area is scrolled into view and tiles are not already available. Map tiles may also be requested for portions of the map that are not currently visible. For example, the map view may load tiles immediately surrounding the currently visible area as needed to handle small pans by the user.
DesktopMapKitViewControlMBS.DidFinishRenderingMap(mapView as MKMapViewMBS, fullyRendered as boolean)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells you that the map view has finished rendering all visible tiles.
Notes:
fullyRendered: This parameter is set to true if the map view was able to render all tiles completely or false if errors prevented all tiles from being rendered.

This method lets you know when the map view finishes rendering all of the currently visible tiles to the best of its ability. This method is called regardless of whether all tiles were rendered successfully. If there were errors loading one or more tiles that prevented map view from rendering them, the fullyRendered parameter is set to false.
DesktopMapKitViewControlMBS.didSelectAnnotationView(mapView as MKMapViewMBS, view as MKAnnotationViewMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells the control that one of its annotation views was selected.
Notes:
mapView: The map view containing the annotation view.
view: The annotation view that was selected.

You can use this method to track changes in the selection state of annotation views.
DesktopMapKitViewControlMBS.didStopLocatingUser(mapView as MKMapViewMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells the control that the map view stopped tracking the user's location.
Notes:
mapView: The map view that stopped tracking the user's location.

This method is called when the value of the showsUserLocation property changes to false.
DesktopMapKitViewControlMBS.didUpdateUserLocation(mapView as MKMapViewMBS, userLocation as MKUserLocationMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Tells the control that the location of the user was updated.
Notes:
mapView: The map view that is tracking the user's location.
userLocation: The location object representing the user's latest location. This property may be nil.

While the showsUserLocation property is set to true, this method is called whenever a new location update is received by the map view. This method is also called if the map view's user tracking mode is set to MKUserTrackingModeFollowWithHeading and the heading changes.

This method is not called if the application is currently running in the background. If you want to receive location updates while running in the background, you must use the Core Location framework.
DesktopMapKitViewControlMBS.endGestureWithEvent(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ 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.
DesktopMapKitViewControlMBS.FocusLost
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function:
The control lost focus.
In older Xojo versions, this event is named LostFocus.
Notes: This only fires if the control itself lost focus and not a sub control.
DesktopMapKitViewControlMBS.FocusReceived
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function:
The control itself got focus.
In older Xojo versions, this event is named GotFocus.
Notes: This only fires if the control itself got focus and not a sub control.
DesktopMapKitViewControlMBS.FrameChanged
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: The event called when the frame changed.
Notes: This event notifies you, that the control changed it's bounding frame, which is position and/or size.
DesktopMapKitViewControlMBS.magnifyWithEvent(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ 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.
DesktopMapKitViewControlMBS.MenuBarSelected
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function:
The event where you can enable menu items.
In older Xojo versions, this event is named EnableMenuItems.
DesktopMapKitViewControlMBS.MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ 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.
DesktopMapKitViewControlMBS.MouseDrag(x as Integer, y as Integer)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ 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.
DesktopMapKitViewControlMBS.MouseUp(x as Integer, y as Integer)
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ 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.
DesktopMapKitViewControlMBS.Opening
Type Topic Version
event MapKit 21.5
Function:
The control is about to was created and you can initialize it.
In older Xojo versions, this event is named Open.
DesktopMapKitViewControlMBS.pressureChange(e as NSEventMBS) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
event MapKit MBS MacFrameworks Plugin 21.5 ✅ Yes ❌ No ❌ No ❌ No
Function: Informs the current object that a pressure change occurred on a system that supports pressure sensitivity.
Notes:
This method is invoked automatically in response to user actions. event is the event that initiated the change in pressure.
Available in OS X v10.10.3 and later.

Next items

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


💬 Ask a question or report a problem
The biggest plugin in space...


Start Chat