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