e87ccb6737ab4f799c8d80361a99404a6eaff1cd
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / functions / qfunctionargument_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 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_FunctionArgument_H
53 #define Patternist_FunctionArgument_H
54
55 #include <QList>
56 #include <QSharedData>
57
58 #include "qxmlname.h"
59 #include "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