epoc32/include/app/cpbkcontactchangenotifier.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*       Class for registering CPbkContactEngine observers.
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef __CPbkContactChangeNotifier_H__
williamr@2
    21
#define __CPbkContactChangeNotifier_H__
williamr@2
    22
williamr@2
    23
//  INCLUDES
williamr@2
    24
#include <e32base.h>  // CBase
williamr@2
    25
williamr@2
    26
// FORWARD DECLARATIONS
williamr@2
    27
class CPbkContactEngine;
williamr@2
    28
class MPbkContactDbObserver;
williamr@2
    29
williamr@2
    30
williamr@2
    31
// CLASS DECLARATION
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
 * A class used for registering as an observer for contact database
williamr@2
    35
 * change events. 
williamr@2
    36
 */
williamr@2
    37
class CPbkContactChangeNotifier : public CBase
williamr@2
    38
    {
williamr@2
    39
    public:  // Constructors and destructor
williamr@2
    40
        /**
williamr@2
    41
         * Creates a new instance of this class and registers aObserver as an
williamr@2
    42
         * observer of aEngine.
williamr@2
    43
         *
williamr@2
    44
         * @param aEngine   The observed object.
williamr@2
    45
         * @param aObserver The observer to call when database changes occur.
williamr@2
    46
         * @return  A contact change notifier instance.
williamr@2
    47
         */
williamr@2
    48
        IMPORT_C static CPbkContactChangeNotifier* NewL
williamr@2
    49
            (CPbkContactEngine& aEngine, MPbkContactDbObserver* aObserver);
williamr@2
    50
williamr@2
    51
        /**
williamr@2
    52
         * Removes the aObserver from aEngine given as paramters to NewL and
williamr@2
    53
         * destructs this object.
williamr@2
    54
         */
williamr@2
    55
        ~CPbkContactChangeNotifier();
williamr@2
    56
williamr@2
    57
    private:  // Implementation
williamr@2
    58
        CPbkContactChangeNotifier
williamr@2
    59
            (MPbkContactDbObserver* aObserver);
williamr@2
    60
        void ConstructL(CPbkContactEngine& aEngine);
williamr@2
    61
williamr@2
    62
    private:  // data
williamr@2
    63
        /// Ref: Phonebook engine
williamr@2
    64
        CPbkContactEngine* iEngine;
williamr@2
    65
        /// Ref: the observer
williamr@2
    66
        MPbkContactDbObserver* iObserver;
williamr@2
    67
    };
williamr@2
    68
williamr@2
    69
williamr@2
    70
#endif // __CPbkContactChangeNotifier_H__
williamr@2
    71
williamr@2
    72
// End of File