src/xmlpatterns/schema/qxsdattributegroup_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_XsdAttributeGroup_H
  53 #define Patternist_XsdAttributeGroup_H
  54
  55 #include <private/qxsdannotated_p.h>
  56 #include <private/qxsdattributeuse_p.h>
  57 #include <private/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