examples/ForumNokia/CalendarExample/inc/CalendarAPIexampleEngine.h

/*
 * Copyright (c) 2008-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
 *    
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    
 *  * Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  * Neither the name of Nokia Corporation nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *    
 *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 *    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 *    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *    
 *    Description:  
 */


#ifndef __CALENDAR_API_EXAMPLE_ENGINE_H
#define __CALENDAR_API_EXAMPLE_ENGINE_H

// INCLUDES
#include <e32base.h>    //CBase
#include <calsession.h>
#include <calentry.h>
#include <calinstanceview.h>
#include <calentryview.h>
#include <CalProgressCallBack.h>
#include <AknProgressDialog.h>
#include <eikprogi.h>   //CEikProgressInfo
#include "CalendarHelperEntry.h" //CCalHelperEntry

// CONSTANTS
const TInt KMaxSync = 2;
const TInt KDefaultAlarmHour = 8;
const TInt KUndefinedModifyIndex = -1;

enum TSearchType
    {
    EWeek,
    EMonth,
    ESixMonths,
    EYear
    };

//commands to observer
class MCalenderEngineObserverUI
    {
    public:
        virtual void ActivateView(TUid aViewId) = 0;
    };

//Commands called from views:
class MCalendarEngineCommandsInterface 
    {
    public:
       virtual void DoSearchL(  const TSearchType& aType) = 0;
       virtual void DoAddL() = 0;
       virtual void DoSaveL() = 0;
       virtual void CreateEntryForModificationL(TBool& aModify)=0;
       virtual TInt EntryCount() const = 0;
       
       virtual void DeleteEntryL(const TInt& aIndex) = 0;
       virtual void ExecuteDeletionL() = 0;
       
       virtual CCalHelperEntry& Entry(const TInt& aIndex) = 0;
       virtual void SetModifyIndex(const TInt& aIndex) = 0;
       virtual TInt ModifyIndex() const = 0;
       virtual TBool SetValuesToNewEntry( const TDesC& aName,
                        const TDateTime& aDate,
                        const TBool& aAlarm,
                        const TDateTime& aAlarmTime,
                        const TInt& aSynchronizationMethod) = 0; 
       virtual void GetValuesToSet(TDes& aName, TTime& aDate,
                       TBool& aAlarm, TTime& aAlarmTime,
                                TInt& aSync) = 0 ;
    
    };

// CLASS DECLARATION

class CCalendarAPIexampleEngine :   public CBase,
                                    public MCalProgressCallBack,
                                    public MCalendarEngineCommandsInterface
{
public: // Constructors and destructor

    static CCalendarAPIexampleEngine* NewL(MCalenderEngineObserverUI& aAppUi);

    virtual ~CCalendarAPIexampleEngine();

public: // Other functions
    
    void AddAnniversaryL(   CCalEntry* aAnniv) ;

    void UpdateAnniversaryL(CCalEntry* aAnniv) ;

    void DeleteAnniversaryL(CCalEntry* aAnniv) ;

    void GetAnniversariesL( const TDateTime& aFrom, 
                            const TDateTime& aTo,                           
                            RPointerArray<CCalInstance>& aAnniversaries);

    TInt EntryCount() const;

    CCalHelperEntry& Entry(const TInt& aIndex);
    
    void DoSearchL( const TSearchType& aType);
    
    void DoAddL();                     
    
    TInt ModifyIndex() const;
    
    void SetModifyIndex(const TInt& aIndex);
    
    void CreateEntryForModificationL(TBool& aModify);
    
    void SaveL();
    
    void DoSaveL();
    
    void DeleteEntryL(const TInt& aIndex);
    
    TBool SetValuesToNewEntry( const TDesC& aName,
                        const TDateTime& aDate,
                        const TBool& aAlarm,
                        const TDateTime& aAlarmTime,
                        const TInt& aSynchronizationMethod);
                        
    void GetValuesToSet(TDes& aName, TTime& aDate,
                   TBool& aAlarm, TTime& aAlarmTime,
                            TInt& aSync);   
                        
    void ExecuteDeletionL();
    
private:
    CCalendarAPIexampleEngine(MCalenderEngineObserverUI& aAppUi);
    void ConstructL();  
    
    virtual void Progress(TInt aPercentageCompleted);
    
    virtual void Completed(TInt aError);
    
    virtual TBool NotifyProgress(); 
    
private: // Data members

    CActiveSchedulerWait* iWait;
    CCalSession* iCalSession;
    CCalEntryView* iEntryView;
    CCalInstanceView* iInstanceView;
    TBool iCreatingEntryView;
    CAknProgressDialog* iProgressDialog;
    CEikProgressInfo* iProgressInfo;
    
    // Here are all CCalEntrys hold inside CCalHelperEntry
    // the results are put here in DoSearchL
    RPointerArray<CCalHelperEntry> iEntries;
    
    TSearchType iCurrentSearchType;
    
    //Used in creating new entries. Created in CreateEntryForModificationL
    CCalHelperEntry* iEntry;
    
    //Used in knowing which CCalEntry we're modifying
    TInt iModifyIndex;
    
    //A reference to appui, used in updating views.
    MCalenderEngineObserverUI& iAppUi;
    
    };

#endif

---