epoc32/include/mw/csendingserviceinfo.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/csendingserviceinfo.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/csendingserviceinfo.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,225 @@
     1.4 -csendingserviceinfo.h
     1.5 +/*
     1.6 +* Copyright (c) 2002-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 "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:   Encapsulates the ECom plugged sending service data.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +#ifndef CSENDINGSERVICEINFO_H
    1.25 +#define CSENDINGSERVICEINFO_H
    1.26 +
    1.27 +// INCLUDES
    1.28 +#include <e32Base.h>
    1.29 +//#include <SendUi.h>     // TSendingCapabilities
    1.30 +
    1.31 +// FORWARD DECLARATIONS
    1.32 +class TSendingCapabilities;
    1.33 +class CSendingServiceInfoImpl;
    1.34 +
    1.35 +// CLASS DECLARATION
    1.36 +
    1.37 +/**
    1.38 + * Encapsulates the ECom plugged sending service data.
    1.39 + *
    1.40 + * @lib Sendui
    1.41 + * @since Series 60 3.0
    1.42 + */ 
    1.43 +class CSendingServiceInfo : public CBase
    1.44 +    {
    1.45 +    public:
    1.46 +    
    1.47 +    enum TServiceFeatures
    1.48 +        {
    1.49 +        EServiceInValid = 1,
    1.50 +        EServiceHidden = 2,
    1.51 +        EServiceCanSendDirectly = 4,
    1.52 +        ENotUsed3 = 8
    1.53 +        };
    1.54 +        
    1.55 +    public:  // Constructors and destructor
    1.56 +    
    1.57 +        /**
    1.58 +        * Two-phased constructor.
    1.59 +        * @return Pointer to object of CSendingServiceInfo.
    1.60 +        */
    1.61 +        IMPORT_C static CSendingServiceInfo* NewL();
    1.62 +        
    1.63 +        /**
    1.64 +        * Two-phased constructor.
    1.65 +        * @return Pointer to object of CSendingServiceInfo.
    1.66 +        */
    1.67 +        IMPORT_C static CSendingServiceInfo* NewLC();
    1.68 +
    1.69 +        /**
    1.70 +        * Destructor.
    1.71 +        */
    1.72 +        IMPORT_C virtual ~CSendingServiceInfo();
    1.73 +
    1.74 +    public: // New functions
    1.75 +
    1.76 +        /**
    1.77 +        * Creates a copy of CSendingServiceInfo object.
    1.78 +        * @since Series 60 3.0
    1.79 +        * @return A pointer to the new copy of the CSendingServiceInfo object.
    1.80 +        */
    1.81 +        IMPORT_C CSendingServiceInfo* CopyLC() const;
    1.82 +
    1.83 +        /**
    1.84 +        * Set service human readable name.
    1.85 +        * Service name is used in editors "To"-field.
    1.86 +        * @since Series 60 3.0
    1.87 +        * @param aServiceName Service human readable name.
    1.88 +        * @return None.
    1.89 +        */
    1.90 +        IMPORT_C void SetServiceNameL( const TDesC& aServiceName );
    1.91 +
    1.92 +        /**
    1.93 +        * Returns service human readable name.
    1.94 +        * Service name is used in editors "To"-field.
    1.95 +        * @since Series 60 3.0
    1.96 +        * @return Service human readable name.
    1.97 +        */
    1.98 +        IMPORT_C const TPtrC ServiceName() const;
    1.99 +
   1.100 +        /**
   1.101 +        * Set service human readable name for the "Send"-menu.
   1.102 +        * @since Series 60 3.0
   1.103 +        * @param aServiceMenuName Service human readable name for the
   1.104 +        *        "Send"-menu.
   1.105 +        * @return None.
   1.106 +        */
   1.107 +        IMPORT_C void SetServiceMenuNameL( const TDesC& aServiceMenuName );
   1.108 +
   1.109 +        /**
   1.110 +        * Returns service human readable name for the "Send"-menu.
   1.111 +        * @since Series 60 3.0
   1.112 +        * @return Service human readable name for the "Send"-menu.
   1.113 +        */
   1.114 +        IMPORT_C const TPtrC ServiceMenuName() const;
   1.115 +
   1.116 +        /**
   1.117 +        * Set service address.
   1.118 +        * @since Series 60 3.0
   1.119 +        * @param aServiceAddress Service address.
   1.120 +        * @return None.
   1.121 +        */
   1.122 +        IMPORT_C void SetServiceAddressL( const TDesC& aServiceAddress );
   1.123 +
   1.124 +        /**
   1.125 +        * Returns service address. 
   1.126 +        * @since Series 60 3.0
   1.127 +        * @return Service address.
   1.128 +        */
   1.129 +        IMPORT_C const TPtrC ServiceAddress() const;
   1.130 +
   1.131 +        /**
   1.132 +        * Set sending service id.
   1.133 +        * @since Series 60 3.0
   1.134 +        * @param aServiceId Service id.
   1.135 +        * @return None.
   1.136 +        */
   1.137 +        IMPORT_C void SetServiceId( TUid aServiceId );
   1.138 +
   1.139 +        /**
   1.140 +        * Returns sending service id.
   1.141 +        * @since Series 60 3.0
   1.142 +        * @return Service id.
   1.143 +        */
   1.144 +        IMPORT_C TUid ServiceId() const;
   1.145 +
   1.146 +        /**
   1.147 +        * Set sending service provider id.
   1.148 +        * @since Series 60 3.0
   1.149 +        * @param aServiceProviderId Service provider id.
   1.150 +        * @return None.
   1.151 +        */
   1.152 +        IMPORT_C void SetServiceProviderId( TUid aServiceProviderId );
   1.153 +
   1.154 +        /**
   1.155 +        * Returns sending service provider id.
   1.156 +        * @since Series 60 3.0
   1.157 +        * @return Service provider id.
   1.158 +        */
   1.159 +        IMPORT_C TUid ServiceProviderId() const;
   1.160 +
   1.161 +        
   1.162 +          /**
   1.163 +        * Returns sending service technology type id.
   1.164 +        * @since Series 60 3.2
   1.165 +        * @return Service id.
   1.166 +        */
   1.167 +        IMPORT_C void SetTechnologyTypeId( TUid aTechnologyType );
   1.168 +        /**
   1.169 +        * Returns sending service technology type id.
   1.170 +        * @since Series 60 3.2
   1.171 +        * @return Service id.
   1.172 +        */
   1.173 +        IMPORT_C TUid TechnologyTypeId() const;
   1.174 +
   1.175 +
   1.176 +        /**
   1.177 +        * Set service sending capabilities.
   1.178 +        * @since Series 60 3.0
   1.179 +        * @param aServiceCapabilities Service sending capabilities.
   1.180 +        * @return None.
   1.181 +        */
   1.182 +        IMPORT_C void SetServiceCapabilities(
   1.183 +            TSendingCapabilities aServiceCapabilities );
   1.184 +
   1.185 +        /**
   1.186 +        * Returns service sending capabilities.
   1.187 +        * @since Series 60 3.0
   1.188 +        * @return Service sending capabilities.
   1.189 +        */
   1.190 +        IMPORT_C TSendingCapabilities ServiceCapabilities() const;
   1.191 +
   1.192 +       /**
   1.193 +        * Set sending service features
   1.194 +        * @since Series 60 3.2
   1.195 +        * @param aServiceCapabilities Sending service features.
   1.196 +        * @return None.
   1.197 +        */
   1.198 +        IMPORT_C void SetServiceFeatures(
   1.199 +            TInt aServiceFeatures );
   1.200 +
   1.201 +        /**
   1.202 +        * Returns service features.
   1.203 +        * @since Series 60 3.2
   1.204 +        * @return Sending service features.
   1.205 +        */
   1.206 +        IMPORT_C TInt ServiceFeatures() const;
   1.207 +        
   1.208 +
   1.209 +    private:
   1.210 +
   1.211 +
   1.212 +        /**
   1.213 +        * C++ default constructor.
   1.214 +        */
   1.215 +        CSendingServiceInfo();
   1.216 +
   1.217 +        /**
   1.218 +        * By default Symbian 2nd phase constructor is private.
   1.219 +        */
   1.220 +        void ConstructL();
   1.221 +
   1.222 +    private:  // Data
   1.223 +
   1.224 +        CSendingServiceInfoImpl*            iServiceInfoImpl;
   1.225 +    };
   1.226 +
   1.227 +#endif      // CSENDINGSERVICEINFO_H
   1.228 +
   1.229 +// End of File