epoc32/include/mw/favouritesdbnotifier.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) 2004 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 "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.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:  Declaration of FavouritesDbNotifier
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef FAVOURITES_DB_NOTIFIER_H
williamr@2
    20
#define FAVOURITES_DB_NOTIFIER_H
williamr@2
    21
williamr@2
    22
//  INCLUDES
williamr@2
    23
williamr@2
    24
#include <FavouritesHandle.h>
williamr@2
    25
williamr@2
    26
// FORWARD DECLARATIONS
williamr@2
    27
williamr@2
    28
class RFavouritesDb;
williamr@2
    29
williamr@2
    30
// CLASS DECLARATION
williamr@2
    31
williamr@2
    32
/**
williamr@2
    33
* RFavouritesDbNotifier is the Favourites database change notifier 
williamr@2
    34
* for the Favourites Engine. It provides notification of database changes.
williamr@2
    35
*/
williamr@2
    36
class RFavouritesDbNotifier: public RFavouritesHandle
williamr@2
    37
    {
williamr@2
    38
    public:     // update
williamr@2
    39
williamr@2
    40
        /**
williamr@2
    41
        * Open the notifier.
williamr@2
    42
        * @since 0.9 
williamr@2
    43
        * @param aDb The database to be watched.
williamr@2
    44
        * @return Error code.
williamr@2
    45
        */
williamr@2
    46
        IMPORT_C TInt Open( RFavouritesDb& aDb );
williamr@2
    47
williamr@2
    48
        /**
williamr@2
    49
        * Request notification about all database events.
williamr@2
    50
        * @since 0.9 
williamr@2
    51
        * @param aStatus Request status.
williamr@2
    52
        * @return void 
williamr@2
    53
        */
williamr@2
    54
        IMPORT_C void NotifyAllEvents( TRequestStatus& aStatus );
williamr@2
    55
williamr@2
    56
        /**
williamr@2
    57
        * Request notification about database changes.
williamr@2
    58
        * @since 0.9 
williamr@2
    59
        * @param aStatus Request status.
williamr@2
    60
        * @return void
williamr@2
    61
        */
williamr@2
    62
        IMPORT_C void NotifyChange( TRequestStatus& aStatus );
williamr@2
    63
williamr@2
    64
        /**
williamr@2
    65
        * Cancel the outstanding request (if any).
williamr@2
    66
        * @since 0.9 
williamr@2
    67
        * @return void
williamr@2
    68
        */
williamr@2
    69
        IMPORT_C void Cancel();
williamr@2
    70
williamr@2
    71
    };
williamr@2
    72
williamr@2
    73
#endif
williamr@2
    74
            
williamr@2
    75
// End of File