1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
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_XsdAttributeGroup_H
53 #define Patternist_XsdAttributeGroup_H
54 
55 #include "qxsdannotated_p.h"
56 #include "qxsdattributeuse_p.h"
57 #include "qxsdwildcard_p.h"
58 
59 #include <QtCore/QList>
60 
61 QT_BEGIN_HEADER
62 
63 QT_BEGIN_NAMESPACE
64 
65 namespace QPatternist
66 {
67     /**
68      * @short Represents the XSD attributeGroup object.
69      *
70      * This class represents the <em>attributeGroup</em> object of a XML schema as described
71      * <a href="http://www.w3.org/TR/xmlschema11-1/#cAttribute_Group_Definitions">here</a>.
72      *
73      * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSAttributeGroup">XML Schema API reference</a>
74      * @ingroup Patternist_schema
75      * @author Tobias Koenig <tobias.koenig@nokia.com>
76      */
77     class XsdAttributeGroup : public NamedSchemaComponent, public XsdAnnotated
78     {
79         public:
80             typedef QExplicitlySharedDataPointer<XsdAttributeGroup> Ptr;
81             typedef QList<XsdAttributeGroup::Ptr> List;
82 
83             /**
84              * Sets the list of attribute @p uses that are defined in the attribute group.
85              *
86              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#agd-attribute_uses">Attribute Uses</a>
87              */
88             void setAttributeUses(const XsdAttributeUse::List &uses);
89 
90             /**
91              * Adds a new attribute @p use to the attribute group.
92              */
93             void addAttributeUse(const XsdAttributeUse::Ptr &use);
94 
95             /**
96              * Returns the list of all attribute uses of the attribute group.
97              */
98             XsdAttributeUse::List attributeUses() const;
99 
100             /**
101              * Sets the attribute @p wildcard of the attribute group.
102              *
103              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#agd-attribute_wildcard">Attribute Wildcard</a>
104              */
105             void setWildcard(const XsdWildcard::Ptr &wildcard);
106 
107             /**
108              * Returns the attribute wildcard of the attribute group.
109              */
110             XsdWildcard::Ptr wildcard() const;
111 
112         private:
113             XsdAttributeUse::List m_attributeUses;
114             XsdWildcard::Ptr      m_wildcard;
115     };
116 }
117 
118 QT_END_NAMESPACE
119 
120 QT_END_HEADER
121 
122 #endif
123