src/xmlpatterns/data/qyearmonthduration_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  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_YearMonthDuration_H
  53 #define Patternist_YearMonthDuration_H
  54
  55 #include <private/qabstractduration_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Implements the value instance of the @c xs:yearMonthDuration type.
  65      *
  66      * @author Frans Englich <frans.englich@nokia.com>
  67      * @ingroup Patternist_xdm
  68      */
  69     class YearMonthDuration : public AbstractDuration
  70     {
  71     public:
  72         typedef AtomicValue::Ptr Ptr;
  73
  74         /**
  75          * Creates an instance from the lexical representation @p string.
  76          */
  77         static YearMonthDuration::Ptr fromLexical(const QString &string);
  78
  79         static YearMonthDuration::Ptr fromComponents(const bool isPositive,
  80                                                      const YearProperty years,
  81                                                      const MonthProperty months);
  82
  83         virtual ItemType::Ptr type() const;
  84         virtual QString stringValue() const;
  85
  86         /**
  87          * @returns the value of this @c xs:yearMonthDuration in months.
  88          * @see <a href="http://www.w3.org/TR/xpath-functions/#dt-yearMonthDuration">XQuery 1.0
  89          * and XPath 2.0 Functions and Operators, 10.3.2.2 Calculating the value of a
  90          * xs:dayTimeDuration from the lexical representation</a>
  91          */
  92         virtual Value value() const;
  93
  94         /**
  95          * If @p val is zero, is CommonValues::YearMonthDurationZero returned.
  96          */
  97         virtual Item fromValue(const Value val) const;
  98
  99         /**
 100          * @returns the years component. Always positive.
 101          */
 102         virtual YearProperty years() const;
 103
 104         /**
 105          * @returns the months component. Always positive.
 106          */
 107         virtual MonthProperty months() const;
 108
 109         /**
 110          * @returns always 0.
 111          */
 112         virtual DayCountProperty days() const;
 113
 114         /**
 115          * @returns always 0.
 116          */
 117         virtual HourProperty hours() const;
 118
 119         /**
 120          * @returns always 0.
 121          */
 122         virtual MinuteProperty minutes() const;
 123
 124         /**
 125          * @returns always 0.
 126          */
 127         virtual SecondProperty seconds() const;
 128
 129         /**
 130          * @returns always 0.
 131          */
 132         virtual MSecondProperty mseconds() const;
 133
 134     protected:
 135         friend class CommonValues;
 136
 137         YearMonthDuration(const bool isPositive,
 138                           const YearProperty years,
 139                           const MonthProperty months);
 140
 141     private:
 142         const YearProperty  m_years;
 143         const MonthProperty m_months;
 144     };
 145 }
 146
 147 QT_END_NAMESPACE
 148
 149 QT_END_HEADER
 150
 151 #endif