Main Page | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

datefmt.h

00001 /*
00002 ********************************************************************************
00003 *   Copyright (C) 1997-2003, International Business Machines
00004 *   Corporation and others.  All Rights Reserved.
00005 ********************************************************************************
00006 *
00007 * File DATEFMT.H
00008 *
00009 * Modification History:
00010 *
00011 *   Date        Name        Description
00012 *   02/19/97    aliu        Converted from java.
00013 *   04/01/97    aliu        Added support for centuries.
00014 *   07/23/98    stephen     JDK 1.2 sync
00015 *   11/15/99    weiv        Added support for week of year/day of week formatting
00016 ********************************************************************************
00017 */
00018 
00019 #ifndef DATEFMT_H
00020 #define DATEFMT_H
00021  
00022 #include "unicode/utypes.h"
00023 
00024 #if !UCONFIG_NO_FORMATTING
00025 
00026 #include "unicode/calendar.h"
00027 #include "unicode/numfmt.h"
00028 #include "unicode/format.h"
00029 #include "unicode/locid.h"
00030 
00031 U_NAMESPACE_BEGIN
00032 
00033 class TimeZone;
00034 
00127 class U_I18N_API DateFormat : public Format {
00128 public:
00140     enum EField
00141     {
00142         kEraField = 0,      // ERA field alignment.
00143         kYearField,         // YEAR field alignment.
00144         kMonthField,        // MONTH field alignment.
00145         kDateField,         // DATE field alignment.
00146         kHourOfDay1Field,     // One-based HOUR_OF_DAY field alignment.
00147                             // kHourOfDay1Field is used for the one-based 24-hour clock.
00148                             // For example, 23:59 + 01:00 results in 24:59.
00149         kHourOfDay0Field,     // Zero-based HOUR_OF_DAY field alignment.
00150                             // HOUR_OF_DAY0_FIELD is used for the zero-based 24-hour clock.
00151                             // For example, 23:59 + 01:00 results in 00:59.
00152         kMinuteField,       // MINUTE field alignment.
00153         kSecondField,       // SECOND field alignment.
00154         kMillisecondField,  // MILLISECOND field alignment.
00155         kDayOfWeekField,      // DAY_OF_WEEK field alignment.
00156         kDayOfYearField,      // DAY_OF_YEAR field alignment.
00157         kDayOfWeekInMonthField,// DAY_OF_WEEK_IN_MONTH field alignment.
00158         kWeekOfYearField,     // WEEK_OF_YEAR field alignment.
00159         kWeekOfMonthField,    // WEEK_OF_MONTH field alignment.
00160         kAmPmField,            // AM_PM field alignment.
00161         kHour1Field,        // One-based HOUR field alignment.
00162                             // HOUR1_FIELD is used for the one-based 12-hour clock.
00163                             // For example, 11:30 PM + 1 hour results in 12:30 AM.
00164         kHour0Field,        // Zero-based HOUR field alignment.
00165                             // HOUR0_FIELD is used for the zero-based 12-hour clock.
00166                             // For example, 11:30 PM + 1 hour results in 00:30 AM.
00167         kTimezoneField,      // TIMEZONE field alignment.
00168         kYearWOYField,   // Corrected year for week representation
00169         kDOWLocalField, // localized day of week
00170 
00171         
00172         
00177         ERA_FIELD                     = kEraField,
00178         YEAR_FIELD                     = kYearField,
00179         MONTH_FIELD                 = kMonthField,
00180         DATE_FIELD                     = kDateField,
00181         HOUR_OF_DAY1_FIELD             = kHourOfDay1Field,
00182         HOUR_OF_DAY0_FIELD             = kHourOfDay0Field,
00183         MINUTE_FIELD                 = kMinuteField,
00184         SECOND_FIELD                 = kSecondField,
00185         MILLISECOND_FIELD             = kMillisecondField,
00186         DAY_OF_WEEK_FIELD             = kDayOfWeekField,
00187         DAY_OF_YEAR_FIELD             = kDayOfYearField,
00188         DAY_OF_WEEK_IN_MONTH_FIELD     = kDayOfWeekInMonthField,
00189         WEEK_OF_YEAR_FIELD             = kWeekOfYearField,
00190         WEEK_OF_MONTH_FIELD         = kWeekOfMonthField,
00191         AM_PM_FIELD                 = kAmPmField,
00192         HOUR1_FIELD                 = kHour1Field,
00193         HOUR0_FIELD                 = kHour0Field,
00194         TIMEZONE_FIELD                 = kTimezoneField
00195 
00196     };
00197 
00205     enum EStyle
00206     {
00207         kNone   = -1,
00208 
00209         kFull   = 0,
00210         kLong   = 1,
00211         kMedium = 2,
00212         kShort  = 3,
00213 
00214         kDateOffset   = kShort + 1,
00215      // kFull   + kDateOffset = 4
00216      // kLong   + kDateOffset = 5
00217      // kMedium + kDateOffset = 6
00218      // kShort  + kDateOffset = 7
00219 
00220         kDateTime             = 8,
00221 
00222         kDefault      = kMedium,
00223 
00224         
00225         
00230         FULL        = kFull,
00231         LONG        = kLong,
00232         MEDIUM        = kMedium,
00233         SHORT        = kShort,
00234         DEFAULT        = kDefault,
00235         DATE_OFFSET    = kDateOffset,
00236         NONE        = kNone,
00237         DATE_TIME    = kDateTime
00238     };
00239 
00244     virtual ~DateFormat();
00245 
00250     virtual UBool operator==(const Format&) const;
00251 
00266     virtual UnicodeString& format(const Formattable& obj,
00267                                   UnicodeString& appendTo,
00268                                   FieldPosition& pos,
00269                                   UErrorCode& status) const;
00270 
00300     virtual UnicodeString& format(  Calendar& cal,
00301                                     UnicodeString& appendTo,
00302                                     FieldPosition& fieldPosition) const = 0;
00303 
00331     UnicodeString& format(  UDate date,
00332                             UnicodeString& appendTo,
00333                             FieldPosition& fieldPosition) const;
00334 
00346     UnicodeString& format(UDate date, UnicodeString& appendTo) const;
00347 
00358     UnicodeString& format(const Formattable& obj,
00359                           UnicodeString& appendTo,
00360                           UErrorCode& status) const;
00361 
00372     virtual UDate parse( const UnicodeString& text,
00373                         UErrorCode& status) const;
00374 
00396     virtual void parse( const UnicodeString& text,
00397                         Calendar& cal,
00398                         ParsePosition& pos) const = 0;
00399 
00419     UDate parse( const UnicodeString& text,
00420                  ParsePosition& pos) const;
00421 
00448     virtual void parseObject(const UnicodeString& source,
00449                              Formattable& result,
00450                              ParsePosition& parse_pos) const;
00451 
00459     static DateFormat* createInstance(void);
00460 
00471     static DateFormat* createTimeInstance(EStyle style = kDefault,
00472                                           const Locale& aLocale = Locale::getDefault());
00473 
00484     static DateFormat* createDateInstance(EStyle style = kDefault,
00485                                           const Locale& aLocale = Locale::getDefault());
00486 
00499     static DateFormat* createDateTimeInstance(EStyle dateStyle = kDefault,
00500                                               EStyle timeStyle = kDefault,
00501                                               const Locale& aLocale = Locale::getDefault());
00502 
00510     static const Locale* getAvailableLocales(int32_t& count);
00511   
00516     virtual UBool isLenient(void) const;
00517 
00528     virtual void setLenient(UBool lenient);
00529     
00535     virtual const Calendar* getCalendar(void) const;
00536     
00546     virtual void adoptCalendar(Calendar* calendarToAdopt);
00547 
00555     virtual void setCalendar(const Calendar& newCalendar);
00556 
00557    
00564     virtual const NumberFormat* getNumberFormat(void) const;
00565     
00572     virtual void adoptNumberFormat(NumberFormat* formatToAdopt);
00573 
00579     virtual void setNumberFormat(const NumberFormat& newNumberFormat);
00580 
00586     virtual const TimeZone& getTimeZone(void) const;
00587     
00594     virtual void adoptTimeZone(TimeZone* zoneToAdopt);
00595 
00601     virtual void setTimeZone(const TimeZone& zone);
00602 
00603     
00604 protected:
00611     DateFormat();
00612 
00617     DateFormat(const DateFormat&);
00618 
00623     DateFormat& operator=(const DateFormat&);
00624 
00631     Calendar* fCalendar;
00632 
00639     NumberFormat* fNumberFormat;
00640 
00641 private:
00650     static DateFormat* create(EStyle timeStyle, EStyle dateStyle, const Locale&);
00651 };
00652 
00653 inline UnicodeString&
00654 DateFormat::format(const Formattable& obj,
00655                    UnicodeString& appendTo,
00656                    UErrorCode& status) const {
00657     return Format::format(obj, appendTo, status);
00658 }
00659 U_NAMESPACE_END
00660 
00661 #endif /* #if !UCONFIG_NO_FORMATTING */
00662 
00663 #endif // _DATEFMT
00664 //eof

Generated on Wed Sep 3 17:47:08 2003 for ICU 2.6 by doxygen 1.3.2