web_pub/favourites_engine_api/inc/FavouritesDbNotifier.h
changeset 0 dd21522fd290
child 25 0ed94ceaa377
equal deleted inserted replaced
-1:000000000000 0:dd21522fd290
       
     1 /*
       
     2 * Copyright (c) 2004 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 the License "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:  Declaration of FavouritesDbNotifier
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef FAVOURITES_DB_NOTIFIER_H
       
    20 #define FAVOURITES_DB_NOTIFIER_H
       
    21 
       
    22 //  INCLUDES
       
    23 
       
    24 #include <FavouritesHandle.h>
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 
       
    28 class RFavouritesDb;
       
    29 
       
    30 // CLASS DECLARATION
       
    31 
       
    32 /**
       
    33 * RFavouritesDbNotifier is the Favourites database change notifier 
       
    34 * for the Favourites Engine. It provides notification of database changes.
       
    35 */
       
    36 class RFavouritesDbNotifier: public RFavouritesHandle
       
    37     {
       
    38     public:     // update
       
    39 
       
    40         /**
       
    41         * Open the notifier.
       
    42         * @since 0.9 
       
    43         * @param aDb The database to be watched.
       
    44         * @return Error code.
       
    45         */
       
    46         IMPORT_C TInt Open( RFavouritesDb& aDb );
       
    47 
       
    48         /**
       
    49         * Request notification about all database events.
       
    50         * @since 0.9 
       
    51         * @param aStatus Request status.
       
    52         * @return void 
       
    53         */
       
    54         IMPORT_C void NotifyAllEvents( TRequestStatus& aStatus );
       
    55 
       
    56         /**
       
    57         * Request notification about database changes.
       
    58         * @since 0.9 
       
    59         * @param aStatus Request status.
       
    60         * @return void
       
    61         */
       
    62         IMPORT_C void NotifyChange( TRequestStatus& aStatus );
       
    63 
       
    64         /**
       
    65         * Cancel the outstanding request (if any).
       
    66         * @since 0.9 
       
    67         * @return void
       
    68         */
       
    69         IMPORT_C void Cancel();
       
    70 
       
    71     };
       
    72 
       
    73 #endif
       
    74             
       
    75 // End of File