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