src/xmlpatterns/schema/qxsdannotated_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_XsdAnnotated_H
  53 #define Patternist_XsdAnnotated_H
  54
  55 #include <private/qxsdannotation_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Base class for all XSD components with annotation content.
  65      *
  66      * @ingroup Patternist_schema
  67      * @author Tobias Koenig <tobias.koenig@nokia.com>
  68      */
  69     class XsdAnnotated
  70     {
  71         public:
  72             /**
  73              * Adds a new @p annotation to the component.
  74              */
  75             void addAnnotation(const XsdAnnotation::Ptr &annotation);
  76
  77             /**
  78              * Adds a list of new @p annotations to the component.
  79              */
  80             void addAnnotations(const XsdAnnotation::List &annotations);
  81
  82             /**
  83              * Returns the list of all annotations of the component.
  84              */
  85             XsdAnnotation::List annotations() const;
  86
  87         private:
  88             XsdAnnotation::List m_annotations;
  89     };
  90 }
  91
  92 QT_END_NAMESPACE
  93
  94 QT_END_HEADER
  95
  96 #endif