diff options
Diffstat (limited to 'platform/macos/src/MGLMapViewDelegate.h')
| -rw-r--r-- | platform/macos/src/MGLMapViewDelegate.h | 74 |
1 files changed, 37 insertions, 37 deletions
diff --git a/platform/macos/src/MGLMapViewDelegate.h b/platform/macos/src/MGLMapViewDelegate.h index 1cf86263f3..534e28e3a8 100644 --- a/platform/macos/src/MGLMapViewDelegate.h +++ b/platform/macos/src/MGLMapViewDelegate.h @@ -26,10 +26,10 @@ NS_ASSUME_NONNULL_BEGIN /** Tells the delegate that the viewpoint depicted by the map view is about to change. - + This method is called whenever the currently displayed map camera will start changing for any reason. - + @param mapView The map view whose viewpoint will change. @param animated Whether the change will cause an animated effect on the map. */ @@ -37,14 +37,14 @@ NS_ASSUME_NONNULL_BEGIN /** Tells the delegate that the viewpoint depicted by the map view is changing. - + This method is called as the currently displayed map camera changes as part of an animation, whether due to a user gesture or due to a call to a method such as `-[MGLMapView setCamera:animated:]`. During the animation, this method may be called many times to report updates to the viewpoint. Therefore, your implementation of this method should be as lightweight as possible to avoid affecting performance. - + @param mapView The map view whose viewpoint is changing. */ - (void)mapViewCameraIsChanging:(MGLMapView *)mapView; @@ -52,10 +52,10 @@ NS_ASSUME_NONNULL_BEGIN /** Tells the delegate that the viewpoint depicted by the map view has finished changing. - + This method is called whenever the currently displayed map camera has finished changing, after any calls to `-mapViewRegionIsChanging:` due to animation. - + @param mapView The map view whose viewpoint has changed. @param animated Whether the change caused an animated effect on the map. */ @@ -65,20 +65,20 @@ NS_ASSUME_NONNULL_BEGIN /** Tells the delegate that the map view will begin to load. - + This method is called whenever the map view starts loading, including when a new style has been set and the map must reload. - + @param mapView The map view that is starting to load. */ - (void)mapViewWillStartLoadingMap:(MGLMapView *)mapView; /** Tells the delegate that the map view has finished loading. - + This method is called whenever the map view finishes loading, either after the initial load or after a style change has forced a reload. - + @param mapView The map view that has finished loading. */ - (void)mapViewDidFinishLoadingMap:(MGLMapView *)mapView; @@ -86,11 +86,11 @@ NS_ASSUME_NONNULL_BEGIN /** Tells the delegate that the map view was unable to load data needed for displaying the map. - + This method may be called for a variety of reasons, including a network connection failure or a failure to fetch the style from the server. You can use the given error message to notify the user that map data is unavailable. - + @param mapView The map view that is unable to load the data. @param error The reason the data could not be loaded. */ @@ -101,26 +101,26 @@ NS_ASSUME_NONNULL_BEGIN /** Tells the delegate that the map view is about to redraw. - + This method is called any time the map view needs to redraw due to a change in the viewpoint or style property transition. This method may be called very frequently, even moreso than `-mapViewRegionIsChanging:`. Therefore, your implementation of this method should be as lightweight as possible to avoid affecting performance. - + @param mapView The map view that is about to redraw. */ - (void)mapViewWillStartRenderingFrame:(MGLMapView *)mapView; /** Tells the delegate that the map view has just redrawn. - + This method is called any time the map view needs to redraw due to a change in the viewpoint or style property transition. This method may be called very frequently, even moreso than `-mapViewRegionIsChanging:`. Therefore, your implementation of this method should be as lightweight as possible to avoid affecting performance. - + @param mapView The map view that has just redrawn. */ - (void)mapViewDidFinishRenderingFrame:(MGLMapView *)mapView fullyRendered:(BOOL)fullyRendered; @@ -147,7 +147,7 @@ NS_ASSUME_NONNULL_BEGIN /** Returns an annotation image object to mark the given point annotation object on the map. - + @param mapView The map view that requested the annotation image. @param annotation The object representing the annotation that is about to be displayed. @@ -161,7 +161,7 @@ NS_ASSUME_NONNULL_BEGIN A value of 0.0 results in a completely transparent shape. A value of 1.0, the default, results in a completely opaque shape. - + This method sets the opacity of an entire shape, inclusive of its stroke and fill. To independently set the values for stroke or fill, specify an alpha component in the color returned by `-mapView:strokeColorForShapeAnnotation:` or @@ -175,13 +175,13 @@ NS_ASSUME_NONNULL_BEGIN /** Returns the color to use when rendering the outline of a shape annotation. - + The default stroke color is the selected menu item color. If a pattern color is specified, the result is undefined. - + Opacity may be set by specifying an alpha component. The default alpha value is `1.0` and results in a completely opaque stroke. - + @param mapView The map view rendering the shape annotation. @param annotation The annotation being rendered. @return A color to use for the shape outline. @@ -190,13 +190,13 @@ NS_ASSUME_NONNULL_BEGIN /** Returns the color to use when rendering the fill of a polygon annotation. - + The default fill color is the selected menu item color. If a pattern color is specified, the result is undefined. - + Opacity may be set by specifying an alpha component. The default alpha value is `1.0` and results in a completely opaque shape. - + @param mapView The map view rendering the polygon annotation. @param annotation The annotation being rendered. @return The polygon’s interior fill color. @@ -206,9 +206,9 @@ NS_ASSUME_NONNULL_BEGIN /** Returns the line width in points to use when rendering the outline of a polyline annotation. - + By default, the polyline is outlined with a line 3.0 points wide. - + @param mapView The map view rendering the polygon annotation. @param annotation The annotation being rendered. @return A line width for the polyline, measured in points. @@ -219,9 +219,9 @@ NS_ASSUME_NONNULL_BEGIN /** Tells the delegate that one of its annotations has been selected. - + You can use this method to track changes to the selection state of annotations. - + @param mapView The map view containing the annotation. @param annotation The annotation that was selected. */ @@ -229,9 +229,9 @@ NS_ASSUME_NONNULL_BEGIN /** Tells the delegate that one of its annotations has been deselected. - + You can use this method to track changes in the selection state of annotations. - + @param mapView The map view containing the annotation. @param annotation The annotation that was deselected. */ @@ -242,19 +242,19 @@ NS_ASSUME_NONNULL_BEGIN /** Returns a Boolean value indicating whether the annotation is able to display extra information in a callout popover. - + This method is called after an annotation is selected, before any callout is displayed for the annotation. - + If the return value is `YES`, a callout popover is shown when the user clicks on an annotation, selecting it. The default callout displays the annotation’s title and subtitle. You can customize the popover’s contents by implementing the `-mapView:calloutViewControllerForAnnotation:` method. - + If the return value is `NO`, or if this method is absent from the delegate, or if the annotation lacks a title, the annotation will not show a callout even when selected. - + @param mapView The map view that has selected the annotation. @param annotation The object representing the annotation. @return A Boolean value indicating whether the annotation should show a @@ -264,16 +264,16 @@ NS_ASSUME_NONNULL_BEGIN /** Returns a view controller to manage the callout popover’s content view. - + Like any instance of `NSPopover`, an annotation callout manages its contents with a view controller. The annotation object is the view controller’s represented object. This means that you can bind controls in the view controller’s content view to KVO-compliant properties of the annotation object, such as `title` and `subtitle`. - + If each annotation should have an identical callout, you can set the `MGLMapView.calloutViewController` property instead. - + @param mapView The map view that is requesting a callout view controller. @param annotation The object representing the annotation. @return A view controller for the given annotation. |