ICU 52.1  52.1
tznames.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2011-2013, International Business Machines Corporation and *
4 * others. All Rights Reserved. *
5 *******************************************************************************
6 */
7 #ifndef __TZNAMES_H
8 #define __TZNAMES_H
9 
14 #include "unicode/utypes.h"
15 
16 #if !UCONFIG_NO_FORMATTING
17 
18 #include "unicode/uloc.h"
19 #include "unicode/unistr.h"
20 
22 
27 typedef enum UTimeZoneNameType {
32  UTZNM_UNKNOWN = 0x00,
63 #ifndef U_HIDE_DRAFT_API
64 
69 #endif /* U_HIDE_DRAFT_API */
71 
73 
75 
76 class UVector;
77 struct MatchInfo;
78 
130 public:
135  virtual ~TimeZoneNames();
136 
143  virtual UBool operator==(const TimeZoneNames& other) const = 0;
144 
152  UBool operator!=(const TimeZoneNames& other) const { return !operator==(other); }
153 
160  virtual TimeZoneNames* clone() const = 0;
161 
170  static TimeZoneNames* U_EXPORT2 createInstance(const Locale& locale, UErrorCode& status);
171 
178  virtual StringEnumeration* getAvailableMetaZoneIDs(UErrorCode& status) const = 0;
179 
187  virtual StringEnumeration* getAvailableMetaZoneIDs(const UnicodeString& tzID, UErrorCode& status) const = 0;
188 
199  virtual UnicodeString& getMetaZoneID(const UnicodeString& tzID, UDate date, UnicodeString& mzID) const = 0;
200 
217  virtual UnicodeString& getReferenceZoneID(const UnicodeString& mzID, const char* region, UnicodeString& tzID) const = 0;
218 
229  virtual UnicodeString& getMetaZoneDisplayName(const UnicodeString& mzID, UTimeZoneNameType type, UnicodeString& name) const = 0;
230 
241  virtual UnicodeString& getTimeZoneDisplayName(const UnicodeString& tzID, UTimeZoneNameType type, UnicodeString& name) const = 0;
242 
262  virtual UnicodeString& getExemplarLocationName(const UnicodeString& tzID, UnicodeString& name) const;
263 
279  virtual UnicodeString& getDisplayName(const UnicodeString& tzID, UTimeZoneNameType type, UDate date, UnicodeString& name) const;
280 
287  public:
297  virtual ~MatchInfoCollection();
298 
299 #ifndef U_HIDE_INTERNAL_API
300 
308  void addZone(UTimeZoneNameType nameType, int32_t matchLength,
309  const UnicodeString& tzID, UErrorCode& status);
310 
319  void addMetaZone(UTimeZoneNameType nameType, int32_t matchLength,
320  const UnicodeString& mzID, UErrorCode& status);
321 
327  int32_t size() const;
328 
337  UTimeZoneNameType getNameTypeAt(int32_t idx) const;
338 
346  int32_t getMatchLengthAt(int32_t idx) const;
347 
355  UBool getTimeZoneIDAt(int32_t idx, UnicodeString& tzID) const;
356 
364  UBool getMetaZoneIDAt(int32_t idx, UnicodeString& mzID) const;
365 #endif /* U_HIDE_INTERNAL_API */
366 
367  private:
368  UVector* fMatches; // vector of MatchEntry
369 
370  UVector* matches(UErrorCode& status);
371  };
372 
386  virtual MatchInfoCollection* find(const UnicodeString& text, int32_t start, uint32_t types, UErrorCode& status) const = 0;
387 };
388 
390 
391 #endif
392 #endif
double UDate
Date and Time data type.
Definition: utypes.h:201
C++ API: Unicode String.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:55
Long display name, such as "Eastern Time".
Definition: tznames.h:37
#define U_CDECL_BEGIN
This is used to begin a declaration of a library private ICU C API.
Definition: umachine.h:82
Short display name, such as "ET".
Definition: tznames.h:52
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:358
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
MatchInfoCollection represents a collection of time zone name matches used by TimeZoneNames#find.
Definition: tznames.h:286
Long display name for standard time, such as "Eastern Standard Time".
Definition: tznames.h:42
Short display name for standard time, such as "EST".
Definition: tznames.h:57
TimeZoneNames is an abstract class representing the time zone display name data model defined by UTS#...
Definition: tznames.h:129
UBool operator!=(const TimeZoneNames &other) const
Return true if the given TimeZoneNames objects are not semantically equal.
Definition: tznames.h:152
#define U_CDECL_END
This is used to end a declaration of a library private ICU C API.
Definition: umachine.h:83
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
Unknown display name type.
Definition: tznames.h:32
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
Exemplar location name, such as "Los Angeles".
Definition: tznames.h:68
Basic definitions for ICU, for both C and C++ APIs.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:245
Long display name for daylight saving time, such as "Eastern Daylight Time".
Definition: tznames.h:47
UTimeZoneNameType
Constants for time zone display name types.
Definition: tznames.h:27
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:221
UMemory is the common ICU base class.
Definition: uobject.h:110
int8_t UBool
The ICU boolean type.
Definition: umachine.h:200
C API: Locale.
Short display name for daylight saving time, such as "EDT".
Definition: tznames.h:62
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:185