1.1 --- a/epoc32/include/xml/dom/xmlengtext.h Wed Mar 31 12:27:01 2010 +0100
1.2 +++ b/epoc32/include/xml/dom/xmlengtext.h Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -1,90 +1,80 @@
1.4 -/*
1.5 -* Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies).
1.6 -* All rights reserved.
1.7 -* This component and the accompanying materials are made available
1.8 -* 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
1.9 -* which accompanies this distribution, and is available
1.10 -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 -*
1.12 -* Initial Contributors:
1.13 -* Nokia Corporation - initial contribution.
1.14 -*
1.15 -* Contributors:
1.16 -*
1.17 -* Description: Text node functions
1.18 -*
1.19 -*/
1.20 -
1.21 -
1.22 -
1.23 -
1.24 -
1.25 -
1.26 -
1.27 -#ifndef XMLENGINE_TEXT_H_INCLUDED
1.28 -#define XMLENGINE_TEXT_H_INCLUDED
1.29 -
1.30 -#include "xmlengcharacterdata.h"
1.31 +// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
1.32 +// All rights reserved.
1.33 +// This component and the accompanying materials are made available
1.34 +// under the terms of "Eclipse Public License v1.0"
1.35 +// which accompanies this distribution, and is available
1.36 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.37 +//
1.38 +// Initial Contributors:
1.39 +// Nokia Corporation - initial contribution.
1.40 +//
1.41 +// Contributors:
1.42 +//
1.43 +// Description:
1.44 +// Text node functions
1.45 +//
1.46
1.47
1.48
1.49 /**
1.50 - * The TXmlEngTextNode interface inherits from TXmlEngCharacterData and represents the textual content
1.51 - * (termed "character data" in XML) of an Element or TXmlEngAttr.
1.52 - *
1.53 - * If there is no markup inside an element's content, the text is contained in a single object
1.54 - * of the TXmlEngTextNode interface that is the only child of the element. If there is markup,
1.55 - * it is parsed into the information items (elements, comments, etc.) and TXmlEngTextNode nodes that
1.56 - * form the list of children of the element.
1.57 - *
1.58 - * When a document is first made available via the DOM, there is only one TXmlEngTextNode node for each
1.59 - * block of text. Users may create adjacent TXmlEngTextNode nodes that represent the contents of a given
1.60 - * element without any intervening markup, but should be aware that there is no way to
1.61 - * represent the separations between these nodes in XML or HTML, so they will not (in general)
1.62 - * persist between DOM editing sessions.
1.63 - *
1.64 - * No lexical check is done on the content of a TXmlEngTextNode node and, depending on its position in
1.65 - * the document, some characters must be escaped during serialization using character references;
1.66 - * e.g. the characters "<&" if the textual content is part of an element or of an attribute,
1.67 - * the character sequence "]]>" when part of an element, the quotation mark character " or
1.68 - * the apostrophe character ' when part of an attribute.
1.69 - *
1.70 - * <b>DOM Level 3 spec:</b>
1.71 - * <p>http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-1312295772
1.72 - *
1.73 - * @lib XmlEngineDOM.lib
1.74 - * @since S60 v3.1
1.75 - */
1.76 + @file
1.77 + @publishedAll
1.78 + @released
1.79 +*/
1.80 +#ifndef XMLENGTEXT_H
1.81 +#define XMLENGTEXT_H
1.82 +
1.83 +#include <xml/dom/xmlengcharacterdata.h>
1.84 +
1.85 +
1.86 +/**
1.87 +The TXmlEngTextNode class inherits from TXmlEngCharacterData and represents the
1.88 +textual content (termed "character data" in XML) of an Element or TXmlEngAttr.
1.89 +
1.90 +If there is no markup inside an element's content, the text is contained in a
1.91 +single TXmlEngTextNode that is the only child of the element. If there is
1.92 +markup, it is parsed into the information items (elements, comments, etc.) and
1.93 +the TXmlEngTextNode nodes that form the list of children of the element.
1.94 +
1.95 +When a document is first made available via the DOM, there is only one
1.96 +TXmlEngTextNode node for each block of text. Users may create adjacent
1.97 +TXmlEngTextNode nodes that represent the contents of a given element without
1.98 +any intervening markup, but should be aware that there is no way to represent
1.99 +the separations between these nodes in XML or HTML, so they will not (in
1.100 +general) persist between DOM editing sessions.
1.101 +
1.102 +No lexical check is done on the content of a TXmlEngTextNode node and depending
1.103 +on its position in the document, some characters must be escaped during
1.104 +serialization using character references. For example, the characters "<&" if
1.105 +the textual content is part of an element or an attribute, the character
1.106 +sequence "]]>" when part of an element, the quotation mark character " or the
1.107 +apostrophe character ' when part of an attribute.
1.108 +
1.109 +@see http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-1312295772
1.110 +*/
1.111 class TXmlEngTextNode : public TXmlEngCharacterData
1.112 {
1.113 public:
1.114 - /**
1.115 - * Default constructor
1.116 - *
1.117 - * @since S60 v3.1
1.118 - */
1.119 + /** Default constructor */
1.120 inline TXmlEngTextNode();
1.121
1.122 /**
1.123 - * Check if element content is whitespace.
1.124 - *
1.125 - * @since S60 v3.1
1.126 - * @return TRUE if is only whitespace
1.127 - */
1.128 + Check if the element content is whitespace. Whitespace may be an empty element,
1.129 + or the characters space, tab, LF, or CR.
1.130 + @return ETrue if the element content only contains whitespace, EFalse otherwise
1.131 + */
1.132 IMPORT_C TBool IsElementContentWhitespace() const;
1.133
1.134 protected:
1.135 /**
1.136 - * Constructor
1.137 - *
1.138 - * @since S60 v3.1
1.139 - * @param aInternal Text node pointer
1.140 - */
1.141 + Constructor
1.142 + @param aInternal Text node pointer
1.143 + */
1.144 inline TXmlEngTextNode(void* aInternal);
1.145 };
1.146
1.147
1.148 +#include <xml/dom/xmlengtext.inl>
1.149
1.150 -#include "xmlengtext.inl"
1.151 +#endif /* XMLENGTEXT_H */
1.152
1.153 -#endif /* XMLENGINE_TEXT_H_INCLUDED */