Collapse all Symbian^3 Application Developer Library

RBkBookmark Class Reference

class RBkBookmark : public RBkNode

The bookmark tree maintained by the database is made up to folders containing bookmarks. The RBkBookmark class is a handle to a bookmark in the database. The RBkDatabase handle will return an RBkBookmark handle to you when you create a new bookmark or on a call to OpenBookmarkL() . As with all items in the database, the client application never owns the bookmark item itself. All actions are performed through this handle.

Inherits from

RBkBookmark
- RBkNode

Public Member Functions
	RBkBookmark ()
IMPORT_C const CAuthentication &	AuthenticationL ()
CBookmark *	Bookmark ()
IMPORT_C TUint32	GetNapL ()
IMPORT_C TBool	IsHomePage ()
IMPORT_C TTime	LastVisited ()
IMPORT_C TUint32	ProxyL ()
IMPORT_C void	SetAuthenticationL (const CAuthentication &)
IMPORT_C void	SetLastVisitedL ( TTime )
IMPORT_C void	SetNapL ( TUint32 )
IMPORT_C void	SetProxyL ( TUint32 )
IMPORT_C void	SetUriL (const TDesC8 &)
IMPORT_C void	UpdateVisited ()
IMPORT_C const TDesC8 &	Uri ()

Inherited Functions
	RBkNode::Close()
	RBkNode::DescriptionL()const
	RBkNode::ExtendedPropertiesL()const
	RBkNode::GetCustomPropertyL(TUid,TDes &)const
	RBkNode::GetCustomPropertyL(TUid,TDes8 &)const
	RBkNode::GetCustomPropertyL(TUid,TInt &)const
	RBkNode::GetCustomPropertyL(TUid,TReal &)const
	RBkNode::IconIdL()const
	RBkNode::Id()const
	RBkNode::IsPublic()const
	RBkNode::IsWritable()const
	RBkNode::Item()const
	RBkNode::LastModifiedL()const
	RBkNode::OpenBookmarkL()const
	RBkNode::OpenFolderL()const
	RBkNode::OpenParentL()const
	RBkNode::OwnerL()const
	RBkNode::RBkNode()
	RBkNode::SetCustomPropertyL(TUid,TInt)
	RBkNode::SetCustomPropertyL(TUid,TReal)
	RBkNode::SetCustomPropertyL(TUid,const TDesC &)
	RBkNode::SetCustomPropertyL(TUid,const TDesC8 &)
	RBkNode::SetDescriptionL(const TDesC &)
	RBkNode::SetIconIdL(Bookmark::TAttachmentId)
	RBkNode::SetItem(CBookmarkBase &)
	RBkNode::SetLastModifiedL(const TTime &)
	RBkNode::SetOwnerL(TSecureId)
	RBkNode::SetParentL(RBkFolder &)
	RBkNode::SetPublicL(TBool)
	RBkNode::SetTitleL(const TDesC &)
	RBkNode::SetWritableL(TBool)
	RBkNode::Title()const
	RBkNode::Type()const

Inherited Attributes
	RBkNode::iItem

Constructor & Destructor Documentation

RBkBookmark()

IMPORT_C

RBkBookmark

(

)

RBkBookmark constructor

Member Functions Documentation

AuthenticationL()

IMPORT_C const CAuthentication &

AuthenticationL

(

)

Returns the assigned authentication object. This object is based on the bookmark's URI

Bookmark()

CBookmark *

Bookmark

(

)

const

This method is an internal utility method for converting the objects item pointer to the correct type. It is not intended for external use.

GetNapL()

IMPORT_C TUint32

GetNapL

(

)

const

Method for getting the bookmark's nap.

IsHomePage()

IMPORT_C TBool

IsHomePage

(

)

Method to query whether this bookmark is the home page

LastVisited()

IMPORT_C TTime

LastVisited

(

)

const

Returns the last visited time for this bookmark

ProxyL()

IMPORT_C TUint32

ProxyL

(

)

const

Method for getting the bookmark's proxy. The proxy will be set to the default proxy when CBookmark is first created

SetAuthenticationL(const CAuthentication &)

IMPORT_C void

SetAuthenticationL

(

const CAuthentication &

aAuthentication

)

Set the bookmark's authentication object.

Parameters

const CAuthentication & aAuthentication

Reference to a new authentication object

SetLastVisitedL(TTime)

IMPORT_C void

SetLastVisitedL

(

TTime

aTime

)

Sets the last visited time for this bookmark to the time specified. This function is intended to only be used for managing bookmarks, and will leave if not called in Management mode. Use RBkBookmark::UpdateVisited() to set the last-modified time to the current time.

leave: KErrPermissionDenied This function will leave when the bookmark database is not opened as Bookmark::EVisibilityManager.

RBkBookmark::UpdateVisited

Parameters

TTime aTime

The new visited time

SetNapL(TUint32)

IMPORT_C void

SetNapL

(

TUint32

aNap

)

Method for setting the bookmark's nap.

Parameters

TUint32 aNap

Id for identifying the nap entry in the commdb

SetProxyL(TUint32)

IMPORT_C void

SetProxyL

(

TUint32

aProxy

)

Method for setting the bookmark's proxy.

Parameters

TUint32 aProxy

Id for identifying the proxy entry in the commdb

SetUriL(const TDesC8 &)

IMPORT_C void

SetUriL

(

const TDesC8 &

aUri

)

Method for setting the bookmark's Uri

Parameters

const TDesC8 & aUri

Descriptor containing the new Uri

UpdateVisited()

IMPORT_C void

UpdateVisited

(

)

Sets the last visited time to be the current time

Uri()

IMPORT_C const TDesC8 &

Uri

(

)

const

Method for getting the bookmark's Uri