20d9e1028c
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Bart Louwers <bart@emeel.net>
44 lines
1.3 KiB
Objective-C
44 lines
1.3 KiB
Objective-C
#import <Foundation/Foundation.h>
|
||
#import <CoreLocation/CoreLocation.h>
|
||
|
||
#import "MLNFoundation.h"
|
||
|
||
NS_ASSUME_NONNULL_BEGIN
|
||
|
||
/**
|
||
The `MLNCompassDirectionFormatter` class provides properly formatted
|
||
descriptions of absolute headings. For example, a value of `90` may be
|
||
formatted as “east”, depending on the locale.
|
||
|
||
Use this class to create localized heading strings when displaying directions
|
||
irrespective of the user’s current location. To format a direction relative to
|
||
the user’s current location, use `MLNClockDirectionFormatter` instead.
|
||
*/
|
||
MLN_EXPORT
|
||
@interface MLNCompassDirectionFormatter : NSFormatter
|
||
|
||
/**
|
||
The unit style used by this formatter.
|
||
|
||
This property defaults to `NSFormattingUnitStyleMedium`.
|
||
*/
|
||
@property (nonatomic) NSFormattingUnitStyle unitStyle;
|
||
|
||
/**
|
||
Returns a heading string for the provided value.
|
||
|
||
@param direction The heading, measured in degrees, where 0° means “due north”
|
||
and 90° means “due east”.
|
||
@return The heading string appropriately formatted for the formatter’s locale.
|
||
*/
|
||
- (NSString *)stringFromDirection:(CLLocationDirection)direction;
|
||
|
||
/**
|
||
This method is not supported for the `MLNDirectionFormatter` class.
|
||
*/
|
||
- (BOOL)getObjectValue:(out id __nullable * __nullable)obj forString:(NSString *)string errorDescription:(out NSString * __nullable * __nullable)error;
|
||
|
||
@end
|
||
|
||
NS_ASSUME_NONNULL_END
|