diff options
author | Struan Donald <struan@exo.org.uk> | 2013-03-25 12:48:43 +0000 |
---|---|---|
committer | Struan Donald <struan@exo.org.uk> | 2013-03-25 13:15:45 +0000 |
commit | 5ecc3c7d6049e0006f6dc25204f2ba5793864586 (patch) | |
tree | 7f5c026524b54a9ab59255d25473a870ede630e8 /iPhone/CordovaLib/Classes/CDVGlobalization.h | |
parent | 6a80df824846ddf74fda82835b997de886d67567 (diff) |
Upgrade to iOS phonegap 2.3
Diffstat (limited to 'iPhone/CordovaLib/Classes/CDVGlobalization.h')
-rwxr-xr-x | iPhone/CordovaLib/Classes/CDVGlobalization.h | 150 |
1 files changed, 150 insertions, 0 deletions
diff --git a/iPhone/CordovaLib/Classes/CDVGlobalization.h b/iPhone/CordovaLib/Classes/CDVGlobalization.h new file mode 100755 index 0000000..0384656 --- /dev/null +++ b/iPhone/CordovaLib/Classes/CDVGlobalization.h @@ -0,0 +1,150 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + */ + +#import <Foundation/Foundation.h> +#import "CDVPlugin.h" + +#define CDV_FORMAT_SHORT 0 +#define CDV_FORMAT_MEDIUM 1 +#define CDV_FORMAT_LONG 2 +#define CDV_FORMAT_FULL 3 +#define CDV_SELECTOR_MONTHS 0 +#define CDV_SELECTOR_DAYS 1 + +enum CDVGlobalizationError { + CDV_UNKNOWN_ERROR = 0, + CDV_FORMATTING_ERROR = 1, + CDV_PARSING_ERROR = 2, + CDV_PATTERN_ERROR = 3, +}; +typedef NSUInteger CDVGlobalizationError; + +@interface CDVGlobalization : CDVPlugin { + CFLocaleRef currentLocale; +} + +- (void)getPreferredLanguage:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Returns the string identifier for the clients current locale setting. + * It returns the locale identifier string to the successCB callback with a + * properties object as a parameter. If there is an error getting the locale, + * then the errorCB callback is invoked. + */ +- (void)getLocaleName:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Returns a date formatted as a string according to the clients user preferences and + * calendar using the time zone of the client. It returns the formatted date string to the + * successCB callback with a properties object as a parameter. If there is an error + * formatting the date, then the errorCB callback is invoked. + * + * options: "date" contains the number of milliseconds that represents the JavaScript date + */ +- (void)dateToString:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Parses a date formatted as a string according to the clients user + * preferences and calendar using the time zone of the client and returns + * the corresponding date object. It returns the date to the successCB + * callback with a properties object as a parameter. If there is an error + * parsing the date string, then the errorCB callback is invoked. + * + * options: "dateString" contains the JavaScript string to parse for a date + */ +- (void)stringToDate:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Returns a pattern string for formatting and parsing dates according to the clients + * user preferences. It returns the pattern to the successCB callback with a + * properties object as a parameter. If there is an error obtaining the pattern, + * then the errorCB callback is invoked. + * + */ +- (void)getDatePattern:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Returns an array of either the names of the months or days of the week + * according to the clients user preferences and calendar. It returns the array of names to the + * successCB callback with a properties object as a parameter. If there is an error obtaining the + * names, then the errorCB callback is invoked. + * + */ +- (void)getDateNames:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Returns whether daylight savings time is in effect for a given date using the clients + * time zone and calendar. It returns whether or not daylight savings time is in effect + * to the successCB callback with a properties object as a parameter. If there is an error + * reading the date, then the errorCB callback is invoked. + * + * options: "date" contains the number of milliseconds that represents the JavaScript date + * + */ +- (void)isDayLightSavingsTime:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Returns the first day of the week according to the clients user preferences and calendar. + * The days of the week are numbered starting from 1 where 1 is considered to be Sunday. + * It returns the day to the successCB callback with a properties object as a parameter. + * If there is an error obtaining the pattern, then the errorCB callback is invoked. + * + */ +- (void)getFirstDayOfWeek:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Returns a number formatted as a string according to the clients user preferences. + * It returns the formatted number string to the successCB callback with a properties object as a + * parameter. If there is an error formatting the number, then the errorCB callback is invoked. + * + * options: "number" contains the JavaScript number to format + * + */ +- (void)numberToString:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Parses a number formatted as a string according to the clients user preferences and + * returns the corresponding number. It returns the number to the successCB callback with a + * properties object as a parameter. If there is an error parsing the number string, then + * the errorCB callback is invoked. + * + * options: "numberString" contains the JavaScript string to parse for a number + * + */ +- (void)stringToNumber:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Returns a pattern string for formatting and parsing numbers according to the clients user + * preferences. It returns the pattern to the successCB callback with a properties object as a + * parameter. If there is an error obtaining the pattern, then the errorCB callback is invoked. + * + */ +- (void)getNumberPattern:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +/** + * Returns a pattern string for formatting and parsing currency values according to the clients + * user preferences and ISO 4217 currency code. It returns the pattern to the successCB callback with a + * properties object as a parameter. If there is an error obtaining the pattern, then the errorCB + * callback is invoked. + * + * options: "currencyCode" contains the ISO currency code from JavaScript + */ +- (void)getCurrencyPattern:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options; + +@end |