epoc32/include/xml/dom/xmlengprocessinginstruction.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // Processing instruction node functions
    15 //
    16 
    17 
    18 
    19 /**
    20  @file
    21  @publishedAll
    22  @released
    23 */
    24 #ifndef XMLENGPROCESSINGINSTRUCTION_H
    25 #define XMLENGPROCESSINGINSTRUCTION_H
    26 
    27 #include <xml/dom/xmlengnode.h>
    28 
    29 
    30 
    31 /**
    32 This class represents an XML processing instruction in the DOM tree.  This class
    33 is usually instantiated through RXmlEngDocument::CreateProcessingInstruction().
    34 */
    35 class TXmlEngProcessingInstruction : public TXmlEngNode
    36 {
    37   public:
    38     /** Default constructor */
    39 	inline TXmlEngProcessingInstruction();
    40     
    41     /**
    42 	Gets a reference to the the target part of the processing instruction.
    43 
    44     @code
    45         <?target data?>
    46     @endcode
    47 
    48     @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
    49     @return A reference to the target part
    50     */
    51     IMPORT_C TPtrC8 Target() const;
    52 
    53     /**
    54     Gets a reference to the data part of the processing instruction.
    55 
    56     @code
    57         <?target data?>
    58     @endcode
    59 
    60     @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
    61     @return A reference to the data part
    62     */
    63     IMPORT_C TPtrC8 Data() const;
    64 
    65     /**
    66 	Copies the parameter and sets the data part of the processing instruction.
    67 	Note: The processing instruction contents should not contain the "?>"
    68 	sequence
    69     @param aData The data part to set
    70 	@leave - One of the system-wide error codes
    71     */
    72     IMPORT_C void SetDataL(const TDesC8& aData);
    73 
    74 protected:
    75     /**
    76     Constructor
    77     @param aInternal Processing instruction pointer
    78     */
    79 	inline TXmlEngProcessingInstruction(void* aInternal);
    80 };
    81 
    82 
    83 #include <xml/dom/xmlengprocessinginstruction.inl>
    84 #endif /* XMLENGPROCESSINGINSTRUCTION_H */
    85