epoc32/include/xml/dom/xmlengcharacterdata.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
// All text nodes 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 XMLENGCHARACTERDATA_H
williamr@4
    25
#define XMLENGCHARACTERDATA_H
williamr@4
    26
williamr@4
    27
#include <xml/dom/xmlengnode.h>
williamr@4
    28
williamr@4
    29
/**
williamr@4
    30
This class represents XML text nodes in the DOM tree.  Inherited classes
williamr@4
    31
further specialize (e.g. TXmlEngTextNode, TXmlEngComment).
williamr@4
    32
williamr@4
    33
The CharacterData Interface is described by the DOM Spec here:
williamr@4
    34
http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-FF21A306
williamr@2
    35
*/
williamr@2
    36
class TXmlEngCharacterData : public TXmlEngNode
williamr@2
    37
{
williamr@2
    38
public:
williamr@2
    39
williamr@4
    40
    /** Get contents of the node.
williamr@4
    41
    @return The content of the node
williamr@4
    42
    */
williamr@2
    43
    IMPORT_C TPtrC8 Contents() const;
williamr@2
    44
    
williamr@2
    45
    /**
williamr@4
    46
    Sets contents of the node.
williamr@4
    47
williamr@4
    48
    The input is taken as non-escaped: for example, 
williamr@4
    49
    aNewContents = "123 > 34 && P" will be serialized as "123 &gt; 34 &amp;&amp; P"
williamr@4
    50
    
williamr@4
    51
    @param aNewContents  The actual value to store
williamr@4
    52
	@leave - One of the system-wide error codes
williamr@4
    53
    */
williamr@2
    54
    IMPORT_C void SetContentsL(const TDesC8& aNewContents);
williamr@2
    55
williamr@4
    56
    /** Append to the contents of the node
williamr@4
    57
    @param aString Content to be appended
williamr@4
    58
	@leave KXmlEngErrNullNode Node is NULL
williamr@4
    59
	@leave - One of the system-wide error codes
williamr@4
    60
    */
williamr@2
    61
    IMPORT_C void AppendContentsL(const TDesC8& aString);
williamr@2
    62
williamr@4
    63
    /** Get length of the content.
williamr@4
    64
    @return Number of characters in the contents
williamr@4
    65
    */
williamr@2
    66
    IMPORT_C TUint Length() const;
williamr@2
    67
williamr@2
    68
protected:
williamr@4
    69
    /** Default constructor */
williamr@4
    70
	inline TXmlEngCharacterData(); 
williamr@2
    71
williamr@2
    72
    /**
williamr@4
    73
    Constructor
williamr@4
    74
    @param aInternal node pointer
williamr@4
    75
    */
williamr@2
    76
	inline TXmlEngCharacterData(void* aInternal);
williamr@2
    77
};
williamr@2
    78
williamr@2
    79
williamr@4
    80
#include <xml/dom/xmlengcharacterdata.inl>
williamr@2
    81
williamr@4
    82
#endif /* XMLENGCHARACTERDATA_H */
williamr@2
    83