/****************************************************************************
**
** 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$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $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 documentation component of an annotation object
* of a XML schema as described here.
*
* @ingroup Patternist_schema
* @author Tobias Koenig
*/
class XsdDocumentation : public NamedSchemaComponent
{
public:
typedef QExplicitlySharedDataPointer Ptr;
typedef QList 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::Ptr &language);
/**
* Returns the language of the documentation.
*/
DerivedString::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::Ptr m_language;
QString m_content;
};
}
QT_END_NAMESPACE
QT_END_HEADER
#endif