sl@0: const TDesC* iContentStart; //

sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). sl@0: // All rights reserved. sl@0: // This component and the accompanying materials are made available sl@0: // under the terms of "Eclipse Public License v1.0" sl@0: // which accompanies this distribution, and is available sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: // sl@0: // Initial Contributors: sl@0: // Nokia Corporation - initial contribution. sl@0: // sl@0: // Contributors: sl@0: // sl@0: // Description: sl@0: // Defines the configuration for the format of the log data. sl@0: // sl@0: // sl@0: sl@0: /** sl@0: @test sl@0: */ sl@0: sl@0: #ifndef __DATAFORMAT_H__ sl@0: #define __DATAFORMAT_H__ sl@0: sl@0: #include sl@0: sl@0: /** sl@0: @internalAll sl@0: @enum TLoggingStyle sl@0: Comments : Indicates the logging style which should be used by CDataLogger sl@0: */ sl@0: enum TLoggingStyle {EText, EHtml, ECustom}; sl@0: sl@0: /** sl@0: @internalAll sl@0: @struct TLogFormat sl@0: Configures the format of the DataLogger's sl@0: documentatry output. (see the comments sl@0: for an example usage. sl@0: */ sl@0: typedef struct sl@0: { sl@0: const TDesC* iDocumentStart; // sl@0: const TDesC* iContentStart; // sl@0: const TDesC* iCommentStart; //

sl@0: const TDesC* iCommentEnd; //

sl@0: const TDesC* iDocumentEnd; // sl@0: } TLogFormat; sl@0: sl@0: /** sl@0: @internalAll sl@0: sl@0: */ sl@0: sl@0: class MLogOutput sl@0: { sl@0: public: sl@0: /** sl@0: @fn OpenL() = 0 sl@0: Intended Usage : Sets up the logging facility provided by the implementation of this sl@0: interface. If logging cannot be established for any reason then sl@0: this function should leave. sl@0: @leave Implementation dependant. sl@0: @since 7.0 sl@0: @pre None sl@0: @post Nothing is left on the CleanupStack sl@0: */ sl@0: sl@0: virtual void OpenL() = 0; sl@0: sl@0: /** sl@0: @fn Write(const TDesC& aOutput) = 0 sl@0: Intended Usage : Logs the specified descriptor. sl@0: @since 7.0 sl@0: @param aOutput The descriptor to stream to the logging facility sl@0: @pre OpenL has been called to set up logging sl@0: @post aOutput has been logged sl@0: */ sl@0: sl@0: virtual void Write(const TDesC& aOutput) = 0; sl@0: sl@0: /** sl@0: @fn Close() = 0 sl@0: Intended Usage : Called when all logging has finished to close down any log sl@0: connections. sl@0: @since 7.0 sl@0: @pre None sl@0: @post Logging facility is closed down and this object can be deleted. sl@0: */ sl@0: sl@0: virtual void Close() = 0; sl@0: }; sl@0: sl@0: /** sl@0: @internalAll sl@0: @struct TLoggingInfo sl@0: Specifies the logging configuration. sl@0: */ sl@0: typedef struct sl@0: { sl@0: /** The title to be used in the output logs */ sl@0: const TDesC* iTitle; sl@0: /** If logging messages should also be printed using RDebug */ sl@0: TBool iUseRDebug; sl@0: /** The output style of the logging (plain text, html etc) */ sl@0: TLoggingStyle iStyle; sl@0: /** If iStyle is set to ECustom then this will be used for outputting log comments */ sl@0: TLogFormat* iLogFormat; sl@0: /** The logging mechanism. NULL will default to RFileLogger */ sl@0: MLogOutput* iLogOutput; sl@0: /** The reporting mechanism. NULL will default to RFileLogger */ sl@0: MLogOutput* iReportOutput; sl@0: } TLoggingInfo; sl@0: sl@0: #endif sl@0: