epoc32/include/logclientchangeobserver.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 __LOGCLIENTCHANGEOBSERVER_H__
    17 #define __LOGCLIENTCHANGEOBSERVER_H__
    18 
    19 // System includes
    20 #include <logwrap.h>
    21 
    22 /**
    23 Constants
    24 @internalComponent
    25 */
    26 const TUid KLogClientChangeEventLogCleared = { 0x101F8C4F };
    27 const TUid KLogClientChangeEventRefreshView = { 0x1020601B }; 
    28 
    29 /** 
    30 This class allows a client of the log engine to observe specific change 
    31 events within a given view.
    32 @publishedAll 
    33 @released
    34 */
    35 class MLogClientChangeObserver
    36 	{
    37 public:
    38 	/** Handle a global change within the logs database
    39 	
    40 	This method is called when a generic event occurs within the log database. 
    41 	Such events are	not specific to a view (see MLogViewChangeObserver for view 
    42 	specific events).
    43 	
    44 	@param aChangeType The uid corresponding to the type of event which 
    45 	occurred.
    46 	@param aChangeParam1 A context-specific change paramater which can be 
    47 	interpreted	based on the change type.
    48 	@param aChangeParam2 A context-specific change paramater which can be 
    49 	interpreted based on the change type.
    50 	@param aChangeParam3 A context-specific change paramater which can be 
    51 	interpreted	based on the change type.
    52 	
    53 	A list of change types and their associated parameters follows:
    54 	
    55 	KLogClientChangeEventLogCleared - no parameters. This event occurs when 
    56 	the log database is cleared.	 
    57 	KLogClientChangeEventRefreshView - no parameters. This event occurs when 
    58 	the client needs to refresh their view. For example, this occurs after the
    59 	log database has been restored from a backup. */
    60 	virtual void HandleLogClientChangeEventL(TUid aChangeType, TInt aChangeParam1, TInt aChangeParam2, TInt aChangeParam3) = 0;
    61 
    62 private:
    63 	IMPORT_C virtual void MLogClientChangeObserver_Reserved1();
    64 	IMPORT_C virtual void MLogClientChangeObserver_Reserved2();
    65 	};
    66 
    67 
    68 #endif