Symbian^3 Product Developer Library >

CHsContentInfo Class Reference

class CHsContentInfo : public CBase

Content data

hscontentinfo.lib
Since
S60 v5.2

Inherits from

Public Member Functions
~CHsContentInfo()
IMPORT_C TBoolCanBeAdded()
IMPORT_C TBoolCanBeRemoved()
IMPORT_C CHsContentInfo *CloneL()
IMPORT_C const TDesC &Description()
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C const TDesC &IconPath()
IMPORT_C TTimeInstallationTime()
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TBoolIsFull()
IMPORT_C TBoolIsWrt()
IMPORT_C HBufC8 *MarshalL()
IMPORT_C TIntMaxWidgets()
IMPORT_C const TDesC &Name()
IMPORT_C HBufC8 *NameAs8BitLC()
IMPORT_C CHsContentInfo *NewL()
IMPORT_C CHsContentInfo *NewL(RReadStream &)
IMPORT_C CHsContentInfo *NewLC()
IMPORT_C const TDesC8 &PluginId()
IMPORT_C const TDesC &PublisherId()
IMPORT_C const TDesC8 &PublisherUid()
IMPORT_C voidSetCanBeAdded(TBool)
IMPORT_C voidSetCanBeRemoved(TBool)
IMPORT_C voidSetDescriptionL(const TDesC &)
IMPORT_C voidSetDescriptionL(const TDesC8 &)
IMPORT_C voidSetIconPathL(const TDesC &)
IMPORT_C voidSetInstallationTime(TTime &)
IMPORT_C voidSetIsFull(TBool)
IMPORT_C voidSetIsWrt(TBool)
IMPORT_C voidSetMaxWidgets(TInt)
IMPORT_C voidSetNameL(const TDesC8 &)
IMPORT_C voidSetNameL(const TDesC &)
IMPORT_C voidSetPluginIdL(const TDesC8 &)
IMPORT_C voidSetPublisherIdL(const TDesC &)
IMPORT_C voidSetPublisherUidL(const TDesC8 &)
IMPORT_C voidSetTypeL(const TDesC8 &)
IMPORT_C voidSetUidL(const TDesC8 &)
IMPORT_C TIntSize()
IMPORT_C const TDesC8 &Type()
IMPORT_C const TDesC8 &Uid()
Private Member Functions
CHsContentInfo()
voidConstructL()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
TBool iCanBeAdded
TBool iCanBeRemoved
HBufC *iDescription
HBufC *iIconPath
TTime iInstallationTime
TBool iIsFull
TBool iIsWrt
TInt iMaxInstance
HBufC *iName
HBufC8 *iPluginId
HBufC *iPublisherId
HBufC8 *iPublisherUid
HBufC8 *iType
HBufC8 *iUid

Constructor & Destructor Documentation

CHsContentInfo()

CHsContentInfo()[private]

Constructor

~CHsContentInfo()

~CHsContentInfo()

Destructor.

Since
S60 v5.2

Member Functions Documentation

CanBeAdded()

IMPORT_C TBoolCanBeAdded()const

Queries whether this widget can be added to the active HS page

Since
S60 5.2

CanBeRemoved()

IMPORT_C TBoolCanBeRemoved()const

Queries whether this widget can be removed from the active HS page

Since
S60 5.2

CloneL()

IMPORT_C CHsContentInfo *CloneL()

Clone.

Since
S60 v5.2

ConstructL()

voidConstructL()[private]

Second phase constructor

Description()

IMPORT_C const TDesC &Description()const

Gets this widget's description

Since
S60 5.2

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)

Externalize.

Since
S60 5.2

Parameters

RWriteStream & aStreamA stream to externalize to

IconPath()

IMPORT_C const TDesC &IconPath()const

Gets this widget's icon path

Since
S60 5.2

InstallationTime()

IMPORT_C TTimeInstallationTime()const

Gets this widget's installation time

Since
S60 5.2

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalize

Since
S60 5.2

Parameters

RReadStream & aStreamA stream where the class is internalized

IsFull()

IMPORT_C TBoolIsFull()const

Returns whether an application configuration or a view is full

Since
S60 5.2

IsWrt()

IMPORT_C TBoolIsWrt()const

Returns whether this is a WRT widget

Since
S60 5.2

MarshalL()

IMPORT_C HBufC8 *MarshalL()

Marshals Content Info data to a descriptor

Since
S60 5.2

MaxWidgets()

IMPORT_C TIntMaxWidgets()const

Get Maximum number of widgets

Since
S60 5.2

Name()

IMPORT_C const TDesC &Name()const

Access to widget name.

Since
S60 5.2

NameAs8BitLC()

IMPORT_C HBufC8 *NameAs8BitLC()const

Access to widget name.

Since
S60 5.2

NewL()

IMPORT_C CHsContentInfo *NewL()[static]

Two-phased constructor.

Since
S60 v5.2

NewL(RReadStream &)

IMPORT_C CHsContentInfo *NewL(RReadStream &aStream)[static]

Two-phased constructor.

Since
S60 v5.2

Parameters

RReadStream & aStream

NewLC()

IMPORT_C CHsContentInfo *NewLC()[static]

Two-phased constructor.

Since
S60 v5.2

PluginId()

IMPORT_C const TDesC8 &PluginId()const

Access to widget plugin id.

Since
S60 5.2

PublisherId()

IMPORT_C const TDesC &PublisherId()const

Access to widget's publisher id.

