summaryrefslogtreecommitdiff
path: root/platform/ios/src/MGLCalloutView.h
diff options
context:
space:
mode:
Diffstat (limited to 'platform/ios/src/MGLCalloutView.h')
-rw-r--r--platform/ios/src/MGLCalloutView.h140
1 files changed, 0 insertions, 140 deletions
diff --git a/platform/ios/src/MGLCalloutView.h b/platform/ios/src/MGLCalloutView.h
deleted file mode 100644
index 71bae71d07..0000000000
--- a/platform/ios/src/MGLCalloutView.h
+++ /dev/null
@@ -1,140 +0,0 @@
-#import <Foundation/Foundation.h>
-
-NS_ASSUME_NONNULL_BEGIN
-
-@protocol MGLCalloutViewDelegate;
-@protocol MGLAnnotation;
-
-/**
- A protocol for a `UIView` subclass that displays information about a selected
- annotation near that annotation.
-
- To receive updates from an object that conforms to the `MGLCalloutView` protocol,
- use the optional methods available in the `MGLCalloutViewDelegate` protocol.
-
- #### Related examples
- See the <a href="https://docs.mapbox.com/ios/maps/examples/custom-callout/">
- Display custom views as callouts</a> example to learn how to customize an
- `MGLCalloutView`.
- */
-@protocol MGLCalloutView <NSObject>
-
-/**
- An object conforming to the `MGLAnnotation` protocol whose details this callout
- view displays.
- */
-@property (nonatomic, strong) id <MGLAnnotation> representedObject;
-
-/**
- A view that the user may tap to perform an action. This view is conventionally
- positioned on the left side of the callout view.
- */
-@property (nonatomic, strong) UIView *leftAccessoryView;
-
-/**
- A view that the user may tap to perform an action. This view is conventionally
- positioned on the right side of the callout view.
- */
-@property (nonatomic, strong) UIView *rightAccessoryView;
-
-/**
- An object conforming to the `MGLCalloutViewDelegate` method that receives
- messages related to the callout view’s interactive subviews.
- */
-@property (nonatomic, weak) id<MGLCalloutViewDelegate> delegate;
-
-/**
- Presents a callout view by adding it to `view` and pointing at the given rect
- of `view`’s bounds. Constrains the callout to the bounds of the given view.
- */
-- (void)presentCalloutFromRect:(CGRect)rect inView:(UIView *)view constrainedToView:(UIView *)constrainedView animated:(BOOL)animated __attribute__((unavailable("Use `-presentCalloutFromRect:inView:constrainedToRect:animated:` instead.")));
-
-
-/**
- Presents a callout view by adding it to `view` and pointing at the given rect
- of `view`’s bounds. Constrains the callout to the rect in the space of `view`.
- */
-- (void)presentCalloutFromRect:(CGRect)rect inView:(UIView *)view constrainedToRect:(CGRect)constrainedRect animated:(BOOL)animated;
-
-/**
- Dismisses the callout view.
- */
-- (void)dismissCalloutAnimated:(BOOL)animated;
-
-@optional
-
-/**
- If implemented, should provide margins to expand the rect the callout is presented from.
-
- These are used to determine positioning. Currently only the top and bottom properties of the return
- value are used. For example, `{ .top = -50.0, .left = -10.0, .bottom = 0.0, .right = -10.0 }` indicates
- a 50 point margin above the presentation origin rect (and 10 point margins to the left and the right)
- in which the callout is assumed to be displayed.
-
- There are no assumed defaults for these margins, as they should be calculated from the callout that
- is to be presented. For example, `SMCalloutView` generates the top margin from the callout height, but
- the left and right margins from a minimum width that the callout should have.
-
- @param rect Rect that the callout is presented from. This should be the same as the one passed in
- `-[MGLCalloutView presentCalloutFromRect:inView:constrainedToRect:animated:]`
- @return `UIEdgeInsets` representing the margins. Values should be negative.
- */
-- (UIEdgeInsets)marginInsetsHintForPresentationFromRect:(CGRect)rect NS_SWIFT_NAME(marginInsetsHintForPresentation(from:));
-
-/**
- A Boolean value indicating whether the callout view should be anchored to
- the corresponding annotation. You can adjust the callout view’s precise location by
- overriding -[UIView setCenter:]. The callout view will not be anchored to the
- annotation if this optional property is unimplemented.
- */
-@property (nonatomic, readonly, assign, getter=isAnchoredToAnnotation) BOOL anchoredToAnnotation;
-
-/**
- A Boolean value indicating whether the callout view should be dismissed automatically
- when the map view’s viewport changes. Note that a single tap on the map view
- still dismisses the callout view regardless of the value of this property.
- The callout view will be dismissed if this optional property is unimplemented.
- */
-@property (nonatomic, readonly, assign) BOOL dismissesAutomatically;
-
-@end
-
-/**
- The `MGLCalloutViewDelegate` protocol defines a set of optional methods that
- you can use to receive messages from an object that conforms to the
- `MGLCalloutView` protocol. The callout view uses these methods to inform the
- delegate that the user has interacted with the the callout view.
- */
-@protocol MGLCalloutViewDelegate <NSObject>
-
-@optional
-/**
- Returns a Boolean value indicating whether the entire callout view “highlights”
- when tapped. The default value is `YES`, which means the callout view
- highlights when tapped.
-
- The return value of this method is ignored unless the delegate also responds to
- the `-calloutViewTapped` method.
- */
-- (BOOL)calloutViewShouldHighlight:(UIView<MGLCalloutView> *)calloutView;
-
-/**
- Tells the delegate that the callout view has been tapped.
- */
-- (void)calloutViewTapped:(UIView<MGLCalloutView> *)calloutView;
-
-/**
- Called before the callout view appears on screen, or before the appearance
- animation will start.
- */
-- (void)calloutViewWillAppear:(UIView<MGLCalloutView> *)calloutView;
-
-/**
- Called after the callout view appears on screen, or after the appearance
- animation is complete.
- */
-- (void)calloutViewDidAppear:(UIView<MGLCalloutView> *)calloutView;
-
-@end
-
-NS_ASSUME_NONNULL_END