ITextRuns.h

//========================================================================================
// 
// $File$
// 
// Owner: Kevin Van Wiel
// 
// $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.
// 
//========================================================================================

#ifndef __ITextRuns__
#define __ITextRuns__

#include "IPMUnknown.h"

#include "WritingModeUIID2.h"
#include "PMRect.h"
#include "UIDList.h"
#include "IInterfaceColors.h"
#include "LineDescription.h"
#include "K2Vector.h"
#include "IStoryService.h"

class ITextRun;
class IGraphicsPort;
class IPMFont;
class ITextModel;
class WideString;
class RangeData;

class RunLocation
{
 public:
 RunLocation() : fLineIndex(-1), fRunIndex(-1) {}
 
 RunLocation(int32 lineIndex, int32 runIndex) : fLineIndex(lineIndex), fRunIndex(runIndex) {}
 
 int32 fLineIndex;
 
 int32 fRunIndex;
};

class ITextRuns : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITEXTRUNS };
 
 virtual ITextRun *QueryRunInterface(const RunDescription &description) = 0;
 
 virtual const RunDescription& GetRun(int32 at, int32 run) = 0;
 
 virtual const RunDescription& GetRun(int32 storyIndex, int32 at, int32 run) = 0;
 
 virtual bool16 TextRunsContainedInLine(int32 storyIndex, int32 lineIndex) = 0;
 
 virtual void DrawRuns(int32 at, IGraphicsPort *gPort, const PMRect &clipRect, const PMPoint &scrollCompensationValue, 
 IPMFont *displayFont, PMReal displaySize, const LineDescription &description, bool16 topLineInDraw) = 0;
 
 virtual void DrawRuns(int32 storyIndex, int32 at, IGraphicsPort *gPort, const PMRect &clipRect, const PMPoint &scrollCompensationValue, 
 IPMFont *displayFont, PMReal displaySize, const LineDescription &description, bool16 topLineInDraw) = 0;
 
 
 virtual void CopyRuns(K2Vector<RunDescription> *source, K2Vector<RunDescription> *destination) = 0;
 
 virtual void AppendRun(LineDescription& line, RunDescription::RunType runType, TextIndex runStartOffset, TextIndex runEndOffset, UIDRef storyThreadRef, RealAGMColor runColor = RealAGMColor(1.0, 1.0, 1.0)) = 0;
 
 virtual int32 GetNumRuns(int32 at) = 0;
 
 virtual int32 GetNumRuns(int32 storyIndex, int32 at) = 0;

 virtual PMRect CalculateRunRect(int32 lineIndex, int32 runIndex) = 0;

 virtual int32 FindIndexOfRunAtPoint(const PMPoint &point, int32 *lineIndex) = 0;

 virtual int32 FindIndexOfRunAtPoint(const PMPoint &point, int32 lineIndex) = 0;

 virtual int32 GetLastRunIndex(int32 lineIndex) = 0;
 
 virtual int32 GetLastRunIndex(int32 storyIndex, int32 lineIndex) = 0;

 virtual PMReal ComputeRunWidth(int32 lineIndex, const RunDescription& runDescription, int32 *runLength) = 0;

 virtual bool8 GetUseTextRuns() = 0;

 virtual TextIndex GetLineStartOffsetAtRun(int32 lineIndex, int32 runIndex) = 0;
 
 virtual TextIndex GetLineEndOffsetAtRun(int32 lineIndex, int32 runIndex) = 0;
 
 virtual bool16 FindCharacterAtXPosition(int32 atLineIndex, int32 atRunIndex, PMReal &xPosition, int32 &offsetIntoLine) = 0;
 
 
 virtual int32 FindIndexOfRunAtTextModelOffset(LineDescription &description, int32 atTextModelOffset) = 0;
 
 virtual int32 FindIndexOfRunAtDisplayOffset(TextIndex offset, int32 &offsetIntoRun, bool16 bUsingEndOfLine = kFalse) = 0;
 
 virtual UIDRef GetNoteContent(ITextModel* model, TextIndex textStart, int32 &textLength, WideString &textContent, int32 startIndex = -1) = 0;

 virtual TextIndex FindInitialRunStart(int32 at, int32 runIndex, RunDescription::RunType type) = 0;
 
 virtual TextIndex FindInitialRunStart(int32 storyIndex, int32 at, int32 runIndex, RunDescription::RunType type) = 0;
 
 virtual RunDescription *FindRunAtDisplayOffset(TextIndex galleyDisplayOffset, int32 lineIndex, int32 *runIndex = nil) = 0;
 
 virtual RunDescription *FindRunAtDisplayOffset(int32 storyIndex, TextIndex galleyDisplayOffset, int32 lineIndex, int32 *runIndex = nil) = 0;
 
 virtual int32 GetRunChunk(ITextModel *model, const RunDescription &description, TextIndex textStart, int32 textLength, WideString &textContent, 
 float *widths, bool16 showInvisibles, int32 bufferSize, IFontMgr::FontStyleBits &fontStyle, IDrawingStyle::CapitalizeMode &capMode,
 int32 lineIndex, int32 runIndex) = 0;
 
 virtual int32 GetRunChunk(int32 storyIndex, ITextModel *model, const RunDescription &description, TextIndex textStart, int32 textLength, WideString &textContent, 
 float *widths, bool16 showInvisibles, int32 bufferSize, IFontMgr::FontStyleBits &fontStyle, IDrawingStyle::CapitalizeMode &capMode,
 int32 lineIndex, int32 runIndex) = 0;
 
 
 virtual int32 GetRunChunk(int32 storyIndex, ITextModel *model, const RunDescription &description, TextIndex textStart, int32 textLength, 
 float *widths, bool16 showInvisibles, int32 bufferSize, IFontMgr::FontStyleBits &fontStyle, IDrawingStyle::CapitalizeMode &capMode,
 int32 lineIndex, int32 runIndex) = 0;
 
 virtual PMReal DrawRegularTextRun(int32 at, IGraphicsPort *gPort, IPMFont *displayFont, PMReal displaySize, 
 int32 runIndex, const RealAGMColor &textColor, const PMPoint &drawPt, bool16 showInvisibles) = 0;

 virtual int32 FindIndexOfRunAtPoint(int32 storyIndex, const PMPoint &point, int32 *lineIndex) = 0;
 
 virtual int32 FindIndexOfRunAtPoint(int32 storyIndex, const PMPoint &point, int32 lineIndex) = 0;


 virtual void DrawLineOverlaps(int32 at, IGraphicsPort *gPort, const PMPoint &scrollCompensationValue,
 const LineDescription &description, bool16 topLineInDraw, int32 storyIndex) = 0;
 
 virtual bool16 GetExtendedRunSpanInformation(int32 storyIndex, const RunLocation &runIndex, RunDescription::RunType type, 
 RangeData *displayIndexRange, 
 RunLocation *extendedRunStart, RunLocation *extendedRunEnd) = 0;
};

#endif // __ITextRuns__