summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLDistanceFormatter.h
diff options
context:
space:
mode:
authorFredrik Karlsson <bjorn.fredrik.karlsson@gmail.com>2017-01-04 16:18:17 +0100
committerFredrik Karlsson <bjorn.fredrik.karlsson@gmail.com>2017-01-27 19:41:13 +0100
commit2ab3af4b1b5dabf7087e6fabfb84617f4ff4b55d (patch)
tree179312c48bf929914acec1ad9eafcbb2d7d2bd4e /platform/darwin/src/MGLDistanceFormatter.h
parent4d358260140c9d52103cc95631a8519b969bc408 (diff)
downloadqtlocation-mapboxgl-2ab3af4b1b5dabf7087e6fabfb84617f4ff4b55d.tar.gz
[ios, macos] added a distance formatter
Diffstat (limited to 'platform/darwin/src/MGLDistanceFormatter.h')
-rw-r--r--platform/darwin/src/MGLDistanceFormatter.h26
1 files changed, 26 insertions, 0 deletions
diff --git a/platform/darwin/src/MGLDistanceFormatter.h b/platform/darwin/src/MGLDistanceFormatter.h
new file mode 100644
index 0000000000..46aad9a940
--- /dev/null
+++ b/platform/darwin/src/MGLDistanceFormatter.h
@@ -0,0 +1,26 @@
+#import <Foundation/Foundation.h>
+#import <CoreLocation/CoreLocation.h>
+
+#import "MGLFoundation.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ `MGLDistanceFormatter` implements a formatter object meant to be used for
+ geographic distances. The user’s current locale will be used by default
+ but it can be overriden by changing the locale property of the numberFormatter.
+ */
+MGL_EXPORT
+@interface MGLDistanceFormatter : NSLengthFormatter
+
+/**
+ Returns a localized formatted string for the provided distance.
+
+ @param distance The distance, measured in meters.
+ @return A localized formatted distance string including units.
+ */
+- (NSString *)stringFromDistance:(CLLocationDistance)distance;
+
+@end
+
+NS_ASSUME_NONNULL_END