RunDescription Class Reference

#include <LineDescription.h>

Public Types
enum	RunType {   regularText = 0, addedText, movedText, baselessBeginTag,   baselessEndTag, endPrimaryStoryTypes, deletedText, inlineNoteText,   inlineNoteBeginTag, inlineNoteEndTag, xmlBeginTag, xmlEndTag,   xmlStoryTag, footnoteText, footnoteBeginTag, footnoteEndTag,   xmlRTLBeginTag, xmlRTLEndTag, footnoteRTLBeginTag, tableText }
typedef object_type	data_type

Public Member Functions
	RunDescription ()
	RunDescription (const RunDescription &src)
virtual	~RunDescription ()
RunDescription &	operator= (const RunDescription &src)
void	ReadWrite (IPMStream *s, StoryDescription *storyDesc)

Public Attributes
TextIndex	startModelOffset
TextIndex	startDisplayOffset
int32	length
TextIndex	anchorPoint
RunType	type
RealAGMColor	color
RealAGMColor	textcolor
PMReal	width
PMReal	xPosition
UIDRef	storyThreadRef
bool16	onlyContainsEndCharacter
CDynamicSpellCheckCache *	fDynamicSpellCheckCache
StoryRunGlyphs *	fGlyphCache
uint32	fThreadDictKey
RunType	fSecondaryType
int32	level
int32	glyphIndex
int32	glyphLength
int32	complementaryFontIndex

Detailed Description

Each LineDescription may have 0 or more RunDescriptions. A RunDescription defines a specific type of item display in story/galley (See RunType enum) and range of text in a line. The RunDescriptions are created along with the line description during composition. These should not in general be modified by third parties but can be looked at to find out information about line text.

Member Typedef Documentation

typedef object_type RunDescription::data_type

object_type - internal use K2Vector detail.

Member Enumeration Documentation

enum RunDescription::RunType

RunType - Enum defines different possible run types for a RunDescription.

Enumerator
regularText	regularText - Standard vanilla text
addedText	movedText - Tracked change added text
movedText	movedText - Tracked change moved text
endPrimaryStoryTypes	endPrimaryStoryTypes - Enum value to separate main story text from anchored text types like inline notes and deleted text. Enums values greater than this value are anchored in the main text. Enum values less than this value are main story text
deletedText	deletedText - Tracked change deleted text
inlineNoteText	inlineNoteText - The text portion of an inline note
inlineNoteBeginTag	inlineNoteBeginTag - The begin tag portion of an inline note
inlineNoteEndTag	inlineNoteBeginTag - The end tag portion of an inline note
xmlBeginTag	xmlBeginTag - obsolete handled by IOwnedItemIcons instead
xmlEndTag	xmlEndTag - obsolete handled by IOwnedItemIcons instead
xmlStoryTag	xmlStoryTag - obsolete handled by IOwnedItemIcons instead
footnoteText	footnoteText - The text portion of a footnote
footnoteBeginTag	footnoteBeginTag - The begin tag portion of a footnote
footnoteEndTag	footnoteBeginTag - The end tag portion of a footnote
tableText	tableText - text in a table

Constructor & Destructor Documentation

RunDescription::RunDescription

(

)

Constructor for RunDescription.

Returns

none.

RunDescription::RunDescription

(

const RunDescription &

src

)

Constructor for RunDescription.

Parameters

src	- source run to base new rundescription on

Returns

none.

virtual RunDescription::~RunDescription ( )

virtual

Destructor for a RunDescription.

Returns

none.

Member Function Documentation

RunDescription& RunDescription::operator=

(

const RunDescription &

src

)

Operator overload for '=' necessary for the fDynamicSpellCheckCache copying

Parameters

src	- source run to base new rundescription on

Returns

a RunDescription created from the src description.

void RunDescription::ReadWrite	(	IPMStream *	s,
		StoryDescription *	storyDesc
	)

internal use only undo/redo support.

Member Data Documentation

TextIndex RunDescription::anchorPoint

anchorPoint - Some non-primary runs need to know the index they start drawing at in the primary story (their anchor position) this stores this

RealAGMColor RunDescription::color

color - highlight color, used for tracked change text types

CDynamicSpellCheckCache* RunDescription::fDynamicSpellCheckCache

onlyContainsEndCharacter - used to cache dynamic spell check information.

StoryRunGlyphs* RunDescription::fGlyphCache

Glyphs that are shown in this run.

RunType RunDescription::fSecondaryType

fSecondaryType - More information describing run for example table text may be also track change added text. So it would have a type of tableText and a secondary type of addedText

uint32 RunDescription::fThreadDictKey

fThreadDictKey - Used to find thread associated with this run.

int32 RunDescription::length

length - length of the run, same for display and model offsets

bool16 RunDescription::onlyContainsEndCharacter

onlyContainsEndCharacter - Is kTrue to indicate that this is a special type of inlineNoteText or footnote run with only the end story thread character present.

TextIndex RunDescription::startDisplayOffset

startDisplayOffset - Start offset of the text run. These are galley display offsets.

TextIndex RunDescription::startModelOffset

startModelOffset - Start offset of the text run. These are text model offsets. See ITextLines for discussion of display vs model offsets

UIDRef RunDescription::storyThreadRef

storyThreadRef - reference to find the non-primary story thread for runs not in the primary story

RealAGMColor RunDescription::textcolor

textcolor - text color, used for tracked change text types

RunType RunDescription::type

type - Describes how this run draws and behaves. See RunType comments for description of different possible types

PMReal RunDescription::width

width - width of run in pixels

PMReal RunDescription::xPosition

xPosition - pixel position from line start where the run starts drawing