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

00001 /*
00002 * ==============================================================================
00003 *  Name        : FavouritesHandle.h 
00004 *  Part of     : Favourites Engine
00005 *  Interface   : Favourites Engine API
00006 *  Description : Declaration of RFavouritesHandle
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_HANDLE_H
00023 #define FAVOURITES_HANDLE_H
00024 
00025 //  INCLUDES
00026 
00027 #include <e32base.h>
00028 #include <FavouritesSession.h>
00029 
00030 // CLASS DECLARATION
00031 
00035 class RFavouritesHandle
00036     {
00037 
00038     public:     // Constructor and destructor
00039         
00044         inline RFavouritesHandle();
00045 
00051         IMPORT_C void Close();
00052 
00053     public:     // New methods
00054 
00060         inline TInt Handle() const;
00061 
00062     protected:  // New methods
00063 
00072         TInt Open
00073             (
00074             RFavouritesSession& aSess,
00075             TInt aFunction,
00076             const TIpcArgs& aArgs
00077             );
00078 
00087         TInt Open
00088             (
00089             RFavouritesHandle& aHandle,
00090             TInt aFunction,
00091             const TIpcArgs& aArgs
00092             );
00093 
00101         void SendReceive
00102             (
00103             TInt aFunction,
00104             const TIpcArgs& aArgs,
00105             TRequestStatus& aStatus
00106             ) const;
00107 
00115         TInt SendReceive( TInt aFunction, const TIpcArgs& aArgs ) const;
00116 
00123         TInt SendReceive( TInt aFunction ) const;
00124 
00125     protected:  // Data
00126 
00127         RFavouritesSession iSess;   
00128         TInt iHandle;               
00129 
00130     };
00131 
00132 #include <FavouritesHandle.inl>
00133 
00134 #endif
00135             
00136 // End of File