epoc32/include/app/calinstance.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
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@2
     1
// Copyright (c) 2005-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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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 __CALINSTANCE_H__
williamr@2
    17
#define __CALINSTANCE_H__
williamr@2
    18
williamr@2
    19
#include <caltime.h>
williamr@4
    20
#include <calcommon.h>
williamr@2
    21
williamr@2
    22
class CCalEntry;
williamr@2
    23
class CCalInstanceImpl;
williamr@2
    24
williamr@4
    25
/** Instance ID to identify an instance uniquely
williamr@4
    26
williamr@4
    27
@publishedAll
williamr@4
    28
@released
williamr@4
    29
 */
williamr@4
    30
struct TCalInstanceId
williamr@4
    31
	{
williamr@4
    32
	/* Entry Local ID */
williamr@4
    33
	TCalLocalUid		iEntryLocalId;
williamr@4
    34
	/* Instance time */
williamr@4
    35
	TCalTime 	 		iInstanceTime;
williamr@4
    36
	/* Collection Id that the instance belongs to */
williamr@4
    37
	TCalCollectionId 	iCollectionId;	
williamr@4
    38
	};
williamr@4
    39
williamr@2
    40
/** Class representing an instance of a calendar entry.
williamr@2
    41
williamr@2
    42
A calendar entry (CCalEntry) can have any number of instances. 
williamr@2
    43
A non-repeating entry will only have one instance.
williamr@2
    44
Any further instances will appear if the entry has recurrence data.
williamr@2
    45
williamr@2
    46
The time of an instance is the start time of that instance of the entry.
williamr@2
    47
williamr@2
    48
@publishedAll
williamr@2
    49
@released
williamr@2
    50
*/
williamr@2
    51
NONSHARABLE_CLASS(CCalInstance) : public CBase
williamr@2
    52
	{
williamr@2
    53
public:
williamr@2
    54
	static CCalInstance* NewL(CCalEntry* aEntry, const TCalTime& iTime);
williamr@2
    55
	IMPORT_C ~CCalInstance();
williamr@2
    56
	
williamr@2
    57
	IMPORT_C CCalEntry& Entry() const;
williamr@2
    58
	IMPORT_C TCalTime Time() const;
williamr@2
    59
	IMPORT_C TCalTime StartTimeL() const;
williamr@2
    60
	IMPORT_C TCalTime EndTimeL() const;
williamr@4
    61
	IMPORT_C TCalInstanceId InstanceIdL() const;
williamr@2
    62
williamr@2
    63
private:
williamr@2
    64
	CCalInstance();
williamr@2
    65
	void ConstructL(CCalEntry* aEntry, const TCalTime& aTime);
williamr@2
    66
	
williamr@2
    67
private:
williamr@2
    68
	CCalInstanceImpl* iImpl;
williamr@2
    69
	};
williamr@2
    70
williamr@2
    71
#endif // __CALINSTANCE_H__