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