FCL/sf/mw/homescreensrv: comparison homescreensrv_plat/hs_content_control

equal deleted inserted replaced

-:edd621764147
+:1b207dd38b72
 /*
-* 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"
 * which accompanies this distribution, and is available
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 // Forward declarations
 /**
 *  Content data
 *
-*
+*  @lib hscontentinfo.lib
-*  @code
+*  @since S60 v5.2
-*
-*  @endcode
-*
-*  @lib hscontentcontrol.lib
-*  @since S60 v5.0
 */
 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();
 private:
 /**
 public:
 /**
 * Set Widget name.
 *
-* @since S60 5.0
+* @since S60 5.2
 * @param aName. Name of the widget.
 * @return Reference to this
 */
 IMPORT_C void SetNameL( const TDesC8& aName );
 /**
 * Set Widget name.
 *
-* @since S60 5.0
+* @since S60 5.2
 * @param aName. Name of the widget.
 * @return Reference to this
 */
 IMPORT_C void SetNameL( const TDesC& aName );
 /**
 * Set Widget's publisher Id .
 *
-* @since S60 5.0
+* @since S60 5.2
 * @param aPublisherId. Name of the publisher.
 * @return Reference to this
 */
 IMPORT_C void SetPublisherIdL( const TDesC& aPublisherId );
 /**
 * Set Widget id.
 *
-* @since S60 5.0
+* @since S60 5.2
 * @param aUid Static uid of the widget.
 * @return Reference to this
 */
 IMPORT_C void SetUidL( const TDesC8& aUid );
 /**
 * Set Widget plugin id.
 *
-* @since S60 5.0
+* @since S60 5.2
 * @param aId Dynamic id generated by hsps.
 * @return Reference to this
 */
 IMPORT_C void SetPluginIdL( const TDesC8& aId );
 /**
 * 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 );
 /**
 * Access to widget name.
 *
-* @since S60 5.0
+* @since S60 5.2
 * @return Reference to name
 */
 IMPORT_C const TDesC& Name() const;
 /**
 * 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;
 /**
 * Access to widget uid.
 *
-* @since S60 5.0
+* @since S60 5.2
 * @return Uid or KNullDesC8
 */
 IMPORT_C const TDesC8& Uid() const;
 /**
 * Access to widget name.
 *
-* @since S60 5.0
+* @since S60 5.2
 * @return Reference to name
 */
 IMPORT_C HBufC8* NameAs8BitLC() const;
 /**
 * 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;
 /**
 * 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;
 /**
 IMPORT_C void SetMaxWidgets( TInt aMaxWidget );
 /**
 * Get Maximum number of widgets
 *
+* @since S60 5.2
 * @return number of widgets or defaule value 1
 */
 IMPORT_C TInt MaxWidgets() const;
 /**
 * Externalize.
 *
+* @since S60 5.2
 * @param aStream A stream to externalize to
 */
 IMPORT_C void ExternalizeL( RWriteStream& aStream );
 /**
 * 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 );
 /**
 * 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;
 /**
 * 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 );
 /**
 * 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;
 /**
 * Sets this widget's installation time
 *
-* @since S60 5.0
+* @since S60 5.2
 * @param aTime Installation time
 */
 IMPORT_C void SetInstallationTime( TTime& aTime );
 /**
 * Gets this widget's installation time
 *
-* @since S60 5.0
+* @since S60 5.2
 * @return Installation time
 */
 IMPORT_C TTime InstallationTime() const;
 /**
 * Sets this widget's description
 *
-* @since S60 5.0
+* @since S60 5.2
 * @param aDescription Description
 */
 IMPORT_C void SetDescriptionL( const TDesC& aDescription );
 /**
 * Sets this widget's description
 *
-* @since S60 5.0
+* @since S60 5.2
 * @param aDescription Description
 */
 IMPORT_C void SetDescriptionL( const TDesC8& aDescription );
 /**
 * Gets this widget's description
 *
-* @since S60 5.0
+* @since S60 5.2
 * @return Description
 */
 IMPORT_C const TDesC& Description() const;
 /**
 * Sets this widget's icon path
 *
-* @since S60 5.0
+* @since S60 5.2
 * @param aPath Path
 */
 IMPORT_C void SetIconPathL( const TDesC& aIconPath );
 /**
 * 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
 */
 IMPORT_C void SetPublisherUidL( const TDesC8& aUid );
 /**
 * Access to WRT widget publisher uid.
 *
-* @since S60 5.0
+* @since S60 5.2
 * @return PublisherUid or KNullDesC8
 */
 IMPORT_C const TDesC8& PublisherUid() const;
 /**
 * 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 );
 /**
 * 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;
 /**
 * 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 );
 /**
 * 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
 */
 IMPORT_C TBool IsFull() const;
 /**
 * 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();
 private: // Data

branch	RCL_3
changeset 78	1b207dd38b72
parent 59	a0713522ab97