epoc32/include/logviewchangeobserver.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
     1.1 --- a/epoc32/include/logviewchangeobserver.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/logviewchangeobserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,80 @@
     1.4 -logviewchangeobserver.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 __LOGVIEWCHANGEOBSERVER_H__
    1.21 +#define __LOGVIEWCHANGEOBSERVER_H__
    1.22 +
    1.23 +// System includes
    1.24 +#include <logwrap.h>
    1.25 +
    1.26 +/**
    1.27 +This class allows a client of the log engine to observe specific change events within
    1.28 +a given view.
    1.29 +@publishedAll 
    1.30 +@released
    1.31 +*/
    1.32 +class MLogViewChangeObserver
    1.33 +	{
    1.34 +public:
    1.35 +
    1.36 +	/**Handle a change corresponding to a view addition
    1.37 +	
    1.38 +	This method is called when a log event is added to a view. The event maybe 
    1.39 +	recently added,	or have existed for some time but only now meet the 
    1.40 +	criteria of this view (i.e satisfy the filter) due to some other change.
    1.41 +	
    1.42 +	@param aId The id of the log event which has been added to the view.
    1.43 +	@param aViewIndex The position within the view at which the event has been 
    1.44 +	added.
    1.45 +	@param aChangeIndex	In a series of changes, this is the index of the 
    1.46 +	currently processing change. The change index will be greater than (or 
    1.47 +	equal to) 0, and less than the total change count.
    1.48 +	@param aTotalChangeCount This is the total count of all changes which will 
    1.49 +	be processed in this batch.
    1.50 +	 */
    1.51 +	virtual void HandleLogViewChangeEventAddedL(TLogId aId, TInt aViewIndex, TInt aChangeIndex, TInt aTotalChangeCount) = 0;
    1.52 +
    1.53 +	/** Handle a change corresponding to a view change
    1.54 +	
    1.55 +	This method is called when a log event changes within a view.
    1.56 +	
    1.57 +	@param aId The id of the log event which has changed within the view.
    1.58 +	@param aViewIndex The position within the view where the change occurred.
    1.59 +	@param aChangeIndex	In a series of changes, this is the index of the 
    1.60 +	currently processing change. The change index will be greater than (or 
    1.61 +	equal to) 0, and less than the total change count.
    1.62 +	@param aTotalChangeCount This is the total count of all changes which will 
    1.63 +	be processed in this batch.
    1.64 +	 */
    1.65 +	virtual void HandleLogViewChangeEventChangedL(TLogId aId, TInt aViewIndex, TInt aChangeIndex, TInt aTotalChangeCount) = 0;
    1.66 +
    1.67 +	/** Handle a change corresponding to a view deletion
    1.68 +	
    1.69 +	This method is called when a log event is removed from a view.
    1.70 +	
    1.71 +	@param aId The id of the log event which has been removed from the view
    1.72 +	@param aViewIndex The position within the view which the event previously 
    1.73 +	held.
    1.74 +	@param aChangeIndex In a series of changes, this is the index of the 
    1.75 +	currently processing change. The change index will be greater than (or 
    1.76 +	equal to) 0, and less than the total change count.
    1.77 +	@param aTotalChangeCount This is the total count of all changes which 
    1.78 +	will be processed in this batch
    1.79 +	 */
    1.80 +	virtual void HandleLogViewChangeEventDeletedL(TLogId aId, TInt aViewIndex, TInt aChangeIndex, TInt aTotalChangeCount) = 0;
    1.81 +	};
    1.82 +
    1.83 +
    1.84 +#endif