epoc32/include/app/MVPbkContactFindObserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2002-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:  Virtual Phonebook observer interface for find operation.
    15 *
    16 */
    17 
    18 
    19 #ifndef MVPBKCONTACTFINDOBSERVER_H
    20 #define MVPBKCONTACTFINDOBSERVER_H
    21 
    22 // INCLUDE FILES
    23 #include <e32cmn.h>
    24 #include <e32base.h>
    25 // included here, instead of forward declared, so that clients
    26 // don't delete an incomplete class.
    27 #include <mvpbkcontactlinkarray.h>
    28 
    29 
    30 /**
    31  * Virtual Phonebook Find observer.
    32  * This interface is used to signal find clients of the operation 
    33  * progress and give the find results to the client.
    34  */
    35 class MVPbkContactFindObserver
    36     {
    37     public: // Interface
    38         /**
    39          * Called when find is complete. Caller takes ownership of the results
    40          * In case of an error during find, the aResults may contain only 
    41          * partial results of the find
    42          *
    43          * @param aResults Array of contact links that matched the find
    44          *                 Callee must take ownership of this object in
    45          *                 the start of the function, ie. in case the 
    46          *                 function leaves the results must be destroyed. 
    47          *                 The find operation can be destroyed at the end 
    48          *                  of this callback.
    49          */
    50         virtual void FindCompleteL( MVPbkContactLinkArray* aResults ) = 0;
    51 
    52         /**
    53          * Called in case the find fails for some reason. The find operation
    54          * can be destroyed at the end of this callback.
    55          * 
    56          * @param aError One of the system wide error codes.
    57          *        KErrNotReady if store is not ready (not open or unavailable)
    58          */
    59         virtual void FindFailed( TInt aError ) = 0;
    60 
    61         /**
    62          * Returns an extension point for this interface or NULL.
    63          * @param aExtensionUid Uid of extension.
    64          * @return Extension point or NULL.
    65          */
    66         virtual TAny* ContactFindObserverExtension( 
    67                 TUid /*aExtensionUid*/ ) { return NULL; }
    68 
    69     protected:  // Destructor
    70         /**
    71          * Destructor.
    72          */
    73         virtual ~MVPbkContactFindObserver() { }
    74 
    75 	};
    76 
    77 #endif // MVPBKCONTACTFINDOBSERVER_H
    78 
    79 // End of File