CFavouritesItem Class Reference

#include <mw/favouritesitem.h>

Link against: favouritesengine.lib

class CFavouritesItem : public CBase

Inherits from

CFavouritesItem
- CBase

Public Member Enumerations
enum	TType { ENone, EItem, EFolder }

Public Member Functions
virtual	~CFavouritesItem()
IMPORT_C void	ClearL()
IMPORT_C TInt32	ContextId()
void	ExternalizeL(RWriteStream &)
void	InternalizeL(RReadStream &)
IMPORT_C TBool	IsFactoryItem()
IMPORT_C TBool	IsFolder()
IMPORT_C TBool	IsHidden()
IMPORT_C TBool	IsItem()
IMPORT_C TBool	IsReadOnly()
IMPORT_C TTime	Modified()
IMPORT_C const TPtrC	Name()
IMPORT_C CFavouritesItem *	NewL()
IMPORT_C CFavouritesItem *	NewLC()
IMPORT_C TInt	ParentFolder()
IMPORT_C const TPtrC	Password()
IMPORT_C void	SetContextId(TInt32)
IMPORT_C TBool	SetHidden(TBool)
IMPORT_C void	SetNameL(const TDesC &)
IMPORT_C void	SetParentFolder(TInt)
IMPORT_C void	SetPasswordL(const TDesC &)
IMPORT_C void	SetType(TType)
IMPORT_C void	SetUrlL(const TDesC &)
IMPORT_C void	SetUserNameL(const TDesC &)
IMPORT_C void	SetWapAp(const TFavouritesWapAp &)
IMPORT_C TType	Type()
IMPORT_C TInt	Uid()
IMPORT_C const TPtrC	Url()
IMPORT_C const TPtrC	UserName()
IMPORT_C TFavouritesWapAp	WapAp()
IMPORT_C CFavouritesItem &	operator=(const CFavouritesItem &)

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()

Detailed Description

CFavouritesItem is the base class for representing one favourites entry (item or folder). Instances of this class are used to exchange data between the Favourites Engine and clients using it.

Member Enumeration Documentation

Enum TType

Type of an item (item or folder).

Defines the type of an item (item or folder).

Enumerator	Value	Description
ENone
EItem
EFolder

Constructor & Destructor Documentation

~CFavouritesItem ( )

IMPORT_C

~CFavouritesItem

(

)

[virtual]

Destructor.

Since: 0.9

Member Function Documentation

ClearL ( )

IMPORT_C void

ClearL

(

)

Reset the item to default values.

Since: 0.9

Return Value: void

ContextId ( )

IMPORT_C TInt32

ContextId

(

)

const

Get context id associated with this item.

Since: 0.9

Return Value: The context id.

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalize into a stream.

Since: 0.9

Parameters
aStream	The stream to externalize to.

Return Value: void

InternalizeL ( RReadStream & )

void

InternalizeL

(

RReadStream &

aStream

)

Internalize from a stream.

Since: 0.9

Parameters
aStream	The stream to externalize from.

Return Value: void

IsFactoryItem ( )

IMPORT_C TBool

IsFactoryItem

(

)

const

Check if this is a factory item.

Since: 0.9

Return Value: ETrue if this is a factory item.

IsFolder ( )

IMPORT_C TBool

IsFolder

(

)

const

Check if this is a folder.

Since: 0.9

Return Value: ETrue if this is a folder.

IsHidden ( )

IMPORT_C TBool

IsHidden

(

)

const

Check if this is a hidden.

Since: 0.9

Return Value: ETrue if this is hidden.

IsItem ( )

IMPORT_C TBool

IsItem

(

)

const

Check if this is an item (not folder).

Since: 0.9

Return Value: ETrue if this is an item.

IsReadOnly ( )

IMPORT_C TBool

IsReadOnly

(

)

const

Check if this is a read-only in database. Note that ETrue value does not prevent modifying this CFavouritesItem object.

Since: 0.9

Return Value: ETrue if this is read-only in database.

Modified ( )

IMPORT_C TTime

Modified

(

)

const

Get last modification time (of database entry), universal time. This can be zero if:

Last modification time is not available in database (old databases); or
Engine does not support this feature. Note that zero means Modified().Int64() == 0, and not Time::NullTTime().
Since

0.9

Return Value: TTime, last modification time

Name ( )

IMPORT_C const TPtrC

