IComposeScanner Class Reference

#include <IComposeScanner.h>

Inheritance diagram for IComposeScanner:

Public Types
enum	{ kDefaultIID = IID_ICOMPOSESCANNER }

Public Member Functions
virtual TextIndex	CopySurroundingWord (TextIndex position, WideString *copy, UID *pLanguageUID=nil, FuncIsWordChar func=nil)=0
virtual TextIndex	CopyText (TextIndex position, int32 length, WideString *copy) const =0
virtual TextIndex	CopyText (const RangeData &range, WideString *copy) const =0
virtual TextIndex	FindSurroundingWord (TextIndex position, int32 *length, UID *pLanguageUID=nil, FuncIsWordChar wordFunc=nil)=0
virtual RangeData	FindSurroundingWord (TextIndex position, UID *pLanguageUID=nil, FuncIsWordChar wordFunc=nil)=0
virtual TextIndex	FindSurroundingWordUsingWordCharFuncOnly (TextIndex position, int32 *length, UID *pLanguageUID=nil, FuncIsWordChar wordFunc=nil)=0
virtual RangeData	FindSurroundingWordUsingWordCharFuncOnly (TextIndex position, UID *pLanguageUID=nil, FuncIsWordChar wordFunc=nil)=0
virtual TextIndex	FindSurroundingParagraph (TextIndex position, int32 *length, bool16 excludeEOS=kTrue, bool16 validatePara=kTrue) const =0
virtual RangeData	FindSurroundingParagraph (TextIndex position, bool16 excludeEOS=kTrue, bool16 validatePara=kTrue) const =0
virtual const IAttrReport *	QueryAttributeAt (int32 startPosition, int32 endPosition, ClassID typeAttribute, int32 *length=nil, bool16 moveBackwards=kFalse) const =0
virtual const IAttrReport *	QueryAttributeAt (const RangeData &range, ClassID typeAttribute, int32 *length=nil, bool16 moveBackwards=kFalse) const =0
virtual void	QueryAttributeAt (int32 startPosition, int32 endPosition, K2Vector< ClassID >::const_iterator firstAttribute, K2Vector< ClassID >::const_iterator endAttribute, AttributeBossList *results, int32 *length=nil, bool16 moveBackwards=kFalse) const =0
virtual IDrawingStyle *	GetCompleteStyleAt (TextIndex position, int32 *lenleft=nil)=0
virtual IDrawingStyle *	GetParagraphStyleAt (TextIndex position, int32 *lenleft=nil, TextIndex *paragraphStart=nil)=0
virtual const RunInStyleResults &	GetRunInStylesResultsAt (TextIndex position, TextIndex *paragraphStart=nil)=0
virtual TextIterator	QueryDataAt (TextIndex position, IDrawingStyle **newstyle, int32 *numChars)=0
virtual void	AttributesChanged (TextIndex start, int32 length)=0
virtual void	Clear ()=0
virtual void	StartComposingNestedStyles ()=0
virtual void	StopComposingNestedStyles ()=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 is the primary iterator for reading a text model (a story). It can return characters and attributes for ranges of text

Member Function Documentation

virtual void IComposeScanner::AttributesChanged ( TextIndex  start, int32  length  )

pure virtual

Indicates that the model has changed for the indicated range, called automatically

virtual void IComposeScanner::Clear ( )

pure virtual

Clears the cache. Shouldn't be necessary to call

virtual TextIndex IComposeScanner::CopySurroundingWord ( TextIndex  position, WideString *  copy, UID *  pLanguageUID = nil, FuncIsWordChar  func = nil  )

pure virtual

copies the word at the position. Uses FindSurroundingWord() to find the word, then copies it into copy

See Also

FindSurroundingWord

Parameters

position	Copy the word that contains this index
copy	Is set to the word found by FindSurroundingWord(). Must be non-nil.
pLanguageUID	Set the language applied to the word if non-nil.
func	Allows word detection heuristics to be overridden.

Returns

the word's starting position.

virtual TextIndex IComposeScanner::CopyText ( TextIndex  position, int32  length, WideString *  copy  ) const

pure virtual

Copies the specified text into the WideString.

Parameters

position	Copy the word that contains this index
length	How many characters should be copied
copy	must be non-nil. Is set to the text specified

Returns

Returns position

virtual TextIndex IComposeScanner::CopyText ( const RangeData &  range, WideString *  copy  ) const

pure virtual

See Also

CopyText

virtual TextIndex IComposeScanner::FindSurroundingParagraph ( TextIndex  position, int32 *  length, bool16  excludeEOS = kTrue, bool16  validatePara = kTrue  ) const

pure virtual

Returns

the paragraph's starting index, optionally including the end-of-story mark

Parameters

position	Get the paragraph that contains this index
length	Get the length of the paragraph, can be nil but default parameter causes ambiguity.
excludeEOS	if the paragraph ends at the story end (no CR) should the story end get counted or not?
validatePara	Only used in the debug build for more rigorous internal checks

virtual RangeData IComposeScanner::FindSurroundingParagraph ( TextIndex  position, bool16  excludeEOS = kTrue, bool16  validatePara = kTrue  ) const

pure virtual

See Also

