fa09facf014ac857fc7028cfc4636d3e44e9817e
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / functions / qfunctionargument_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_FunctionArgument_H
53 #define Patternist_FunctionArgument_H
54
55 #include <QList>
56 #include <QSharedData>
57
58 #include <QXmlName>
59 #include <private/qsequencetype_p.h>
60
61 QT_BEGIN_HEADER
62
63 QT_BEGIN_NAMESPACE
64
65 namespace QPatternist
66 {
67     /**
68      * @short Carries meta data for a function argument as found in XPath's
69      * builtin functions and user declared functions in XQuery and XSL-T.
70      *
71      * @ingroup Patternist_functions
72      * @see VariableDeclaration
73      * @author Frans Englich <frans.englich@nokia.com>
74      */
75     class FunctionArgument : public QSharedData
76     {
77     public:
78         typedef QExplicitlySharedDataPointer<FunctionArgument> Ptr;
79         typedef QList<FunctionArgument::Ptr> List;
80
81         FunctionArgument(const QXmlName name,
82                          const SequenceType::Ptr &type);
83
84         QXmlName name() const;
85         SequenceType::Ptr type() const;
86
87     private:
88         Q_DISABLE_COPY(FunctionArgument)
89         const QXmlName m_name;
90         const SequenceType::Ptr m_type;
91     };
92 }
93
94 QT_END_NAMESPACE
95
96 QT_END_HEADER
97
98 #endif