Inheritance diagram for ISectionUtils:

Public Types
enum	{ kDefaultIID = IID_ISECTIONUTILS }

Public Member Functions
virtual bool16	IsPageStartOfSection (const UIDRef &pageRef, int32 *sectionIndex=nil)=0

virtual ErrorCode	RemoveEmptySection (IDocument *doc)=0

virtual bool16	IsLegalAlternateLayoutName (IDocument *doc, const PMString &nameToCheck, const PMString &nameToSkip)=0

virtual void	GetSectionNames (IDocument *doc, K2Vector< PMString > &sectionNames, PageNameStyle style)=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

Utilities related to sections.

Member Function Documentation

virtual void ISectionUtils::GetSectionNames	(	IDocument *	doc,
		K2Vector< PMString > &	sectionNames,
		PageNameStyle	style
	)

pure virtual

Return the section and/or alternate layout names for the document (in the order they appear in the document, i.e. QueryOrderedList).

Parameters

doc,the	document to get the names for
sectionNames,a	K2Vector of strings that will be the OUT paramater
style,one	of a PageNameStyle enum to return sections, alternate layouts, or both.

See Also: ISectionList::QueryOrderedList; WidgetDefs.h, use one of the PageNumStyle values: kAlternateLayoutNames, kSectionNames, or kAlternateAndSectionNames

virtual bool16 ISectionUtils::IsLegalAlternateLayoutName	(	IDocument *	doc,
		const PMString &	nameToCheck,
		const PMString &	nameToSkip
	)

pure virtual

IsLegalAlternateLayoutName

Parameters

doc,the	document
nameToCheck,the	name to check for validity
nameToSkip,the	name to skip (e.g. the name for the section you are validating). May be kNullString to avoid this check. Return kFalse if name is valid, kFalse if not (e.g. empty or duplicate)

virtual bool16 ISectionUtils::IsPageStartOfSection	(	const UIDRef &	pageRef,
		int32 *	sectionIndex = `nil`
	)

pure virtual

Is the page UID the starting page of a section? Return the section index if requested.

virtual ErrorCode ISectionUtils::RemoveEmptySection ( IDocument * doc )

pure virtual

INTERNAL USE: Remove an empty sections from the document. This is a section associated with page[0] in the document.