FindSurroundingParagraph

virtual TextIndex IComposeScanner::FindSurroundingWord ( TextIndex  position, int32 *  length, UID *  pLanguageUID = nil, FuncIsWordChar  wordFunc = nil  )

pure virtual

Returns

the word's starting index and optionally the language applied to the word

Parameters

position	Get the word that contains this index
length	length of the word, can be nil but default parameter causes ambiguity.
pLanguageUID	if non-nil, is set to the language at the position
wordFunc	allows the "is a word" function to get overridden

virtual RangeData IComposeScanner::FindSurroundingWord ( TextIndex  position, UID *  pLanguageUID = nil, FuncIsWordChar  wordFunc = nil  )

pure virtual

See Also

FindSurroundingWord

virtual TextIndex IComposeScanner::FindSurroundingWordUsingWordCharFuncOnly ( TextIndex  position, int32 *  length, UID *  pLanguageUID = nil, FuncIsWordChar  wordFunc = nil  )

pure virtual

See Also

FindSurroundingWord

virtual RangeData IComposeScanner::FindSurroundingWordUsingWordCharFuncOnly ( TextIndex  position, UID *  pLanguageUID = nil, FuncIsWordChar  wordFunc = nil  )

pure virtual

See Also

FindSurroundingWord

virtual IDrawingStyle* IComposeScanner::GetCompleteStyleAt ( TextIndex  position, int32 *  lenleft = nil  )

pure virtual

Returns

a NON-ADDREF'D drawingstyle that reflects ALL attributes at the passed in location The returned length is not guaranteed to be precise. It may be that the next run shares these attributes due to the lazy combining that can occur.

Parameters

position	Get attributes for this location
lenleft	If non-nil, indicates how many characters (at least) share these attributes

virtual IDrawingStyle* IComposeScanner::GetParagraphStyleAt ( TextIndex  position, int32 *  lenleft = nil, TextIndex *  paragraphStart = nil  )

pure virtual

Returns

a NON-ADDREF'D drawingstyle that reflects the paragraph attributes at the passed in location The returned length is not guaranteed to be precise. It may be that the next paragraph shares these attributes due to the lazy combining that can occur. Run-in styles can also affect the length

Parameters

position	Get attributes for this location
lenleft	If non-nil, indicates how many characters (at least) share these attributes
paragraphStart	If non-nil, indicates the position of the start of the paragraph containing position

virtual const IAttrReport* IComposeScanner::QueryAttributeAt ( int32  startPosition, int32  endPosition, ClassID  typeAttribute, int32 *  length = nil, bool16  moveBackwards = kFalse  ) const

pure virtual

Returns

the specified attribute applied at startPosition. Will join runs when this attribute is unchanged until endPosition.

Parameters

startPosition	initial text location to start from
endPosition	text location to not bother looking beyond
typeAttribute	the text attribute in question
length	pointer to value that will contain the number of characters after startPosition that share the same attribute value for forward direction and number of characters from end position for backwards direction.
moveBackwards	specifies the direction in which above stated length parameter is to be reported. The value is kTrue for backwards direction and kFalse for forward direction.

virtual const IAttrReport* IComposeScanner::QueryAttributeAt ( const RangeData &  range, ClassID  typeAttribute, int32 *  length = nil, bool16  moveBackwards = kFalse  ) const

pure virtual

See Also

QueryAttributeAt

virtual void IComposeScanner::QueryAttributeAt ( int32  startPosition, int32  endPosition, K2Vector< ClassID >::const_iterator  firstAttribute, K2Vector< ClassID >::const_iterator  endAttribute, AttributeBossList *  results, int32 *  length = nil, bool16  moveBackwards = kFalse  ) const

pure virtual

This version of QueryAttributeAt works on collections of attributes.

Precondition

Params must not contain any duplicate ClassIDs. Results must be empty on input (results->CountBosses() == 0)

Postcondition

Results will contain attributes for each classID of params (results->CountBosses() == params.Length()) If length != nil on input, *length will be the number of characters starting at startPosition that have the same values for all of the given text attributes. length <= endPosition - startPosition

Parameters

startPosition	initial text location to start from
endPosition	text location to not bother looking beyond
firstAttribute	iterator.begin() of list of attributes being examined
endAttribute	iterator.end() of list of attributes being examined
results	filled with the list of attributes in question. Should NOT be nil.
length	pointer to value that will contain the number of characters after startPosition that share the same attribute value for forward direction and number of characters from end position for backwards direction.
moveBackwards	specifies the direction in which above stated length parameter is to be reported. The value is kTrue for backwards direction and kFalse for forward direction.

virtual TextIterator IComposeScanner::QueryDataAt ( TextIndex  position, IDrawingStyle **  newstyle, int32 *  numChars  )

pure virtual

This is the primary method that text composition uses to iterate the text model

Returns

an iterator on the buffer to characters. This buffer is referenced in the TextIterator, therefore, it is valid beyond the next call to the compose scanner.

Parameters

position	index to get the data for
newstyle	address of pointer to drawingstyle. If non-nil, the address will return pointing to an AddRef'd drawingstyle
numChars	if non-nil, number of characters (either 2 or 4 bytes) in the returned iterator that have the same style