SLCGlyphNode.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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 __SLCGlyphNode_h__
#define __SLCGlyphNode_h__

class IComposeScanner;
class IDrawingStyle;
class IWaxLine;
class IWaxRun;
class IFontInstance;
class PMRect;


class SLCGlyphNode
{
public:

 enum GlyphNodeType
 {
 kGNTText = 0,
 kGNTInlineGraphic
 };

 SLCGlyphNode( IComposeScanner* composeScanner, 
 IDrawingStyle* drawingStyle, 
 TextIndex startingIndex, 
 const PMReal& xOffset,
 GlyphNodeType glyphNodeType);

 virtual SLComposerStatusCode GetStatus() const
 {
 return fStatus;
 };

 virtual ~SLCGlyphNode();

 virtual SLComposerStatusCode GetGlyph(const UTF32TextChar& character, 
 Text::GlyphID& glyphID, 
 PMReal& glyphWidth) = 0;

 virtual SLComposerStatusCode BufferGlyph(const UTF32TextChar& character, const Text::GlyphID& glyphID, const PMReal& glyphWidth) = 0;

 virtual PMReal GetWidth() const = 0;

 virtual SLComposerStatusCode FindTextBreak() = 0;

 virtual bool16 GetTrailingWhiteSpaceWidth(PMReal& width) const = 0;


 virtual bool16 FitTrailingWhiteSpace(const PMReal& widthScaleFactor) = 0;

 virtual SLComposerStatusCode CreateWax(const IWaxLine* waxLine) const = 0;

 virtual IWaxRun* CreateWaxRun() const = 0; 

 virtual IDrawingStyle* GetDrawingStyle() const
 {
 return fDrawingStyle;
 }

 virtual const int32& GetTextSpan() const
 {
 return fTextSpan;
 };

 inline const PMReal& GetLeading() const
 {
 return fLeading;
 }

 inline const PMReal& GetAscent() const
 {
 return fAscent;
 }

 inline const PMReal& GetCapHeight() const
 {
 return fCapHeight;
 }

 inline const PMReal& GetXHeight() const
 {
 return fXHeight;
 }

 inline const TextIndex& GetTextIndex() const
 {
 return fTextIndex;
 }; 

 bool16 IsTrailingWhiteSpace(const UTF32TextChar& character) const;

 virtual void Dump(const char* msg) const;

 void SetTextSpan(int32 count)
 {
 fTextSpan = count;
 };

protected:
 SLComposerStatusCode fStatus; 

 IComposeScanner* fComposeScanner;

 IDrawingStyle* fDrawingStyle; 

 PMReal fXOffset;

 TextIndex fTextIndex;

 /* Cached metrics for the font.
 */
 PMReal fLeading; 
 PMReal fAscent;
 PMReal fCapHeight;
 PMReal fXHeight;

 int32 fTextSpan; 

 const GlyphNodeType fGlyphNodeType;
};

#endif // __SLCGlyphNode_h__

// End, SLCGlyphNode.h