src/xmlpatterns/schema/qxsdattributeuse_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_XsdAttributeUse_H
  53 #define Patternist_XsdAttributeUse_H
  54
  55 #include <private/qxsdattribute_p.h>
  56 #include <private/qxsdattributeterm_p.h>
  57
  58 #include <QtCore/QList>
  59
  60 QT_BEGIN_HEADER
  61
  62 QT_BEGIN_NAMESPACE
  63
  64 namespace QPatternist
  65 {
  66     /**
  67      * @short Represents a XSD attribute use object.
  68      *
  69      * This class represents the <em>attribute use</em> object of a XML schema as described
  70      * <a href="http://www.w3.org/TR/xmlschema11-1/#cAttributeUse">here</a>.
  71      *
  72      * It contains information from a local attribute declaration (as child of <em>complexType</em>
  73      * or <em>attributeGroup</em> object).
  74      *
  75      * All other occurrences of the <em>attribute</em> object are represented by the XsdAttribute class.
  76      *
  77      * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSAttributeUse">XML Schema API reference</a>
  78      * @ingroup Patternist_schema
  79      * @author Tobias Koenig <tobias.koenig@nokia.com>
  80      */
  81     class XsdAttributeUse : public XsdAttributeTerm
  82     {
  83         public:
  84             typedef QExplicitlySharedDataPointer<XsdAttributeUse> Ptr;
  85             typedef QList<XsdAttributeUse::Ptr> List;
  86
  87             /**
  88              * Describes the value constraint of an attribute use.
  89              *
  90              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#vc_au">Value Constraint Definition</a>
  91              */
  92             class ValueConstraint : public QSharedData
  93             {
  94                 public:
  95                     typedef QExplicitlySharedDataPointer<ValueConstraint> Ptr;
  96
  97                     /**
  98                      * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#au-value_constraint">value constraint</a> of an attribute use.
  99                      */
 100                     enum Variety
 101                     {
 102                         Default,  ///< The attribute use has a default value set.
 103                         Fixed     ///< The attribute use has a fixed value set.
 104                     };
 105
 106                     /**
 107                      * Sets the @p variety of the attribute use value constraint.
 108                      */
 109                     void setVariety(Variety variety);
 110
 111                     /**
 112                      * Returns the variety of the attribute use value constraint.
 113                      */
 114                     Variety variety() const;
 115
 116                     /**
 117                      * Sets the @p value of the constraint.
 118                      */
 119                     void setValue(const QString &value);
 120
 121                     /**
 122                      * Returns the value of the constraint.
 123                      */
 124                     QString value() const;
 125
 126                     /**
 127                      * Sets the lexical @p form of the constraint.
 128                      */
 129                     void setLexicalForm(const QString &form);
 130
 131                     /**
 132                      * Returns the lexical form of the constraint.
 133                      */
 134                     QString lexicalForm() const;
 135
 136                     /**
 137                      * Creates a new value constraint from a XsdAttribute::ValueConstraint.
 138                      */
 139                     static ValueConstraint::Ptr fromAttributeValueConstraint(const XsdAttribute::ValueConstraint::Ptr &constraint);
 140
 141                 private:
 142                     Variety m_variety;
 143                     QString m_value;
 144                     QString m_lexicalForm;
 145             };
 146
 147             /**
 148              * Describes the use type of the attribute use.
 149              */
 150             enum UseType
 151             {
 152                 OptionalUse,        ///< The attribute can be there but doesn't need to.
 153                 RequiredUse,        ///< The attribute must be there.
 154                 ProhibitedUse       ///< The attribute is not allowed to be there.
 155             };
 156
 157             /**
 158              * Creates a new attribute use object.
 159              */
 160             XsdAttributeUse();
 161
 162             /**
 163              * Always returns true, used to avoid dynamic casts.
 164              */
 165             virtual bool isAttributeUse() const;
 166
 167             /**
 168              * Sets the use @p type of the attribute use.
 169              *
 170              * @see UseType
 171              */
 172             void setUseType(UseType type);
 173
 174             /**
 175              * Returns the use type of the attribute use.
 176              */
 177             UseType useType() const;
 178
 179             /**
 180              * Returns whether the attribute use is required.
 181              *
 182              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#au-required">Required Definition</a>
 183              */
 184             bool isRequired() const;
 185
 186             /**
 187              * Sets the @p attribute the attribute use is referring to.
 188              * That is either a local definition as child of a complexType
 189              * or attributeGroup object, or a reference defined by the
 190              * 'ref' attribute.
 191              *
 192              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#au-attribute_declaration">Attribute Declaration</a>
 193              */
 194             void setAttribute(const XsdAttribute::Ptr &attribute);
 195
 196             /**
 197              * Returns the attribute the attribute use is referring to.
 198              */
 199             XsdAttribute::Ptr attribute() const;
 200
 201             /**
 202              * Sets the value @p constraint of the attribute use.
 203              *
 204              * @see http://www.w3.org/TR/xmlschema11-1/#vc_au
 205              */
 206             void setValueConstraint(const ValueConstraint::Ptr &constraint);
 207
 208             /**
 209              * Returns the value constraint of the attribute use.
 210              */
 211             ValueConstraint::Ptr valueConstraint() const;
 212
 213         private:
 214             UseType              m_useType;
 215             XsdAttribute::Ptr    m_attribute;
 216             ValueConstraint::Ptr m_valueConstraint;
 217     };
 218 }
 219
 220 QT_END_NAMESPACE
 221
 222 QT_END_HEADER
 223
 224 #endif