1 /*

     2 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Declarition of CAcpProvider

    15 *

    16 */

    17 

    18  

    19 #ifndef ACPPROVIDER_H

    20 #define ACPPROVIDER_H

    21 

    22 #include <e32base.h>

    23 

    24 class CGulIcon;

    25 class CFbsBitmap;

    26 

    27 /**

    28  *  CAcpProvider class

    29  *  Declarition of CAcpProvider.

    30  *

    31  *  @lib accountcreationplugin.lib

    32  *  @since S60 v3.2

    33  */

    34 class CAcpProvider : public CBase

    35     {

    36 public: 

    37 

    38     static CAcpProvider* NewL();

    39     static CAcpProvider* NewLC();

    40     virtual ~CAcpProvider();

    41 

    42     /**

    43      * Copies provider data from given parameter to member data.

    44      *

    45      * @since S60 v3.2

    46      * @param aProvider for provider to be copies

    47      */ 

    48     void CopyL( const CAcpProvider& aProvider );

    49 

    50     /**

    51      * Returns name of the provider.

    52      *

    53      * @since S60 v3.2

    54      * @return name of the provider

    55      */ 

    56     TPtrC ProviderName() const;

    57 

    58     /**

    59      * Sets name of the provider.

    60      *

    61      * @since S60 v3.2

    62      * @param aProviderName for provider name

    63      */ 

    64     void SetProviderNameL( const TDesC& aProviderName );

    65 

    66     /**

    67      * Returns the location of icons.

    68      *

    69      * @since S60 v3.2

    70      * @return location of icons

    71      */ 

    72     TPtrC8 IconUrl() const;

    73 

    74     /**

    75      * Sets the location of icons.

    76      *

    77      * @since S60 v3.2

    78      * @param aIconUrl for location of icons

    79      */ 

    80     void SetIconUrlL( const TDesC8& aIconUrl );

    81 

    82     /**

    83      * Returns priority of the provider.

    84      *

    85      * @since S60 v3.2

    86      * @return priority of the provider

    87      */ 

    88     TInt Priority() const;

    89 

    90     /**

    91      * Sets priority of the provider.

    92      *

    93      * @since S60 v3.2

    94      * @param aPriority for provider

    95      */ 

    96     void SetPriority( TInt aPriority );

    97 

    98     /**

    99      * Returns the location of SIS file.

   100      *

   101      * @since S60 v3.2

   102      * @return location of SIS file

   103      */ 

   104     TPtrC8 SisUrl() const;

   105 

   106     /**

   107      * Sets the location of SIS file.

   108      *

   109      * @since S60 v3.2

   110      * @param aSisUrl for location of SIS file

   111      */ 

   112     void SetSisUrlL( const TDesC8& aSisUrl );

   113 

   114     /**

   115      * Returns the location of creation URL.

   116      *

   117      * @since S60 v3.2

   118      * @return location of creation URL

   119      */ 

   120     TPtrC8 CreationUrl() const;

   121 

   122     /**

   123      * Sets the location of creation URL.

   124      *

   125      * @since S60 v3.2

   126      * @param aSisUrl for location of creation URL

   127      */ 

   128     void SetCreationUrlL( const TDesC8& aCreationUrl );

   129 

   130     /**

   131      * Returns the location of activation URL.

   132      *

   133      * @since S60 v3.2

   134      * @return location of activation URL

   135      */ 

   136     TPtrC8 ActivationUrl() const;

   137 

   138     /**

   139      * Sets the location of activation URL.

   140      *

   141      * @since S60 v3.2

   142      * @param aSisUrl for location of activation URL

   143      */ 

   144     void SetActivationUrlL( const TDesC8& aActivationUrl );

   145 

   146     /**

   147      * Returns the content type of image file.

   148      *

   149      * @since S60 v3.2

   150      * @return mime type of image file.

   151      */ 

   152     TPtrC8 ContentData() const;

   153 

   154     /**

   155      * Sets the content type of image file.

   156      *

   157      * @since S60 v3.2

   158      * @param aContentData for type of image file

   159      */ 

   160     void SetContentDataL( const TDesC8& aContentData );

   161 

   162     /**

   163      * Returns the provider type

   164      *

   165      * @since S60 v3.2

   166      * @return type of the provider

   167      */ 

   168     TPtrC ProviderType() const;

   169 

   170     /**

   171      * Sets type of the provider

   172      *

   173      * @since S60 v3.2

   174      * @param aProviderType for provider type

   175      */ 

   176     void SetProviderTypeL( const TDesC& aProviderType );        

   177 

   178     /**

   179      * Returns the provider description

   180      *

   181      * @since S60 v3.2

   182      * @return description of the provider

   183      */ 

   184     TPtrC ProviderDescription() const;

   185 

   186     /**

   187      * Sets the description of the provider

   188      *

   189      * @since S60 v3.2

   190      * @param aProviderDescription for provider description

   191      */ 

   192     void SetProviderDescriptionL( const TDesC& aProviderDescription );        

   193 

   194     /**

   195      * Sets bitmap and mask for provider

   196      *

   197      * @since S60 v3.2

   198      * @param aBitmap Bitmap.

   199      * @param aMask Mask.

   200      */

   201     void SetBitmapL( CFbsBitmap* aBitmap, CFbsBitmap* aMask ); 

   202 

   203     /**

   204      * Returns bitmap

   205      *

   206      * @since S60 v3.2

   207      * @param aBitmap Gets a pointer to the bitmap.

   208      * @param aMask Gets a pointer to the mask.

   209      */

   210     void GetBitmaps( CFbsBitmap*& aBitmap, CFbsBitmap*& aMask );

   211 

   212 private: // Constructor

   213 

   214     CAcpProvider();

   215 

   216 private: // data

   217 

   218     /**

   219      * Provider name.

   220      * Own.

   221      */

   222     HBufC* iProviderName;

   223 

   224     /**

   225      * Location of the provider specific icon.

   226      * Own.

   227      */

   228     HBufC8* iIconUrl;

   229 

   230     /**

   231      * Priority of the provider.

   232      */

   233     TInt iPriority;

   234 

   235     /**

   236      * Location of the provider specific SIS file.

   237      * Own.

   238      */

   239     HBufC8* iSisUrl;

   240 

   241     /**

   242      * Url to be used in account creation.

   243      * Own.

   244      */

   245     HBufC8* iCreationUrl;

   246 

   247     /**

   248      * Url to be used in account activation.

   249      * Own.

   250      */

   251     HBufC8* iActivationUrl;

   252 

   253     /**

   254      * Mime type to be used when decoding image to bitmap.

   255      * Own.

   256      */

   257     HBufC8* iMimeType;

   258 

   259     /**

   260      * Provider typr.

   261      * Own.

   262      */

   263     HBufC* iProviderType;        

   264 

   265     /**

   266      * Provider description.

   267      * Own.

   268      */

   269     HBufC* iProviderDescription;        

   270 

   271     /**

   272      * Bitmap reference

   273      * Own.

   274      */

   275     CFbsBitmap* iBitmap;

   276 

   277     /**

   278      * Mask reference

   279      * Own.

   280      */

   281     CFbsBitmap* iMask;

   282     };

   283 

   284 #endif // ACPPROVIDER_H