IFootnoteViewSuite Class Reference

Inheritance diagram for IFootnoteViewSuite:

Public Types
enum	{ kDefaultIID = IID_IFOOTNOTEVIEWSUITE }

Public Member Functions
virtual bool16	SelectionInFootnote (void)=0
virtual bool16	MoveSelectionOutOfFootnote (void)=0
virtual ErrorCode	CollapseExpandAllFootnotes (void)=0
virtual ErrorCode	CollapseExpandFootnote (TextIndex anchorIndex)=0
virtual bool16	IsFootnoteCollapsed (TextIndex anchorIndex)=0
virtual bool16	ShouldCollapseAllFootnotes ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual ErrorCode IFootnoteViewSuite::CollapseExpandAllFootnotes ( void  )

pure virtual

Check the current footnotes in a story and see if they are collapsed or expanded. If all are uncollapsed then it will collapse them all. If all are collapsed then it will expand them all.

Returns

kSuccess or kFailure

virtual ErrorCode IFootnoteViewSuite::CollapseExpandFootnote ( TextIndex  anchorIndex )

pure virtual

Toggle the collapse/expand state at the given footnote anchor text index

Parameters

index

of the footnote anchor character in text.

Returns

kSuccess or kFailure

virtual bool16 IFootnoteViewSuite::IsFootnoteCollapsed ( TextIndex  anchorIndex )

pure virtual

See if a footnote at the given footnote anchor text index is collapsed or not. This routine assumes the caller has verified the existance of a footnote at a given anchor index.

Parameters

index

of the footnote anchor character in text.

Returns

kSuccess or kFailure

virtual bool16 IFootnoteViewSuite::MoveSelectionOutOfFootnote ( void  )

pure virtual

Move selection that is currently in a footnote outside the footnote and to the text index just before the footnote anchor index in the primary text story thread.

Returns

true if selection was moved

virtual bool16 IFootnoteViewSuite::SelectionInFootnote ( void  )

pure virtual

Check if the current text selection is within a footnote

Returns

true if the selection is in a footnote.

virtual bool16 IFootnoteViewSuite::ShouldCollapseAllFootnotes ( )

pure virtual

Determine whether footnotes are in a state where they can all be collapsed or all expanded. This is a utility function that is called by CallapseExpandAllFootnotes to determine which action it should take.

Returns

kTrue (should be able to collapse) kFalse (not able to collapse)