src/xmlpatterns/schema/qxsdattributereference_p.h
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2008 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 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    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_XsdAttributeReference_H
       
    53 #define Patternist_XsdAttributeReference_H
       
    54 
       
    55 #include "qxsdattributeuse_p.h"
       
    56 
       
    57 #include <QtXmlPatterns/QSourceLocation>
       
    58 
       
    59 QT_BEGIN_HEADER
       
    60 
       
    61 QT_BEGIN_NAMESPACE
       
    62 
       
    63 namespace QPatternist
       
    64 {
       
    65     /**
       
    66      * @short A helper class for attribute reference resolving.
       
    67      *
       
    68      * For easy resolving of attribute references, we have this class
       
    69      * that can be used as a place holder for the real attribute use
       
    70      * object it is referring to.
       
    71      * So whenever the parser detects an attribute reference, it creates
       
    72      * a XsdAttributeReference and returns it instead of the XsdAttributeUse.
       
    73      * During a later phase, the resolver will look for all XsdAttributeReferences
       
    74      * in the schema and will replace them with their referring XsdAttributeUse
       
    75      * objects.
       
    76      *
       
    77      * @ingroup Patternist_schema
       
    78      * @author Tobias Koenig <tobias.koenig@nokia.com>
       
    79      */
       
    80     class XsdAttributeReference : public XsdAttributeUse
       
    81     {
       
    82         public:
       
    83             typedef QExplicitlySharedDataPointer<XsdAttributeReference> Ptr;
       
    84 
       
    85             /**
       
    86              * Describes the type of the attribute reference.
       
    87              */
       
    88             enum Type
       
    89             {
       
    90                 AttributeUse,   ///< The reference points to an attribute use.
       
    91                 AttributeGroup  ///< The reference points to an attribute group.
       
    92             };
       
    93 
       
    94             /**
       
    95              * Always returns false, used to avoid dynamic casts.
       
    96              */
       
    97             virtual bool isAttributeUse() const;
       
    98 
       
    99             /**
       
   100              * Always returns true, used to avoid dynamic casts.
       
   101              */
       
   102             virtual bool isReference() const;
       
   103 
       
   104             /**
       
   105              * Sets the @p type of the attribute reference.
       
   106              */
       
   107             void setType(Type type);
       
   108 
       
   109             /**
       
   110              * Returns the type of the attribute reference.
       
   111              */
       
   112             Type type() const;
       
   113 
       
   114             /**
       
   115              * Sets the @p name of the attribute or attribute group the
       
   116              * attribute reference refers to.
       
   117              */
       
   118             void setReferenceName(const QXmlName &name);
       
   119 
       
   120             /**
       
   121              * Returns the name of the attribute or attribute group the
       
   122              * attribute reference refers to.
       
   123              */
       
   124             QXmlName referenceName() const;
       
   125 
       
   126             /**
       
   127              * Sets the source @p location where the reference is located.
       
   128              */
       
   129             void setSourceLocation(const QSourceLocation &location);
       
   130 
       
   131             /**
       
   132              * Returns the source location where the reference is located.
       
   133              */
       
   134             QSourceLocation sourceLocation() const;
       
   135 
       
   136         private:
       
   137             Type            m_type;
       
   138             QXmlName        m_referenceName;
       
   139             QSourceLocation m_sourceLocation;
       
   140     };
       
   141 }
       
   142 
       
   143 QT_END_NAMESPACE
       
   144 
       
   145 QT_END_HEADER
       
   146 
       
   147 #endif