blob: 3cf71c459092890d2fbbf569ccba32cbb0b44000 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $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_XsdNotation_H
#define Patternist_XsdNotation_H
#include <private/qanyuri_p.h>
#include <private/qderivedstring_p.h>
#include <private/qnamedschemacomponent_p.h>
#include <private/qxsdannotated_p.h>
#include <QtCore/QList>
QT_BEGIN_NAMESPACE
namespace QPatternist
{
/**
* @short Represents a XSD notation object, which should not
* be confused with the atomic type @c xs:NOTATION.
*
* This class represents the <em>notation</em> object of a XML schema as described
* <a href="http://www.w3.org/TR/xmlschema11-1/#cNotation_Declarations">here</a>.
*
* @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#XS-NotationDecl">XML Schema API reference</a>
* @ingroup Patternist_schema
* @author Tobias Koenig <tobias.koenig@nokia.com>
*/
class XsdNotation : public NamedSchemaComponent, public XsdAnnotated
{
public:
typedef QExplicitlySharedDataPointer<XsdNotation> Ptr;
typedef QList<XsdNotation::Ptr> List;
/**
* Sets the public @p identifier of the notation.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#nd-public_identifier">Public Identifier Definition</a>
*/
void setPublicId(const DerivedString<TypeToken>::Ptr &identifier);
/**
* Returns the public identifier of the notation.
*/
DerivedString<TypeToken>::Ptr publicId() const;
/**
* Sets the system @p identifier of the notation.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#nd-system_identifier">System Identifier Definition</a>
*/
void setSystemId(const AnyURI::Ptr &identifier);
/**
* Returns the system identifier of the notation.
*/
AnyURI::Ptr systemId() const;
private:
DerivedString<TypeToken>::Ptr m_publicId;
AnyURI::Ptr m_systemId;
};
}
QT_END_NAMESPACE
#endif