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_XsdDocumentation_H 53 #define Patternist_XsdDocumentation_H 54 55 #include "qanytype_p.h" 56 #include "qanyuri_p.h" 57 #include "qderivedstring_p.h" 58 #include "qnamedschemacomponent_p.h" 59 60 QT_BEGIN_HEADER 61 62 QT_BEGIN_NAMESPACE 63 64 namespace QPatternist 65 { 66 /** 67 * @short Represents a XSD documentation object. 68 * 69 * This class represents the <em>documentation</em> component of an <em>annotation</em> object 70 * of a XML schema as described <a href="http://www.w3.org/TR/xmlschema11-1/#cAnnotations">here</a>. 71 * 72 * @ingroup Patternist_schema 73 * @author Tobias Koenig <tobias.koenig@nokia.com> 74 */ 75 class XsdDocumentation : public NamedSchemaComponent 76 { 77 public: 78 typedef QExplicitlySharedDataPointer<XsdDocumentation> Ptr; 79 typedef QList<XsdDocumentation::Ptr> List; 80 81 /** 82 * Creates a new documentation object. 83 */ 84 XsdDocumentation(); 85 86 /** 87 * Destroys the documentation object. 88 */ 89 ~XsdDocumentation(); 90 91 /** 92 * Sets the @p source of the documentation. 93 * 94 * The source points to an URL that contains more 95 * information. 96 */ 97 void setSource(const AnyURI::Ptr &source); 98 99 /** 100 * Returns the source of the documentation. 101 */ 102 AnyURI::Ptr source() const; 103 104 /** 105 * Sets the @p language of the documentation. 106 */ 107 void setLanguage(const DerivedString<TypeLanguage>::Ptr &language); 108 109 /** 110 * Returns the language of the documentation. 111 */ 112 DerivedString<TypeLanguage>::Ptr language() const; 113 114 /** 115 * Sets the @p content of the documentation. 116 * 117 * The content can be of abritrary type. 118 */ 119 void setContent(const QString &content); 120 121 /** 122 * Returns the content of the documentation. 123 */ 124 QString content() const; 125 126 private: 127 AnyURI::Ptr m_source; 128 DerivedString<TypeLanguage>::Ptr m_language; 129 QString m_content; 130 }; 131 } 132 133 QT_END_NAMESPACE 134 135 QT_END_HEADER 136 137 #endif 138