ICU 4.8.1.1  4.8.1.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
datefmt.h
Go to the documentation of this file.
1 /*
2  ********************************************************************************
3  * Copyright (C) 1997-2011, International Business Machines
4  * Corporation and others. All Rights Reserved.
5  ********************************************************************************
6  *
7  * File DATEFMT.H
8  *
9  * Modification History:
10  *
11  * Date Name Description
12  * 02/19/97 aliu Converted from java.
13  * 04/01/97 aliu Added support for centuries.
14  * 07/23/98 stephen JDK 1.2 sync
15  * 11/15/99 weiv Added support for week of year/day of week formatting
16  ********************************************************************************
17  */
18 
19 #ifndef DATEFMT_H
20 #define DATEFMT_H
21 
22 #include "unicode/utypes.h"
23 
24 #if !UCONFIG_NO_FORMATTING
25 
26 #include "unicode/udat.h"
27 #include "unicode/calendar.h"
28 #include "unicode/numfmt.h"
29 #include "unicode/format.h"
30 #include "unicode/locid.h"
31 
38 
39 class TimeZone;
41 
138 class U_I18N_API DateFormat : public Format {
139 public:
140 
148  enum EStyle
149  {
150  kNone = -1,
151 
152  kFull = 0,
153  kLong = 1,
154  kMedium = 2,
155  kShort = 3,
156 
157  kDateOffset = kShort + 1,
158  // kFull + kDateOffset = 4
159  // kLong + kDateOffset = 5
160  // kMedium + kDateOffset = 6
161  // kShort + kDateOffset = 7
162 
163  kDateTime = 8,
164  // Default DateTime
165 
166  kDateTimeOffset = kDateTime + 1,
167  // kFull + kDateTimeOffset = 9
168  // kLong + kDateTimeOffset = 10
169  // kMedium + kDateTimeOffset = 11
170  // kShort + kDateTimeOffset = 12
171 
172  // relative dates
173  kRelative = (1 << 7),
174 
175  kFullRelative = (kFull | kRelative),
176 
177  kLongRelative = kLong | kRelative,
178 
179  kMediumRelative = kMedium | kRelative,
180 
181  kShortRelative = kShort | kRelative,
182 
183 
184  kDefault = kMedium,
185 
186 
187 
192  FULL = kFull,
193  LONG = kLong,
194  MEDIUM = kMedium,
195  SHORT = kShort,
196  DEFAULT = kDefault,
197  DATE_OFFSET = kDateOffset,
198  NONE = kNone,
199  DATE_TIME = kDateTime
200  };
201 
206  virtual ~DateFormat();
207 
212  virtual UBool operator==(const Format&) const;
213 
214 
215  using Format::format;
216 
231  virtual UnicodeString& format(const Formattable& obj,
232  UnicodeString& appendTo,
233  FieldPosition& pos,
234  UErrorCode& status) const;
235 
251  virtual UnicodeString& format(const Formattable& obj,
252  UnicodeString& appendTo,
253  FieldPositionIterator* posIter,
254  UErrorCode& status) const;
288  virtual UnicodeString& format( Calendar& cal,
289  UnicodeString& appendTo,
290  FieldPosition& fieldPosition) const = 0;
291 
310  virtual UnicodeString& format(Calendar& cal,
311  UnicodeString& appendTo,
312  FieldPositionIterator* posIter,
313  UErrorCode& status) const;
341  UnicodeString& format( UDate date,
342  UnicodeString& appendTo,
343  FieldPosition& fieldPosition) const;
344 
358  UnicodeString& format(UDate date,
359  UnicodeString& appendTo,
360  FieldPositionIterator* posIter,
361  UErrorCode& status) const;
373  UnicodeString& format(UDate date, UnicodeString& appendTo) const;
374 
385  UnicodeString& format(const Formattable& obj,
386  UnicodeString& appendTo,
387  UErrorCode& status) const;
388 
399  virtual UDate parse( const UnicodeString& text,
400  UErrorCode& status) const;
401 
428  virtual void parse( const UnicodeString& text,
429  Calendar& cal,
430  ParsePosition& pos) const = 0;
431 
451  UDate parse( const UnicodeString& text,
452  ParsePosition& pos) const;
453 
480  virtual void parseObject(const UnicodeString& source,
481  Formattable& result,
482  ParsePosition& parse_pos) const;
483 
491  static DateFormat* U_EXPORT2 createInstance(void);
492 
504  static DateFormat* U_EXPORT2 createTimeInstance(EStyle style = kDefault,
505  const Locale& aLocale = Locale::getDefault());
506 
517  static DateFormat* U_EXPORT2 createDateInstance(EStyle style = kDefault,
518  const Locale& aLocale = Locale::getDefault());
519 
533  static DateFormat* U_EXPORT2 createDateTimeInstance(EStyle dateStyle = kDefault,
534  EStyle timeStyle = kDefault,
535  const Locale& aLocale = Locale::getDefault());
536 
544  static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
545 
550  virtual UBool isLenient(void) const;
551 
562  virtual void setLenient(UBool lenient);
563 
569  virtual const Calendar* getCalendar(void) const;
570 
580  virtual void adoptCalendar(Calendar* calendarToAdopt);
581 
589  virtual void setCalendar(const Calendar& newCalendar);
590 
591 
598  virtual const NumberFormat* getNumberFormat(void) const;
599 
606  virtual void adoptNumberFormat(NumberFormat* formatToAdopt);
607 
613  virtual void setNumberFormat(const NumberFormat& newNumberFormat);
614 
620  virtual const TimeZone& getTimeZone(void) const;
621 
628  virtual void adoptTimeZone(TimeZone* zoneToAdopt);
629 
635  virtual void setTimeZone(const TimeZone& zone);
636 
637 protected:
644  DateFormat();
645 
650  DateFormat(const DateFormat&);
651 
657 
665 
673 
674 private:
683  static DateFormat* U_EXPORT2 create(EStyle timeStyle, EStyle dateStyle, const Locale& inLocale);
684 
685 public:
691  enum EField
692  {
693  // Obsolete; use UDateFormatField instead
694  kEraField = UDAT_ERA_FIELD,
695  kYearField = UDAT_YEAR_FIELD,
696  kMonthField = UDAT_MONTH_FIELD,
697  kDateField = UDAT_DATE_FIELD,
698  kHourOfDay1Field = UDAT_HOUR_OF_DAY1_FIELD,
699  kHourOfDay0Field = UDAT_HOUR_OF_DAY0_FIELD,
700  kMinuteField = UDAT_MINUTE_FIELD,
701  kSecondField = UDAT_SECOND_FIELD,
702  kMillisecondField = UDAT_FRACTIONAL_SECOND_FIELD,
703  kDayOfWeekField = UDAT_DAY_OF_WEEK_FIELD,
704  kDayOfYearField = UDAT_DAY_OF_YEAR_FIELD,
705  kDayOfWeekInMonthField = UDAT_DAY_OF_WEEK_IN_MONTH_FIELD,
706  kWeekOfYearField = UDAT_WEEK_OF_YEAR_FIELD,
707  kWeekOfMonthField = UDAT_WEEK_OF_MONTH_FIELD,
708  kAmPmField = UDAT_AM_PM_FIELD,
709  kHour1Field = UDAT_HOUR1_FIELD,
710  kHour0Field = UDAT_HOUR0_FIELD,
711  kTimezoneField = UDAT_TIMEZONE_FIELD,
712  kYearWOYField = UDAT_YEAR_WOY_FIELD,
713  kDOWLocalField = UDAT_DOW_LOCAL_FIELD,
714  kExtendedYearField = UDAT_EXTENDED_YEAR_FIELD,
715  kJulianDayField = UDAT_JULIAN_DAY_FIELD,
716  kMillisecondsInDayField = UDAT_MILLISECONDS_IN_DAY_FIELD,
717 
718  // Obsolete; use UDateFormatField instead
719  ERA_FIELD = UDAT_ERA_FIELD,
720  YEAR_FIELD = UDAT_YEAR_FIELD,
721  MONTH_FIELD = UDAT_MONTH_FIELD,
722  DATE_FIELD = UDAT_DATE_FIELD,
723  HOUR_OF_DAY1_FIELD = UDAT_HOUR_OF_DAY1_FIELD,
724  HOUR_OF_DAY0_FIELD = UDAT_HOUR_OF_DAY0_FIELD,
725  MINUTE_FIELD = UDAT_MINUTE_FIELD,
726  SECOND_FIELD = UDAT_SECOND_FIELD,
727  MILLISECOND_FIELD = UDAT_FRACTIONAL_SECOND_FIELD,
728  DAY_OF_WEEK_FIELD = UDAT_DAY_OF_WEEK_FIELD,
729  DAY_OF_YEAR_FIELD = UDAT_DAY_OF_YEAR_FIELD,
730  DAY_OF_WEEK_IN_MONTH_FIELD = UDAT_DAY_OF_WEEK_IN_MONTH_FIELD,
731  WEEK_OF_YEAR_FIELD = UDAT_WEEK_OF_YEAR_FIELD,
732  WEEK_OF_MONTH_FIELD = UDAT_WEEK_OF_MONTH_FIELD,
733  AM_PM_FIELD = UDAT_AM_PM_FIELD,
734  HOUR1_FIELD = UDAT_HOUR1_FIELD,
735  HOUR0_FIELD = UDAT_HOUR0_FIELD,
736  TIMEZONE_FIELD = UDAT_TIMEZONE_FIELD
737  };
738 };
739 
740 inline UnicodeString&
742  UnicodeString& appendTo,
743  UErrorCode& status) const {
744  return Format::format(obj, appendTo, status);
745 }
747 
748 #endif /* #if !UCONFIG_NO_FORMATTING */
749 
750 #endif // _DATEFMT
751 //eof
FieldPosition and UFieldPosition selector for &#39;w&#39; field alignment, corresponding to the UCAL_WEEK_OF_...
Definition: udat.h:355
FieldPosition and UFieldPosition selector for &#39;e&#39; field alignment, corresponding to the UCAL_DOW_LOCA...
Definition: udat.h:409
Calendar is an abstract base class for converting between a UDate object and a set of integer fields ...
Definition: calendar.h:165
NumberFormat * fNumberFormat
The number formatter that DateFormat uses to format numbers in dates and times.
Definition: datefmt.h:672
FieldPosition and UFieldPosition selector for &#39;M&#39; field alignment, corresponding to the UCAL_MONTH fi...
Definition: udat.h:281
FieldPosition and UFieldPosition selector for &#39;k&#39; field alignment, corresponding to the UCAL_HOUR_OF_...
Definition: udat.h:297
double UDate
Date and Time data type.
Definition: utypes.h:314
virtual void parseObject(const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const =0
Parse a string to produce an object.
UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
Formats an object to produce a string.
Calendar * fCalendar
The calendar that DateFormat uses to produce the time field values needed to implement date/time form...
Definition: datefmt.h:664
DateFormat is an abstract class for a family of classes that convert dates and times from their inter...
Definition: datefmt.h:138
FieldPosition and UFieldPosition selector for &#39;g&#39; field alignment, corresponding to the UCAL_JULIAN_D...
Definition: udat.h:423
FieldPosition and UFieldPosition selector for &#39;D&#39; field alignment, corresponding to the UCAL_DAY_OF_Y...
Definition: udat.h:341
EStyle
Constants for various style patterns.
Definition: datefmt.h:148
C++ API: Base class for all formats.
FieldPosition and UFieldPosition selector for &#39;u&#39; field alignment, corresponding to the UCAL_EXTENDED...
Definition: udat.h:416
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:521
FieldPosition and UFieldPosition selector for &#39;d&#39; field alignment, corresponding to the UCAL_DATE fie...
Definition: udat.h:288
FieldPosition and UFieldPosition selector for &#39;Y&#39; field alignment, corresponding to the UCAL_YEAR_WOY...
Definition: udat.h:402
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
FieldPosition and UFieldPosition selector for &#39;F&#39; field alignment, corresponding to the UCAL_DAY_OF_W...
Definition: udat.h:348
Abstract base class for all number formats.
Definition: numfmt.h:165
EField
Field selector for FieldPosition for DateFormat fields.
Definition: datefmt.h:691
FieldPosition and UFieldPosition selector for &#39;A&#39; field alignment, corresponding to the UCAL_MILLISEC...
Definition: udat.h:430
C++ API: Calendar object.
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition: parsepos.h:47
C API: DateFormat.
FieldPosition and UFieldPosition selector for &#39;W&#39; field alignment, corresponding to the UCAL_WEEK_OF_...
Definition: udat.h:362
virtual UBool operator==(const Format &other) const =0
Return true if the given Format objects are semantically equal.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:188
#define U_EXPORT2
Definition: platform.h:314
FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...
Definition: fpositer.h:53
FieldPosition and UFieldPosition selector for &#39;E&#39; field alignment, corresponding to the UCAL_DAY_OF_W...
Definition: udat.h:334
FieldPosition and UFieldPosition selector for &#39;a&#39; field alignment, corresponding to the UCAL_AM_PM fi...
Definition: udat.h:369
FieldPosition and UFieldPosition selector for &#39;K&#39; field alignment, corresponding to the UCAL_HOUR fie...
Definition: udat.h:387
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition: fieldpos.h:106
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
static const Locale & getDefault(void)
Common methods of getting the current default Locale.
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition: fmtable.h:52
FieldPosition and UFieldPosition selector for &#39;G&#39; field alignment, corresponding to the UCAL_ERA fiel...
Definition: udat.h:267
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:639
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:123
FieldPosition and UFieldPosition selector for &#39;m&#39; field alignment, corresponding to the UCAL_MINUTE f...
Definition: udat.h:313
C++ API: Locale ID object.
Base class for all formats.
Definition: format.h:94
FieldPosition and UFieldPosition selector for &#39;s&#39; field alignment, corresponding to the UCAL_SECOND f...
Definition: udat.h:320
Basic definitions for ICU, for both C and C++ APIs.
FieldPosition and UFieldPosition selector for &#39;z&#39; field alignment, corresponding to the UCAL_ZONE_OFF...
Definition: udat.h:395
FieldPosition and UFieldPosition selector for &#39;y&#39; field alignment, corresponding to the UCAL_YEAR fie...
Definition: udat.h:274
virtual UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Format an object to produce a string.
C++ API: Abstract base class for all number formats.
FieldPosition and UFieldPosition selector for &#39;H&#39; field alignment, corresponding to the UCAL_HOUR_OF_...
Definition: udat.h:306
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:181
FieldPosition and UFieldPosition selector for &#39;S&#39; field alignment, corresponding to the UCAL_MILLISEC...
Definition: udat.h:327
FieldPosition and UFieldPosition selector for &#39;h&#39; field alignment, corresponding to the UCAL_HOUR fie...
Definition: udat.h:378
This class provides flexible generation of date format patterns, like &quot;yy-MM-dd&quot;. ...
Definition: dtptngen.h:49
int8_t UBool
The ICU boolean type.
Definition: umachine.h:228
Format & operator=(const Format &)