pimappservices/calendar/inc/calcalendariterator.h
changeset 0 f979ecb2b13e
equal deleted inserted replaced
-1:000000000000 0:f979ecb2b13e
       
     1 // Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef __CALCALENDARINFOITERATOR_H__
       
    17 #define __CALCALENDARINFOITERATOR_H__
       
    18 
       
    19 #include <e32base.h>
       
    20 
       
    21 class CCalSession;
       
    22 class CCalCalendarInfo;
       
    23 class CCalCalendarIteratorImpl;
       
    24 
       
    25 /** 
       
    26 An iterator for iterating though all calendar file metadata.
       
    27 
       
    28 The iterator returns CCalCalendarInfo objects for calendar files that 
       
    29 have metadata set. The iterator is unordered.
       
    30 
       
    31 The iterator implementation will cache filenames on the client side
       
    32 
       
    33 @publishedAll
       
    34 @released
       
    35 */
       
    36 NONSHARABLE_CLASS(CCalCalendarIterator) : public CBase
       
    37     {
       
    38 public:
       
    39     IMPORT_C static CCalCalendarIterator* NewL(CCalSession& aSession);
       
    40     IMPORT_C ~CCalCalendarIterator();
       
    41     
       
    42     IMPORT_C CCalCalendarInfo* FirstL(); 
       
    43     IMPORT_C CCalCalendarInfo* NextL();
       
    44     IMPORT_C CCalCalendarInfo* CurrentL();
       
    45     
       
    46     IMPORT_C TInt Count() const;
       
    47 
       
    48 private:
       
    49     CCalCalendarIterator();
       
    50     void ConstructL(CCalSession& aSession);
       
    51     
       
    52 private:
       
    53     CCalCalendarIteratorImpl* iImpl; 
       
    54     };
       
    55 
       
    56 #endif