epoc32/include/xmlengprocessinginstruction.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
     1.1 --- a/epoc32/include/xmlengprocessinginstruction.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/xmlengprocessinginstruction.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,96 @@
     1.4 -xmlengprocessinginstruction.h
     1.5 +/*
     1.6 +* Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies). 
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:       Processing instruction node functions
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +
    1.25 +
    1.26 +
    1.27 +
    1.28 +#ifndef XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED
    1.29 +#define XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED
    1.30 +
    1.31 +#include "xmlengnode.h"
    1.32 +
    1.33 +
    1.34 +
    1.35 +/**
    1.36 + * Instance of TXmlEngProcessingInstruction class represents an XML processing 
    1.37 + * instruction in the DOM tree.
    1.38 + * 
    1.39 + * @lib XmlEngineDOM.lib
    1.40 + * @since S60 v3.1
    1.41 + */
    1.42 +class TXmlEngProcessingInstruction : public TXmlEngNode
    1.43 +{
    1.44 +  public:
    1.45 +    /**
    1.46 +     * Default constructor
    1.47 +     *
    1.48 +     * @since S60 v3.1
    1.49 +     */
    1.50 +	inline TXmlEngProcessingInstruction();
    1.51 +    
    1.52 +    /**
    1.53 +     * Get target of processing instruction.
    1.54 +     *
    1.55 +     * @since S60 v3.1
    1.56 +     * @return "Target" part of a processing instruction
    1.57 +     *
    1.58 +     * @code
    1.59 +     *    <?target data?>
    1.60 +     * @endcode
    1.61 +     * @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
    1.62 +     */
    1.63 +    IMPORT_C TPtrC8 Target() const;
    1.64 +
    1.65 +    /**
    1.66 +     * Get data of processing instruction.
    1.67 +     *
    1.68 +     * @since S60 v3.1
    1.69 +     * @return "Data" part of a processing instruction
    1.70 +     *
    1.71 +     * @code
    1.72 +     *    <?target data?>
    1.73 +     * @endcode
    1.74 +     * @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
    1.75 +     */
    1.76 +    IMPORT_C TPtrC8 Data() const;
    1.77 +
    1.78 +    /**
    1.79 +     * Sets data part of processing instruction
    1.80 +     *
    1.81 +     * @since S60 v3.1
    1.82 +     * @param aData New data part of processing instruction
    1.83 +     * @note PI contents should not contain "?>" sequence
    1.84 +     */
    1.85 +    IMPORT_C void SetDataL(const TDesC8& aData);
    1.86 +
    1.87 +protected:
    1.88 +    /**
    1.89 +     * Constructor
    1.90 +     *
    1.91 +     * @since S60 v3.1
    1.92 +     * @param aInternal processing instruction pointer
    1.93 +     */
    1.94 +	inline TXmlEngProcessingInstruction(void* aInternal);
    1.95 +};
    1.96 +
    1.97 +
    1.98 +
    1.99 +#include "xmlengprocessinginstruction.inl"
   1.100 +#endif /* XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED */