williamr@2: /*
williamr@2: * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  Declaration of RFavouritesHandle
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef FAVOURITES_HANDLE_H
williamr@2: #define FAVOURITES_HANDLE_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include <FavouritesSession.h>
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2: * RFavouritesHandle is the favourite object handle.
williamr@2: */
williamr@2: class RFavouritesHandle
williamr@2:     {
williamr@2: 
williamr@2:     public:     // Constructor and destructor
williamr@2:         
williamr@2:         /**
williamr@2:         * Constructor.
williamr@2:         * @since 0.9       
williamr@2:         */
williamr@2:         inline RFavouritesHandle();
williamr@2: 
williamr@2:         /**
williamr@2:         * Close the object.
williamr@2:         * @since 0.9       
williamr@2:         * return void
williamr@2:         */
williamr@2:         IMPORT_C void Close();
williamr@2: 
williamr@2:     public:     // New methods
williamr@2: 
williamr@2:         /**
williamr@2:         * Get handle number.
williamr@2:         * @since 0.9       
williamr@2:         * @return Handle number.
williamr@2:         */
williamr@2:         inline TInt Handle() const;
williamr@2: 
williamr@2:     protected:  // New methods
williamr@2: 
williamr@2:         /**
williamr@2:         * Open the object.
williamr@2:         * @since 0.9       
williamr@2:         * @param aSess Session to be used.
williamr@2:         * @param aFunction Function.
williamr@2:         * @param aArgs Arguments.
williamr@2:         * @return Error code.
williamr@2:         */
williamr@2:         TInt Open
williamr@2:             (
williamr@2:             RFavouritesSession& aSess,
williamr@2:             TInt aFunction,
williamr@2:             const TIpcArgs& aArgs
williamr@2:             );
williamr@2: 
williamr@2:         /**
williamr@2:         * Open this object using other object.
williamr@2:         * @since 0.9       
williamr@2:         * @param aHandle Handle used to open this object.
williamr@2:         * @param aFunction Function.
williamr@2:         * @param aArgs Arguments.
williamr@2:         * @return Error code.
williamr@2:         */
williamr@2:         TInt Open
williamr@2:             (
williamr@2:             RFavouritesHandle& aHandle,
williamr@2:             TInt aFunction,
williamr@2:             const TIpcArgs& aArgs
williamr@2:             );
williamr@2: 
williamr@2:         /**
williamr@2:         * Message passing routine.
williamr@2:         * @since 0.9       
williamr@2:         * @param aFunction Function.
williamr@2:         * @param aArgs Arguments.
williamr@2:         * @param aStatus Request status.
williamr@2:         */
williamr@2:         void SendReceive
williamr@2:             (
williamr@2:             TInt aFunction,
williamr@2:             const TIpcArgs& aArgs,
williamr@2:             TRequestStatus& aStatus
williamr@2:             ) const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Message passing routine.
williamr@2:         * @since 0.9       
williamr@2:         * @param aFunction Function.
williamr@2:         * @param aArgs Arguments.
williamr@2:         * @return Error code.
williamr@2:         */
williamr@2:         TInt SendReceive( TInt aFunction, const TIpcArgs& aArgs ) const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Message passing routine.
williamr@2:         * @since 0.9       
williamr@2:         * @param aFunction Function.
williamr@2:         * @return Error code.
williamr@2:         */
williamr@2:         TInt SendReceive( TInt aFunction ) const;
williamr@2: 
williamr@2:     protected:  // Data
williamr@2: 
williamr@2:         RFavouritesSession iSess;   ///< Session handle.
williamr@2:         TInt iHandle;               ///< Handle number.
williamr@2: 
williamr@2:     };
williamr@2: 
williamr@2: #include <FavouritesHandle.inl>
williamr@2: 
williamr@2: #endif
williamr@2:             
williamr@2: // End of File