inc/CPEngTrackedPresenceIDs2.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     1 /*
       
     2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Tracked Presence IDs.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __CPENGTRACKEDPRESENCEIDS2_H
       
    19 #define __CPENGTRACKEDPRESENCEIDS2_H
       
    20 
       
    21 
       
    22 //  INCLUDES
       
    23 #include <E32Base.h>
       
    24 
       
    25 
       
    26 //FORWARD DECLARATIONS
       
    27 class CPEngTrackedPresenceIDCollection;
       
    28 class CPEngTrackedPresenceID2;
       
    29 
       
    30 
       
    31 
       
    32 /**
       
    33  * Tracked Presence IDs.
       
    34  *
       
    35  * Presents a collection of tracked Presence IDs.
       
    36  * One tracked presence ID is presented with CPEngTrackedPresenceID2
       
    37  * interface which gives access to individual attributes tracked for
       
    38  * the presence ID.
       
    39  *
       
    40  * In case of notification, holds information of presence IDs that
       
    41  * have changed. (Changed attributes for one Presence ID can be
       
    42  * iterated from CPEngTrackedPresenceID2.)
       
    43  *
       
    44  * @lib PEngManager2.lib
       
    45  * @since 3.0
       
    46  */
       
    47 class CPEngTrackedPresenceIDs2 : public CBase
       
    48     {
       
    49         //-----------------------------------------------------------------------
       
    50     protected: /* Construction */
       
    51 
       
    52         /**
       
    53          * C++ constructor.
       
    54          */
       
    55         CPEngTrackedPresenceIDs2( CPEngTrackedPresenceIDCollection& aImp );
       
    56 
       
    57 
       
    58         /**
       
    59          * Destructor.
       
    60          */
       
    61         ~CPEngTrackedPresenceIDs2();
       
    62 
       
    63 
       
    64 
       
    65 
       
    66         //-----------------------------------------------------------------------
       
    67     public: /* Iterators for Tracked presence IDs*/
       
    68 
       
    69         /**
       
    70          * Count of tracked presence IDs.
       
    71          *
       
    72          * @since 3.0
       
    73          * @return Count of tracked presence IDs.
       
    74          */
       
    75         IMPORT_C TInt TrackedPresenceIDsCount() const;
       
    76 
       
    77 
       
    78         /**
       
    79          * Gets first tracked Presence ID.
       
    80          * Tracked Presence IDs are kept in
       
    81          * ascending key order.
       
    82          *
       
    83          * @since 3.0
       
    84          * @return First tracked Presence ID.
       
    85          * If there isn't any tracked Presence IDs,
       
    86          * returns  NULL. Object ownership stays on
       
    87          * the collection.
       
    88          */
       
    89         IMPORT_C CPEngTrackedPresenceID2* FirstTrackedPresenceID();
       
    90 
       
    91 
       
    92         /**
       
    93          * Gets next tracked Presence ID.
       
    94          *
       
    95          * @since 3.0
       
    96          * @return Next tracked Presence ID.
       
    97          * If there isn't any more tracked Presence IDs,
       
    98          * returns  NULL. Object ownership stays on
       
    99          * the collection.
       
   100          */
       
   101         IMPORT_C CPEngTrackedPresenceID2* NextTrackedPresenceID();
       
   102 
       
   103 
       
   104         /**
       
   105          * Resets the tracked Presence ID iterator to its
       
   106          * initial state, so the a subsequent call to
       
   107          * NextTrackedPresenceID() method go to the first
       
   108          * tracked item.
       
   109          */
       
   110         IMPORT_C void ResetTrackedIterator();
       
   111 
       
   112 
       
   113 
       
   114         //-----------------------------------------------------------------------
       
   115     public: /* Iterators for changed attributes */
       
   116 
       
   117 
       
   118         /**
       
   119          * Gets first changed Presence ID.
       
   120          *
       
   121          * Changed Presence IDs are kept in
       
   122          * ascending key order. Changed Presence IDs
       
   123          * are available only after presence change
       
   124          * notification.
       
   125          *
       
   126          * @since 3.0
       
   127          * @return First changed Presence ID.
       
   128          * If there isn't any changed Presence IDs,
       
   129          * returns  NULL. Object ownership stays on
       
   130          * the collection.
       
   131          */
       
   132         IMPORT_C CPEngTrackedPresenceID2* FirstChangedPresenceID();
       
   133 
       
   134 
       
   135         /**
       
   136          * Gets next changed Presence ID.
       
   137          *
       
   138          * Changed attributes are available only
       
   139          * after presence change notification.
       
   140          *
       
   141          * @since 3.0
       
   142          * @return Next changed Presence ID.
       
   143          * If there isn't any changed Presence IDs,
       
   144          * returns  NULL. Object ownership stays on
       
   145          * the collection.
       
   146          */
       
   147         IMPORT_C CPEngTrackedPresenceID2* NextChangedPresenceID();
       
   148 
       
   149 
       
   150         /**
       
   151          * Resets the changed Presence ID iterator to its
       
   152          * initial state, so the a subsequent call to
       
   153          * NextChangedPresenceID() method go to the first
       
   154          * changed item.
       
   155          *
       
   156          * @since 3.0
       
   157          */
       
   158         IMPORT_C void ResetChangedIterator();
       
   159 
       
   160 
       
   161 
       
   162         //-----------------------------------------------------------------------
       
   163     private: /* Data */
       
   164 
       
   165 
       
   166         /**
       
   167          * Implementation is friend.
       
   168          * @since 3.0
       
   169          */
       
   170         friend class CPEngTrackedPresenceIDCollection;		// CSI: 36 #
       
   171 
       
   172 
       
   173         //REF: Implementation
       
   174         CPEngTrackedPresenceIDCollection&  iImp;
       
   175 
       
   176         //OWN: Iterator index
       
   177         TInt iNextTrackedIdIx;
       
   178 
       
   179         //OWN: Iterator index
       
   180         TInt iNextChangedIdIx;
       
   181 
       
   182     };
       
   183 
       
   184 #endif      //__CPENGTRACKEDPRESENCEIDS2_H
       
   185 
       
   186 //End of file
       
   187 
       
   188 
       
   189