StoryDescription Class Reference

#include <LineDescription.h>

Public Types
enum	ViewComposeOptions { kDisplayTextOnly = 0, kDisplayInlineNotes = 1, kDisplayFootnotes = 2 }
typedef object_type	data_type

Public Member Functions
	StoryDescription ()
void	ReadWrite (IPMStream *s)
bool	operator< (const StoryDescription &other) const
bool	operator== (const StoryDescription &other) const

Public Attributes
UIDRef	fStoryRef
PMReal	fYFirstLineStartPosition
int32	fLastValidIndex
int32	fStoryOversetDividerIndex
bool16	fCollapsed
bool16	fStoryBarSelected
uint32	fViewComposeOptions
K2Vector< LineDescription > *	fTextLines
K2Vector< UncomposedIDNode > *	fUncomposedIDs

Detailed Description

Used to make a vector of stories for multiple stories in one panel galley view and story view. InDesign will only have one story per window (view) but InCopy may have many.

Member Typedef Documentation

typedef object_type StoryDescription::data_type

object_type - internal use K2Vector detail.

Member Enumeration Documentation

enum StoryDescription::ViewComposeOptions

ViewComposeOptions - These are values correspond to session preferences that affect the way text is composed on a view level. They are duplicated here because on undo the StoryDescription data is restored from snapshot data but this might be in disagreement with the session settings that had changed but do not get undone on the document level. Therefore we do a compare between the compose settings that view story has verses the version in the session to determine if any fix up needs to occur. It's an imperfect world, sigh.

Enumerator
kDisplayTextOnly	kDisplayTextOnly - basic text.
kDisplayInlineNotes	kDisplayInlineNotes - basic text with inline notes.
kDisplayFootnotes	kDisplayFootnotes - basic text with footnotes.

Constructor & Destructor Documentation

StoryDescription::StoryDescription

(

)

Constructor.

Returns

none

Member Function Documentation

void StoryDescription::ReadWrite

(

IPMStream *

s

)

internal use only undo/redo support.

Member Data Documentation

bool16 StoryDescription::fCollapsed

fCollapsed - InCopy allows stories to be collapsed if this story is collapse then this will be kTrue

int32 StoryDescription::fLastValidIndex

fLastValidIndex - last update line index in the story (See ITextLines::UpdateLine()).

bool16 StoryDescription::fStoryBarSelected

fStoryBarSelected - Story bars are not regular text so they must be marked as being selected specially. This will be true if the storybar is selected.

int32 StoryDescription::fStoryOversetDividerIndex

fStoryOversetDividerIndex - If there is an overset divider adornment drawn this will mark which line index to draw it at. If there is none then it will be -1.

UIDRef StoryDescription::fStoryRef

fStoryRef - UID reference of the text model display in the story.

K2Vector<LineDescription>* StoryDescription::fTextLines

fTextLines - pointer to a vector of LineDescriptions representing the lines in the story

K2Vector<UncomposedIDNode>* StoryDescription::fUncomposedIDs

fUncomposedIDs - pointer to a vector of psuedo composed lines (for background composition)

uint32 StoryDescription::fViewComposeOptions

fViewComposeOptions - Values from ViewComposeOptions enum, may be or'd to gether.

PMReal StoryDescription::fYFirstLineStartPosition

fYFirstLineStartPosition - how far down from the top of the view in pixels to start drawing this story.