ITextEditSuite Class Reference

#include <ITextEditSuite.h>

Inheritance diagram for ITextEditSuite:

Public Types
enum	{ kDefaultIID = IID_ITEXTEDIT_ISUITE }
enum	PageNumberType { kThisPage, kContinuedFrom, kContinuedOn }

Public Member Functions
virtual bool16	CanEditText () const =0
virtual ErrorCode	InsertCharacter (UTF32TextChar ch)=0
virtual ErrorCode	InsertPageNumber (PageNumberType pageNumberType)=0
virtual ErrorCode	InsertBreakCharacter (Text::StartBreakLocation breakLocation)=0
virtual bool16	CanInsertFootnote ()=0
virtual ErrorCode	InsertFootnote ()=0
virtual bool16	CanConvertVariable (ClassID whichVariableClass=kInvalidClass) const =0
virtual ErrorCode	ConvertVariableToText (ClassID whichVariableClass=kInvalidClass)=0
virtual ErrorCode	InsertText (const WideString &theText)=0
virtual ErrorCode	Delete (CharCounter numChars=1)=0
virtual ErrorCode	ForwardDelete (CharCounter numChars=1)=0
virtual ErrorCode	InsertEndnote ()=0
virtual bool16	CanInsertEndnote ()=0
virtual bool16	IsTextSelectionInEndnoteStory ()=0
virtual bool16	IsInsideEndnoteTextRange ()=0
virtual bool16	IsInsideEndnoteAnchor ()=0
virtual bool16	GotoEndnoteAnchor ()=0
virtual bool16	GotoEndnoteTextRange ()=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 implemented by the abstract selection boss and by the concrete selection bosses for text.

Member Function Documentation

virtual bool16 ITextEditSuite::CanConvertVariable ( ClassID  whichVariableClass = kInvalidClass ) const

pure virtual

Can a variable be converted here? Optionally specify the class of a variable. If one is specified, this method will only return true if a variable of that type can be converted.

virtual bool16 ITextEditSuite::CanEditText ( ) const

pure virtual

Are insertions/deletions allowed? Returns kFalse is the story is locked, for example.

virtual bool16 ITextEditSuite::CanInsertEndnote ( )

pure virtual

Can an endnote be inserted here?

virtual bool16 ITextEditSuite::CanInsertFootnote ( )

pure virtual

Can a footnote be inserted here?

virtual ErrorCode ITextEditSuite::ConvertVariableToText ( ClassID  whichVariableClass = kInvalidClass )

pure virtual

Convert Variable to text.

virtual ErrorCode ITextEditSuite::Delete ( CharCounter  numChars = 1 )

pure virtual

Deletes the current selection. If the selection is an insertion point, deletes the character to the left of the insertion point. This goes through the user typing path, and therefore includes command joining behavior and forcing recomposition to complete before returning.

virtual ErrorCode ITextEditSuite::ForwardDelete ( CharCounter  numChars = 1 )

pure virtual

The same as Delete(), if a range is selected. If the selection is an insertion point, deletes the character to the right of the insertion point. This goes through the user typing path, and therefore includes command joining behavior and forcing recomposition to complete before returning.

virtual bool16 ITextEditSuite::GotoEndnoteAnchor ( )

pure virtual

Jump to the matching endnote anchor if current selection is in an endnote text.

virtual bool16 ITextEditSuite::GotoEndnoteTextRange ( )

pure virtual

Jump to the matching endnote text if current selection is an endnote reference.

virtual ErrorCode ITextEditSuite::InsertBreakCharacter ( Text::StartBreakLocation  breakLocation )

pure virtual

Insert a next column, next frame, next page, next odd page, or next even page character. Replaces the current selection.

virtual ErrorCode ITextEditSuite::InsertCharacter ( UTF32TextChar  ch )

pure virtual

Insert the given Unicode character. Replaces the current selection.

virtual ErrorCode ITextEditSuite::InsertEndnote ( )

pure virtual

Insert an endnote

virtual ErrorCode ITextEditSuite::InsertFootnote ( )

pure virtual

Insert a footnote OR a footnote designator into an existing footnote. Fails inserting into tables, notes, etc.

virtual ErrorCode ITextEditSuite::InsertPageNumber ( PageNumberType  pageNumberType )

pure virtual

Insert a page number, continued on, or continued from marker. Replaces the current selection.

virtual ErrorCode ITextEditSuite::InsertText ( const WideString &  theText )

pure virtual

Insert this Unicode string. Replaces the current selection. Goes through the user typing path and therefore includes font locking behavior, command joining, and forcing recomposition to complete before returning.

virtual bool16 ITextEditSuite::IsInsideEndnoteAnchor ( )

pure virtual

Is selection an endnote reference?

virtual bool16 ITextEditSuite::IsInsideEndnoteTextRange ( )

pure virtual

Is selection within an endnote text?

virtual bool16 ITextEditSuite::IsTextSelectionInEndnoteStory ( )

pure virtual

Is selection in endnote story?