epoc32/include/tinternetdate.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// This file contains the class TInternetDate
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file tinternetdate.h
williamr@2
    20
 @publishedAll
williamr@2
    21
 @released
williamr@2
    22
*/
williamr@2
    23
  
williamr@2
    24
williamr@2
    25
#ifndef		__TINTERNETDATE_H__
williamr@2
    26
#define		__TINTERNETDATE_H__
williamr@2
    27
williamr@2
    28
#include <e32std.h>
williamr@2
    29
williamr@2
    30
/**
williamr@2
    31
Stores dates in universal time and provides parsing of internet style dates 
williamr@2
    32
into TDateTime and RFC 1123 (updates RFC 822) dates.
williamr@2
    33
williamr@2
    34
Supports parsing of the following date formats:
williamr@2
    35
Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
williamr@2
    36
Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
williamr@2
    37
Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
williamr@2
    38
williamr@2
    39
In case of Date Formats with offsets "Mon, 21 Jan 2002 23:00:00 +0210" , equivalent 
williamr@2
    40
time in UTC can be determined by substracting the offset from the local time (RFC 3339).
williamr@2
    41
williamr@2
    42
All dates are store relative to Universal Time and not local time. 
williamr@2
    43
williamr@2
    44
@publishedAll
williamr@2
    45
@released
williamr@2
    46
@since 7.0
williamr@2
    47
*/
williamr@2
    48
class TInternetDate
williamr@2
    49
	{
williamr@2
    50
public:	
williamr@2
    51
/** 
williamr@2
    52
	Enum defining internet date formats.
williamr@2
    53
	@publishedAll
williamr@2
    54
	@released
williamr@2
    55
	@since 9.1	
williamr@2
    56
 */
williamr@2
    57
	enum TInternetDateFormat
williamr@2
    58
		{
williamr@2
    59
		/** 
williamr@2
    60
			Rfc 1123 Compliant date format 
williamr@2
    61
		*/
williamr@2
    62
		ERfc1123Format
williamr@2
    63
		};
williamr@2
    64
williamr@2
    65
	inline TInternetDate();
williamr@2
    66
williamr@2
    67
williamr@2
    68
	inline TInternetDate(TDateTime aUniversalTime);
williamr@2
    69
williamr@2
    70
	IMPORT_C void SetDateL(const TDesC8& aDate);
williamr@2
    71
williamr@2
    72
	IMPORT_C const TDateTime& DateTime();
williamr@2
    73
williamr@2
    74
	IMPORT_C HBufC8* InternetDateTimeL(TInternetDateFormat aInternetDateFormat);
williamr@2
    75
williamr@2
    76
private:
williamr@2
    77
	/**
williamr@2
    78
	A date and time object
williamr@2
    79
	*/
williamr@2
    80
	TDateTime iDateTime;
williamr@2
    81
	};
williamr@2
    82
williamr@2
    83
williamr@2
    84
/**
williamr@2
    85
	Intended Usage:	Default Constructor. Used when setting dates that are in a text format using SetDateL
williamr@2
    86
	
williamr@2
    87
	@since			7.0	.	
williamr@2
    88
*/
williamr@2
    89
inline TInternetDate::TInternetDate()
williamr@2
    90
	{}
williamr@2
    91
williamr@2
    92
/**
williamr@2
    93
	Intended Usage:	Constructor. Used when setting a date that you later want parsed into an internet text format
williamr@2
    94
	
williamr@2
    95
	@since			7.0
williamr@2
    96
	@param			aUniversalTime	a time that should correspond to Universal Time.
williamr@2
    97
*/
williamr@2
    98
inline TInternetDate::TInternetDate(TDateTime aUniversalTime) :
williamr@2
    99
	iDateTime(aUniversalTime)
williamr@2
   100
	{}
williamr@2
   101
williamr@2
   102
williamr@2
   103
#endif	//	__TINTERNETDATE_H__