#include <IBookContent.h>

Inheritance diagram for IBookContent:

Public Types
enum	{ kDefaultIID = IID_IBOOKCONTENT }

Public Member Functions
virtual PMString	GetCurrentBook ()=0

virtual void	SetCurrentBook (const PMString &book)=0

virtual PMString	GetPageRange ()=0

virtual void	SetPageRange (const PMString &pageRange)=0

virtual int32	GetFirstPageNum ()=0

virtual void	SetFirstPageNum (const int32 &pageNum)=0

virtual int32	GetNonHiddenFirstPageNum ()=0

virtual void	SetNonHiddenFirstPageNum (const int32 &pageNum)=0

virtual bool16	IsAvailable ()=0

virtual bool16	IsPaginated ()=0

virtual void	SetPaginated (bool16 paginate)=0

virtual void	Open ()=0

virtual int32	GetChapterNumber ()=0

virtual void	SetChapterNumber (int32 chapterNumber)=0

virtual bool16	GetIDFile (IDFile &file) const =0

virtual WideString	GetShortName () const =0

virtual WideString	GetLongName () const =0

virtual uint64	GetSize () const =0

virtual IDTime	GetModTime () const =0

virtual bool16	IsNormal () const =0

virtual bool16	IsMissing () const =0

virtual bool16	IsModified () const =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 access the information about book content. Currently, the book content is individual InDesign documents. We also call book content as chapter.

See Also: kBookContentBoss

Member Function Documentation

virtual int32 IBookContent::GetChapterNumber ( )

pure virtual

Get the chapter number of the book content(chapter).

Parameters

none

Returns: int32 the chapter number of book content.

virtual PMString IBookContent::GetCurrentBook ( )

pure virtual

Get the current book.

Parameters

none

Returns: PMString the file name of current book.

virtual int32 IBookContent::GetFirstPageNum ( )

pure virtual

Get the first page number of the book content(chapter).

Parameters

none

Returns: int32 the first page number of book content.

virtual bool16 IBookContent::GetIDFile ( IDFile & file ) const

pure virtual

Returns kTrue if a file can be obtained for the book content, kFalse otherwise.

Parameters

file

Returns: kTrue if a file can be obtained for the book content, kFalse otherwise.

virtual WideString IBookContent::GetLongName ( ) const

pure virtual

Returns the long name of the book content.

Returns: the long name of the book content.

virtual IDTime IBookContent::GetModTime ( ) const

pure virtual

Returns the modification time of the book content.

Returns: the modification time of the book content.

virtual int32 IBookContent::GetNonHiddenFirstPageNum ( )

pure virtual

Get the first non hidden page number of the book content(chapter).

Parameters

none

Returns: int32 the first non hidden page number of book content.

virtual PMString IBookContent::GetPageRange ( )

pure virtual

Get the string representation of book content(chapter)'s page range.

Parameters

none

Returns: PMString the string reprsentation fo page range.

virtual WideString IBookContent::GetShortName ( ) const

pure virtual

Returns the short name of the book content.

Returns: the short name of the book content.

virtual uint64 IBookContent::GetSize ( ) const

pure virtual

Returns the size of the book content.

Returns: the size of the book content.

virtual bool16 IBookContent::IsAvailable ( )

pure virtual

Returns kTrue if the book content is available, kFalse otherwise.

Returns: kTrue if the book content is available, kFalse otherwise.

virtual bool16 IBookContent::IsMissing ( ) const

pure virtual

Returns kTrue if the book content is missing, kFalse otherwise.

Returns: kTrue if the book content is missing, kFalse otherwise.

virtual bool16 IBookContent::IsModified ( ) const

pure virtual

Returns kTrue if the book content is modified, kFalse otherwise.

Returns: kTrue if the book content is modified, kFalse otherwise.

virtual bool16 IBookContent::IsNormal ( ) const

pure virtual

Returns kTrue if the book content is unmodified and available, kFalse otherwise.

Returns: kTrue if the book content is unmodified and available, kFalse otherwise.

virtual bool16 IBookContent::IsPaginated ( )

pure virtual

Check if chapter is paginated or not.

Parameters

none

Returns: bool16 kTrue means chapter is paginated, otherwise return kFalse.

virtual void IBookContent::Open ( )

pure virtual

Open the chapter. This API currently is NOT used in InDesign' core code base and it is a no-op. Third party may want to override this if they want to use it.

Parameters

none

virtual void IBookContent::SetChapterNumber ( int32 chapterNumber )

pure virtual

Set the chapter number of book content(chapter).

Parameters

chapterNumber IN the chapter number to be set

virtual void IBookContent::SetCurrentBook ( const PMString & book )

pure virtual

Set the current book.

Parameters

book	IN the file name of current book that is to be the current book.

virtual void IBookContent::SetFirstPageNum ( const int32 & pageNum )

pure virtual

Set the first page number of book content(chapter).

Parameters

pageNum IN the page number to be set

virtual void IBookContent::SetNonHiddenFirstPageNum ( const int32 & pageNum )

pure virtual

Set the first non hidden page number of book content(chapter).

Parameters

pageNum IN the page number to be set

virtual void IBookContent::SetPageRange ( const PMString & pageRange )

pure virtual

Set the page range of the current book.

Parameters

pageRange IN the string of page range to be set on the book content.

virtual void IBookContent::SetPaginated ( bool16 paginate )

pure virtual

Set the flag about if chapter is paginated or not.

Parameters

paginate IN the flag to be set as to chapter's pagination.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation