epoc32/include/mw/sendateutils.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
/*
williamr@2
     2
* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:        This utility class provides static methods for conversions
williamr@2
    15
*                between Symbian class types and XSD time-date type
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
williamr@2
    26
#ifndef SEN_DATE_UTILS_H
williamr@2
    27
#define SEN_DATE_UTILS_H
williamr@2
    28
williamr@2
    29
//  INCLUDES
williamr@2
    30
#include <e32base.h>
williamr@2
    31
williamr@2
    32
// CLASS DECLARATION
williamr@2
    33
williamr@2
    34
/**
williamr@2
    35
* This utility class provides static methods for conversions between Symbian 
williamr@2
    36
* class types and XSD time-date type.
williamr@2
    37
*  @lib SenUtils.lib
williamr@2
    38
*  @since Series60 3.0
williamr@2
    39
*/
williamr@2
    40
class SenDateUtils
williamr@2
    41
    {
williamr@2
    42
    public: 
williamr@2
    43
        enum { KXmlDateTimeMaxLength = 31 };
williamr@2
    44
williamr@2
    45
        // New functions
williamr@2
    46
        /**
williamr@2
    47
        * Convert dateTime (from XML schema) to Symbian TTime. 
williamr@2
    48
        * A panic will occur if an attempt is made to set an invalid 
williamr@2
    49
        * value for any of the fields. 
williamr@2
    50
        * Panics: User 3 if illegal date.
williamr@2
    51
        * Leave codes:  KErrUnderflow   Not enough data given or 
williamr@2
    52
        *                               negative values
williamr@2
    53
        *               KErrOverflow    Too big values for e.g. month
williamr@2
    54
        *               KErrGeneral     Invalid date structure
williamr@2
    55
        * No check is made upon the validity of the year.
williamr@2
    56
        * @since Series60 3.0
williamr@2
    57
        * @param aXmlDateTime   source datetime to convert from
williamr@2
    58
        * @return The returned time will be in UTC.
williamr@2
    59
        */
williamr@2
    60
        IMPORT_C static TTime FromXmlDateTimeL(const TDesC8& aXmlDateTime);
williamr@2
    61
williamr@2
    62
        /**
williamr@2
    63
        * Convert Symbian TTime to dateTime (from XML schema).
williamr@2
    64
        * Leave codes:  KErrOverflow    target descriptor is less than
williamr@2
    65
        *               KXmlDateTimeMaxLength (25 bytes)
williamr@2
    66
        * @since Series60 3.0
williamr@2
    67
        * @param aDest (UTF8) result will be written here. It must be at least
williamr@2
    68
        *                KXmlDateTimeMaxLength long.
williamr@2
    69
        * @param TTime in UTC.
williamr@2
    70
        */
williamr@2
    71
        IMPORT_C static void ToXmlDateTimeUtf8L(TDes8& aDest, 
williamr@2
    72
                                                const TTime& aSrc);
williamr@2
    73
williamr@2
    74
        /**
williamr@2
    75
        * Convert Symbian TTime to dateTime (from XML schema).
williamr@2
    76
        * Leave codes:  KErrOverflow    target descriptor is less than
williamr@2
    77
        *               KXmlDateTimeMaxLength (25 bytes)
williamr@2
    78
        * @since Series60 5.0
williamr@2
    79
        * @param aDest (UTF8) result will be written here. It must be at least
williamr@2
    80
        *                KXmlDateTimeMaxLength long.
williamr@2
    81
        * @param TTime in UTC.
williamr@2
    82
        */
williamr@2
    83
	IMPORT_C static void ToXmlDateTimeUtf82L(TDes8& aDest, const TTime& aSrc) ;
williamr@2
    84
williamr@2
    85
    private:
williamr@2
    86
        /**
williamr@2
    87
        * Hide default C++ constructor.
williamr@2
    88
        */
williamr@2
    89
        SenDateUtils() { }
williamr@2
    90
williamr@2
    91
        /**
williamr@2
    92
        * Prohibit copy constructor if not deriving from CBase.
williamr@2
    93
        */
williamr@2
    94
        SenDateUtils( const SenDateUtils& );
williamr@2
    95
williamr@2
    96
        /**
williamr@2
    97
        * Prohibit assignment operator if not deriving from CBase.
williamr@2
    98
        */
williamr@2
    99
        SenDateUtils& operator=( const SenDateUtils& );
williamr@2
   100
    };
williamr@2
   101
williamr@2
   102
#endif // SEN_DATE_UTILS_H
williamr@2
   103
// End of File