diff -r e1b950c65cb4 -r 837f303aceeb epoc32/include/xml/dom/xmlengcharacterdata.h --- a/epoc32/include/xml/dom/xmlengcharacterdata.h Wed Mar 31 12:27:01 2010 +0100 +++ b/epoc32/include/xml/dom/xmlengcharacterdata.h Wed Mar 31 12:33:34 2010 +0100 @@ -1,105 +1,83 @@ -/* -* Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies). -* All rights reserved. -* This component and the accompanying materials are made available -* 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 -* which accompanies this distribution, and is available -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". -* -* Initial Contributors: -* Nokia Corporation - initial contribution. -* -* Contributors: -* -* Description: All text nodes functions -* -*/ +// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). +// All rights reserved. +// This component and the accompanying materials are made available +// under the terms of "Eclipse Public License v1.0" +// which accompanies this distribution, and is available +// at the URL "http://www.eclipse.org/legal/epl-v10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +// All text nodes functions +// - - - +/** + @file + @publishedAll + @released +*/ +#ifndef XMLENGCHARACTERDATA_H +#define XMLENGCHARACTERDATA_H -#ifndef XMLENGINE_CHARACTERDATA_H_INCLUDED -#define XMLENGINE_CHARACTERDATA_H_INCLUDED - -#include "xmlengnode.h" +#include /** -* Instance of TXmlEngCharacterData class represents all kinds of XML text nodes -* (i.e. text node, comment node) in the DOM tree. -* -* Describe DOM action for nodes that contains text data. -* DOM spec: -* http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-FF21A306 -* -* @lib XmlEngineDOM.lib -* @since S60 v3.1 +This class represents XML text nodes in the DOM tree. Inherited classes +further specialize (e.g. TXmlEngTextNode, TXmlEngComment). + +The CharacterData Interface is described by the DOM Spec here: +http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-FF21A306 */ class TXmlEngCharacterData : public TXmlEngNode { public: - /** - * Get content of the node. - * - * @since S60 v3.1 - * @return String with nodes content - * - * This method applies to TXmlEngCDATASection, TXmlEngComment and TXmlEngTextNode nodes. - */ + /** Get contents of the node. + @return The content of the node + */ IMPORT_C TPtrC8 Contents() const; /** - * Sets contents of basic character nodes: TXmlEngTextNode, TXmlEngComment, TXmlEngCDATASection - * - * @since S60 v3.1 - * @param aNewContents The actual value to store - * - * The input is taken as non-escaped: for example, - * aNewContents = "123 > 34 && P" will be serialized as "123 > 34 && P" - * - * Escaped contents may be set only for TXmlEngElement and TXmlEngAttr nodes. - * @see TXmlEngAttr::SetEscapedValueL(const TDesC8&), TXmlEngElement::SetEscapedTextL(const TDesC8&), - */ + Sets contents of the node. + + The input is taken as non-escaped: for example, + aNewContents = "123 > 34 && P" will be serialized as "123 > 34 && P" + + @param aNewContents The actual value to store + @leave - One of the system-wide error codes + */ IMPORT_C void SetContentsL(const TDesC8& aNewContents); - /** - * Extends the contents of the node by appending aString - * - * @since S60 v3.1 - * @param aString Content to be added to current content - */ + /** Append to the contents of the node + @param aString Content to be appended + @leave KXmlEngErrNullNode Node is NULL + @leave - One of the system-wide error codes + */ IMPORT_C void AppendContentsL(const TDesC8& aString); - /** - * Get length of the content - * - * @since S60 v3.1 - * @return Number of characters in the contents - */ + /** Get length of the content. + @return Number of characters in the contents + */ IMPORT_C TUint Length() const; protected: - /** - * Default constructor - * - * @since S60 v3.1 - */ - inline TXmlEngCharacterData(); // protected from API users + /** Default constructor */ + inline TXmlEngCharacterData(); /** - * Constructor - * - * @since S60 v3.1 - * @param aInternal node pointer - */ + Constructor + @param aInternal node pointer + */ inline TXmlEngCharacterData(void* aInternal); }; -#include "xmlengcharacterdata.inl" +#include -#endif /* XMLENGINE_CHARACTERDATA_H_INCLUDED */ +#endif /* XMLENGCHARACTERDATA_H */