src/xmlpatterns/data/qdaytimeduration_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 //
       
    43 //  W A R N I N G
       
    44 //  -------------
       
    45 //
       
    46 // This file is not part of the Qt API.  It exists purely as an
       
    47 // implementation detail.  This header file may change from version to
       
    48 // version without notice, or even be removed.
       
    49 //
       
    50 // We mean it.
       
    51 
       
    52 #ifndef Patternist_DayTimeDuration_H
       
    53 #define Patternist_DayTimeDuration_H
       
    54 
       
    55 #include "qabstractduration_p.h"
       
    56 #include "qitem_p.h"
       
    57 
       
    58 QT_BEGIN_HEADER
       
    59 
       
    60 QT_BEGIN_NAMESPACE
       
    61 
       
    62 namespace QPatternist
       
    63 {
       
    64     /**
       
    65      * @short Implements the value instance of the @c xs:dayTimeDuration type.
       
    66      *
       
    67      * @author Frans Englich <frans.englich@nokia.com>
       
    68      * @ingroup Patternist_xdm
       
    69      */
       
    70     class DayTimeDuration : public AbstractDuration
       
    71     {
       
    72     public:
       
    73 
       
    74         typedef QExplicitlySharedDataPointer<DayTimeDuration> Ptr;
       
    75 
       
    76         /**
       
    77          * Creates an instance from the lexical representation @p string.
       
    78          */
       
    79         static DayTimeDuration::Ptr fromLexical(const QString &string);
       
    80 
       
    81         static DayTimeDuration::Ptr fromComponents(const bool isPositive,
       
    82                                                    const DayCountProperty days,
       
    83                                                    const HourProperty hours,
       
    84                                                    const MinuteProperty minutes,
       
    85                                                    const SecondProperty seconds,
       
    86                                                    const MSecondProperty mseconds);
       
    87         /**
       
    88          * Creates a DayTimeDuration that has the value expressed in seconds @p secs
       
    89          * and milli seconds @p msecs. The signedness of @p secs communicates
       
    90          * whether this DayTimeDuration is positive or negative. @p msecs must always
       
    91          * be positive.
       
    92          */
       
    93         static DayTimeDuration::Ptr fromSeconds(const SecondCountProperty secs,
       
    94                                                 const MSecondProperty msecs = 0);
       
    95 
       
    96         virtual ItemType::Ptr type() const;
       
    97         virtual QString stringValue() const;
       
    98 
       
    99         /**
       
   100          * @returns always 0.
       
   101          */
       
   102         virtual YearProperty years() const;
       
   103 
       
   104         /**
       
   105          * @returns always 0.
       
   106          */
       
   107         virtual MonthProperty months() const;
       
   108         virtual DayCountProperty days() const;
       
   109         virtual HourProperty hours() const;
       
   110         virtual MinuteProperty minutes() const;
       
   111         virtual MSecondProperty mseconds() const;
       
   112         virtual SecondProperty seconds() const;
       
   113 
       
   114         /**
       
   115          * @returns the value of this xs:dayTimeDuration
       
   116          * in milli seconds.
       
   117          * @see <a href="http://www.w3.org/TR/xpath-functions/#dt-dayTimeDuration">XQuery 1.0
       
   118          * and XPath 2.0 Functions and Operators, 10.3.2.2 Calculating the value of a
       
   119          * xs:dayTimeDuration from the lexical representation</a>
       
   120          */
       
   121         virtual Value value() const;
       
   122 
       
   123         /**
       
   124          * Creates a DayTimeDuration containing the value @p val. @p val is
       
   125          * expressed in milli seconds.
       
   126          *
       
   127          * If @p val is zero, is CommonValues::DayTimeDurationZero returned.
       
   128          */
       
   129         virtual Item fromValue(const Value val) const;
       
   130 
       
   131     protected:
       
   132         friend class CommonValues;
       
   133 
       
   134         DayTimeDuration(const bool isPositive,
       
   135                         const DayCountProperty days,
       
   136                         const HourProperty hours,
       
   137                         const MinuteProperty minutes,
       
   138                         const SecondProperty seconds,
       
   139                         const MSecondProperty mseconds);
       
   140 
       
   141     private:
       
   142         const DayCountProperty  m_days;
       
   143         const HourProperty      m_hours;
       
   144         const MinuteProperty    m_minutes;
       
   145         const SecondProperty    m_seconds;
       
   146         const MSecondProperty   m_mseconds;
       
   147     };
       
   148 }
       
   149 
       
   150 QT_END_NAMESPACE
       
   151 
       
   152 QT_END_HEADER
       
   153 
       
   154 #endif