epoc32/include/logclientchangeobserver.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
     1.1 --- a/epoc32/include/logclientchangeobserver.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/logclientchangeobserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,68 @@
     1.4 -logclientchangeobserver.h
     1.5 +// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// 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
     1.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +//
    1.19 +
    1.20 +#ifndef __LOGCLIENTCHANGEOBSERVER_H__
    1.21 +#define __LOGCLIENTCHANGEOBSERVER_H__
    1.22 +
    1.23 +// System includes
    1.24 +#include <logwrap.h>
    1.25 +
    1.26 +/**
    1.27 +Constants
    1.28 +@internalComponent
    1.29 +*/
    1.30 +const TUid KLogClientChangeEventLogCleared = { 0x101F8C4F };
    1.31 +const TUid KLogClientChangeEventRefreshView = { 0x1020601B }; 
    1.32 +
    1.33 +/** 
    1.34 +This class allows a client of the log engine to observe specific change 
    1.35 +events within a given view.
    1.36 +@publishedAll 
    1.37 +@released
    1.38 +*/
    1.39 +class MLogClientChangeObserver
    1.40 +	{
    1.41 +public:
    1.42 +	/** Handle a global change within the logs database
    1.43 +	
    1.44 +	This method is called when a generic event occurs within the log database. 
    1.45 +	Such events are	not specific to a view (see MLogViewChangeObserver for view 
    1.46 +	specific events).
    1.47 +	
    1.48 +	@param aChangeType The uid corresponding to the type of event which 
    1.49 +	occurred.
    1.50 +	@param aChangeParam1 A context-specific change paramater which can be 
    1.51 +	interpreted	based on the change type.
    1.52 +	@param aChangeParam2 A context-specific change paramater which can be 
    1.53 +	interpreted based on the change type.
    1.54 +	@param aChangeParam3 A context-specific change paramater which can be 
    1.55 +	interpreted	based on the change type.
    1.56 +	
    1.57 +	A list of change types and their associated parameters follows:
    1.58 +	
    1.59 +	KLogClientChangeEventLogCleared - no parameters. This event occurs when 
    1.60 +	the log database is cleared.	 
    1.61 +	KLogClientChangeEventRefreshView - no parameters. This event occurs when 
    1.62 +	the client needs to refresh their view. For example, this occurs after the
    1.63 +	log database has been restored from a backup. */
    1.64 +	virtual void HandleLogClientChangeEventL(TUid aChangeType, TInt aChangeParam1, TInt aChangeParam2, TInt aChangeParam3) = 0;
    1.65 +
    1.66 +private:
    1.67 +	IMPORT_C virtual void MLogClientChangeObserver_Reserved1();
    1.68 +	IMPORT_C virtual void MLogClientChangeObserver_Reserved2();
    1.69 +	};
    1.70 +
    1.71 +
    1.72 +#endif