src/xmlpatterns/type/qlocalnametest_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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_LocalNameTest_H
  53 #define Patternist_LocalNameTest_H
  54
  55 #include <private/qabstractnodetest_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 template<typename Key, typename Value> class QHash;
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short A name test that is of the type <tt>*:local-name</tt>.
  67      *
  68      * @ingroup Patternist_types
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      */
  71     class LocalNameTest : public AbstractNodeTest
  72     {
  73     public:
  74         typedef QHash<QString, ItemType::Ptr> Hash;
  75
  76         static ItemType::Ptr create(const ItemType::Ptr &primaryType, const QXmlName::LocalNameCode localName);
  77
  78         /**
  79          * @note This function assumes that @p item is a QXmlNodeModelIndex.
  80          */
  81         virtual bool itemMatches(const Item &item) const;
  82
  83         virtual QString displayName(const NamePool::Ptr &np) const;
  84
  85         virtual bool operator==(const ItemType &other) const;
  86         virtual PatternPriority patternPriority() const;
  87
  88     protected:
  89         virtual InstanceOf instanceOf() const;
  90
  91     private:
  92         LocalNameTest(const ItemType::Ptr &primaryType, const QXmlName::LocalNameCode &ncName);
  93
  94         const QXmlName::LocalNameCode m_ncName;
  95     };
  96 }
  97
  98 QT_END_NAMESPACE
  99
 100 QT_END_HEADER
 101
 102 #endif