src/xmlpatterns/schema/qxsdnotation_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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_XsdNotation_H
  53 #define Patternist_XsdNotation_H
  54
  55 #include <private/qanyuri_p.h>
  56 #include <private/qderivedstring_p.h>
  57 #include <private/qnamedschemacomponent_p.h>
  58 #include <private/qxsdannotated_p.h>
  59
  60 #include <QtCore/QList>
  61
  62 QT_BEGIN_HEADER
  63
  64 QT_BEGIN_NAMESPACE
  65
  66 namespace QPatternist
  67 {
  68     /**
  69      * @short Represents a XSD notation object, which should not
  70      * be confused with the atomic type @c xs:NOTATION.
  71      *
  72      * This class represents the <em>notation</em> object of a XML schema as described
  73      * <a href="http://www.w3.org/TR/xmlschema11-1/#cNotation_Declarations">here</a>.
  74      *
  75      * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#XS-NotationDecl">XML Schema API reference</a>
  76      * @ingroup Patternist_schema
  77      * @author Tobias Koenig <tobias.koenig@nokia.com>
  78      */
  79     class XsdNotation : public NamedSchemaComponent, public XsdAnnotated
  80     {
  81         public:
  82             typedef QExplicitlySharedDataPointer<XsdNotation> Ptr;
  83             typedef QList<XsdNotation::Ptr> List;
  84
  85             /**
  86              * Sets the public @p identifier of the notation.
  87              *
  88              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nd-public_identifier">Public Identifier Definition</a>
  89              */
  90             void setPublicId(const DerivedString<TypeToken>::Ptr &identifier);
  91
  92             /**
  93              * Returns the public identifier of the notation.
  94              */
  95             DerivedString<TypeToken>::Ptr publicId() const;
  96
  97             /**
  98              * Sets the system @p identifier of the notation.
  99              *
 100              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nd-system_identifier">System Identifier Definition</a>
 101              */
 102             void setSystemId(const AnyURI::Ptr &identifier);
 103
 104             /**
 105              * Returns the system identifier of the notation.
 106              */
 107             AnyURI::Ptr systemId() const;
 108
 109         private:
 110             DerivedString<TypeToken>::Ptr m_publicId;
 111             AnyURI::Ptr m_systemId;
 112     };
 113 }
 114
 115 QT_END_NAMESPACE
 116
 117 QT_END_HEADER
 118
 119 #endif