Collapse all Symbian^3 Application Developer Library

RBkFolder Class Reference

class RBkFolder : public RBkNode

The bookmark tree maintained by the database is made up to folders containing bookmarks. The RBkFolder class is a handle to a bookmark folder. Bookmark folders contain a list of children which can be bookmarks or other folders. As with all items in the database, the client application never owns the folder item itself. All actions are performed through this handle.

Inherits from

RBkFolder
- RBkNode

Public Member Functions
	RBkFolder ()
IMPORT_C void	AppendL ( RBkNode &)
IMPORT_C TInt	Count ()
CBookmarkFolder *	Folder ()
IMPORT_C TInt	Index (const RBkNode &)
IMPORT_C void	InsertL ( RBkNode &, TInt )
IMPORT_C TInt	Move ( TInt , TInt )
IMPORT_C RBkNode	OpenItemL ( TInt )

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

RBkFolder()

IMPORT_C

RBkFolder

(

)

RBkFolder constructor

Member Functions Documentation

AppendL(RBkNode &)

IMPORT_C void

AppendL

(

RBkNode &

aItem

)

Moves the given bookmark item into this folder. Append simply adds the bookmark to the end of the folder's child list.

Parameters

RBkNode & aItem

The bookmark item to add

Count()

IMPORT_C TInt

Count

(

)

const

Returns the number of items in the folder's child list

Folder()

CBookmarkFolder *

Folder

(

)

const

Not intended for external use

Index(const RBkNode &)

IMPORT_C TInt

Index

(

const RBkNode &

aItem

)

const

Gets the index of the child with the given ID.

Parameters

const RBkNode & aItem

Id of the bookmark item to be found

InsertL(RBkNode &, TInt)

IMPORT_C void	InsertL	(	RBkNode &	aItem,
			TInt	aIndexPosition
		)

Moves the given bookmark item into this folder. Insert adds the bookmark into a specific position in the folder's child list. The item is just added to the end if the specified index is greater than the number of current children.

Parameters

RBkNode & aItem	The bookmark item to add
TInt aIndexPosition	The index position in which to place the bookmark item

Move(TInt, TInt)

IMPORT_C TInt	Move	(	TInt	aOldPosition,
			TInt	aNewPosition
		)

Shifts the position of a bookmark item in the child list.

Parameters

TInt aOldPosition	The index position of the bookmark item to be moved
TInt aNewPosition	The new index position where the bookmark item is to be placed

OpenItemL(TInt)

IMPORT_C RBkNode

OpenItemL

(

TInt

aIndex

)

Method for opening a handle to a child bookmark item by index value

Parameters

TInt aIndex

Index position to retrieve