3bc81fc787f8f103455cbe25a08758efad9c3028
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / schema / qxsdattributeterm_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2008 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 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 **
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 **
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
29 **
30 ** Other Usage
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
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_XsdAttributeTerm_H
53 #define Patternist_XsdAttributeTerm_H
54
55 #include <private/qnamedschemacomponent_p.h>
56 #include <private/qxsdannotated_p.h>
57
58 QT_BEGIN_HEADER
59
60 QT_BEGIN_NAMESPACE
61
62 namespace QPatternist
63 {
64     /**
65      * @short A base class for all attribute types.
66      *
67      * For easy resolving of attribute references, we use this as
68      * common base class for XsdAttribute and XsdAttributeReference.
69      *
70      * @ingroup Patternist_schema
71      * @author Tobias Koenig <tobias.koenig@nokia.com>
72      */
73     class XsdAttributeTerm : public NamedSchemaComponent, public XsdAnnotated
74     {
75         public:
76             typedef QExplicitlySharedDataPointer<XsdAttributeTerm> Ptr;
77
78             /**
79              * Returns @c true if the term is an attribute use, @c false otherwise.
80              */
81             virtual bool isAttributeUse() const;
82
83             /**
84              * Returns @c true if the term is an attribute use reference, @c false otherwise.
85              *
86              * @note The reference term is only used internally as helper during type resolving.
87              */
88             virtual bool isReference() const;
89     };
90 }
91
92 QT_END_NAMESPACE
93
94 QT_END_HEADER
95
96 #endif