LineDescription.h

//========================================================================================
// 
// $File$
// 
// Owner:
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// ADOBE CONFIDENTIAL
// 
//========================================================================================

#ifndef __LineDescription__
#define __LineDescription__

#include "IInterfaceColors.h"
#include "ITextUtils.h"


#ifdef PUBLIC_BUILD
#endif
class CDynamicSpellCheckCache;
class RealAGMColor;
class StoryDescription;
class PMRealGlyphPoint;


class GlyphDrawAddIn
{
public:
 typedef object_type data_type;

 enum AddInType
 {
 kNone,

 kOwnedItemIcon,

 kAttributeIcon
 };

 AddInType fType;

 int32 glyphIndex;
};

class LineDescriptionME;

class DrawingChunkRange
{
public:
 typedef object_type data_type;

 enum FontDrawStyle
 {
 kNormal = 0x00,

 kBold = 0x02,

 kItalic = 0x04,

 kAllCaps = 0x08,

 kSmallCaps = 0x10
 };

 FontDrawStyle fFontStyle;

 bool16 fUseModelFont;

 uint16 fLength;
};


class StoryRunGlyphs
{
public:
 typedef object_type data_type;

 StoryRunGlyphs();

 virtual ~StoryRunGlyphs();

 void ReadWrite(IPMStream* s, StoryDescription *storyDesc);

 K2Vector<PMRealGlyphPoint> *fGlyphPoints;

 K2Vector<GlyphDrawAddIn> *fAddIns;

 K2Vector<DrawingChunkRange> *fDrawRanges;
};

class RunDescription
{
 public:
 typedef object_type data_type;


 RunDescription();

 RunDescription(const RunDescription& src);

 virtual ~RunDescription();

 RunDescription& operator= (const RunDescription& src);

 void ReadWrite(IPMStream* s, StoryDescription *storyDesc);


 enum RunType
 {
 regularText = 0,

 addedText,

 movedText,

 baselessBeginTag,
 baselessEndTag,

 endPrimaryStoryTypes,

 deletedText,

 inlineNoteText,

 inlineNoteBeginTag,

 inlineNoteEndTag,

 xmlBeginTag,

 xmlEndTag,

 xmlStoryTag,

 footnoteText,

 footnoteBeginTag,

 footnoteEndTag,

 xmlRTLBeginTag,
 xmlRTLEndTag,
 footnoteRTLBeginTag,

 tableText
 };
 
 // 2008/01/28 MH: WARNING!!! DON'T FORGET TO UPDATE THIS MACRO IN CASE OF ADDING OR REMOVING a RunType
#define STORYEDITOR_CONTEXTUALIZED_RUN(runType)\
 ((runType == RunDescription::regularText)\
 || (runType == RunDescription::addedText)\
 || (runType == RunDescription::movedText)\
 || (runType == RunDescription::deletedText)\
 || (runType == RunDescription::inlineNoteText)\
 || (runType == RunDescription::footnoteText)\
 || (runType == RunDescription::tableText))

 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; // direction level of the run
 int32 glyphIndex; // index of the first glyph in LineDescriptionME::fStrikes
 int32 glyphLength; // number of glyphs for this run in LineDescriptionME::fStrikes
 int32 complementaryFontIndex;
};

#define NoPsuedoComposeID 0

class LineDescription
{
 public:
 typedef object_type data_type;

 virtual ~LineDescription();

 enum LineType
 {
 textWithLineNumber = 0,

 textWithoutLineNumber,

 pageDivider,

 columnDivider,

 frameDivider,

 oversetDivider,

 storyBar,

 paraDivider,

 tableRowDivider,

 tableColumnDivider,
 };
 static const int32 kMaxViewSpace;

 enum LineAttributes
 {
 none = 0x0,
 oversetSplitLineStart = 0x1,
 oversetSplitLineEnd = 0x2
 };
 LineDescription();
 LineDescription(const LineDescription& other);

 void ReadWrite(IPMStream *s, StoryDescription *storyDesc);

 TextIndex lineStartOffset;

 TextIndex lineEndOffset;

 TextIndex tableThreadStartOffset;

 TextIndex tableThreadEndOffset;

 TextIndex displayStartOffset;

 TextIndex displayEndOffset;

 PMReal xPosition;

 PMReal lineWidth;

 int32 lineID;

 int32 lineNumber;

 LineType typeLine;

 bool16 hyphenAtEnd;

 bool16 paraEndCharacter;

 bool16 overlapsWithNext;

 int32 psuedoLineID;

 uint32 attributes;

 K2Vector<RunDescription> *fTextRuns;
 LineDescriptionME* fMEData;
};

class UncomposedIDNode
{
 public:
 typedef object_type data_type;
 UncomposedIDNode();
 void ReadWrite(IPMStream* s);

 int32 fID;

 int32 fLineIndexHint;
};

class StoryDescription
{
 public:
 typedef object_type data_type;

 enum ViewComposeOptions
 {
 kDisplayTextOnly = 0,

 kDisplayInlineNotes = 1,

 kDisplayFootnotes = 2,
 };
 StoryDescription();

 virtual ~StoryDescription();

 void ReadWrite(IPMStream *s);

 UIDRef fStoryRef;

 PMReal fYFirstLineStartPosition;

 int32 fLastValidIndex;

 int32 fStoryOversetDividerIndex;

 bool16 fCollapsed;

 bool16 fStoryBarSelected;

 uint32 fViewComposeOptions;

 bool operator < (const StoryDescription& other) const
 {return fStoryRef.GetUID() < other.fStoryRef.GetUID();}

 bool operator == (const StoryDescription& other) const
 {return &other == this;}

 K2Vector<LineDescription> *fTextLines;

 K2Vector<UncomposedIDNode> *fUncomposedIDs;
};

#ifdef PUBLIC_BUILD
#endif

#endif // __LineDescription__