1 /*

     2 * Copyright (c) 2005 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:  Watcher list

    15 *

    16 */

    17 

    18 #ifndef __CPENGWATCHERLIST_H__

    19 #define __CPENGWATCHERLIST_H__

    20 

    21 //  INCLUDES

    22 #include   "CPEngContactListModBase.h"

    23 #include <e32base.h>

    24 

    25 

    26 /**

    27  * Watcher list,

    28  * Implements watcher list specific function of the const lists model

    29  * All editing function from the Contact list model are

    30  * implemented again and leaves with KErrNotSupported

    31  *

    32  * @lib PEngListLib2

    33  * @since 3.0

    34  */

    35 NONSHARABLE_CLASS( CPEngWatcherList ) : public CPEngContactListModBase

    36     {

    37 

    38 public: // Constructors, destructor

    39 

    40     /**

    41      * Two-phased constructor.

    42      */

    43     static CPEngWatcherList* NewLC(

    44         CPEngContactListSettings& aListSetting,

    45         MPEngStorageManager& aStorageManager,

    46         MPEngContactListSettingsManager& aCntLstSettingsManager );

    47 

    48 

    49     /**

    50      * Destructor

    51      */

    52     ~CPEngWatcherList();

    53 

    54 public: // Functions from MPEngContactList2

    55 

    56     /**

    57      * Inserts a Contact into the Contact list.

    58      * @see <MPEngContactList2>

    59      */

    60     TInt AddContactL( const TDesC& aContact,

    61                       const TDesC& aNickName = KNullDesC );

    62 

    63 

    64     /**

    65      * Removes Contact from the Contact list

    66      * @see <MPEngContactList2>

    67      */

    68     void RemoveContactL( const TDesC& aContact );

    69 

    70 

    71     /**

    72      * Remove all contacts from the contact list

    73      * @see <MPEngContactList2>

    74      */

    75     void RemoveAllContactsL( );

    76 

    77 

    78     /**

    79      * Roll back all changes

    80      * @see <MPEngContactList2>

    81      */

    82     TInt RollBackAllChangesL();

    83 

    84 

    85 public: // Functions from MPresenceStoreEntry

    86 

    87     /**

    88      * Storage Id

    89      * @see <MPEngStoreEntry.h>

    90      */

    91     virtual const TDesC& StorageId( ) const;

    92 

    93 

    94 private: // Constructors

    95 

    96     /**

    97      * C++ constructor.

    98      * @param aStorageManager A reference to StorageManager instance to use.

    99      */

   100     CPEngWatcherList( CPEngContactListSettings& aListSetting,

   101                       MPEngContactListSettingsManager& aCntLstSettingsManager );

   102 

   103     /**

   104      * By default Symbian constructor is private.

   105      */

   106     void ConstructL( MPEngStorageManager& aStorageManager );

   107     };

   108 

   109 #endif      //  __CPENGWATCHERLIST_H__

   110 

   111 

   112 //  End of File

   113 

   114 

   115 

   116 

   117 

   118 

   119 

   120 

   121 

   122 

   123 

   124 

   125 

   126 

   127 

   128 

   129 

   130 

   131 

   132 

   133 

   134