src/xmlpatterns/schema/qxsdannotation_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_XsdAnnotation_H
  53 #define Patternist_XsdAnnotation_H
  54
  55 #include <private/qderivedstring_p.h>
  56 #include <private/qxsdapplicationinformation_p.h>
  57 #include <private/qxsddocumentation_p.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short Represents a XSD annotation object.
  67      *
  68      * This class represents the <em>annotation</em> object of a XML schema as described
  69      * <a href="http://www.w3.org/TR/xmlschema11-1/#cAnnotations">here</a>.
  70      *
  71      * @ingroup Patternist_schema
  72      * @author Tobias Koenig <tobias.koenig@nokia.com>
  73      */
  74     class XsdAnnotation : public NamedSchemaComponent
  75     {
  76         public:
  77             typedef QExplicitlySharedDataPointer<XsdAnnotation> Ptr;
  78             typedef QList<XsdAnnotation::Ptr> List;
  79
  80             /**
  81              * Sets the @p id of the annotation.
  82              */
  83             void setId(const DerivedString<TypeID>::Ptr &id);
  84
  85             /**
  86              * Returns the @p id of the annotation.
  87              */
  88             DerivedString<TypeID>::Ptr id() const;
  89
  90             /**
  91              * Adds an application @p information to the annotation.
  92              *
  93              * The application information is meant to be interpreted by
  94              * a software system, e.g. other parts of the XML processor pipeline.
  95              */
  96             void addApplicationInformation(const XsdApplicationInformation::Ptr &information);
  97
  98             /**
  99              * Returns the list of all application information of the annotation.
 100              */
 101             XsdApplicationInformation::List applicationInformation() const;
 102
 103             /**
 104              * Adds a @p documentation to the annotation.
 105              *
 106              * The documentation is meant to be read by human being, e.g. additional
 107              * constraints or information about schema components.
 108              */
 109             void addDocumentation(const XsdDocumentation::Ptr &documentation);
 110
 111             /**
 112              * Returns the list of all documentations of the annotation.
 113              */
 114             XsdDocumentation::List documentation() const;
 115
 116         private:
 117             DerivedString<TypeID>::Ptr      m_id;
 118             XsdApplicationInformation::List m_applicationInformation;
 119             XsdDocumentation::List          m_documentations;
 120     };
 121 }
 122
 123 QT_END_NAMESPACE
 124
 125 QT_END_HEADER
 126
 127 #endif