1.1 --- a/epoc32/include/mw/favouriteshandle.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/favouriteshandle.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,133 @@
     1.4 -favouriteshandle.h
     1.5 +/*
     1.6 +* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Eclipse Public License v1.0"
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Declaration of RFavouritesHandle
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef FAVOURITES_HANDLE_H
    1.24 +#define FAVOURITES_HANDLE_H
    1.25 +
    1.26 +//  INCLUDES
    1.27 +
    1.28 +#include <e32base.h>
    1.29 +#include <FavouritesSession.h>
    1.30 +
    1.31 +// CLASS DECLARATION
    1.32 +
    1.33 +/**
    1.34 +* RFavouritesHandle is the favourite object handle.
    1.35 +*/
    1.36 +class RFavouritesHandle
    1.37 +    {
    1.38 +
    1.39 +    public:     // Constructor and destructor
    1.40 +        
    1.41 +        /**
    1.42 +        * Constructor.
    1.43 +        * @since 0.9       
    1.44 +        */
    1.45 +        inline RFavouritesHandle();
    1.46 +
    1.47 +        /**
    1.48 +        * Close the object.
    1.49 +        * @since 0.9       
    1.50 +        * return void
    1.51 +        */
    1.52 +        IMPORT_C void Close();
    1.53 +
    1.54 +    public:     // New methods
    1.55 +
    1.56 +        /**
    1.57 +        * Get handle number.
    1.58 +        * @since 0.9       
    1.59 +        * @return Handle number.
    1.60 +        */
    1.61 +        inline TInt Handle() const;
    1.62 +
    1.63 +    protected:  // New methods
    1.64 +
    1.65 +        /**
    1.66 +        * Open the object.
    1.67 +        * @since 0.9       
    1.68 +        * @param aSess Session to be used.
    1.69 +        * @param aFunction Function.
    1.70 +        * @param aArgs Arguments.
    1.71 +        * @return Error code.
    1.72 +        */
    1.73 +        TInt Open
    1.74 +            (
    1.75 +            RFavouritesSession& aSess,
    1.76 +            TInt aFunction,
    1.77 +            const TIpcArgs& aArgs
    1.78 +            );
    1.79 +
    1.80 +        /**
    1.81 +        * Open this object using other object.
    1.82 +        * @since 0.9       
    1.83 +        * @param aHandle Handle used to open this object.
    1.84 +        * @param aFunction Function.
    1.85 +        * @param aArgs Arguments.
    1.86 +        * @return Error code.
    1.87 +        */
    1.88 +        TInt Open
    1.89 +            (
    1.90 +            RFavouritesHandle& aHandle,
    1.91 +            TInt aFunction,
    1.92 +            const TIpcArgs& aArgs
    1.93 +            );
    1.94 +
    1.95 +        /**
    1.96 +        * Message passing routine.
    1.97 +        * @since 0.9       
    1.98 +        * @param aFunction Function.
    1.99 +        * @param aArgs Arguments.
   1.100 +        * @param aStatus Request status.
   1.101 +        */
   1.102 +        void SendReceive
   1.103 +            (
   1.104 +            TInt aFunction,
   1.105 +            const TIpcArgs& aArgs,
   1.106 +            TRequestStatus& aStatus
   1.107 +            ) const;
   1.108 +
   1.109 +        /**
   1.110 +        * Message passing routine.
   1.111 +        * @since 0.9       
   1.112 +        * @param aFunction Function.
   1.113 +        * @param aArgs Arguments.
   1.114 +        * @return Error code.
   1.115 +        */
   1.116 +        TInt SendReceive( TInt aFunction, const TIpcArgs& aArgs ) const;
   1.117 +
   1.118 +        /**
   1.119 +        * Message passing routine.
   1.120 +        * @since 0.9       
   1.121 +        * @param aFunction Function.
   1.122 +        * @return Error code.
   1.123 +        */
   1.124 +        TInt SendReceive( TInt aFunction ) const;
   1.125 +
   1.126 +    protected:  // Data
   1.127 +
   1.128 +        RFavouritesSession iSess;   ///< Session handle.
   1.129 +        TInt iHandle;               ///< Handle number.
   1.130 +
   1.131 +    };
   1.132 +
   1.133 +#include <FavouritesHandle.inl>
   1.134 +
   1.135 +#endif
   1.136 +            
   1.137 +// End of File