1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkContactGroup.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,93 @@
     1.4 +/*
     1.5 +* Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  Virtual Phonebook interface for contact groups.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef MVPBKCONTACTGROUP_H
    1.23 +#define MVPBKCONTACTGROUP_H
    1.24 +
    1.25 +
    1.26 +// INCLUDES
    1.27 +#include <e32base.h>
    1.28 +#include <mvpbkstorecontact.h>
    1.29 +#include <mvpbkstorecontact2.h>
    1.30 +
    1.31 +// FORWARD DECLARATIONS
    1.32 +class MVPbkContactLinkArray;
    1.33 +
    1.34 +
    1.35 +// CLASS DECLARATIONS
    1.36 +
    1.37 +/**
    1.38 + * An interface for Virtual Phonebook contact groups.
    1.39 + * This interface can be used to manipulate contact groups.
    1.40 + *
    1.41 + * @see MVPbkContactStore
    1.42 + */
    1.43 +class MVPbkContactGroup : public MVPbkStoreContact,
    1.44 +                          public MVPbkStoreContact2
    1.45 +    {
    1.46 +    public:  // Destructor
    1.47 +        /**
    1.48 +         * Destructor.
    1.49 +         */
    1.50 +        virtual ~MVPbkContactGroup() { }
    1.51 +
    1.52 +    public:  // Interface
    1.53 +        /**
    1.54 +         * Sets the group label.
    1.55 +         * @param aLabel    New label to set for the group.
    1.56 +         */
    1.57 +        virtual void SetGroupLabelL(const TDesC& aLabel) =0;
    1.58 +        
    1.59 +        /**
    1.60 +         * Returns the group label.
    1.61 +         * @return The group label.
    1.62 +         */
    1.63 +        virtual TPtrC GroupLabel() const =0;
    1.64 +        
    1.65 +        /**
    1.66 +         * Adds new contact to this group.
    1.67 +         *
    1.68 +         * @param aContact  Contact to add to this group.
    1.69 +         */
    1.70 +        virtual void AddContactL(const MVPbkContactLink& aContactLink) =0;
    1.71 +        
    1.72 +        /**
    1.73 +         * Removes a contact from this group.
    1.74 +         *
    1.75 +         * @param aContact  Contact to remove from this group.
    1.76 +         */
    1.77 +        virtual void RemoveContactL(const MVPbkContactLink& aContactLink) =0;
    1.78 +        
    1.79 +        /**
    1.80 +         * Returns links to the items in this group.
    1.81 +         * @return Links to the items in this group.
    1.82 +         */
    1.83 +        virtual MVPbkContactLinkArray* ItemsContainedLC() const =0;
    1.84 +        
    1.85 +        /**
    1.86 +         * Returns an extension point for this interface or NULL.
    1.87 +         * @param aExtensionUid Uid of extension.
    1.88 +         * @return Extension point or NULL.
    1.89 +         */
    1.90 +        virtual TAny* ContactGroupExtension(
    1.91 +                TUid /*aExtensionUid*/) { return NULL; }
    1.92 +    };
    1.93 +
    1.94 +#endif  // MVPBKCONTACTGROUP_H
    1.95 +
    1.96 +// End of File