ISetRepaginationCmdOptions Class Reference

#include <ISetRepaginationCmdOptions.h>

Inheritance diagram for ISetRepaginationCmdOptions:

Public Types
enum	{ kDefaultIID = IID_ISETREPAGINATIONCMDOPTIONS }
enum	UpdateOptionsEnum {   kUpdatePageNumbers = 1, kUpdateChapterNumbers = 2, kUpdateParagraphNumbers = 4, kUpdateChapterAndParagrapghNumbers = kUpdateChapterNumbers|kUpdateParagraphNumbers,   kUpdateAll = 0xFF }

Public Member Functions
virtual void	SetUpdateOptions (ISetRepaginationCmdOptions::UpdateOptionsEnum updateOptions=kUpdatePageNumbers)=0
virtual ISetRepaginationCmdOptions::UpdateOptionsEnum	GetUpdateOptions () 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

Interface to set/get options to kSetRepaginationCmdBoss

Member Enumeration Documentation

enum ISetRepaginationCmdOptions::UpdateOptionsEnum

It specifies which numbering to be updated during command execution It can be any combination of Page numbering, Chapter Numbering and Paragraph Numbering

Enumerator
kUpdatePageNumbers	Update page numbers
kUpdateChapterNumbers	Update chapter numbers
kUpdateParagraphNumbers	Update paragraph numbers
kUpdateChapterAndParagrapghNumbers	Update chapter and paragraph numbers
kUpdateAll	Update all numbering

Member Function Documentation

virtual ISetRepaginationCmdOptions::UpdateOptionsEnum ISetRepaginationCmdOptions::GetUpdateOptions ( ) const

pure virtual

Gets the update options i.e. retrieves combination of numberings to be updated during execution of kSetRepaginationCmdBoss

Returns

updateOptions: combination of numbering to be updated in command

virtual void ISetRepaginationCmdOptions::SetUpdateOptions ( ISetRepaginationCmdOptions::UpdateOptionsEnum  updateOptions = kUpdatePageNumbers )

pure virtual

Sets the update options i.e. specifies which numbering to be updated during execution of kSetRepaginationCmdBoss

Parameters

updateOptions

[IN] combination of numbering to be updated in command