1.1 --- a/epoc32/include/app/caleninterimutils2.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/app/caleninterimutils2.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,108 @@
1.4 -caleninterimutils2.h
1.5 +/*
1.6 +* Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* 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.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description:
1.19 +* This class contains utility methods related to usage of
1.20 +* Calendar Interim API.
1.21 +*
1.22 +*/
1.23 +
1.24 +
1.25 +
1.26 +#ifndef __CALENINTERIMUTILS2_H__
1.27 +#define __CALENINTERIMUTILS2_H__
1.28 +
1.29 +// INCLUDES
1.30 +#include <e32base.h>
1.31 +#include <calcommon.h>
1.32 +
1.33 +// FORWARD DECLARATIONS
1.34 +class CCalEntry;
1.35 +class CCalEntryView;
1.36 +class CCalenInterimUtils2Impl;
1.37 +
1.38 +// CLASS DECLARATION
1.39 +
1.40 +/**
1.41 +* This class contains utility methods related to usage of
1.42 +* Calendar Interim API
1.43 +*/
1.44 +NONSHARABLE_CLASS(CCalenInterimUtils2) : public CBase
1.45 + {
1.46 + public: // Construction/destruction
1.47 + /**
1.48 + * Create a new instance of CalenInterimUtils2
1.49 + */
1.50 + IMPORT_C static CCalenInterimUtils2* NewL();
1.51 +
1.52 + /**
1.53 + * Destructor
1.54 + */
1.55 + IMPORT_C ~CCalenInterimUtils2();
1.56 +
1.57 + public: // New functions
1.58 + /**
1.59 + * Allocates and returns a new global UID.
1.60 + * @return UID, ownership is transferred to caller
1.61 + */
1.62 + IMPORT_C HBufC8* GlobalUidL();
1.63 +
1.64 + /**
1.65 + * Populates empty fields of a child entry with data from
1.66 + * the parent entry.
1.67 + * @param aChild child (modifying) entry to be populated
1.68 + * @param aParent parent (originating) entry
1.69 + */
1.70 + IMPORT_C static void PopulateChildFromParentL( CCalEntry& aChild,
1.71 + const CCalEntry& aParent );
1.72 +
1.73 + /**
1.74 + * Checks to see if Meeting Request Viewer functionality
1.75 + * is enabled and is available to use
1.76 + * @return current state of MR Viewers implementation
1.77 + */
1.78 + IMPORT_C TBool MRViewersEnabledL(TBool aForceCheck = EFalse);
1.79 +
1.80 + /**
1.81 + * This function is a wrapper around CCalEntryView::StoreL() and CCalEntryView::UpdateL().
1.82 + * The function makes the appropriate call to either of those functions, depending on several
1.83 + * factors, such as whether the entry is a child or parent, and whether it has exceptions or not.
1.84 + * If aCopyToChildren is set to ETrue, extra logic is applied as follows:
1.85 + * For each exception, for each field, if the field is NOT the reason for the
1.86 + * entry being an exception, copy the new parent's field across to the exception.
1.87 + * @param aEntryView view of the entries
1.88 + * @param aEntry entry to be stored
1.89 + * @param aCopyToChildren whether the extra logic regarding exception data should be run
1.90 + */
1.91 + IMPORT_C static void StoreL( CCalEntryView& aEntryView,
1.92 + CCalEntry& aEntry,
1.93 + TBool aCopyToChildren = EFalse );
1.94 +
1.95 + /**
1.96 + * Checks to see if the given entry has properties consistent with a meeting request.
1.97 + * @param aEntry Entry to test
1.98 + * @return ETrue if the entry is a meeting request, EFalse otherwise
1.99 + */
1.100 + IMPORT_C static TBool IsMeetingRequestL( CCalEntry& aEntry );
1.101 +
1.102 + private: // Construction/destruction
1.103 + void ConstructL();
1.104 + CCalenInterimUtils2();
1.105 +
1.106 + private: // Member data
1.107 + CCalenInterimUtils2Impl* iImpl;
1.108 + };
1.109 +
1.110 +#endif // __CALENINTERIMUTILS2_H__
1.111 +
1.112 +// End of File