epoc32/include/logclientchangeobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations

// Copyright (c) 2002-2009 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:
//

#ifndef __LOGCLIENTCHANGEOBSERVER_H__
#define __LOGCLIENTCHANGEOBSERVER_H__

// System includes
#include <logwrap.h>

/**
Constants
@internalComponent
*/
const TUid KLogClientChangeEventLogCleared = { 0x101F8C4F };
const TUid KLogClientChangeEventRefreshView = { 0x1020601B }; 

/** 
This class allows a client of the log engine to observe specific change 
events within a given view.
@publishedAll 
@released
*/
class MLogClientChangeObserver
	{
public:
	/** Handle a global change within the logs database
	
	This method is called when a generic event occurs within the log database. 
	Such events are	not specific to a view (see MLogViewChangeObserver for view 
	specific events).
	
	@param aChangeType The uid corresponding to the type of event which 
	occurred.
	@param aChangeParam1 A context-specific change paramater which can be 
	interpreted	based on the change type.
	@param aChangeParam2 A context-specific change paramater which can be 
	interpreted based on the change type.
	@param aChangeParam3 A context-specific change paramater which can be 
	interpreted	based on the change type.
	
	A list of change types and their associated parameters follows:
	
	KLogClientChangeEventLogCleared - no parameters. This event occurs when 
	the log database is cleared.	 
	KLogClientChangeEventRefreshView - no parameters. This event occurs when 
	the client needs to refresh their view. For example, this occurs after the
	log database has been restored from a backup. */
	virtual void HandleLogClientChangeEventL(TUid aChangeType, TInt aChangeParam1, TInt aChangeParam2, TInt aChangeParam3) = 0;

private:
	IMPORT_C virtual void MLogClientChangeObserver_Reserved1();
	IMPORT_C virtual void MLogClientChangeObserver_Reserved2();
	};


#endif