homescreensrv_plat/hs_content_control_api/inc/hscontentinfo.h
branchRCL_3
changeset 78 1b207dd38b72
parent 59 a0713522ab97
--- a/homescreensrv_plat/hs_content_control_api/inc/hscontentinfo.h	Tue May 11 16:30:05 2010 +0300
+++ b/homescreensrv_plat/hs_content_control_api/inc/hscontentinfo.h	Tue May 25 13:01:39 2010 +0300
@@ -1,5 +1,5 @@
 /*
-* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
+* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of "Eclipse Public License v1.0"
@@ -28,39 +28,44 @@
 /**
  *  Content data
  *
- *
- *  @code
- *
- *  @endcode
- *
- *  @lib hscontentcontrol.lib
- *  @since S60 v5.0
+ *  @lib hscontentinfo.lib
+ *  @since S60 v5.2
  */
 NONSHARABLE_CLASS( CHsContentInfo ) : public CBase
     {
     public:
     /**
      * Two-phased constructor.
+     *
+     * @since S60 v5.2
      */
     IMPORT_C static CHsContentInfo* NewL();
     
     /**
      * Two-phased constructor.
+     *
+     * @since S60 v5.2
      */    
     IMPORT_C static CHsContentInfo* NewL( RReadStream& aStream );
     
     /**
      * Two-phased constructor.
+     *
+     * @since S60 v5.2
      */    
     IMPORT_C static CHsContentInfo* NewLC();
     
     /**
      * Clone.
+     *
+     * @since S60 v5.2
      */
 	IMPORT_C CHsContentInfo* CloneL();
 
     /**
      * Destructor.
+     *
+     * @since S60 v5.2
      */
     ~CHsContentInfo();
 
@@ -77,7 +82,7 @@
     /**
      * Set Widget name. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aName. Name of the widget.
      * @return Reference to this
      */
@@ -86,7 +91,7 @@
     /**
      * Set Widget name. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aName. Name of the widget.
      * @return Reference to this
      */
@@ -95,7 +100,7 @@
     /**
      * Set Widget's publisher Id . 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aPublisherId. Name of the publisher.
      * @return Reference to this
      */
@@ -104,7 +109,7 @@
     /**
      * Set Widget id. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aUid Static uid of the widget.
      * @return Reference to this
      */
@@ -113,7 +118,7 @@
     /**
      * Set Widget plugin id. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aId Dynamic id generated by hsps.
      * @return Reference to this
      */
@@ -122,7 +127,7 @@
     /**
      * Set widget type. Possible values widget and template 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aType Widget type.
      */
     IMPORT_C void SetTypeL( const TDesC8& aType );
@@ -130,7 +135,7 @@
     /**
      * Access to widget name. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Reference to name
      */
     IMPORT_C const TDesC& Name() const;
@@ -138,7 +143,7 @@
     /**
      * Access to widget's publisher id. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Reference to publisher id
      */
     IMPORT_C const TDesC& PublisherId() const;
@@ -146,7 +151,7 @@
     /**
      * Access to widget uid. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Uid or KNullDesC8
      */
     IMPORT_C const TDesC8& Uid() const;
@@ -154,7 +159,7 @@
     /**
      * Access to widget name. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Reference to name
      */
     IMPORT_C HBufC8* NameAs8BitLC() const;
@@ -162,7 +167,7 @@
     /**
      * Access to widget plugin id. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Plugin id or null if not set
      */
     IMPORT_C const TDesC8& PluginId() const;
@@ -170,7 +175,7 @@
     /**
      * Set widget type. Possible values widget and template 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Type or KNullDesC8.
      */
     IMPORT_C const TDesC8& Type() const;
@@ -185,6 +190,7 @@
     /**
      * Get Maximum number of widgets
      *
+     * @since S60 5.2
      * @return number of widgets or defaule value 1
      */
     IMPORT_C TInt MaxWidgets() const;   
@@ -192,6 +198,7 @@
     /**
      * Externalize.
      *
+     * @since S60 5.2
      * @param aStream A stream to externalize to
      */
     IMPORT_C void ExternalizeL( RWriteStream& aStream );
@@ -199,7 +206,7 @@
     /**
      * Sets whether this widget can be added to the active HS page
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aValue ETrue if can be added, EFalse otherwise
      */
     IMPORT_C void SetCanBeAdded( TBool aValue );
@@ -207,7 +214,7 @@
     /**
      * Queries whether this widget can be added to the active HS page
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return ETrue if can be added, EFalse otherwise
      */    
     IMPORT_C TBool CanBeAdded() const;
@@ -215,7 +222,7 @@
     /**
      * Sets whether this widget can be removed from the active HS page
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aValue ETrue if can be added, EFalse otherwise
      */
     IMPORT_C void SetCanBeRemoved( TBool aValue );
@@ -223,7 +230,7 @@
     /**
      * Queries whether this widget can be removed from the active HS page
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return ETrue if can be removed, EFalse otherwise
      */    
     IMPORT_C TBool CanBeRemoved() const;
@@ -231,7 +238,7 @@
     /**
      * Sets this widget's installation time
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aTime Installation time
      */        
     IMPORT_C void SetInstallationTime( TTime& aTime );
@@ -239,7 +246,7 @@
     /**
      * Gets this widget's installation time
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Installation time
      */            
     IMPORT_C TTime InstallationTime() const;
@@ -247,7 +254,7 @@
     /**
      * Sets this widget's description
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aDescription Description
      */                
     IMPORT_C void SetDescriptionL( const TDesC& aDescription );
@@ -255,7 +262,7 @@
     /**
      * Sets this widget's description
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aDescription Description
      */                
     IMPORT_C void SetDescriptionL( const TDesC8& aDescription );
@@ -263,7 +270,7 @@
     /**
      * Gets this widget's description
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Description
      */                    
     IMPORT_C const TDesC& Description() const;
@@ -271,7 +278,7 @@
     /**
      * Sets this widget's icon path
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aPath Path
      */                    
     IMPORT_C void SetIconPathL( const TDesC& aIconPath );
@@ -279,30 +286,30 @@
     /**
      * Gets this widget's icon path
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Path
      */                    
     IMPORT_C const TDesC& IconPath() const;
     
     /**
      * Internalize
+     *
+     * @since S60 5.2
      * @param aStream A stream where the class is internalized
-     *
-     * @since S60 5.0
      */                    
     IMPORT_C void InternalizeL( RReadStream& aStream );    
 
     /**
      * Returns size of a descriptor needed to externalize the class
      *
-     * @since S60 5.0
+     * @since S60 5.2
      */
     IMPORT_C TInt Size();
     
     /**
      * Set WRT widget publisher uid. 
      *
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aUid Publisher uid of the wrt widget.
      * @return Reference to this
      */
@@ -311,7 +318,7 @@
     /**
      * Access to WRT widget publisher uid.
      * 
-     * @since S60 5.0
+     * @since S60 5.2
      * @return PublisherUid or KNullDesC8
      */
     IMPORT_C const TDesC8& PublisherUid() const;
@@ -319,7 +326,7 @@
     /**
      * Sets whether this is a WRT widget
      * 
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aIsWrt, ETrue if is WRT
      */    
     IMPORT_C void SetIsWrt( TBool aIsWrt );
@@ -327,7 +334,7 @@
     /**
      * Returns whether this is a WRT widget
      * 
-     * @since S60 5.0
+     * @since S60 5.2
      * @return ETrue if WRT, EFalse otherwise
      */    
     IMPORT_C TBool IsWrt() const;
@@ -335,7 +342,7 @@
     /**
      * Sets whether an application confguration or a view is full
      * 
-     * @since S60 5.0
+     * @since S60 5.2
      * @param aIsFull, ETrue if application configuration or a view is full
      */    
     IMPORT_C void SetIsFull( TBool aIsFull );
@@ -343,7 +350,7 @@
     /**
      * Returns whether an application configuration or a view is full
      * 
-     * @since S60 5.0
+     * @since S60 5.2
      * @return ETrue if application configuration or view is full, 
      *         EFalse otherwise
      */    
@@ -352,7 +359,7 @@
     /**
      * Marshals Content Info data to a descriptor
      * 
-     * @since S60 5.0
+     * @since S60 5.2
      * @return Descriptor containing the externalized Content Info data
      */
     IMPORT_C HBufC8* MarshalL();