1 /*

     2 * Copyright (c) 2002-2007 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:  Virtual Phonebook interface for contact groups.

    15 *

    16 */

    17 

    18 

    19 #ifndef MVPBKCONTACTGROUP_H

    20 #define MVPBKCONTACTGROUP_H

    21 

    22 

    23 // INCLUDES

    24 #include <e32base.h>

    25 #include <MVPbkStoreContact.h>

    26 #include <MVPbkStoreContact2.h>

    27 

    28 // FORWARD DECLARATIONS

    29 class MVPbkContactLinkArray;

    30 

    31 

    32 // CLASS DECLARATIONS

    33 

    34 /**

    35  * An interface for Virtual Phonebook contact groups.

    36  * This interface can be used to manipulate contact groups.

    37  *

    38  * @see MVPbkContactStore

    39  */

    40 class MVPbkContactGroup : public MVPbkStoreContact,

    41                           public MVPbkStoreContact2

    42     {

    43     public:  // Destructor

    44         /**

    45          * Destructor.

    46          */

    47         virtual ~MVPbkContactGroup() { }

    48 

    49     public:  // Interface

    50         /**

    51          * Sets the group label.

    52          * @param aLabel    New label to set for the group.

    53          */

    54         virtual void SetGroupLabelL(const TDesC& aLabel) =0;

    55         

    56         /**

    57          * Returns the group label.

    58          * @return The group label.

    59          */

    60         virtual TPtrC GroupLabel() const =0;

    61         

    62         /**

    63          * Adds new contact to this group.

    64          *

    65          * @param aContact  Contact to add to this group.

    66          */

    67         virtual void AddContactL(const MVPbkContactLink& aContactLink) =0;

    68         

    69         /**

    70          * Removes a contact from this group.

    71          *

    72          * @param aContact  Contact to remove from this group.

    73          */

    74         virtual void RemoveContactL(const MVPbkContactLink& aContactLink) =0;

    75         

    76         /**

    77          * Returns links to the items in this group.

    78          * @return Links to the items in this group.

    79          */

    80         virtual MVPbkContactLinkArray* ItemsContainedLC() const =0;

    81         

    82         /**

    83          * Returns an extension point for this interface or NULL.

    84          * @param aExtensionUid Uid of extension.

    85          * @return Extension point or NULL.

    86          */

    87         virtual TAny* ContactGroupExtension(

    88                 TUid /*aExtensionUid*/) { return NULL; }

    89     };

    90 

    91 #endif  // MVPBKCONTACTGROUP_H

    92 

    93 // End of File