/**************************************************************************** | |
** | |
** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies). | |
** All rights reserved. | |
** Contact: Nokia Corporation (qt-info@nokia.com) | |
** | |
** This file is part of the QtXmlPatterns module of the Qt Toolkit. | |
** | |
** $QT_BEGIN_LICENSE:LGPL$ | |
** GNU Lesser General Public License Usage | |
** This file may be used under the terms of the GNU Lesser General Public | |
** License version 2.1 as published by the Free Software Foundation and | |
** appearing in the file LICENSE.LGPL included in the packaging of this | |
** file. Please review the following information to ensure the GNU Lesser | |
** General Public License version 2.1 requirements will be met: | |
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. | |
** | |
** In addition, as a special exception, Nokia gives you certain additional | |
** rights. These rights are described in the Nokia Qt LGPL Exception | |
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. | |
** | |
** GNU General Public License Usage | |
** Alternatively, this file may be used under the terms of the GNU General | |
** Public License version 3.0 as published by the Free Software Foundation | |
** and appearing in the file LICENSE.GPL included in the packaging of this | |
** file. Please review the following information to ensure the GNU General | |
** Public License version 3.0 requirements will be met: | |
** http://www.gnu.org/copyleft/gpl.html. | |
** | |
** Other Usage | |
** Alternatively, this file may be used in accordance with the terms and | |
** conditions contained in a signed written agreement between you and Nokia. | |
** | |
** | |
** | |
** | |
** | |
** $QT_END_LICENSE$ | |
** | |
****************************************************************************/ | |
// | |
// W A R N I N G | |
// ------------- | |
// | |
// This file is not part of the Qt API. It exists purely as an | |
// implementation detail. This header file may change from version to | |
// version without notice, or even be removed. | |
// | |
// We mean it. | |
#ifndef Patternist_XsdDocumentation_H | |
#define Patternist_XsdDocumentation_H | |
#include "qanytype_p.h" | |
#include "qanyuri_p.h" | |
#include "qderivedstring_p.h" | |
#include "qnamedschemacomponent_p.h" | |
QT_BEGIN_HEADER | |
QT_BEGIN_NAMESPACE | |
namespace QPatternist | |
{ | |
/** | |
* @short Represents a XSD documentation object. | |
* | |
* This class represents the <em>documentation</em> component of an <em>annotation</em> object | |
* of a XML schema as described <a href="http://www.w3.org/TR/xmlschema11-1/#cAnnotations">here</a>. | |
* | |
* @ingroup Patternist_schema | |
* @author Tobias Koenig <tobias.koenig@nokia.com> | |
*/ | |
class XsdDocumentation : public NamedSchemaComponent | |
{ | |
public: | |
typedef QExplicitlySharedDataPointer<XsdDocumentation> Ptr; | |
typedef QList<XsdDocumentation::Ptr> List; | |
/** | |
* Creates a new documentation object. | |
*/ | |
XsdDocumentation(); | |
/** | |
* Destroys the documentation object. | |
*/ | |
~XsdDocumentation(); | |
/** | |
* Sets the @p source of the documentation. | |
* | |
* The source points to an URL that contains more | |
* information. | |
*/ | |
void setSource(const AnyURI::Ptr &source); | |
/** | |
* Returns the source of the documentation. | |
*/ | |
AnyURI::Ptr source() const; | |
/** | |
* Sets the @p language of the documentation. | |
*/ | |
void setLanguage(const DerivedString<TypeLanguage>::Ptr &language); | |
/** | |
* Returns the language of the documentation. | |
*/ | |
DerivedString<TypeLanguage>::Ptr language() const; | |
/** | |
* Sets the @p content of the documentation. | |
* | |
* The content can be of abritrary type. | |
*/ | |
void setContent(const QString &content); | |
/** | |
* Returns the content of the documentation. | |
*/ | |
QString content() const; | |
private: | |
AnyURI::Ptr m_source; | |
DerivedString<TypeLanguage>::Ptr m_language; | |
QString m_content; | |
}; | |
} | |
QT_END_NAMESPACE | |
QT_END_HEADER | |
#endif |