1634058b51
Reformatted documentation comments in public headers in the OS X SDK and public headers shared between the iOS and OS X SDKs to wrap at column 80 and avoid excessive indentation that causes SourceKitten to detect code blocks.
62 lines
1.8 KiB
Objective-C
62 lines
1.8 KiB
Objective-C
#import <Foundation/Foundation.h>
|
||
#import <CoreLocation/CoreLocation.h>
|
||
#import <TargetConditionals.h>
|
||
|
||
#import "MGLTypes.h"
|
||
|
||
NS_ASSUME_NONNULL_BEGIN
|
||
|
||
/**
|
||
The `MGLAnnotation` protocol is used to provide annotation-related information
|
||
to a map view. To use this protocol, you adopt it in any custom objects that
|
||
store or represent annotation data. Each object then serves as the source of
|
||
information about a single map annotation and provides critical information,
|
||
such as the annotation’s location on the map. Annotation objects do not provide
|
||
the visual representation of the annotation but typically coordinate (in
|
||
conjunction with the map view’s delegate) the creation of an appropriate
|
||
objects to handle the display.
|
||
|
||
An object that adopts this protocol must implement the `coordinate` property.
|
||
The other methods of this protocol are optional.
|
||
*/
|
||
@protocol MGLAnnotation <NSObject>
|
||
|
||
#pragma mark Position Attributes
|
||
|
||
/**
|
||
The center point (specified as a map coordinate) of the annotation. (required)
|
||
(read-only)
|
||
*/
|
||
@property (nonatomic, readonly) CLLocationCoordinate2D coordinate;
|
||
|
||
@optional
|
||
|
||
#pragma mark Title Attributes
|
||
|
||
/**
|
||
The string containing the annotation’s title.
|
||
|
||
Although this property is optional, if you support the selection of annotations
|
||
in your map view, you are expected to provide this property. This string is
|
||
displayed in the callout for the associated annotation.
|
||
*/
|
||
@property (nonatomic, readonly, copy, nullable) NSString *title;
|
||
|
||
/**
|
||
The string containing the annotation’s subtitle.
|
||
|
||
This string is displayed in the callout for the associated annotation.
|
||
*/
|
||
@property (nonatomic, readonly, copy, nullable) NSString *subtitle;
|
||
|
||
#if !TARGET_OS_IPHONE
|
||
|
||
/** The string containing the annotation’s tooltip. */
|
||
@property (nonatomic, readonly, copy, nullable) NSString *toolTip;
|
||
|
||
#endif
|
||
|
||
@end
|
||
|
||
NS_ASSUME_NONNULL_END
|