epoc32/include/app/calfilechangenotification.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
//
williamr@4
    15
williamr@4
    16
#ifndef __CALFILECHANGENOTIFICATION_H__
williamr@4
    17
#define __CALFILECHANGENOTIFICATION_H__
williamr@4
    18
williamr@4
    19
class CAgnFileChangeInfo;
williamr@4
    20
class CCalFileChangeInfo;
williamr@4
    21
williamr@4
    22
/** The mixin/interface class used for recieving calendar file change notifications.
williamr@4
    23
williamr@4
    24
The call back returns an array containing information about at least
williamr@4
    25
one change to the calendar file. The information includes the file name and type of change.
williamr@4
    26
williamr@4
    27
A client will not be notified of a change if it has register with the CCalSession.
williamr@4
    28
williamr@4
    29
@publishedAll
williamr@4
    30
@prototype
williamr@4
    31
*/
williamr@4
    32
class MCalFileChangeObserver
williamr@4
    33
	{
williamr@4
    34
public:
williamr@4
    35
williamr@4
    36
	/** An enum to describe the types of file changes that may occur */
williamr@4
    37
	enum TChangeType
williamr@4
    38
		{
williamr@4
    39
		/** A calendar file has been created */
williamr@4
    40
		ECalendarFileCreated,
williamr@4
    41
		/** A calendar file has been deleted */
williamr@4
    42
		ECalendarFileDeleted,
williamr@4
    43
		/** Calendar info has been set on a calendar file */
williamr@4
    44
		ECalendarInfoCreated,
williamr@4
    45
		/** A calendar file had its calendar info updated */
williamr@4
    46
		ECalendarInfoUpdated,
williamr@4
    47
		/** Calendar info has been deleted on a calendar file */
williamr@4
    48
		ECalendarInfoDeleted
williamr@4
    49
		};
williamr@4
    50
williamr@4
    51
public:
williamr@4
    52
williamr@4
    53
	/** The callback that will recieve 1 or more file change notifications */
williamr@4
    54
	virtual void CalendarInfoChangeNotificationL(RPointerArray<CCalFileChangeInfo>& aCalendarInfoChangeEntries) = 0;
williamr@4
    55
	};
williamr@4
    56
	
williamr@4
    57
/** This class provides information about the calendar file change
williamr@4
    58
williamr@4
    59
@publishedAll
williamr@4
    60
@prototype
williamr@4
    61
*/
williamr@4
    62
class CCalFileChangeInfo : public CBase
williamr@4
    63
	{
williamr@4
    64
public:
williamr@4
    65
	static CCalFileChangeInfo* NewL(CAgnFileChangeInfo* aAgnFileChangeInfo);
williamr@4
    66
	~CCalFileChangeInfo();
williamr@4
    67
	
williamr@4
    68
	/** Get the file name of the file that has changed */
williamr@4
    69
	IMPORT_C const TDesC& FileNameL() const;
williamr@4
    70
	
williamr@4
    71
	/** Get the type of change that happened to the file */
williamr@4
    72
	IMPORT_C MCalFileChangeObserver::TChangeType ChangeType() const;
williamr@4
    73
	
williamr@4
    74
private:
williamr@4
    75
	CCalFileChangeInfo(CAgnFileChangeInfo* aAgnFileChangeInfo);
williamr@4
    76
williamr@4
    77
private:
williamr@4
    78
    CAgnFileChangeInfo* iImpl;
williamr@4
    79
	};
williamr@4
    80
#endif