IBookPaginateOptions Class Reference

#include <IBookPaginateOptions.h>

Inheritance diagram for IBookPaginateOptions:

Public Types
enum	{ kDefaultIID = IID_IBOOKPAGINATEOPTIONS }
enum	Options { kNextPage, kOdd, kEven }

Public Member Functions
virtual IBookPaginateOptions::Options	GetPaginateOptions ()=0
virtual void	SetPaginateOptions (IBookPaginateOptions::Options option)=0
virtual bool16	GetInsertBlankPage ()=0
virtual void	SetInsertBlankPage (bool16 insertBlankPage)=0
virtual UIDRef	GetCurrentBookUIDRef ()=0
virtual void	SetCurrentBookUIDRef (UIDRef &bookUIDRef)=0
virtual bool16	GetAutoRepaginateFlag ()=0
virtual void	SetAutoRepaginateFlag (bool16 autoRepaginate)=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 define the pagination options.

Member Enumeration Documentation

enum IBookPaginateOptions::Options

Enum value for book repagination. kNextPage: such as 1,2,3,4... kOdd: such as 1,3,5,7... kEven: such as 2,4,6,8...

Member Function Documentation

virtual bool16 IBookPaginateOptions::GetAutoRepaginateFlag ( )

pure virtual

Get the flag about auto repagination.

Parameters

none

Returns

bool16 kTrue means we will to auto repagination when the chapters in the book are modified(add/delete/reorder/replace), otherwise kFalse.

virtual UIDRef IBookPaginateOptions::GetCurrentBookUIDRef ( )

pure virtual

Get the UIDRef of the current book.

Parameters

none

Returns

UIDRef the current book.

virtual bool16 IBookPaginateOptions::GetInsertBlankPage ( )

pure virtual

Get the flag about if we should insert blank page or not when the paginate option is set as kOdd or kEven.

Parameters

none

Returns

bool16 kTrue means we will insert blank page when paginate option is kOdd or kEven, otherwise, return kFalse.

virtual IBookPaginateOptions::Options IBookPaginateOptions::GetPaginateOptions ( )

pure virtual

Get the paginate option.

Parameters

none

Returns

IBookPaginateOptions::Options the pagination option.

virtual void IBookPaginateOptions::SetAutoRepaginateFlag ( bool16  autoRepaginate )

pure virtual

Set the auto repagination flag.

Parameters

autoRepaginate

IN the flag to be set.

virtual void IBookPaginateOptions::SetCurrentBookUIDRef ( UIDRef &  bookUIDRef )

pure virtual

Set the current book.

Parameters

bookUIDRef

IN the UIDRef of book to be set as current book.

virtual void IBookPaginateOptions::SetInsertBlankPage ( bool16  insertBlankPage )

pure virtual

Set the flag about insert blank page.

Parameters

insertBlankPage

IN the flag to be set.

virtual void IBookPaginateOptions::SetPaginateOptions ( IBookPaginateOptions::Options  option )

pure virtual

Set the paginate option.

Parameters

option

IN the paginate option to set