1.1 --- a/epoc32/include/calinstanceview.h Tue Mar 16 16:12:26 2010 +0000
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,129 +0,0 @@
1.4 -// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 -// All rights reserved.
1.6 -// This component and the accompanying materials are made available
1.7 -// 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
1.8 -// which accompanies this distribution, and is available
1.9 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 -//
1.11 -// Initial Contributors:
1.12 -// Nokia Corporation - initial contribution.
1.13 -//
1.14 -// Contributors:
1.15 -//
1.16 -// Description:
1.17 -//
1.18 -
1.19 -#ifndef __CALINSTANCEVIEW_H__
1.20 -#define __CALINSTANCEVIEW_H__
1.21 -
1.22 -#include <calentry.h>
1.23 -#include <calentryview.h>
1.24 -#include <calinstanceiterator.h>
1.25 -
1.26 -class CCalFindInstanceSettings;
1.27 -class CCalInstance;
1.28 -class CCalInstanceIterator;
1.29 -class CCalInstanceViewImpl;
1.30 -class CCalSession;
1.31 -class MCalProgressCallBack;
1.32 -class TCalTime;
1.33 -class CCalLiteEntry;
1.34 -class TAgnInstanceId;
1.35 -struct TASShdAlarmedInstanceParams;
1.36 -
1.37 -/** View class for accessing instances of calendar entries.
1.38 -
1.39 -Once a session to a calendar file has been created, a view to the session
1.40 -can be created.
1.41 -
1.42 -An instance is a calendar entry, a repeated instance of a calendar entry,
1.43 -or an RDate added to an entry.
1.44 -
1.45 -This view can be used to search for instances and also to delete instances.
1.46 -
1.47 -@publishedAll
1.48 -@released
1.49 -*/
1.50 -NONSHARABLE_CLASS(CCalInstanceView) : public CBase
1.51 - {
1.52 -public:
1.53 -
1.54 - /** Parameter struct for storing search data.
1.55 - This contains a descriptor to store search text and an enum to describe the text search behaviour.
1.56 -
1.57 - @publishedAll
1.58 - @released
1.59 - */
1.60 - class TCalSearchParams
1.61 - {
1.62 - public:
1.63 - IMPORT_C TCalSearchParams(const TDesC& aText, CalCommon::TCalSearchBehaviour aBehaviour);
1.64 - IMPORT_C const TDesC& Text() const;
1.65 - IMPORT_C CalCommon::TCalSearchBehaviour Behaviour() const;
1.66 -
1.67 - private:
1.68 - TPtrC iSearchText;
1.69 - CalCommon::TCalSearchBehaviour iSearchBehaviour;
1.70 - };
1.71 -
1.72 - IMPORT_C static CCalInstanceView* NewL(CCalSession& aSession, MCalProgressCallBack& aProgressCallBack);
1.73 - IMPORT_C static CCalInstanceView* NewL(CCalSession& aSession);
1.74 - IMPORT_C ~CCalInstanceView();
1.75 -
1.76 - IMPORT_C void FindInstanceL(RPointerArray<CCalInstance>& aInstanceList,
1.77 - CalCommon::TCalViewFilter aCalViewFilter,
1.78 - const CalCommon::TCalTimeRange& aTimeRange) const;
1.79 -
1.80 - IMPORT_C void FindInstanceL(RPointerArray<CCalInstance>& aMatchedInstanceList,
1.81 - CalCommon::TCalViewFilter aCalViewFilter,
1.82 - const CalCommon::TCalTimeRange& aTimeRange,
1.83 - const TCalSearchParams& aSearchParams) const;
1.84 -
1.85 - IMPORT_C CCalInstanceIterator* FindInstanceL(const CCalFindInstanceSettings& aSettings) const;
1.86 -
1.87 - IMPORT_C void FindAlarmedInstanceL(RPointerArray<CCalInstance>& aAlarmedInstanceList,
1.88 - TASShdAlarmedInstanceParams aAlarmedInstanceParams) const;
1.89 -
1.90 - IMPORT_C void DeleteL(CCalInstance* aInstance, CalCommon::TRecurrenceRange aWhichInstances);
1.91 -
1.92 - IMPORT_C TCalTime NextInstanceL(CalCommon::TCalViewFilter aCalViewFilter, const TCalTime& aStartDate) const;
1.93 - IMPORT_C TCalTime PreviousInstanceL(CalCommon::TCalViewFilter aCalViewFilter, const TCalTime& aStartDate) const;
1.94 -
1.95 -private:
1.96 - CCalInstanceView();
1.97 - void ConstructL(CCalSession& aSession, MCalProgressCallBack* aProgressCallBack);
1.98 -
1.99 -private:
1.100 - CCalInstanceViewImpl* iImpl;
1.101 - };
1.102 -
1.103 -/** Class for specifying the search criteria for use in @see CCalInstanceView::FindInstanceL.
1.104 -
1.105 -@publishedPartner
1.106 -@released
1.107 -*/
1.108 -NONSHARABLE_CLASS(CCalFindInstanceSettings) : public CBase
1.109 - {
1.110 -public:
1.111 - IMPORT_C static CCalFindInstanceSettings* NewL(CalCommon::TCalViewFilter aFilter, const CalCommon::TCalTimeRange& aTimeRange);
1.112 - IMPORT_C ~CCalFindInstanceSettings();
1.113 -
1.114 - IMPORT_C void SetFilter(CalCommon::TCalViewFilter aFilter);
1.115 - IMPORT_C void SetTimeRange(const CalCommon::TCalTimeRange& aTimeRange);
1.116 - IMPORT_C void SetTextSearchL(const CCalInstanceView::TCalSearchParams& aSearchParams);
1.117 -
1.118 - CalCommon::TCalSearchBehaviour Behaviour() const;
1.119 - CalCommon::TCalViewFilter Filter() const;
1.120 - const CalCommon::TCalTimeRange TimeRange() const;
1.121 - const TDesC& Text() const;
1.122 -private:
1.123 - CCalFindInstanceSettings(CalCommon::TCalViewFilter aFilter, const CalCommon::TCalTimeRange& aTimeRange);
1.124 -
1.125 -private:
1.126 - CalCommon::TCalTimeRange iTimeRange;
1.127 - CalCommon::TCalViewFilter iFilter;
1.128 - HBufC* iSearchText;
1.129 - CalCommon::TCalSearchBehaviour iSearchBehaviour;
1.130 - };
1.131 -
1.132 -#endif // __CALINSTANCEVIEW_H__