IChapterNumberPreferences Class Reference

#include <IChapterNumberPreferences.h>

Inheritance diagram for IChapterNumberPreferences:

Public Types
enum	{ kDefaultIID = IID_ICHAPTERNUMBERPREFERENCES }

Public Member Functions
virtual ClassID	GetNumberFormatter () const =0
virtual int32	GetChapterNumber () const =0
virtual ChapterNumType::Type	GetChapterNumberType () const =0
virtual void	SetNumberFormatter (ClassID)=0
virtual void	SetUserDefinedChapterNumber (int32)=0
virtual void	SetChapterNumberType (ChapterNumType::Type)=0
virtual void	SetCalculatedChapterNumber (int32)=0
virtual bool16	IsChapterNumberingEnabled () const =0
virtual void	EnableChapterNumbering (bool16)=0
virtual void	CopyPreferencesFromDocument (IDocument *)=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 chapter number preferences of Document

See Also

kDocWorkSpaceBoss, kModifyChapterNumberPrefsCmdBoss

Member Function Documentation

virtual void IChapterNumberPreferences::CopyPreferencesFromDocument ( IDocument *  )

pure virtual

Copy preferences from a document Intended to be used with kModifyChapterNumPrefsCmdBoss

Parameters

document

IN source document

See Also

kModifyChapterNumPrefsCmdBoss

virtual void IChapterNumberPreferences::EnableChapterNumbering ( bool16  )

pure virtual

Enable chapter numbering.

Parameters

bool16

kTrue to enable, kFalse to disable. Note: We introduced this API according to UI spec V2 but now we dont have option to disable chapter numbering (UI spec V4) and this API now does not work.

virtual int32 IChapterNumberPreferences::GetChapterNumber ( ) const

pure virtual

Get Chapter Number of document

Parameters

none

Returns

int32 Chapter Number of Document

virtual ChapterNumType::Type IChapterNumberPreferences::GetChapterNumberType ( ) const

pure virtual

Get Chapter Number Type or method for computing chapter number

Parameters

none

Returns

ChapterNumType::Type Chapter Number Type

virtual ClassID IChapterNumberPreferences::GetNumberFormatter ( ) const

pure virtual

Get ClassID of number Formatting service. This class id is of a service of kService_ParagraphNumberingStyles

Parameters

none

Returns

ClassID of number Formatting service

virtual bool16 IChapterNumberPreferences::IsChapterNumberingEnabled ( ) const

pure virtual

Is document has Chapter Numbering enabled?

Parameters

none

Returns

bool16 kTrue for enabled, kFalse for disabled. Note: We introduced this API according to UI spec V2 but now we dont have option to disable chapter numbering (UI spec V4) and this API now returns useless/wrong data. We left this API as it is for keeping future changes in mind.

virtual void IChapterNumberPreferences::SetCalculatedChapterNumber ( int32  )

pure virtual

To set calculated Chapter Numbers Note: Use only when chapter Numbers are calculated from Book.

Parameters

chapterNumber

IN calculated chapter number to set

virtual void IChapterNumberPreferences::SetChapterNumberType ( ChapterNumType::Type  )

pure virtual

Set Chapter Number Type or method for computing chapter number

Parameters

ChapterNumType::Type

Chapter Number Type

virtual void IChapterNumberPreferences::SetNumberFormatter ( ClassID  )

pure virtual

Set ClassID of number Formatting service to be used for chapter number. This class id is of a service of kService_ParagraphNumberingStyles

Parameters

class

id of number formatting service

virtual void IChapterNumberPreferences::SetUserDefinedChapterNumber ( int32  )

pure virtual

Set Chapter Number when Chapter Numbers are User defined. If Chapter Number are not user defined it throws ASSERT

Parameters

chapterNumber

IN user defined chapter number to set