diff -r e1b950c65cb4 -r 837f303aceeb epoc32/include/xml/dom/xmlengserializationoptions.h --- a/epoc32/include/xml/dom/xmlengserializationoptions.h Wed Mar 31 12:27:01 2010 +0100 +++ b/epoc32/include/xml/dom/xmlengserializationoptions.h Wed Mar 31 12:33:34 2010 +0100 @@ -1,43 +1,41 @@ -/* -* 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: Serialization options 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: +// Serialization options functions +// - - - +/** + @file + @publishedAll + @released +*/ - -#ifndef XMLENGINE_SERIALIZATIONOPTIONS_H_INCLUDED -#define XMLENGINE_SERIALIZATIONOPTIONS_H_INCLUDED +#ifndef XMLENGSERIALIZATIONOPTIONS_H +#define XMLENGSERIALIZATIONOPTIONS_H #include -// FORWARD DECLARATION class MXmlEngOutputStream; class MXmlEngDataSerializer; class MXmlEngNodeFilter; /** - * Class allow to set serialization option during document save. - * - * @lib XmlEngineDOM.lib - * @since S60 v3.1 - */ +This class stores serialization options to be used when a document is +serialized. +@see RXmlEngDocument::SaveL() +*/ class TXmlEngSerializationOptions { public: @@ -49,20 +47,19 @@ static const TUint KOptionStandalone = 0x04; /** Add encoding in xml declaration. KOptionOmitXMLDeclaration must not be set */ static const TUint KOptionEncoding = 0x08; - /** Not supported currently */ + /** Not supported */ static const TUint KOptionIncludeNsPrefixes = 0x10; - /** Not supported currently */ + /** Not supported */ static const TUint KOptionCDATASectionElements = 0x20; - /** Decode base64 encoded binary containers content upon XOP serialization*/ + /** Decode base64 encoded binary containers content upon XOP serialization */ static const TUint KOptionDecodeBinaryContainers = 0x40; /** - * Constructor - * - * @since S60 v3.1 - * @param aOptionFlags Serialization options - * @param aEncoding Serialization encoding - */ + Constructor + @param aOptionFlags Serialization options + @param aEncoding Serialization encoding. If KNullDesC8, the document + encoding is used. + */ IMPORT_C TXmlEngSerializationOptions( TUint aOptionFlags = (TXmlEngSerializationOptions::KOptionIndent | TXmlEngSerializationOptions::KOptionStandalone | @@ -70,13 +67,22 @@ const TDesC8& aEncoding = KNullDesC8); /** - * Set node filter - * - * @since S60 v3.1 - * @param aFilter New node filter - */ + Sets a node filter. The node filter is used to choose which nodes from the + tree are serialized. Ownership of the node filter is not transferred and + the caller is responsible for freeing aFilter. + + @param aFilter The node filter to set + */ IMPORT_C void SetNodeFilter(MXmlEngNodeFilter* aFilter); + /** + Sets a data serializer. Ownership of the data serializer is not + transferred and the caller is responsbile for freeing aSerializer. + + @param aSerializer The data serializer to set + */ + IMPORT_C void SetDataSerializer(MXmlEngDataSerializer* aSerializer); + public: /** Options flag */ TUint iOptions; @@ -84,10 +90,10 @@ TPtrC8 iEncoding; /** Node filter */ MXmlEngNodeFilter* iNodeFilter; - /** Object whose serialization callback is invoked **/ + /** Data serializer */ MXmlEngDataSerializer* iDataSerializer; }; +#endif /* XMLENGSERIALIZATIONOPTIONS_H */ -#endif /* XMLENGINE_SERIALIZATIONOPTIONS_H_INCLUDED */