Files
MapLibreParticleLab/platform/ios/src/MGLCalloutView.h
Jason Wray 256689a33d [ios, macos] Make Xcode 7.3 the minimum required version
- Removes nullability shims for Xcode 6.
- Removes MGLTypes.h from files where it was only being used for
  nullability support.
- Accepts that `NS_SWIFT_NAME` is not fully supported by Xcode 7.2 and
  lower.
- Adds documentation about Xcode 7.3 requirement.
2016-08-18 11:35:32 -04:00

90 lines
2.6 KiB
Objective-C
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
#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.
*/
@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;
/**
Dismisses the callout view.
*/
- (void)dismissCalloutAnimated:(BOOL)animated;
@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