epoc32/include/app/MVPbkContactCopyObserver.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkContactCopyObserver.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,76 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004-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 observer interface for contact copying.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef MVPBKCONTACTCOPYOBSERVER_H
    1.23 +#define MVPBKCONTACTCOPYOBSERVER_H
    1.24 +
    1.25 +// INCLUDES
    1.26 +#include <e32cmn.h>
    1.27 +#include <e32def.h>
    1.28 +
    1.29 +// FORWARD DECLARATIONS
    1.30 +class MVPbkContactOperationBase;
    1.31 +class MVPbkContactLinkArray;
    1.32 +
    1.33 +/**
    1.34 + * Virtual Phonebook contact copy observer interface.
    1.35 + * This interface is used to signal the client of the copying
    1.36 + * operations events. 
    1.37 + */
    1.38 +class MVPbkContactCopyObserver
    1.39 +    {
    1.40 +    public: // Interface
    1.41 +        /**
    1.42 +         * Called when the contact has been successfully commited or
    1.43 +         * copied. Caller takes the ownership of results.
    1.44 +         *
    1.45 +         * @param aOperation    The operation that this observer monitors.
    1.46 +         * @param aResults  An array of links to copied contacts.
    1.47 +         *                  Caller takes the ownership of the 
    1.48 +         *                  object immediately.
    1.49 +         */
    1.50 +        virtual void ContactsSaved( MVPbkContactOperationBase& aOperation,
    1.51 +            MVPbkContactLinkArray* aResults ) = 0;
    1.52 +        
    1.53 +        /**
    1.54 +         * Called when there was en error while saving contact(s).
    1.55 +         * @param aOperation    The operation that this observer monitors.
    1.56 +         * @param aError an error that occured.
    1.57 +         */
    1.58 +        virtual void ContactsSavingFailed( 
    1.59 +                MVPbkContactOperationBase& aOperation, TInt aError ) = 0;
    1.60 +
    1.61 +        /**
    1.62 +         * Returns an extension point for this interface or NULL.
    1.63 +         * @param aExtensionUid Uid of extension
    1.64 +         * @return Extension point or NULL
    1.65 +         */
    1.66 +        virtual TAny* ContactCopyObserverExtension( 
    1.67 +                TUid /*aExtensionUid*/ ) { return NULL; }
    1.68 +
    1.69 +    protected:  // Destructor
    1.70 +        /**
    1.71 +         * Destructor.
    1.72 +         */
    1.73 +        virtual ~MVPbkContactCopyObserver() { }
    1.74 +
    1.75 +    };
    1.76 +    
    1.77 +#endif // MVPBKCONTACTCOPYOBSERVER_H
    1.78 +
    1.79 +// End of File