1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // Defines the configuration for the format of the log data.
22 #ifndef __DATAFORMAT_H__
23 #define __DATAFORMAT_H__
30 Comments : Indicates the logging style which should be used by CDataLogger
32 enum TLoggingStyle {EText, EHtml, ECustom};
37 Configures the format of the DataLogger's
38 documentatry output. (see the comments
43 const TDesC* iDocumentStart; // <HTML><HEAD><TITLE>
44 const TDesC* iContentStart; // </TITLE><BODY>
45 const TDesC* iCommentStart; // <P>
46 const TDesC* iCommentEnd; // </P>
47 const TDesC* iDocumentEnd; // </BODY></HTML>
60 Intended Usage : Sets up the logging facility provided by the implementation of this
61 interface. If logging cannot be established for any reason then
62 this function should leave.
63 @leave Implementation dependant.
66 @post Nothing is left on the CleanupStack
69 virtual void OpenL() = 0;
72 @fn Write(const TDesC& aOutput) = 0
73 Intended Usage : Logs the specified descriptor.
75 @param aOutput The descriptor to stream to the logging facility
76 @pre OpenL has been called to set up logging
77 @post aOutput has been logged
80 virtual void Write(const TDesC& aOutput) = 0;
84 Intended Usage : Called when all logging has finished to close down any log
88 @post Logging facility is closed down and this object can be deleted.
91 virtual void Close() = 0;
97 Specifies the logging configuration.
101 /** The title to be used in the output logs */
103 /** If logging messages should also be printed using RDebug */
105 /** The output style of the logging (plain text, html etc) */
106 TLoggingStyle iStyle;
107 /** If iStyle is set to ECustom then this will be used for outputting log comments */
108 TLogFormat* iLogFormat;
109 /** The logging mechanism. NULL will default to RFileLogger */
110 MLogOutput* iLogOutput;
111 /** The reporting mechanism. NULL will default to RFileLogger */
112 MLogOutput* iReportOutput;