Inheritance diagram for IStoryService:

Public Types
enum	{ kDefaultIID = IID_ISTORYSERVICE }

Public Member Functions
virtual int32	GetRangeOfDrawGlyphs (UID storyThreadDict, int32 storyThreadKey, ITextLines textLines, TextIndex rangeStart, int32 textLength, int32 glyphArray, float widths, WideString &text, PMReal rangeWidth, IFontMgr::FontStyleBits &fontStyle, IDrawingStyle::CapitalizeMode &capMode, bool16 showInvisibles, int32 maxSizeSAllowed, bool16 returnFullText)=0

virtual IFontInstance *	QueryDisplayFontInstanceForCurrentChunk ()=0

virtual IPMFont *	QueryDisplayFontForCurrentChunk ()=0

virtual int32 *	GetCurrentInvisibles ()=0

virtual float *	GetCurrentInvisiblesWidths ()=0

virtual float *	GetCurrentInvisiblesYAjustments ()=0

virtual int32	GetCurrentInvisiblesLength ()=0

virtual PMReal	SumCharWidths (float *widths, int32 numOfCharactersIn)=0

virtual void	GetStoryContent (UID storyThreadDict, int32 storyThreadKey, TextIndex lineStart, int32 textLength, WideString &lineText)=0

virtual TextIndex	GetStoryThreadIndex (UID storyThreadDict, int32 storyThreadKey, TextIndex inTextIndex)=0

virtual TextIndex	GetStoryThreadEnd (UID storyThreadDict, int32 storyThreadKey, TextIndex inTextIndex)=0

virtual TextIndex	GetTextLineIndex (UID storyThreadDict, int32 storyThreadKey, TextIndex inTextIndex)=0

virtual IFontMgr::FontStyleBits	GetFontStyle (IDrawingStyle *drawStyle)=0

virtual Text::GlyphID	ConvertToGlyphUsingPlatformEncoding (IFontInstance fontInstance, IPMFont font, UTF32TextChar character, PMReal *glyphWidth)=0

virtual void	ClearGlyphCache ()=0

virtual int32	GetRangeOfDrawGlyphs (UID storyThreadDict, int32 storyThreadKey, ITextLines textLines, TextIndex rangeStart, int32 textLength, int32 glyphArray, float widths, PMReal rangeWidth, IFontMgr::FontStyleBits &fontStyle, IDrawingStyle::CapitalizeMode &capMode, bool16 showInvisibles, int32 maxSizeSAllowed, bool16 returnFullText)=0

virtual void	SetCurrentLineDescription (LineDescription *lineDescription)=0

virtual LineDescription *	GetCurrentLineDescription ()=0

virtual void	SetCurrentRunDescription (const RunDescription *runDescription)=0

virtual const RunDescription *	GetCurrentRunDescription ()=0

virtual void	SetInvisiblesOffset (float offset)=0

virtual float	GetInvisiblesOffset ()=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 void IStoryService::ClearGlyphCache ( )

pure virtual

Call to clear the cached glyph data. Return void

virtual Text::GlyphID IStoryService::ConvertToGlyphUsingPlatformEncoding	(	IFontInstance *	fontInstance,
		IPMFont *	font,
		UTF32TextChar	character,
		PMReal *	glyphWidth
	)

pure virtual

This is used so when all other attempts to convert a character code to a glyph fail to provide a valid glyph. Typically this is because we have a symbol font or some other font that is encoded in the text model with platform encoding. Return glyph id coorsponding to character code passed in (character)

Parameters

fontInstance	to get glyph width from
font	Font to ask for a gyph from
character	The character code to convert to a glyph
glyphWidth	width of glyph is returned in this variable.

virtual int32 IStoryService::GetRangeOfDrawGlyphs	(	UID	storyThreadDict,
		int32	storyThreadKey,
		ITextLines *	textLines,
		TextIndex	rangeStart,
		int32	textLength,
		int32 *	glyphArray,
		float *	widths,
		WideString &	text,
		PMReal *	rangeWidth,
		IFontMgr::FontStyleBits &	fontStyle,
		IDrawingStyle::CapitalizeMode &	capMode,
		bool16	showInvisibles,
		int32	maxSizeSAllowed,
		bool16	returnFullText
	)

pure virtual

Given a range of indexes provide an array of glyphs to display in the story and galley views. This version will also return unicode text values for the range and is less efficient than the version that does not. Return number of glyphs

Parameters

storyThreadDict	dict of story thread for range
storyThreadKey	thread key to get range for
textLines	a pointer to the ITextLines of the view to get the glyphs for. Used to get display font etc.
rangeStart	start text index to get glyphs for.
textLength	number of characters to get glyphs for.
glyphArray	preallocated array to return glyphs in.
widths	preallocated array to return glyph width values in.
text	a WideString where the unicode values for the range are returned.
rangeWidth	draw width of all glyphs (can pass nil if don't care it will be more efficient).
fontStyle	if not "returnFullText" this returns the display font style for this range of text (see IFontMgr)
capMode	if not "returnFullText" this returns the cap mode for this range of text (see IDrawingStyle)
showInvisibles	Pass kTrue to get the routine to calculate hidden character array. Call GetCurrentInvisibles() and GetCurrentInvisiblesWidths() to get array values back after calling this routine
maxSizeSAllowed	maximum number of enteries there is space allocated for in the glyphArray param
returnFullText	kTrue to ignore run information and return a the full range requested regardless.

virtual int32 IStoryService::GetRangeOfDrawGlyphs	(	UID	storyThreadDict,
		int32	storyThreadKey,
		ITextLines *	textLines,
		TextIndex	rangeStart,
		int32	textLength,
		int32 *	glyphArray,
		float *	widths,
		PMReal *	rangeWidth,
		IFontMgr::FontStyleBits &	fontStyle,
		IDrawingStyle::CapitalizeMode &	capMode,
		bool16	showInvisibles,
		int32	maxSizeSAllowed,
		bool16	returnFullText
	)

pure virtual

Given a range of indexes provide an array of glyphs to display in the story and galley views. This version is more efficient than the version which also will return the model unicode values. Return number of glyphs

Parameters

storyThreadDict	dict of story thread for range
storyThreadKey	thread key to get range for
textLines	a pointer to the ITextLines of the view to get the glyphs for. Used to get display font etc.
rangeStart	start text index to get glyphs for.
textLength	number of characters to get glyphs for.
glyphArray	preallocated array to return glyphs in.
widths	preallocated array to return glyph width values in.
rangeWidth	draw width of all glyphs (can pass nil if don't care it will be more efficient).
fontStyle	if not "returnFullText" this returns the display font style for this range of text (see IFontMgr)
capMode	if not "returnFullText" this returns the cap mode for this range of text (see IDrawingStyle)
showInvisibles	Pass kTrue to get the routine to calculate hidden character array. Call GetCurrentInvisibles() and GetCurrentInvisiblesWidths() to get array values back after calling this routine
maxSizeSAllowed	maximum number of enteries there is space allocated for in the glyphArray param
returnFullText	kTrue to ignore run information and return a the full range requested regardless.

Public Types

Public Member Functions

Member Function Documentation