ITextAdornment.h

//========================================================================================
// 
// $File$
// 
// Owner: dwaterfa
// 
// $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 __ITextAdornment__
#define __ITextAdornment__

#include "IPMUnknown.h"
#include "TextID.h"
#include "IPMStream.h"
#include "IShape.h"
#include "TextDrawPriority.h"

class IGraphicsContext;
class PMRect;
class IWaxRun;
class IWaxLineShape;
class IWaxRenderData;
class IWaxGlyphs;
class ITextAdornmentData;
class GraphicsData;


class ITextAdornment : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTADORNMENT };

 virtual Text::DrawPriority GetDrawPriority() = 0;

 virtual void GetInkBounds(PMRect* inkBounds, const PMRect& runInkBounds,
 IWaxRun* waxRun,
 IWaxRenderData* renderData,
 IWaxGlyphs* waxGlyphs,
 const ITextAdornmentData *data) = 0;


 virtual void Draw(GraphicsData *gd, int32 iShapeFlags,
 IWaxRun* waxRun,
 IWaxRenderData* renderData,
 IWaxGlyphs* waxGlyphs,
 const ITextAdornmentData *data) = 0;
 
 virtual ITextAdornmentData* SplitAt( int32 offsetInRun, IWaxRun* waxRun, IWaxRun* newWaxRun, ITextAdornmentData* data ) = 0 ;
};


// Some well known Adobe non-Global adornment priorities
// Paragraph Rules:
// Give Rule above priority over Rule below - this way Rule below overprints
// (which is what version 152 did before we split into 2 bosses).
#define kTAPriParagraphShade Text::DrawPriority(Text::kTAPassPriBackground + -0.62) // BEFORE Para border
#define kTAPriParagraphBorder Text::DrawPriority(Text::kTAPassPriBackground + -0.61) // Before Para Rules
#define kTAPriParagraphRuleAbove Text::DrawPriority(Text::kTAPassPriBackground + -0.60) // BEFORE kTAPriMissingFont
#define kTAPriParagraphRuleBelow Text::DrawPriority(Text::kTAPassPriBackground + -0.59) // Above is drawn above below

// Underline draws below the text, strike through above
#define kTAPriUnderline Text::DrawPriority(Text::kTAPassPriBackground + -0.58) // right after paragraph rules
#define kTAPriStrikethru Text::DrawPriority(Text::kTAPassPriText + 0.55)

#define kTAPriIMEHints Text::DrawPriority(Text::kTAPassPriText + 0.45)

#define kTAPriBN Text::DrawPriority(Text::kTAPassPriText + 0.48) // Make bullets and numbering draw before text so that when export to PDF they will be tagged before paragraph, see bug #1695730.

#define kTAPriDrawText Text::DrawPriority(Text::kTAPassPriText + 0.50)

#define kTAPriKenten Text::DrawPriority(Text::kTAPassPriText + 0.60)
#define kTAPriRuby Text::DrawPriority(Text::kTAPassPriText + 0.65) // Ruby after Kenten

#define kTAPriFakeTabViolations Text::DrawPriority(Text::kTAPassPriBackground + -0.60) // before kTAPriHnJKeepsViolations. See IGlobalTextAdornment.h

#endif