CFTimeZone.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 /*      CFTimeZone.h
  24         Copyright (c) 1998-2007, Apple Inc. All rights reserved.
  25 */
  26
  27 #if !defined(__COREFOUNDATION_CFTIMEZONE__)
  28 #define __COREFOUNDATION_CFTIMEZONE__ 1
  29
  30 #include <CoreFoundation/CFBase.h>
  31 #include <CoreFoundation/CFArray.h>
  32 #include <CoreFoundation/CFData.h>
  33 #include <CoreFoundation/CFDate.h>
  34 #include <CoreFoundation/CFDictionary.h>
  35 #include <CoreFoundation/CFString.h>
  36
  37 CF_EXTERN_C_BEGIN
  38
  39 CF_EXPORT
  40 CFTypeID CFTimeZoneGetTypeID(void);
  41
  42 CF_EXPORT
  43 CFTimeZoneRef CFTimeZoneCopySystem(void);
  44
  45 CF_EXPORT
  46 void CFTimeZoneResetSystem(void);
  47
  48 CF_EXPORT
  49 CFTimeZoneRef CFTimeZoneCopyDefault(void);
  50
  51 CF_EXPORT
  52 void CFTimeZoneSetDefault(CFTimeZoneRef tz);
  53
  54 CF_EXPORT
  55 CFArrayRef CFTimeZoneCopyKnownNames(void);
  56
  57 CF_EXPORT
  58 CFDictionaryRef CFTimeZoneCopyAbbreviationDictionary(void);
  59
  60 CF_EXPORT
  61 void CFTimeZoneSetAbbreviationDictionary(CFDictionaryRef dict);
  62
  63 CF_EXPORT
  64 CFTimeZoneRef CFTimeZoneCreate(CFAllocatorRef allocator, CFStringRef name, CFDataRef data);
  65
  66 CF_EXPORT
  67 CFTimeZoneRef CFTimeZoneCreateWithTimeIntervalFromGMT(CFAllocatorRef allocator, CFTimeInterval ti);
  68
  69 CF_EXPORT
  70 CFTimeZoneRef CFTimeZoneCreateWithName(CFAllocatorRef allocator, CFStringRef name, Boolean tryAbbrev);
  71
  72 CF_EXPORT
  73 CFStringRef CFTimeZoneGetName(CFTimeZoneRef tz);
  74
  75 CF_EXPORT
  76 CFDataRef CFTimeZoneGetData(CFTimeZoneRef tz);
  77
  78 CF_EXPORT
  79 CFTimeInterval CFTimeZoneGetSecondsFromGMT(CFTimeZoneRef tz, CFAbsoluteTime at);
  80
  81 CF_EXPORT
  82 CFStringRef CFTimeZoneCopyAbbreviation(CFTimeZoneRef tz, CFAbsoluteTime at);
  83
  84 CF_EXPORT
  85 Boolean CFTimeZoneIsDaylightSavingTime(CFTimeZoneRef tz, CFAbsoluteTime at);
  86
  87 CF_EXPORT
  88 CFTimeInterval CFTimeZoneGetDaylightSavingTimeOffset(CFTimeZoneRef tz, CFAbsoluteTime at) AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;
  89
  90 CF_EXPORT
  91 CFAbsoluteTime CFTimeZoneGetNextDaylightSavingTimeTransition(CFTimeZoneRef tz, CFAbsoluteTime at) AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;
  92
  93 #if MAC_OS_X_VERSION_10_5 <= MAC_OS_X_VERSION_MAX_ALLOWED
  94 enum {
  95         kCFTimeZoneNameStyleStandard,
  96         kCFTimeZoneNameStyleShortStandard,
  97         kCFTimeZoneNameStyleDaylightSaving,
  98         kCFTimeZoneNameStyleShortDaylightSaving
  99 };
 100 typedef CFIndex CFTimeZoneNameStyle;
 101
 102 CF_EXPORT
 103 CFStringRef CFTimeZoneCopyLocalizedName(CFTimeZoneRef tz, CFTimeZoneNameStyle style, CFLocaleRef locale) AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;
 104 #endif
 105
 106 CF_EXPORT
 107 const CFStringRef kCFTimeZoneSystemTimeZoneDidChangeNotification AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;
 108
 109 CF_EXTERN_C_END
 110
 111 #endif /* ! __COREFOUNDATION_CFTIMEZONE__ */
 112