CFDateFormatter.h

   1 /*
   2  * Copyright (c) 2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*      CFDateFormatter.h
  24         Copyright (c) 2003-2007, Apple Inc. All rights reserved.
  25 */
  26
  27 #if !defined(__COREFOUNDATION_CFDATEFORMATTER__)
  28 #define __COREFOUNDATION_CFDATEFORMATTER__ 1
  29
  30 #include <CoreFoundation/CFBase.h>
  31 #include <CoreFoundation/CFDate.h>
  32 #include <CoreFoundation/CFLocale.h>
  33
  34 #if MAC_OS_X_VERSION_10_3 <= MAC_OS_X_VERSION_MAX_ALLOWED
  35
  36 CF_EXTERN_C_BEGIN
  37
  38 typedef struct __CFDateFormatter *CFDateFormatterRef;
  39
  40 // CFDateFormatters are not thread-safe.  Do not use one from multiple threads!
  41
  42 CF_EXPORT
  43 CFTypeID CFDateFormatterGetTypeID(void) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  44
  45 enum {  // date and time format styles
  46         kCFDateFormatterNoStyle = 0,
  47         kCFDateFormatterShortStyle = 1,
  48         kCFDateFormatterMediumStyle = 2,
  49         kCFDateFormatterLongStyle = 3,
  50         kCFDateFormatterFullStyle = 4
  51 };
  52 typedef CFIndex CFDateFormatterStyle;
  53
  54 // The exact formatted result for these date and time styles depends on the
  55 // locale, but generally:
  56 //     Short is completely numeric, such as "12/13/52" or "3:30pm"
  57 //     Medium is longer, such as "Jan 12, 1952"
  58 //     Long is longer, such as "January 12, 1952" or "3:30:32pm"
  59 //     Full is pretty complete; e.g. "Tuesday, April 12, 1952 AD" or "3:30:42pm PST"
  60 // The specifications though are left fuzzy, in part simply because a user's
  61 // preference choices may affect the output, and also the results may change
  62 // from one OS release to another.  To produce an exactly formatted date you
  63 // should not rely on styles and localization, but set the format string and
  64 // use nothing but numbers.
  65
  66 CF_EXPORT
  67 CFDateFormatterRef CFDateFormatterCreate(CFAllocatorRef allocator, CFLocaleRef locale, CFDateFormatterStyle dateStyle, CFDateFormatterStyle timeStyle) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  68         // Returns a CFDateFormatter, localized to the given locale, which
  69         // will format dates to the given date and time styles.
  70
  71 CF_EXPORT
  72 CFLocaleRef CFDateFormatterGetLocale(CFDateFormatterRef formatter) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  73
  74 CF_EXPORT
  75 CFDateFormatterStyle CFDateFormatterGetDateStyle(CFDateFormatterRef formatter) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  76
  77 CF_EXPORT
  78 CFDateFormatterStyle CFDateFormatterGetTimeStyle(CFDateFormatterRef formatter) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  79         // Get the properties with which the date formatter was created.
  80
  81 CF_EXPORT
  82 CFStringRef CFDateFormatterGetFormat(CFDateFormatterRef formatter) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  83
  84 CF_EXPORT
  85 void CFDateFormatterSetFormat(CFDateFormatterRef formatter, CFStringRef formatString) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  86         // Set the format description string of the date formatter.  This
  87         // overrides the style settings.  The format of the format string
  88         // is as defined by the ICU library.  The date formatter starts with a
  89         // default format string defined by the style arguments with
  90         // which it was created.
  91
  92
  93 CF_EXPORT
  94 CFStringRef CFDateFormatterCreateStringWithDate(CFAllocatorRef allocator, CFDateFormatterRef formatter, CFDateRef date) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  95
  96 CF_EXPORT
  97 CFStringRef CFDateFormatterCreateStringWithAbsoluteTime(CFAllocatorRef allocator, CFDateFormatterRef formatter, CFAbsoluteTime at) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  98         // Create a string representation of the given date or CFAbsoluteTime
  99         // using the current state of the date formatter.
 100
 101
 102 CF_EXPORT
 103 CFDateRef CFDateFormatterCreateDateFromString(CFAllocatorRef allocator, CFDateFormatterRef formatter, CFStringRef string, CFRange *rangep) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
 104
 105 CF_EXPORT
 106 Boolean CFDateFormatterGetAbsoluteTimeFromString(CFDateFormatterRef formatter, CFStringRef string, CFRange *rangep, CFAbsoluteTime *atp) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
 107         // Parse a string representation of a date using the current state
 108         // of the date formatter.  The range parameter specifies the range
 109         // of the string in which the parsing should occur in input, and on
 110         // output indicates the extent that was used; this parameter can
 111         // be NULL, in which case the whole string may be used.  The
 112         // return value indicates whether some date was computed and
 113         // (if atp is not NULL) stored at the location specified by atp.
 114
 115
 116 CF_EXPORT
 117 void CFDateFormatterSetProperty(CFDateFormatterRef formatter, CFStringRef key, CFTypeRef value) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
 118
 119 CF_EXPORT
 120 CFTypeRef CFDateFormatterCopyProperty(CFDateFormatterRef formatter, CFStringRef key) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
 121         // Set and get various properties of the date formatter, the set of
 122         // which may be expanded in the future.
 123
 124 CF_EXPORT const CFStringRef kCFDateFormatterIsLenient AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;        // CFBoolean
 125 CF_EXPORT const CFStringRef kCFDateFormatterTimeZone AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;         // CFTimeZone
 126 CF_EXPORT const CFStringRef kCFDateFormatterCalendarName AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;     // CFString
 127 CF_EXPORT const CFStringRef kCFDateFormatterDefaultFormat AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;    // CFString
 128 CF_EXPORT const CFStringRef kCFDateFormatterTwoDigitStartDate AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER; // CFDate
 129 CF_EXPORT const CFStringRef kCFDateFormatterDefaultDate AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;      // CFDate
 130 CF_EXPORT const CFStringRef kCFDateFormatterCalendar AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;         // CFCalendar
 131 CF_EXPORT const CFStringRef kCFDateFormatterEraSymbols AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;       // CFArray of CFString
 132 CF_EXPORT const CFStringRef kCFDateFormatterMonthSymbols AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;     // CFArray of CFString
 133 CF_EXPORT const CFStringRef kCFDateFormatterShortMonthSymbols AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER; // CFArray of CFString
 134 CF_EXPORT const CFStringRef kCFDateFormatterWeekdaySymbols AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;   // CFArray of CFString
 135 CF_EXPORT const CFStringRef kCFDateFormatterShortWeekdaySymbols AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER; // CFArray of CFString
 136 CF_EXPORT const CFStringRef kCFDateFormatterAMSymbol AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;         // CFString
 137 CF_EXPORT const CFStringRef kCFDateFormatterPMSymbol AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;         // CFString
 138 CF_EXPORT const CFStringRef kCFDateFormatterLongEraSymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;   // CFArray of CFString
 139 CF_EXPORT const CFStringRef kCFDateFormatterVeryShortMonthSymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 140 CF_EXPORT const CFStringRef kCFDateFormatterStandaloneMonthSymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 141 CF_EXPORT const CFStringRef kCFDateFormatterShortStandaloneMonthSymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 142 CF_EXPORT const CFStringRef kCFDateFormatterVeryShortStandaloneMonthSymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 143 CF_EXPORT const CFStringRef kCFDateFormatterVeryShortWeekdaySymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 144 CF_EXPORT const CFStringRef kCFDateFormatterStandaloneWeekdaySymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 145 CF_EXPORT const CFStringRef kCFDateFormatterShortStandaloneWeekdaySymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 146 CF_EXPORT const CFStringRef kCFDateFormatterVeryShortStandaloneWeekdaySymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 147 CF_EXPORT const CFStringRef kCFDateFormatterQuarterSymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;   // CFArray of CFString
 148 CF_EXPORT const CFStringRef kCFDateFormatterShortQuarterSymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 149 CF_EXPORT const CFStringRef kCFDateFormatterStandaloneQuarterSymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 150 CF_EXPORT const CFStringRef kCFDateFormatterShortStandaloneQuarterSymbols AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFArray of CFString
 151 CF_EXPORT const CFStringRef kCFDateFormatterGregorianStartDate AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFDate
 152
 153 // See CFLocale.h for these calendar constants:
 154 //      const CFStringRef kCFGregorianCalendar;
 155 //      const CFStringRef kCFBuddhistCalendar;
 156 //      const CFStringRef kCFJapaneseCalendar;
 157 //      const CFStringRef kCFIslamicCalendar;
 158 //      const CFStringRef kCFIslamicCivilCalendar;
 159 //      const CFStringRef kCFHebrewCalendar;
 160 //      const CFStringRef kCFChineseCalendar;
 161
 162 CF_EXTERN_C_END
 163
 164 #endif
 165
 166 #endif /* ! __COREFOUNDATION_CFDATEFORMATTER__ */
 167