williamr@2: /*
williamr@2: * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description: 
williamr@2: *       Interface class declaration for Phonebook contact database observers.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef __MPbkContactDbObserver_H__
williamr@2: #define __MPbkContactDbObserver_H__
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <cntdef.h>     // cntdbobs.h requires TContactItemId from this header
williamr@2: #include <cntdbobs.h>   // MContactDbObserver
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CPbkContactEngine;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2:  * Interface class for Phonebook contact database observers.
williamr@2:  *
williamr@2:  * @see MContactDbObserver
williamr@2:  * @see CPbkContactChangeNotifier
williamr@2:  */
williamr@2: class MPbkContactDbObserver : public MContactDbObserver
williamr@2:     {
williamr@2:     protected:  // Derived class interface
williamr@2:         /**
williamr@2:          * Called by CPbkContactEngine when it receives a database 
williamr@2:          * change event. From MContactDbObserver.
williamr@2: 		 * @param aEvent The database event.
williamr@2:          */
williamr@2:         virtual void HandleDatabaseEventL(TContactDbObserverEvent aEvent) = 0;
williamr@2: 
williamr@2:         /**
williamr@2:          * Called by CPbkContactEngine after HandleDatabaseEventL has been 
williamr@2:          * called for all observers.
williamr@2:          * In other words: CPbkContactEngine calls first HandleDatabaseEventL
williamr@2:          * for all its observers and then this function again for all 
williamr@2:          * observers. You can think of it as an "all observers have seen 
williamr@2:          * aEvent" -notification. This used in Phonebook view activation for 
williamr@2:          * now. Default implementation does nothing.
williamr@2:          *
williamr@2:          * @param aEvent The database event
williamr@2:          */
williamr@2:         virtual void DatabaseEventHandledL(TContactDbObserverEvent /*aEvent*/)
williamr@2:             {
williamr@2:             // Empty default implementation
williamr@2:             }
williamr@2: 
williamr@2:         /**
williamr@2:          * Protected destructor. 
williamr@2:          * Observers are not destroyed via this interface.
williamr@2:          */
williamr@2:         virtual ~MPbkContactDbObserver() { }
williamr@2: 
williamr@2:     private:  // friend declarations
williamr@2:         /// CPbkContactEngine calls protected functions of this class.
williamr@2:         friend class CPbkContactEngine;
williamr@2:     };
williamr@2: 
williamr@2: 
williamr@2: #endif // __MPbkContactDbObserver_H__
williamr@2: 
williamr@2: // End of File