epoc32/include/app/cpbkcontactchangenotifier.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations

/*
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: 
*       Class for registering CPbkContactEngine observers.
*
*/


#ifndef __CPbkContactChangeNotifier_H__
#define __CPbkContactChangeNotifier_H__

//  INCLUDES
#include <e32base.h>  // CBase

// FORWARD DECLARATIONS
class CPbkContactEngine;
class MPbkContactDbObserver;


// CLASS DECLARATION

/**
 * A class used for registering as an observer for contact database
 * change events. 
 */
class CPbkContactChangeNotifier : public CBase
    {
    public:  // Constructors and destructor
        /**
         * Creates a new instance of this class and registers aObserver as an
         * observer of aEngine.
         *
         * @param aEngine   The observed object.
         * @param aObserver The observer to call when database changes occur.
         * @return  A contact change notifier instance.
         */
        IMPORT_C static CPbkContactChangeNotifier* NewL
            (CPbkContactEngine& aEngine, MPbkContactDbObserver* aObserver);

        /**
         * Removes the aObserver from aEngine given as paramters to NewL and
         * destructs this object.
         */
        ~CPbkContactChangeNotifier();

    private:  // Implementation
        CPbkContactChangeNotifier
            (MPbkContactDbObserver* aObserver);
        void ConstructL(CPbkContactEngine& aEngine);

    private:  // data
        /// Ref: Phonebook engine
        CPbkContactEngine* iEngine;
        /// Ref: the observer
        MPbkContactDbObserver* iObserver;
    };


#endif // __CPbkContactChangeNotifier_H__

// End of File