epoc32/include/xml/dom/xmlengprocessinginstruction.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/xmlengprocessinginstruction.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 /*
     2 * Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies). 
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * 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
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:       Processing instruction node functions
    15 *
    16 */
    17 
    18 
    19 
    20 
    21 
    22 
    23 
    24 #ifndef XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED
    25 #define XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED
    26 
    27 #include "xmlengnode.h"
    28 
    29 
    30 
    31 /**
    32  * Instance of TXmlEngProcessingInstruction class represents an XML processing 
    33  * instruction in the DOM tree.
    34  * 
    35  * @lib XmlEngineDOM.lib
    36  * @since S60 v3.1
    37  */
    38 class TXmlEngProcessingInstruction : public TXmlEngNode
    39 {
    40   public:
    41     /**
    42      * Default constructor
    43      *
    44      * @since S60 v3.1
    45      */
    46 	inline TXmlEngProcessingInstruction();
    47     
    48     /**
    49      * Get target of processing instruction.
    50      *
    51      * @since S60 v3.1
    52      * @return "Target" part of a processing instruction
    53      *
    54      * @code
    55      *    <?target data?>
    56      * @endcode
    57      * @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
    58      */
    59     IMPORT_C TPtrC8 Target() const;
    60 
    61     /**
    62      * Get data of processing instruction.
    63      *
    64      * @since S60 v3.1
    65      * @return "Data" part of a processing instruction
    66      *
    67      * @code
    68      *    <?target data?>
    69      * @endcode
    70      * @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
    71      */
    72     IMPORT_C TPtrC8 Data() const;
    73 
    74     /**
    75      * Sets data part of processing instruction
    76      *
    77      * @since S60 v3.1
    78      * @param aData New data part of processing instruction
    79      * @note PI contents should not contain "?>" sequence
    80      */
    81     IMPORT_C void SetDataL(const TDesC8& aData);
    82 
    83 protected:
    84     /**
    85      * Constructor
    86      *
    87      * @since S60 v3.1
    88      * @param aInternal processing instruction pointer
    89      */
    90 	inline TXmlEngProcessingInstruction(void* aInternal);
    91 };
    92 
    93 
    94 
    95 #include "xmlengprocessinginstruction.inl"
    96 #endif /* XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED */