1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/inc/DataFormat.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,116 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Defines the configuration for the format of the log data.
1.18 +//
1.19 +//
1.20 +
1.21 +/**
1.22 + @test
1.23 +*/
1.24 +
1.25 +#ifndef __DATAFORMAT_H__
1.26 +#define __DATAFORMAT_H__
1.27 +
1.28 +#include <e32std.h>
1.29 +
1.30 +/**
1.31 + @internalAll
1.32 + @enum TLoggingStyle
1.33 + Comments : Indicates the logging style which should be used by CDataLogger
1.34 + */
1.35 +enum TLoggingStyle {EText, EHtml, ECustom};
1.36 +
1.37 +/**
1.38 + @internalAll
1.39 + @struct TLogFormat
1.40 + Configures the format of the DataLogger's
1.41 + documentatry output. (see the comments
1.42 + for an example usage.
1.43 + */
1.44 +typedef struct
1.45 + {
1.46 + const TDesC* iDocumentStart; // <HTML><HEAD><TITLE>
1.47 + const TDesC* iContentStart; // </TITLE><BODY>
1.48 + const TDesC* iCommentStart; // <P>
1.49 + const TDesC* iCommentEnd; // </P>
1.50 + const TDesC* iDocumentEnd; // </BODY></HTML>
1.51 + } TLogFormat;
1.52 +
1.53 +/**
1.54 + @internalAll
1.55 +
1.56 + */
1.57 +
1.58 +class MLogOutput
1.59 + {
1.60 +public:
1.61 +/**
1.62 + @fn OpenL() = 0
1.63 + Intended Usage : Sets up the logging facility provided by the implementation of this
1.64 + interface. If logging cannot be established for any reason then
1.65 + this function should leave.
1.66 + @leave Implementation dependant.
1.67 + @since 7.0
1.68 + @pre None
1.69 + @post Nothing is left on the CleanupStack
1.70 + */
1.71 +
1.72 + virtual void OpenL() = 0;
1.73 +
1.74 +/**
1.75 + @fn Write(const TDesC& aOutput) = 0
1.76 + Intended Usage : Logs the specified descriptor.
1.77 + @since 7.0
1.78 + @param aOutput The descriptor to stream to the logging facility
1.79 + @pre OpenL has been called to set up logging
1.80 + @post aOutput has been logged
1.81 + */
1.82 +
1.83 + virtual void Write(const TDesC& aOutput) = 0;
1.84 +
1.85 +/**
1.86 + @fn Close() = 0
1.87 + Intended Usage : Called when all logging has finished to close down any log
1.88 + connections.
1.89 + @since 7.0
1.90 + @pre None
1.91 + @post Logging facility is closed down and this object can be deleted.
1.92 + */
1.93 +
1.94 + virtual void Close() = 0;
1.95 + };
1.96 +
1.97 +/**
1.98 + @internalAll
1.99 + @struct TLoggingInfo
1.100 + Specifies the logging configuration.
1.101 + */
1.102 +typedef struct
1.103 + {
1.104 + /** The title to be used in the output logs */
1.105 + const TDesC* iTitle;
1.106 + /** If logging messages should also be printed using RDebug */
1.107 + TBool iUseRDebug;
1.108 + /** The output style of the logging (plain text, html etc) */
1.109 + TLoggingStyle iStyle;
1.110 + /** If iStyle is set to ECustom then this will be used for outputting log comments */
1.111 + TLogFormat* iLogFormat;
1.112 + /** The logging mechanism. NULL will default to RFileLogger */
1.113 + MLogOutput* iLogOutput;
1.114 + /** The reporting mechanism. NULL will default to RFileLogger */
1.115 + MLogOutput* iReportOutput;
1.116 + } TLoggingInfo;
1.117 +
1.118 +#endif
1.119 +