Name

(

)

const

Get the name of this item.

Since: 0.9

Return Value: The name of this item.

NewL ( )

IMPORT_C CFavouritesItem *

NewL

(

)

[static]

Two-phased constructor. Leaves on failure.

Since: 0.9

Return Value: The constructed item.

NewLC ( )

IMPORT_C CFavouritesItem *

NewLC

(

)

[static]

Two-phased constructor. Leaves on failure. Places the instance on the cleanup stack.

Since: 0.9

Return Value: The constructed item.

ParentFolder ( )

IMPORT_C TInt

ParentFolder

(

)

const

Get the uid of the parent folder of this item.

Since: 0.9

Return Value: The unique id of the parent folder.

Password ( )

IMPORT_C const TPtrC

Password

(

)

const

Get password associated with this item.

Since: 0.9

Return Value: The password.

SetContextId ( TInt32 )

IMPORT_C void

SetContextId

(

TInt32

aContextId

)

Set context id of the item.

Since: 0.9

Parameters
aContextId	The context id to be set.

Return Value: void

SetHidden ( TBool )

IMPORT_C TBool

SetHidden

(

TBool

aHidden

)

const

Set hidden value of the item.

Since: 0.9

Parameters
aHidden	The hidden value to be set.

Return Value: void

SetNameL ( const TDesC & )

IMPORT_C void

SetNameL

(

const TDesC &

aName

)

Set name of the item. Leading or trailing whitespace is trimmed. Length limit is KFavouritesMaxName (leaves with KErrOverflow).

Since: 0.9

Parameters
aName	The name to be set.

Return Value: void

SetParentFolder ( TInt )

IMPORT_C void

SetParentFolder

(

TInt

aId

)

Set parent folder.

Since: 0.9

Parameters
aId	The unique id of the parent folder.

Return Value: void

SetPasswordL ( const TDesC & )

IMPORT_C void

SetPasswordL

(

const TDesC &

aPassword

)

Set password. Length limit is KFavouritesMaxPassword (leaves with KErrOverflow).

Since: 0.9

Parameters
aPassword	The password to be set.

Return Value: void

SetType ( TType )

IMPORT_C void

SetType

(

TType

aType

)

Set item type (item or folder).

Since: 0.9

Parameters
aType	The type to be set. ENone cannot be set (if that is specified, it is ignored).

Return Value: void

SetUrlL ( const TDesC & )

IMPORT_C void

SetUrlL

(

const TDesC &

aUrl

)

Set URL of the item.

Since: 0.9 Length limit is KFavouritesMaxURL (leaves with KErrOverflow).

Parameters
aUrl	The URL to be set.

Return Value: void

SetUserNameL ( const TDesC & )

IMPORT_C void

SetUserNameL

(

const TDesC &

aUserName

)

Set username of the item. Length limit is KFavouritesMaxUserName (leaves with KErrOverflow).

Since: 0.9

Parameters
aUserName	The username to be set.

Return Value: void

SetWapAp ( const TFavouritesWapAp & )

IMPORT_C void

SetWapAp

(

const TFavouritesWapAp &

aAccessPoint

)

Set WAP Access Point of the item.

Since: 0.9

Parameters
aAccessPoint	The WAP Access point to be set.

Return Value: void

Type ( )

IMPORT_C TType

Type

(

)

const

Get type of the item (item or folder).

Since: 0.9

Return Value: The type of the item. It is either EFolder or EItem (never ENone).

Uid ( )

IMPORT_C TInt

Uid

(

)

const

Get unique id of the item.

Since: 0.9

Return Value: The unique id.

Url ( )

IMPORT_C const TPtrC

Url

(

)

const

Get the URL of this item.

Since: 0.9

Return Value: The URL of this item.

UserName ( )

IMPORT_C const TPtrC

UserName

(

)

const

Get the username associated with this item.

Since: 0.9

Return Value: The username.

WapAp ( )

IMPORT_C TFavouritesWapAp

WapAp

(

)

const

Get WAP Access Point id associated with this item.

Since: 0.9

Return Value: The WAP Access Point id.

operator= ( const CFavouritesItem & )

IMPORT_C CFavouritesItem &

operator=

(

const CFavouritesItem &

aCopyFrom

)

Assignment operator.

Since: 0.9

Parameters
aCopyFrom	Assign from this.