Foundation/NSNumberFormatter.h

   1 /* Copyright (c) 2006-2007 Christopher J. W. Lloyd
   2
   3 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
   4
   5 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
   6
   7 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
   8
   9 #import <Foundation/NSFormatter.h>
  10 #import <CoreFoundation/CFNumberFormatter.h>
  11
  12 @class NSLocale, NSDecimalNumberHandler;
  13
  14 enum {
  15     NSNumberFormatterBehaviorDefault = 0,
  16     NSNumberFormatterBehavior10_0 = 1000,
  17     NSNumberFormatterBehavior10_4 = 1040,
  18 };
  19
  20 typedef NSUInteger NSNumberFormatterBehavior;
  21
  22 enum {
  23     NSNumberFormatterNoStyle = kCFNumberFormatterNoStyle,
  24     NSNumberFormatterDecimalStyle = kCFNumberFormatterDecimalStyle,
  25     NSNumberFormatterCurrencyStyle = kCFNumberFormatterCurrencyStyle,
  26     NSNumberFormatterPercentStyle = kCFNumberFormatterPercentStyle,
  27     NSNumberFormatterScientificStyle = kCFNumberFormatterScientificStyle,
  28     NSNumberFormatterSpellOutStyle = kCFNumberFormatterSpellOutStyle,
  29 };
  30 typedef NSUInteger NSNumberFormatterStyle;
  31
  32 enum {
  33     NSNumberFormatterPadBeforePrefix = kCFNumberFormatterPadBeforePrefix,
  34     NSNumberFormatterPadAfterPrefix = kCFNumberFormatterPadAfterPrefix,
  35     NSNumberFormatterPadBeforeSuffix = kCFNumberFormatterPadBeforeSuffix,
  36     NSNumberFormatterPadAfterSuffix = kCFNumberFormatterPadAfterSuffix,
  37 };
  38 typedef NSUInteger NSNumberFormatterPadPosition;
  39
  40 enum {
  41     NSNumberFormatterRoundCeiling = kCFNumberFormatterRoundCeiling,
  42     NSNumberFormatterRoundFloor = kCFNumberFormatterRoundFloor,
  43     NSNumberFormatterRoundDown = kCFNumberFormatterRoundDown,
  44     NSNumberFormatterRoundUp = kCFNumberFormatterRoundUp,
  45     NSNumberFormatterRoundHalfEven = kCFNumberFormatterRoundHalfEven,
  46     NSNumberFormatterRoundHalfDown = kCFNumberFormatterRoundHalfDown,
  47     NSNumberFormatterRoundHalfUp = kCFNumberFormatterRoundHalfUp,
  48 };
  49 typedef NSUInteger NSNumberFormatterRoundingMode;
  50
  51 @interface NSNumberFormatter : NSFormatter {
  52     NSNumberFormatterBehavior _behavior;
  53     // 10.4
  54     NSNumberFormatterStyle _numberStyle;
  55     NSUInteger _formatWidth;
  56     NSLocale *_locale;
  57     NSNumber *_multiplier;
  58
  59     BOOL _allowsFloats;
  60     BOOL _alwaysShowsDecimalSeparator;
  61     BOOL _isLenient;
  62     BOOL _isPartialStringValidationEnabled;
  63     BOOL _generatesDecimalNumbers;
  64     BOOL _usesGroupingSeparator;
  65     BOOL _usesSignificantDigits;
  66
  67     NSUInteger _minimumIntegerDigits;
  68     NSUInteger _minimumFractionDigits;
  69     NSUInteger _minimumSignificantDigits;
  70     NSUInteger _maximumIntegerDigits;
  71     BOOL _customMaximumFractionDigits;
  72     NSUInteger _maximumFractionDigits;
  73     NSUInteger _maximumSignificantDigits;
  74
  75     NSNumber *_minimum;
  76     NSNumber *_maximum;
  77
  78     NSString *_nilSymbol;
  79     NSString *_notANumberSymbol;
  80     NSString *_zeroSymbol;
  81     NSString *_plusSign;
  82     NSString *_minusSign;
  83     NSString *_negativePrefix;
  84     NSString *_negativeSuffix;
  85     NSString *_positivePrefix;
  86     NSString *_positiveSuffix;
  87     NSString *_negativeInfinitySymbol;
  88     NSString *_positiveInfinitySymbol;
  89
  90     NSString *_decimalSeparator;
  91     NSString *_exponentSymbol;
  92     NSString *_currencyCode;
  93     NSString *_currencySymbol;
  94     NSString *_internationalCurrencySymbol;
  95     NSString *_currencyDecimalSeparator;
  96     NSString *_currencyGroupingSeparator;
  97     NSString *_groupingSeparator;
  98     NSUInteger _groupingSize;
  99     NSUInteger _secondaryGroupingSize;
 100     NSString *_paddingCharacter;
 101     NSNumberFormatterPadPosition _paddingPosition;
 102     NSString *_percentSymbol;
 103     NSString *_perMillSymbol;
 104     NSNumber *_roundingIncrement;
 105     NSNumberFormatterRoundingMode _roundingMode;
 106     NSString *_positiveFormat;
 107     NSString *_negativeFormat;
 108     NSDictionary *_textAttributesForPositiveValues;
 109     NSDictionary *_textAttributesForNegativeValues;
 110     NSDictionary *_textAttributesForNegativeInfinity;
 111     NSDictionary *_textAttributesForNil;
 112     NSDictionary *_textAttributesForNotANumber;
 113     NSDictionary *_textAttributesForPositiveInfinity;
 114     NSDictionary *_textAttributesForZero;
 115
 116     // 10.0
 117     NSAttributedString *_attributedStringForNil;
 118     NSAttributedString *_attributedStringForNotANumber;
 119     NSAttributedString *_attributedStringForZero;
 120     NSDecimalNumberHandler *_roundingBehavior;
 121     NSString *_thousandSeparator;
 122
 123     BOOL _hasThousandSeparators;
 124     BOOL _localizesFormat;
 125 }
 126
 127 + (NSNumberFormatterBehavior)defaultFormatterBehavior;
 128 + (void)setDefaultFormatterBehavior:(NSNumberFormatterBehavior)value;
 129
 130 - (NSNumberFormatterBehavior)formatterBehavior;
 131 - (NSNumberFormatterStyle)numberStyle;
 132
 133 - (NSUInteger)formatWidth;
 134 - (NSLocale *)locale;
 135 - (NSNumber *)multiplier;
 136
 137 - (BOOL)allowsFloats;
 138 - (BOOL)alwaysShowsDecimalSeparator;
 139 - (BOOL)isLenient;
 140 - (BOOL)isPartialStringValidationEnabled;
 141 - (BOOL)generatesDecimalNumbers;
 142 - (BOOL)usesGroupingSeparator;
 143 - (BOOL)usesSignificantDigits;
 144
 145 - (NSUInteger)minimumIntegerDigits;
 146 - (NSUInteger)minimumFractionDigits;
 147 - (NSUInteger)minimumSignificantDigits;
 148
 149 - (NSUInteger)maximumIntegerDigits;
 150 - (NSUInteger)maximumFractionDigits;
 151 - (NSUInteger)maximumSignificantDigits;
 152
 153 - (NSNumber *)minimum;
 154 - (NSNumber *)maximum;
 155
 156 - (void)setMinimum:(NSNumber *)value;
 157 - (void)setMaximum:(NSNumber *)value;
 158
 159 - (NSString *)nilSymbol;
 160 - (NSString *)notANumberSymbol;
 161 - (NSString *)zeroSymbol;
 162 - (NSString *)plusSign;
 163 - (NSString *)minusSign;
 164 - (NSString *)negativePrefix;
 165 - (NSString *)negativeSuffix;
 166 - (NSString *)positivePrefix;
 167 - (NSString *)positiveSuffix;
 168 - (NSString *)negativeInfinitySymbol;
 169 - (NSString *)positiveInfinitySymbol;
 170 - (NSString *)decimalSeparator;
 171 - (NSString *)exponentSymbol;
 172 - (NSString *)currencyCode;
 173 - (NSString *)currencySymbol;
 174 - (NSString *)internationalCurrencySymbol;
 175 - (NSString *)currencyDecimalSeparator;
 176 - (NSString *)currencyGroupingSeparator;
 177 - (NSString *)groupingSeparator;
 178 - (NSUInteger)groupingSize;
 179 - (NSUInteger)secondaryGroupingSize;
 180 - (NSString *)paddingCharacter;
 181 - (NSNumberFormatterPadPosition)paddingPosition;
 182 - (NSString *)percentSymbol;
 183 - (NSString *)perMillSymbol;
 184 - (NSNumber *)roundingIncrement;
 185 - (NSNumberFormatterRoundingMode)roundingMode;
 186
 187 - (NSString *)positiveFormat;
 188 - (NSString *)negativeFormat;
 189 - (NSDictionary *)textAttributesForPositiveValues;
 190 - (NSDictionary *)textAttributesForNegativeValues;
 191 - (NSDictionary *)textAttributesForNegativeInfinity;
 192 - (NSDictionary *)textAttributesForNil;
 193 - (NSDictionary *)textAttributesForNotANumber;
 194 - (NSDictionary *)textAttributesForPositiveInfinity;
 195 - (NSDictionary *)textAttributesForZero;
 196
 197 - (void)setAllowsFloats:(BOOL)flag;
 198
 199 - (void)setCurrencyCode:(NSString *)value;
 200 - (void)setCurrencyDecimalSeparator:(NSString *)value;
 201 - (void)setCurrencyGroupingSeparator:(NSString *)value;
 202 - (void)setCurrencySymbol:(NSString *)value;
 203 - (void)setDecimalSeparator:(NSString *)value;
 204 - (void)setExponentSymbol:(NSString *)value;
 205 - (void)setFormatterBehavior:(NSNumberFormatterBehavior)value;
 206 - (void)setFormatWidth:(NSUInteger)value;
 207 - (void)setGeneratesDecimalNumbers:(BOOL)value;
 208 - (void)setGroupingSeparator:(NSString *)value;
 209 - (void)setGroupingSize:(NSUInteger)value;
 210 - (void)setInternationalCurrencySymbol:(NSString *)value;
 211 - (void)setLenient:(BOOL)value;
 212 - (void)setLocale:(NSLocale *)value;
 213 - (void)setMaximumFractionDigits:(NSUInteger)value;
 214 - (void)setMaximumIntegerDigits:(NSUInteger)value;
 215 - (void)setMaximumSignificantDigits:(NSUInteger)value;
 216 - (void)setMinimumFractionDigits:(NSUInteger)value;
 217 - (void)setMinimumIntegerDigits:(NSUInteger)value;
 218 - (void)setMinimumSignificantDigits:(NSUInteger)value;
 219 - (void)setMinusSign:(NSString *)value;
 220 - (void)setMultiplier:(NSNumber *)value;
 221 - (void)setNegativeInfinitySymbol:(NSString *)value;
 222 - (void)setNegativePrefix:(NSString *)value;
 223 - (void)setNegativeSuffix:(NSString *)value;
 224 - (void)setNilSymbol:(NSString *)value;
 225 - (void)setNotANumberSymbol:(NSString *)value;
 226 - (void)setNumberStyle:(NSNumberFormatterStyle)value;
 227 - (void)setPaddingCharacter:(NSString *)value;
 228 - (void)setPaddingPosition:(NSNumberFormatterPadPosition)value;
 229 - (void)setPartialStringValidationEnabled:(BOOL)value;
 230 - (void)setPercentSymbol:(NSString *)value;
 231 - (void)setPerMillSymbol:(NSString *)value;
 232 - (void)setPlusSign:(NSString *)value;
 233 - (void)setPositiveInfinitySymbol:(NSString *)value;
 234 - (void)setPositivePrefix:(NSString *)value;
 235 - (void)setPositiveSuffix:(NSString *)value;
 236 - (void)setRoundingIncrement:(NSNumber *)value;
 237 - (void)setRoundingMode:(NSNumberFormatterRoundingMode)value;
 238 - (void)setSecondaryGroupingSize:(NSUInteger)value;
 239 - (void)setTextAttributesForNegativeInfinity:(NSDictionary *)value;
 240 - (void)setTextAttributesForNil:(NSDictionary *)value;
 241 - (void)setTextAttributesForNotANumber:(NSDictionary *)value;
 242 - (void)setTextAttributesForPositiveInfinity:(NSDictionary *)value;
 243 - (void)setTextAttributesForZero:(NSDictionary *)value;
 244 - (void)setUsesGroupingSeparator:(BOOL)value;
 245 - (void)setUsesSignificantDigits:(BOOL)value;
 246 - (void)setZeroSymbol:(NSString *)value;
 247
 248 - (void)setAlwaysShowsDecimalSeparator:(BOOL)value;
 249
 250 - (void)setPositiveFormat:(NSString *)format;
 251 - (void)setNegativeFormat:(NSString *)format;
 252
 253 - (void)setTextAttributesForNegativeValues:(NSDictionary *)attributes;
 254 - (void)setTextAttributesForPositiveValues:(NSDictionary *)attributes;
 255
 256 - (NSString *)stringFromNumber:(NSNumber *)number;
 257 - (NSNumber *)numberFromString:(NSString *)string;
 258
 259 - (BOOL)getObjectValue:(id *)valuep forString:(NSString *)string range:(NSRange *)rangep error:(NSError **)errorp;
 260
 261 // 10.0 behavior methods
 262
 263 - (BOOL)hasThousandSeparators;
 264 - (BOOL)localizesFormat;
 265 - (NSString *)thousandSeparator;
 266
 267 - (NSString *)format;
 268 - (NSAttributedString *)attributedStringForZero;
 269 - (NSAttributedString *)attributedStringForNil;
 270 - (NSAttributedString *)attributedStringForNotANumber;
 271 - (NSDecimalNumberHandler *)roundingBehavior;
 272
 273 - (void)setHasThousandSeparators:(BOOL)value;
 274 - (void)setLocalizesFormat:(BOOL)flag;
 275 - (void)setThousandSeparator:(NSString *)value;
 276 - (void)setFormat:(NSString *)format;
 277 - (void)setAttributedStringForZero:(NSAttributedString *)attributedString;
 278 - (void)setAttributedStringForNil:(NSAttributedString *)attributedString;
 279 - (void)setAttributedStringForNotANumber:(NSAttributedString *)attributedString;
 280 - (void)setRoundingBehavior:(NSDecimalNumberHandler *)value;
 281
 282 @end