S60 3rd Edition API Reference: favouritesfile.h Source File

00001 /*
00002 * ==============================================================================
00003 *  Name        : FavouritesFile.h 
00004 *  Part of     : Favourites Engine
00005 *  Interface   : Favourites Engine API
00006 *  Description : Declaration of FavouritesFile
00007 *  Version     : %Version%
00008 *
00009 *  Copyright (C) 2004 Nokia Corporation.
00010 *  This material, including documentation and any related 
00011 *  computer programs, is protected by copyright controlled by 
00012 *  Nokia Corporation. All rights are reserved. Copying, 
00013 *  including reproducing, storing,  adapting or translating, any 
00014 *  or all of this material requires the prior written consent of 
00015 *  Nokia Corporation. This material also contains confidential 
00016 *  information which may not be disclosed to others without the 
00017 *  prior written consent of Nokia Corporation.
00018 *
00019 * ============================================================================
00020 */
00021 
00022 #ifndef FAVOURITES_FILE_H
00023 #define FAVOURITES_FILE_H
00024 
00025 //  INCLUDES
00026 
00027 #include <FavouritesHandle.h>
00028 
00029 // FORWARD DECLARATION
00030 
00031 class RFavouritesDb;
00032 class CFavouritesFileImpl;
00033 
00034 // CLASS DECLARATION
00035 
00041 class RFavouritesFile: public RFavouritesHandle
00042     {
00043 
00044     public:     // Constructor and destructor
00045         
00050         inline RFavouritesFile();
00051 
00057         IMPORT_C void Close();
00058 
00066         IMPORT_C TInt Open( RFavouritesDb& aDb, TInt aUid );
00067 
00076         IMPORT_C TInt Replace( RFavouritesDb& aDb, TInt aUid );
00077 
00078     public:     // new methods
00079 
00088         IMPORT_C TInt Read( TDes8& aDes ) const;
00089 
00096         IMPORT_C TInt Write( const TDesC8& aDes );
00097 
00104                 IMPORT_C TInt Size(TInt &aSize) const;
00105                 
00106     private:    // new methods
00107 
00116         TInt DoOpen( RFavouritesDb& aDb, TInt aUid, TInt aFunction );
00117 
00118     private:    // data
00119 
00120         CFavouritesFileImpl* iImpl;  
00121 
00122     };
00123 
00124 #include <FavouritesFile.inl>
00125 
00126 #endif
00127 
00128 // End of File