williamr@4: /*
williamr@4: * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4: * All rights reserved.
williamr@4: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@4: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4: *
williamr@4: * Initial Contributors:
williamr@4: * Nokia Corporation - initial contribution.
williamr@4: *
williamr@4: * Contributors:
williamr@4: *
williamr@4: * Description:  Virtual Phonebook interface for contact groups.
williamr@4: *
williamr@4: */
williamr@4: 
williamr@4: 
williamr@4: #ifndef MVPBKCONTACTGROUP_H
williamr@4: #define MVPBKCONTACTGROUP_H
williamr@4: 
williamr@4: 
williamr@4: // INCLUDES
williamr@4: #include <e32base.h>
williamr@4: #include <mvpbkstorecontact.h>
williamr@4: #include <mvpbkstorecontact2.h>
williamr@4: 
williamr@4: // FORWARD DECLARATIONS
williamr@4: class MVPbkContactLinkArray;
williamr@4: 
williamr@4: 
williamr@4: // CLASS DECLARATIONS
williamr@4: 
williamr@4: /**
williamr@4:  * An interface for Virtual Phonebook contact groups.
williamr@4:  * This interface can be used to manipulate contact groups.
williamr@4:  *
williamr@4:  * @see MVPbkContactStore
williamr@4:  */
williamr@4: class MVPbkContactGroup : public MVPbkStoreContact,
williamr@4:                           public MVPbkStoreContact2
williamr@4:     {
williamr@4:     public:  // Destructor
williamr@4:         /**
williamr@4:          * Destructor.
williamr@4:          */
williamr@4:         virtual ~MVPbkContactGroup() { }
williamr@4: 
williamr@4:     public:  // Interface
williamr@4:         /**
williamr@4:          * Sets the group label.
williamr@4:          * @param aLabel    New label to set for the group.
williamr@4:          */
williamr@4:         virtual void SetGroupLabelL(const TDesC& aLabel) =0;
williamr@4:         
williamr@4:         /**
williamr@4:          * Returns the group label.
williamr@4:          * @return The group label.
williamr@4:          */
williamr@4:         virtual TPtrC GroupLabel() const =0;
williamr@4:         
williamr@4:         /**
williamr@4:          * Adds new contact to this group.
williamr@4:          *
williamr@4:          * @param aContact  Contact to add to this group.
williamr@4:          */
williamr@4:         virtual void AddContactL(const MVPbkContactLink& aContactLink) =0;
williamr@4:         
williamr@4:         /**
williamr@4:          * Removes a contact from this group.
williamr@4:          *
williamr@4:          * @param aContact  Contact to remove from this group.
williamr@4:          */
williamr@4:         virtual void RemoveContactL(const MVPbkContactLink& aContactLink) =0;
williamr@4:         
williamr@4:         /**
williamr@4:          * Returns links to the items in this group.
williamr@4:          * @return Links to the items in this group.
williamr@4:          */
williamr@4:         virtual MVPbkContactLinkArray* ItemsContainedLC() const =0;
williamr@4:         
williamr@4:         /**
williamr@4:          * Returns an extension point for this interface or NULL.
williamr@4:          * @param aExtensionUid Uid of extension.
williamr@4:          * @return Extension point or NULL.
williamr@4:          */
williamr@4:         virtual TAny* ContactGroupExtension(
williamr@4:                 TUid /*aExtensionUid*/) { return NULL; }
williamr@4:     };
williamr@4: 
williamr@4: #endif  // MVPBKCONTACTGROUP_H
williamr@4: 
williamr@4: // End of File