115484185ab9c495383bec93386ecfdf46e34426
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / type / qqnametest_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_QNameTest_H
53 #define Patternist_QNameTest_H
54
55 #include <private/qabstractnodetest_p.h>
56
57 template<typename Key, typename Value> class QHash;
58
59 QT_BEGIN_HEADER
60
61 QT_BEGIN_NAMESPACE
62
63 namespace QPatternist
64 {
65     /**
66      * @short A name test that is of the type <tt>prefix:ncName</tt>.
67      *
68      * @ingroup Patternist_types
69      * @author Frans Englich <frans.englich@nokia.com>
70      */
71     class QNameTest : public AbstractNodeTest
72     {
73     public:
74         typedef QHash<QString, QNameTest::Ptr> Hash;
75
76         static ItemType::Ptr create(const ItemType::Ptr &primaryType, const QXmlName qName);
77
78         /**
79          * @note This function assumes that @p item is a QXmlNodeModelIndex.
80          */
81         virtual bool itemMatches(const Item &item) const;
82
83         virtual QString displayName(const NamePool::Ptr &np) const;
84
85         virtual bool operator==(const ItemType &other) const;
86
87         virtual PatternPriority patternPriority() const;
88
89     protected:
90         virtual InstanceOf instanceOf() const;
91
92     private:
93         QNameTest(const ItemType::Ptr &primaryType, const QXmlName qName);
94
95         const QXmlName m_qName;
96     };
97 }
98
99 QT_END_NAMESPACE
100
101 QT_END_HEADER
102
103 #endif