IStoryService.h

//========================================================================================
// 
// $File$
// 
// Owner: Wai Cheuk
// 
// $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 __ISTORYSERVICE__
#define __ISTORYSERVICE__

#include "IPMUnknown.h"
#include "WritingModeUIID2.h"
#include "WritingModeID2.h"
#include "IFontMgr.h"
#include "IDrawingStyle.h"


class ITextLines;
class IDrawingStyle;
class WideString;
class LineDescription;
class RunDescription;

class IStoryService : public IPMUnknown
{
 public:

 enum { kDefaultIID = IID_ISTORYSERVICE };

 // Used for galley drawing gets a single chunk of glyphs
 // that can be drawn in one burst for galley view. Fills out
 // drawglyphs, widths and invisible characters. Buffers
 // for these glyphs must be passed to this routine.
 // It also returns information on what type of glyphs
 // are being returned with regards to what font style
 // the glyphs should be drawn in.


 virtual int32 GetRangeOfDrawGlyphs(UID storyThreadDict,
 int32 storyThreadKey,
 ITextLines *textLines,
 TextIndex rangeStart,
 int32 textLength,
 int32 *glyphArray, // space allocated by caller filled out by this method
 float *widths, // space allocated by caller filled out by this method
 WideString &text, // returned text
 PMReal *rangeWidth,
 IFontMgr::FontStyleBits &fontStyle,
 IDrawingStyle::CapitalizeMode &capMode,
 bool16 showInvisibles,
 int32 maxSizeSAllowed,
 bool16 returnFullText) = 0;

 // After calling GetRangeOfDrawGlyphs you may call this routine to get the
 // font to draw in or to measure text with. Galley normally will display in
 // a single display font family but allows for the possibility that the user
 // may have used a font having glyphs that are not displayable correctly in
 // a single display font (such as Symbol font). Galley allows a list of font
 // overrides to be specified. This routine is aware of those and will always
 // return the correct font to display text in.

 virtual IFontInstance *QueryDisplayFontInstanceForCurrentChunk() = 0;
 virtual IPMFont *QueryDisplayFontForCurrentChunk() = 0;

 // Return the glyphs for invisible characters. Must have called GetRangeOfDrawGlyphs
 // for the range of invisibles you are interested in prior to calling these methods.
 virtual int32 *GetCurrentInvisibles() = 0;
 virtual float *GetCurrentInvisiblesWidths() = 0;
 virtual float *GetCurrentInvisiblesYAjustments() = 0;
 virtual int32 GetCurrentInvisiblesLength() = 0;

 // Given a widths array from GetRangeOfDrawGlyphs this routine can be used
 // to find the xPosition from the left of a position.
 virtual PMReal SumCharWidths(float *widths, int32 numOfCharactersIn) = 0;


 // Get the text out of a story useful if you don't care
 // about any style information or glyphs just the straight
 // text.

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

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

 // Given the inTextIndex, return the corresponding text
 // index in the story thread.

 virtual TextIndex GetStoryThreadEnd(UID storyThreadDict,
 int32 storyThreadKey,
 TextIndex inTextIndex) = 0;
 // Given the inTextIndex, return the corresponding text
 // last index in the story thread.

 virtual TextIndex GetTextLineIndex(UID storyThreadDict,
 int32 storyThreadKey,
 TextIndex inTextIndex) = 0;
 // Given the inTextIndex in the story thread, return the
 // corresponding text index in the main story thread.

 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, // space allocated by caller filled out by this method
 float *widths, // space allocated by caller filled out by this method
 PMReal *rangeWidth,
 IFontMgr::FontStyleBits &fontStyle,
 IDrawingStyle::CapitalizeMode &capMode,
 bool16 showInvisibles,
 int32 maxSizeSAllowed,
 bool16 returnFullText) = 0;


 // Set the current lineDescription
 virtual void SetCurrentLineDescription(LineDescription* lineDescription) = 0;

 // Get the current lineDescription
 virtual LineDescription* GetCurrentLineDescription() = 0;

 // Set the current runDescription
 virtual void SetCurrentRunDescription(const RunDescription* runDescription) = 0;

 // Get the current runDescription
 virtual const RunDescription* GetCurrentRunDescription() = 0;

 // Set the offset of the invisibles glyphs (for a run)
 virtual void SetInvisiblesOffset(float offset) = 0;

 // Get the offset of the invisibles glyphs (for a run)
 virtual float GetInvisiblesOffset() = 0;

};

#endif // __ISTORYSERVICE__