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