os/persistentdata/loggingservices/eventlogger/LogCli/inc/LogViewChangeObserver.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
#ifndef __LOGVIEWCHANGEOBSERVER_H__
sl@0
    17
#define __LOGVIEWCHANGEOBSERVER_H__
sl@0
    18
sl@0
    19
// System includes
sl@0
    20
#include <logwrap.h>
sl@0
    21
sl@0
    22
/**
sl@0
    23
This class allows a client of the log engine to observe specific change events within
sl@0
    24
a given view.
sl@0
    25
@publishedAll 
sl@0
    26
@released
sl@0
    27
*/
sl@0
    28
class MLogViewChangeObserver
sl@0
    29
	{
sl@0
    30
public:
sl@0
    31
sl@0
    32
	/**Handle a change corresponding to a view addition
sl@0
    33
	
sl@0
    34
	This method is called when a log event is added to a view. The event maybe 
sl@0
    35
	recently added,	or have existed for some time but only now meet the 
sl@0
    36
	criteria of this view (i.e satisfy the filter) due to some other change.
sl@0
    37
	
sl@0
    38
	@param aId The id of the log event which has been added to the view.
sl@0
    39
	@param aViewIndex The position within the view at which the event has been 
sl@0
    40
	added.
sl@0
    41
	@param aChangeIndex	In a series of changes, this is the index of the 
sl@0
    42
	currently processing change. The change index will be greater than (or 
sl@0
    43
	equal to) 0, and less than the total change count.
sl@0
    44
	@param aTotalChangeCount This is the total count of all changes which will 
sl@0
    45
	be processed in this batch.
sl@0
    46
	 */
sl@0
    47
	virtual void HandleLogViewChangeEventAddedL(TLogId aId, TInt aViewIndex, TInt aChangeIndex, TInt aTotalChangeCount) = 0;
sl@0
    48
sl@0
    49
	/** Handle a change corresponding to a view change
sl@0
    50
	
sl@0
    51
	This method is called when a log event changes within a view.
sl@0
    52
	
sl@0
    53
	@param aId The id of the log event which has changed within the view.
sl@0
    54
	@param aViewIndex The position within the view where the change occurred.
sl@0
    55
	@param aChangeIndex	In a series of changes, this is the index of the 
sl@0
    56
	currently processing change. The change index will be greater than (or 
sl@0
    57
	equal to) 0, and less than the total change count.
sl@0
    58
	@param aTotalChangeCount This is the total count of all changes which will 
sl@0
    59
	be processed in this batch.
sl@0
    60
	 */
sl@0
    61
	virtual void HandleLogViewChangeEventChangedL(TLogId aId, TInt aViewIndex, TInt aChangeIndex, TInt aTotalChangeCount) = 0;
sl@0
    62
sl@0
    63
	/** Handle a change corresponding to a view deletion
sl@0
    64
	
sl@0
    65
	This method is called when a log event is removed from a view.
sl@0
    66
	
sl@0
    67
	@param aId The id of the log event which has been removed from the view
sl@0
    68
	@param aViewIndex The position within the view which the event previously 
sl@0
    69
	held.
sl@0
    70
	@param aChangeIndex In a series of changes, this is the index of the 
sl@0
    71
	currently processing change. The change index will be greater than (or 
sl@0
    72
	equal to) 0, and less than the total change count.
sl@0
    73
	@param aTotalChangeCount This is the total count of all changes which 
sl@0
    74
	will be processed in this batch
sl@0
    75
	 */
sl@0
    76
	virtual void HandleLogViewChangeEventDeletedL(TLogId aId, TInt aViewIndex, TInt aChangeIndex, TInt aTotalChangeCount) = 0;
sl@0
    77
	};
sl@0
    78
sl@0
    79
sl@0
    80
#endif