1 /*

     2  * Copyright (c) 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:  Presents publisher info

    15  *

    16  */

    17 

    18 #ifndef PUBLISHERINFO_H

    19 #define PUBLISHERINFO_H

    20 

    21 #include <e32base.h>

    22 

    23 namespace cpswrapper

    24     {

    25     /**

    26      * Content publishing service wrapper namespace

    27      */

    28 

    29     /**

    30      *  Presents publisher info

    31      *

    32      *

    33      *  @code

    34      *

    35      *  @endcode

    36      *

    37      *  @lib cpswrapper.lib

    38      *  @since S60 v5.0

    39      */

    40     NONSHARABLE_CLASS( CPublisherInfo ) : public CBase

    41         {

    42     public:

    43         /**

    44          * Two-phased constructor.

    45          */

    46         IMPORT_C static CPublisherInfo* NewL();

    47         IMPORT_C static CPublisherInfo* NewLC();

    48 

    49         /**

    50          * Destructor.

    51          */

    52         IMPORT_C ~CPublisherInfo();

    53 

    54     protected:

    55         // constructors

    56         CPublisherInfo();

    57 

    58         void ConstructL();

    59 

    60     public:

    61         // new functions

    62 

    63         /**

    64          * Set content id

    65          *

    66          * @param aContentId content id

    67          */

    68         IMPORT_C void SetContentIdL( const TDesC& aContentId );

    69 

    70         /**

    71          * Get content id

    72          *

    73          * @return content id or KNullDesC8

    74          */

    75         IMPORT_C const TDesC& ContentId() const;

    76 

    77         /**

    78          * Set publisher id

    79          *

    80          * @param aPublisherId publisher id

    81          */

    82         IMPORT_C void SetPublisherIdL( const TDesC& aPublisherId );

    83 

    84         /**

    85          * Get Publisher id

    86          *

    87          * @return Publisher id or KNullDesC8

    88          */

    89         IMPORT_C const TDesC& PublisherId() const;

    90 

    91         /**

    92          * Set Widget name

    93          *

    94          * @param aWidgetName widget name

    95          */

    96         IMPORT_C void SetWidgetNameL( const TDesC& aWidgetName );

    97 

    98         /**

    99          * Get Widget name

   100          *

   101          * @return widget name or KNullDesC8

   102          */

   103         IMPORT_C const TDesC& WidgetName() const;

   104 

   105         /**

   106          * Set content type

   107          *

   108          * @param aContentType content type

   109          */

   110         IMPORT_C void SetContentTypeL( const TDesC& aContentType );

   111 

   112         /**

   113          * Get Content type

   114          *

   115          * @return Content type or KNullDesC8

   116          */

   117         IMPORT_C const TDesC& ContentType() const;

   118 

   119         /**

   120          * Set Template type

   121          *

   122          * @param aTemplateType template type

   123          */

   124         IMPORT_C void SetTemplateTypeL( const TDesC& aTemplateType );

   125 

   126         /**

   127          * Get Template type

   128          *

   129          * @return Template type or KNullDesC

   130          */

   131         IMPORT_C const TDesC& TemplateType() const;

   132 

   133         /**

   134          * Set Logo icon

   135          *

   136          * @param aLogoIcon logo icon

   137          */

   138         IMPORT_C void SetLogoIconL( const TDesC& aLogoIcon );

   139 

   140         /**

   141          * Get Logo icon

   142          *

   143          * @return LogoIcon logo icon or KNullDesC

   144          */

   145         IMPORT_C const TDesC& LogoIcon() const;

   146 

   147         /**

   148          * Set widget description

   149          *

   150          * @param aDescription widget description

   151          */

   152         IMPORT_C void SetDescriptionL( const TDesC& aDescription );

   153 

   154         /**

   155          * Get widget description

   156          *

   157          * @return Description widget description or KNullDesC

   158          */

   159         IMPORT_C const TDesC& Description() const;

   160         

   161         /**

   162          * Set Maximum number of widgets

   163          *

   164          * @param aMaxWidget maximum number of widgets

   165          */

   166         IMPORT_C void SetMaxWidgets( const TInt32& aMaxWidget );

   167 

   168         /**

   169          * Get Maximum number of widgets

   170          *

   171          * @return number of widgets or defaule value 1

   172          */

   173         IMPORT_C const TInt32& MaxWidgets() const;

   174 

   175     private:

   176         // data

   177         // Content id, owned

   178         HBufC* iContentId;

   179         // Publisher id, owned

   180         HBufC* iPublisherId;

   181         // Publisher name, owned

   182         HBufC* iWidgetName;

   183         // Content type, owned

   184         HBufC* iContentType;

   185         // Template type, owned

   186         HBufC* iTemplateType;

   187         // Logo icon, owned

   188         HBufC* iLogoIcon;

   189         // Widget description, owned

   190         HBufC* iDescription;

   191         // Maximum instances

   192         TInt32 iMaxInst;

   193         };

   194     }

   195 

   196 #endif // PUBLISHERINFO_H

   197 // End of file