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