Symbian^3 Application Developer Library >

CFavouritesItem Class Reference

class CFavouritesItem : public CBase

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.

Inherits from

Public Member Functions
~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 &)
Private Member Functions
CFavouritesItem ()
void ConstructL ()
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()
Public Member Enumerations
enum TType { ENone , EItem , EFolder }
Private Attributes
CFavouritesItemImpl * iImpl

Constructor & Destructor Documentation

CFavouritesItem()

CFavouritesItem ( ) [private]
C++ constructor.
Since
0.9

~CFavouritesItem()

IMPORT_C ~CFavouritesItem ( ) [virtual]
Destructor.
Since
0.9

Member Functions Documentation

ClearL()

IMPORT_C void ClearL ( )
Reset the item to default values.
Since
0.9

ConstructL()

void ConstructL ( ) [private]
Second-phase constructor.
Since
0.9

ContextId()

IMPORT_C TInt32 ContextId ( ) const
Get context id associated with this item.
Since
0.9

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aStream ) const
Externalize into a stream.
Since
0.9

Parameters

RWriteStream & aStream The stream to externalize to.

InternalizeL(RReadStream &)

void InternalizeL ( RReadStream & aStream )
Internalize from a stream.
Since
0.9

Parameters

RReadStream & aStream The stream to externalize from.

IsFactoryItem()

IMPORT_C TBool IsFactoryItem ( ) const
Check if this is a factory item.
Since
0.9

IsFolder()

IMPORT_C TBool IsFolder ( ) const
Check if this is a folder.
Since
0.9

IsHidden()

IMPORT_C TBool IsHidden ( ) const
Check if this is a hidden.
Since
0.9

IsItem()

IMPORT_C TBool IsItem ( ) const
Check if this is an item (not folder).
Since
0.9

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

Modified()

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

Name()

IMPORT_C const TPtrC Name ( ) const
Get the name of this item.
Since
0.9

NewL()

IMPORT_C CFavouritesItem * NewL ( ) [static]
Two-phased constructor. Leaves on failure.
Since
0.9

NewLC()

IMPORT_C CFavouritesItem * NewLC ( ) [static]
Two-phased constructor. Leaves on failure. Places the instance on the cleanup stack.
Since
0.9

ParentFolder()

IMPORT_C TInt ParentFolder ( ) const
Get the uid of the parent folder of this item.
Since
0.9

Password()

IMPORT_C const TPtrC Password ( ) const
Get password associated with this item.
Since
0.9

SetContextId(TInt32)

IMPORT_C void SetContextId ( TInt32 aContextId )
Set context id of the item.
Since
0.9

Parameters

TInt32 aContextId The context id to be set.

SetHidden(TBool)

IMPORT_C TBool SetHidden ( TBool aHidden ) const
Set hidden value of the item.
Since
0.9

Parameters

TBool aHidden The hidden value to be set.

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

const TDesC & aName The name to be set.

SetParentFolder(TInt)

IMPORT_C void SetParentFolder ( TInt aId )
Set parent folder.
Since
0.9

Parameters

TInt aId The unique id of the parent folder.

SetPasswordL(const TDesC &)

IMPORT_C void SetPasswordL ( const TDesC & aPassword )
Set password. Length limit is KFavouritesMaxPassword (leaves with KErrOverflow).
Since
0.9

Parameters

const TDesC & aPassword The password to be set.

SetType(TType)

IMPORT_C void SetType ( TType aType )
Set item type (item or folder).
Since
0.9

Parameters

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

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

const TDesC & aUrl The URL to be set.

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

const TDesC & aUserName The username to be set.

SetWapAp(const TFavouritesWapAp &)

IMPORT_C void SetWapAp ( const TFavouritesWapAp & aAccessPoint )
Set WAP Access Point of the item.
Since
0.9

Parameters

const TFavouritesWapAp & aAccessPoint The WAP Access point to be set.

Type()

IMPORT_C TType Type ( ) const
Get type of the item (item or folder).
Since
0.9

Uid()

IMPORT_C TInt Uid ( ) const
Get unique id of the item.
Since
0.9

Url()

IMPORT_C const TPtrC Url ( ) const
Get the URL of this item.
Since
0.9

UserName()

IMPORT_C const TPtrC UserName ( ) const
Get the username associated with this item.
Since
0.9

WapAp()

IMPORT_C TFavouritesWapAp WapAp ( ) const
Get WAP Access Point id associated with this item.
Since
0.9

operator=(const CFavouritesItem &)

IMPORT_C CFavouritesItem & operator= ( const CFavouritesItem & aCopyFrom )
Assignment operator.
Since
0.9

Parameters

const CFavouritesItem & aCopyFrom Assign from this.

Member Enumerations Documentation

Enum TType

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

Enumerators

ENone
EItem
EFolder

Member Data Documentation

CFavouritesItemImpl * iImpl

CFavouritesItemImpl * iImpl [private]

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.