Since
S60 5.2

PublisherUid()

IMPORT_C const TDesC8 &PublisherUid()const

Access to WRT widget publisher uid.

Since
S60 5.2

SetCanBeAdded(TBool)

IMPORT_C voidSetCanBeAdded(TBoolaValue)

Sets whether this widget can be added to the active HS page

Since
S60 5.2

Parameters

TBool aValueETrue if can be added, EFalse otherwise

SetCanBeRemoved(TBool)

IMPORT_C voidSetCanBeRemoved(TBoolaValue)

Sets whether this widget can be removed from the active HS page

Since
S60 5.2

Parameters

TBool aValueETrue if can be added, EFalse otherwise

SetDescriptionL(const TDesC &)

IMPORT_C voidSetDescriptionL(const TDesC &aDescription)

Sets this widget's description

Since
S60 5.2

Parameters

const TDesC & aDescriptionDescription

SetDescriptionL(const TDesC8 &)

IMPORT_C voidSetDescriptionL(const TDesC8 &aDescription)

Sets this widget's description

Since
S60 5.2

Parameters

const TDesC8 & aDescriptionDescription

SetIconPathL(const TDesC &)

IMPORT_C voidSetIconPathL(const TDesC &aIconPath)

Sets this widget's icon path

Since
S60 5.2

Parameters

const TDesC & aIconPath

SetInstallationTime(TTime &)

IMPORT_C voidSetInstallationTime(TTime &aTime)

Sets this widget's installation time

Since
S60 5.2

Parameters

TTime & aTimeInstallation time

SetIsFull(TBool)

IMPORT_C voidSetIsFull(TBoolaIsFull)

Sets whether an application confguration or a view is full

Since
S60 5.2

Parameters

TBool aIsFull

SetIsWrt(TBool)

IMPORT_C voidSetIsWrt(TBoolaIsWrt)

Sets whether this is a WRT widget

Since
S60 5.2

Parameters

TBool aIsWrt

SetMaxWidgets(TInt)

IMPORT_C voidSetMaxWidgets(TIntaMaxWidget)

Set Maximum number of widgets

Parameters

TInt aMaxWidgetmaximum number of widgets

SetNameL(const TDesC8 &)

IMPORT_C voidSetNameL(const TDesC8 &aName)

Set Widget name.

Since
S60 5.2

Parameters

const TDesC8 & aName

SetNameL(const TDesC &)

IMPORT_C voidSetNameL(const TDesC &aName)

Set Widget name.

Since
S60 5.2

Parameters

const TDesC & aName

SetPluginIdL(const TDesC8 &)

IMPORT_C voidSetPluginIdL(const TDesC8 &aId)

Set Widget plugin id.

Since
S60 5.2

Parameters

const TDesC8 & aIdDynamic id generated by hsps.

SetPublisherIdL(const TDesC &)

IMPORT_C voidSetPublisherIdL(const TDesC &aPublisherId)

Set Widget's publisher Id .

Since
S60 5.2

Parameters

const TDesC & aPublisherId

SetPublisherUidL(const TDesC8 &)

IMPORT_C voidSetPublisherUidL(const TDesC8 &aUid)

Set WRT widget publisher uid.

Since
S60 5.2

Parameters

const TDesC8 & aUidPublisher uid of the wrt widget.

SetTypeL(const TDesC8 &)

IMPORT_C voidSetTypeL(const TDesC8 &aType)

Set widget type. Possible values widget and template

Since
S60 5.2

Parameters

const TDesC8 & aTypeWidget type.

SetUidL(const TDesC8 &)

IMPORT_C voidSetUidL(const TDesC8 &aUid)

Set Widget id.

Since
S60 5.2

Parameters

const TDesC8 & aUidStatic uid of the widget.

Size()

IMPORT_C TIntSize()

Returns size of a descriptor needed to externalize the class

Since
S60 5.2

Type()

IMPORT_C const TDesC8 &Type()const

Set widget type. Possible values widget and template

Since
S60 5.2

Uid()

IMPORT_C const TDesC8 &Uid()const

Access to widget uid.

Since
S60 5.2

Member Data Documentation

TBool iCanBeAdded

TBool iCanBeAdded[private]

Flag to determine whether this widget can be added to the active HS page.

TBool iCanBeRemoved

TBool iCanBeRemoved[private]

Flag to determine whether this widget can be removed from the active HS page.

HBufC * iDescription

HBufC *iDescription[private]

Description, Owned

HBufC * iIconPath

HBufC *iIconPath[private]

Icon path, Owned

TTime iInstallationTime

TTime iInstallationTime[private]

Installation time

TBool iIsFull

TBool iIsFull[private]

Flag to indicate wheter an application configuration or a view is full

TBool iIsWrt

TBool iIsWrt[private]

Flag to indicate whether this is a WRT widget

TInt iMaxInstance

TInt iMaxInstance[private]

Max number of instances allowed

HBufC * iName

HBufC *iName[private]

Widget name, Owned

HBufC8 * iPluginId

HBufC8 *iPluginId[private]

Widget plugin id, Owned

HBufC * iPublisherId

HBufC *iPublisherId[private]

Publisher Id, Owned

HBufC8 * iPublisherUid

HBufC8 *iPublisherUid[private]

WRT Widget publisher uid, Owned

HBufC8 * iType

HBufC8 *iType[private]

Widget type, Owned

HBufC8 * iUid

HBufC8 *iUid[private]

Widget uid, Owned

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.