epoc32/include/app/MVPbkContactStoreListObserver.h
branchSymbian3
changeset 4 837f303aceeb
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
       
     1 /*
       
     2 * Copyright (c) 2004-2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  An observer interface for observing events related
       
    15 *                to a list of contact stores
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef MVPBKCONTACTSTORELISTOBSERVER_H
       
    21 #define MVPBKCONTACTSTORELISTOBSERVER_H
       
    22 
       
    23 
       
    24 // INCLUDES
       
    25 #include <mvpbkcontactstoreobserver.h>
       
    26 
       
    27 // CLASS DECLARATIONS
       
    28 
       
    29 /**
       
    30  * An observer interface for observing events from a list of contact stores.
       
    31  *
       
    32  * The interface is implemented by the client who is opening a list of stores.
       
    33  *
       
    34  * @see MVPbkContactStoreList
       
    35  */
       
    36 class MVPbkContactStoreListObserver : public MVPbkContactStoreObserver
       
    37     {
       
    38     public:  // New functions
       
    39         /**
       
    40          * Called when the opening process is complete. 
       
    41          *
       
    42          * Before this all stores have sent StoreReady or StoreUnavailable 
       
    43          * event. The client can not trust that all stores are available
       
    44          * for use when this is called.
       
    45          */
       
    46         virtual void OpenComplete() =0;
       
    47         
       
    48         /**
       
    49          * Returns an extension point for this interface or NULL.
       
    50          *
       
    51          * @param aExtensionUid no extensions defined currently.
       
    52          * @return an extension point for this interface or NULL.
       
    53          */
       
    54         virtual TAny* ContactStoreListObserverExtension(TUid /*aExtensionUid*/)
       
    55                 { return NULL; }
       
    56 
       
    57     protected:  // Destructor
       
    58         virtual ~MVPbkContactStoreListObserver() { }
       
    59 
       
    60     };
       
    61 
       
    62 
       
    63 #endif  // MVPBKCONTACTSTORELISTOBSERVER_H
       
    64 
       
    65 //End of file