test: epoc32/include/xml/dom/xmlengtext.h@e1b950c65cb4

     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:       Text node functions

    15 *

    16 */

    24 #ifndef XMLENGINE_TEXT_H_INCLUDED

    25 #define XMLENGINE_TEXT_H_INCLUDED

    27 #include "xmlengcharacterdata.h"

    31 /**

    32  * The TXmlEngTextNode interface inherits from TXmlEngCharacterData and represents the textual content

    33  * (termed "character data" in XML) of an Element or TXmlEngAttr.

    34  *

    35  * If there is no markup inside an element's content, the text is contained in a single object

    36  * of the TXmlEngTextNode interface that is the only child of the element. If there is markup,

    37  * it is parsed into the information items (elements, comments, etc.) and TXmlEngTextNode nodes that

    38  * form the list of children of the element.

    39  *

    40  * When a document is first made available via the DOM, there is only one TXmlEngTextNode node for each

    41  * block of text. Users may create adjacent TXmlEngTextNode nodes that represent the contents of a given

    42  * element without any intervening markup, but should be aware that there is no way to

    43  * represent the separations between these nodes in XML or HTML, so they will not (in general)

    44  * persist between DOM editing sessions.

    45  *

    46  * No lexical check is done on the content of a TXmlEngTextNode node and, depending on its position in

    47  * the document, some characters must be escaped during serialization using character references;

    48  * e.g. the characters "<&" if the textual content is part of an element or of an attribute,

    49  * the character sequence "]]>" when part of an element, the quotation mark character " or

    50  * the apostrophe character ' when part of an attribute.

    51  *

    52  * <b>DOM Level 3 spec:</b>

    53  * <p>http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-1312295772

    54  *

    55  * @lib XmlEngineDOM.lib

    56  * @since S60 v3.1

    57  */

    58 class TXmlEngTextNode : public TXmlEngCharacterData

    59 {

    60 public:

    61     /**

    62      * Default constructor

    63      *

    64      * @since S60 v3.1

    65      */

    66 	inline TXmlEngTextNode();

    68     /**

    69      * Check if element content is whitespace.

    70      *

    71      * @since S60 v3.1

    72      * @return TRUE if is only whitespace

    73      */

    74     IMPORT_C TBool IsElementContentWhitespace() const;

    76 protected:

    77     /**

    78      * Constructor

    79      *

    80      * @since S60 v3.1

    81      * @param aInternal Text node pointer

    82      */

    83     inline TXmlEngTextNode(void* aInternal);

    84 };

    88 #include "xmlengtext.inl"

    90 #endif /* XMLENGINE_TEXT_H_INCLUDED */

author	William Roberts <williamr@symbian.org>
	Wed, 31 Mar 2010 12:27:01 +0100
branch	Symbian2
changeset 3	e1b950c65cb4
parent 2	epoc32/include/xmlengtext.h@2fe1408b6811
child 4	837f303aceeb
permissions	-rw-r--r--