IGlobalTextAdornment.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 __IGlobalTextAdornment__
#define __IGlobalTextAdornment__

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

class GraphicsData;
class PMRect;
class IWaxRun;
class IWaxRenderData;
class IWaxGlyphs;
class IParcelShape;
class ITextOptions;



class IGlobalTextAdornment : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGLOBALTEXTADORNMENT };

 virtual Text::DrawPriority GetDrawPriority() = 0;

 virtual bool16 GetCheckIsActive() = 0;
 
 virtual bool16 GetIsActive(const IParcelShape *parcelShape,
 const ITextOptions *textOptions,
 int32 iShapeFlags) = 0;

 virtual bool16 GetCheckCouldDraw() = 0;

 virtual bool16 GetCouldDraw(const IWaxRun *waxRun,
 const IWaxRenderData *waxRenderData,
 const IWaxGlyphs *waxGlyphs) = 0;

 virtual bool16 GetHasInkBounds() = 0;

 virtual void GetInkBounds(PMRect *inkBounds,
 const IWaxRun *waxRun,
 const IWaxRenderData *waxRenderData,
 const IWaxGlyphs *waxGlyphs) = 0;

 virtual void Draw(GraphicsData *gd, int32 iShapeFlags,
 const IWaxRun *waxRun,
 const IWaxRenderData *waxRenderData,
 const IWaxGlyphs *waxGlyphs) = 0;

 virtual void StartOfParcelDraw(GraphicsData* gd, int32 iShapeFlags,
 const IParcelShape *parcelShape) = 0;

 virtual void EndOfParcelDraw(GraphicsData* gd, int32 iShapeFlags,
 const IParcelShape *parcelShape) = 0;

};


//
// Draw priorities of some well known Adobe Global adornments.
//
#define kTAPriHnJKeepsViolations Text::DrawPriority(Text::kTAPassPriBackground + -0.54)
#define kTAPriMissingFont Text::DrawPriority(Text::kTAPassPriBackground + -0.52)
#define kTAPriMissingGlyphs Text::DrawPriority(Text::kTAPassPriBackground + -0.50)
#define kTAPriKinsoku Text::DrawPriority(Text::kTAPassPriBackground + -0.49)
#define kTAPriCustomCharWidths Text::DrawPriority(Text::kTAPassPriBackground + -0.49)
#define kTAPriNotes Text::DrawPriority(Text::kTAPassPriText + 0.30)
#define kTAPriPositionMarker Text::DrawPriority(Text::kTAPassPriText + 0.35)
#define kTAPriXMLMarkers Text::DrawPriority(Text::kTAPassPriText + 0.48)
#define kTAPriShowInvisibles Text::DrawPriority(Text::kTAPassPriForeground + 0.50)
#define kTAPriDynamicSpellCheck Text::DrawPriority(Text::kTAPassPriForeground + 0.52)

#endif