1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
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.
52 #ifndef Patternist_XsdReference_H
53 #define Patternist_XsdReference_H
55 #include <private/qxsdterm_p.h>
57 #include <QtXmlPatterns/QSourceLocation>
66 * @short A helper class for element and group reference resolving.
68 * For easy resolving of element and group references, we have this class
69 * that can be used as a place holder for the real element or group
70 * object it is referring to.
71 * So whenever the parser detects an element or group reference, it creates
72 * a XsdReference and returns it instead of the XsdElement or XsdModelGroup.
73 * During a later phase, the resolver will look for all XsdReferences
74 * in the schema and will replace them with their referring XsdElement or
75 * XsdModelGroup objects.
77 * @ingroup Patternist_schema
78 * @author Tobias Koenig <tobias.koenig@nokia.com>
80 class XsdReference : public XsdTerm
83 typedef QExplicitlySharedDataPointer<XsdReference> Ptr;
86 * Describes the type of the reference.
90 Element, ///< The reference points to an element.
91 ModelGroup ///< The reference points to a model group.
95 * Returns always @c true, used to avoid dynamic casts.
97 virtual bool isReference() const;
100 * Sets the @p type of the reference.
104 void setType(Type type);
107 * Returns the type of the reference.
112 * Sets the @p name of the referenced object.
114 * The name can either be a top-level element declaration
115 * or a top-level group declaration.
117 void setReferenceName(const QXmlName &ame);
120 * Returns the name of the referenced object.
122 QXmlName referenceName() const;
125 * Sets the source @p location where the reference is located.
127 void setSourceLocation(const QSourceLocation &location);
130 * Returns the source location where the reference is located.
132 QSourceLocation sourceLocation() const;
136 QXmlName m_referenceName;
137 QSourceLocation m_sourceLocation;