IBookContentMgr Class Reference

#include <IBookContentMgr.h>

Inheritance diagram for IBookContentMgr:

Public Types
enum	{ kDefaultIID = IID_IBOOKCONTENTMGR }

Public Member Functions
virtual ErrorCode	AppendContents (UIDList *list)=0
virtual ErrorCode	InsertContents (UIDList *list, int32 pos=-1)=0
virtual void	RemoveContents (UIDList *list)=0
virtual UID	GetNthContent (int32 n)=0
virtual int32	GetContentIndex (UID content)=0
virtual int32	GetContentCount ()=0
virtual UID	GetCurrentContent ()=0
virtual void	SetCurrentContent (UID current)=0
virtual int32	GetCurrentContentIndex ()=0
virtual UID	FindContentByName (const IDFile &whatFile, int32 &location)=0
virtual void	Clear ()=0
virtual void	UpdateBookContentFileList (const UID &content, const IDFile &docFile)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This interface is used to manage individual content items (kBookContentBoss) within a book (kBookBoss).

See Also

kBookContentBoss

kBookBoss

IBookContent

Member Function Documentation

virtual ErrorCode IBookContentMgr::AppendContents ( UIDList *  list )

pure virtual

Add the contents(chapters) to the end of the book.

Parameters

list	IN UIDList of chapters to be added.

Returns

ErrorCode kSuccess means we add all the chapters.

virtual void IBookContentMgr::Clear ( )

pure virtual

Clear all the contents(chapters) in the book.

Parameters

none

virtual UID IBookContentMgr::FindContentByName ( const IDFile &  whatFile, int32 &  location  )

pure virtual

Get the content UID with the specified IDFile.

Parameters

whatFile	IN the speciied IDFile.
location	OUT if content is found, set the position within the book.

Returns

UID the content corresponding to the specified IDFile.

virtual int32 IBookContentMgr::GetContentCount ( )

pure virtual

Get the total number of contents(chapters) in the book.

Parameters

none

Returns

int32 the number of contents in the book.

virtual int32 IBookContentMgr::GetContentIndex ( UID  content )

pure virtual

Get the position for the specified content(chapter)

Parameters

content

IN the specified content.

Returns

int32 the index of the specified content.

virtual UID IBookContentMgr::GetCurrentContent ( )

pure virtual

Get the UID of current selected content(chapter) in the book.

Parameters

none

Returns

UID the current selected content in the book.

virtual int32 IBookContentMgr::GetCurrentContentIndex ( )

pure virtual

Get the index of current selected content(chapter) in the book.

Parameters

none

Returns

int32 the index of the current content, 0-based.

virtual UID IBookContentMgr::GetNthContent ( int32  n )

pure virtual

Get the nth content(chapter) of the book.

Parameters

n	IN the index of content, 0-based.

Returns

UID the nth content.

virtual ErrorCode IBookContentMgr::InsertContents ( UIDList *  list, int32  pos = -1  )

pure virtual

Insert the contents(chapters) to the specified position in the book.

Parameters

list	IN UIDList of chapters to be added.
pos	IN the position where we insert the chapters. By default(-1), we add to the end of the book.

Returns

ErrorCode kSuccess means we add all the chapters.

virtual void IBookContentMgr::RemoveContents ( UIDList *  list )

pure virtual

Remove the contents(chapters) from the book.

Parameters

list	IN UIDList of chapters to be removed from book.

virtual void IBookContentMgr::SetCurrentContent ( UID  current )

pure virtual

Set the specified content(chapter) as the current content in the book.

Parameters

current

IN the UID of content to be set as current.

virtual void IBookContentMgr::UpdateBookContentFileList ( const UID &  content, const IDFile &  docFile  )

pure virtual

Update the book content's (UID, IDFile) map in the book content manager.

Parameters

content	IN the UID of the chapter.
docFile	IN the corresponding IDFile of the chapter.