IDrawingStyle.h

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


#include "IPMUnknown.h"
#include "TextID.h"
#include "CTextEnum.h"

class IDataBase;
class IPMFont;
class IFontInstance;
class IWaxRenderData;
class ITextAdornmentData;
class IWaxRun;

class PMString;
class PMMatrix;
class PMPoint;

class IDrawingStyle : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IDRAWINGSTYLE };

 enum CapitalizeMode { kCapNormal = 0, kCapSmallLowercase, kCapAll, kCapSmallEverything, kCapLowercase };

 enum PositionMode { kPosNormal = 0, kPosSuperscript, kPosSubscript,
 kPosSuperior, kPosInferior, kPosNumerator, kPosDenominator };

 enum UnderlineMode { kUnderlineNone = 0, kUnderlineSingle };

 enum CharacterHang { kHangBaseline = 0, kHangEmCenter, kHangEmBottom, kHangEmTop, kHangICFBottom, kHangICFTop };

 enum PositionIndicator { kDataPosition_ThisPage = 0, kDataPosition_PreviousPage, kDataPosition_NextPage, kDataPosition_TextVariable,
#ifdef ID_DEPRECATED
 kDataPosition_This = kDataPosition_ThisPage, kDataPosition_Previous = kDataPosition_PreviousPage, kDataPosition_Next = kDataPosition_NextPage
#endif
 };

 enum OTPositioningForm { kOTPosForm_Off, kOTPosForm_Auto, kOTPosForm_Initial, kOTPosForm_Medial, kOTPosForm_Final, kOTPosForm_Isolated };

 virtual IFontInstance* QueryFontInstance(bool16 vertical) const = 0;

 virtual IPMFont* QueryFont() const = 0;

 virtual bool16 IsFontMissing() const = 0;

 virtual bool16 HasMMOpticalSize() const = 0;

 virtual void SetSpecialGlyph(const char* name, Text::GlyphID glyph = kInvalidGlyphID) = 0;

 virtual Text::GlyphID GetSpecialGlyph() const = 0; // figures out glyphid for this font

 virtual void SetPointSize(PMReal p) = 0;

 virtual PMReal GetPointSize() const = 0;

 virtual void SetSkewAngle(PMReal p) = 0;
 virtual PMReal GetSkewAngle() const = 0;

 virtual void GetScaledFontMatrix(PMMatrix * fontMatrix) const = 0;

 virtual void GetUnScaledFinalFontMatrix(PMMatrix * fontMatrix, bool16 vertical) const = 0;

 virtual void GetFinalFontMatrix(PMMatrix * fontMatrix, bool16 vertical) const = 0;

 virtual void SetFontUID(UID u) = 0;

 virtual UID GetFontUID() const = 0;

 virtual void SetFontStyleName(const PMString& name) = 0;

 virtual const PMString& GetFontStyleName() const = 0;

 virtual const PMString& GetPostscriptFontName() const = 0;

 virtual void SetMMAxes(int32 num, const Fixed *buffer) = 0;

 virtual const Fixed* GetMMAxes() const = 0;

 virtual void SetGlyphScaleX(PMReal scale) = 0;
 virtual void SetGlyphScaleY(PMReal scale) = 0;

 virtual void SetDesiredGlyphScale(PMReal xscale) = 0;

 virtual PMReal GetXScale() const = 0;

 virtual PMReal GetYScale() const = 0;

 virtual PMReal GetXScaleOnly() const = 0;

 virtual void SetLeading(PMReal abs) = 0;

 virtual void SetAutoLead(PMReal factor) = 0;

 virtual PMReal GetLeading() const = 0;

 virtual PMReal GetAutoLead() const = 0;

 virtual bool16 UseAutoLeading() const = 0;

 virtual PMReal GetBaseLineShift() const = 0;

 virtual void SetBaseLineShift(PMReal r) = 0;

 virtual CharacterHang GetCharacterHang() const = 0;

 virtual void SetCharacterHang(CharacterHang b) = 0;

 virtual OTPositioningForm GetOTPositioningForm() const = 0;

 virtual void SetOTPositioningForm(OTPositioningForm form) = 0;

 virtual PositionIndicator GetPageNumberPosition() const = 0;

 virtual void SetPageNumberPosition(PositionIndicator pi) = 0;

 virtual PMReal GetEffectiveBaseline() const = 0;

 virtual UID GetColorUID(bool16 stroke) const = 0;

 virtual void SetColorUID(bool16 stroke, UID newColor) = 0;

 virtual void SetTint(bool16 stroke, PMReal tint) = 0;

 virtual PMReal GetTint(bool16 stroke) const = 0;

 virtual void SetOverprint(bool16 stroke, bool16 over) = 0;

 virtual bool16 GetOverprint(bool16 stroke) const = 0;

 virtual void SetHiliteAngle(bool16 stroke, PMReal v) = 0;

 virtual PMReal GetHiliteAngle(bool16 stroke) const = 0;

 virtual void SetHiliteLength(bool16 stroke, PMReal v) = 0;

 virtual PMReal GetHiliteLength(bool16 stroke) const = 0;

 virtual void SetGradientAngle(bool16 stroke, PMReal angle) = 0;

 virtual PMReal GetGradientAngle(bool16 stroke) const = 0;

 virtual void SetGradientLength(bool16 stroke, PMReal length) = 0;

 virtual PMReal GetGradientLength(bool16 stroke) const = 0;

 virtual void SetGradientCenter(bool16 stroke, const PMPoint& center) = 0;

 virtual PMPoint GetGradientCenter(bool16 stroke) const = 0;

 virtual void SetDataBase(IDataBase *db) = 0;

 virtual IDataBase* GetDataBase() const = 0;

 virtual bool16 IsOutlined() const = 0;

 virtual void SetOutlineWidth(PMReal width) = 0;

 virtual PMReal GetOutlineWidth() const = 0;

 virtual void SetMiterLimit(PMReal miterLimit) = 0;

 virtual PMReal GetMiterLimit() const = 0;

 virtual void SetStrokeAlignment(int32 align) = 0;

 virtual int32 GetStrokeAlignment() const = 0;

 virtual void SetOutlineJoin(int32 join) = 0;

 virtual int32 GetOutlineJoin() const = 0;

 virtual void SetUnderlineMode(UnderlineMode underlineMode) = 0;

 virtual UnderlineMode GetUnderlineMode() const = 0;

 virtual void SetPositionMode(PositionMode position) = 0;

 virtual PositionMode GetPositionMode() const = 0;

 virtual void SetStrikethruFlag(bool16 strikethru) = 0;

 virtual bool16 GetStrikethruFlag() const = 0;

 virtual void SetCapitalsMode(CapitalizeMode cm) = 0;

 virtual CapitalizeMode GetCapitalsMode() const = 0;

 virtual Text::GlyphID GetSpaceGlyph() const = 0;

 virtual PMReal GetSpaceWidth() const = 0;

 virtual PMReal GetEmSpaceWidth(bool16 vertical) const = 0;

 virtual PMReal GetEnSpaceWidth(bool16 vertical) const = 0;

 virtual PMReal GetHyphenWidth() const = 0;

 virtual bool16 CanSimpleKernWith(const IDrawingStyle* other, bool16 vertical) const = 0;

 virtual bool16 CanDoOpenTypeFeaturesAcross(const IDrawingStyle* other, bool16 vertical) const = 0;

 virtual bool16 CanShareWaxRunWith(const IDrawingStyle* other) const = 0;

 virtual bool16 GetForceVerticalGlyphs() const = 0;

 virtual void SetForceVerticalGlyphs(bool16 b) = 0;

 virtual void AddTextAdornment(ClassID attrID, ClassID adornmentID, ITextAdornmentData *data) = 0;

 virtual void GetTextAdornment(ClassID attrID, ClassID *adornmentID, ITextAdornmentData **data) = 0;

 virtual void GetTextAdornment(ClassID attrID, ClassID *adornmentID, const ITextAdornmentData **data) const = 0;

 virtual void FillOutRenderData(IWaxRenderData* data, bool16 vertical) const = 0;

 virtual void AddAdornments(IWaxRun *waxRun) const = 0;

 virtual PMReal GetStyleEmBoxTop(bool16 verticalGlyphs, bool16 usePointSizeNotScale = kFalse) const = 0;
 virtual PMReal GetStyleEmBoxBottom(bool16 verticalGlyphs, bool16 usePointSizeNotScale = kFalse) const = 0;
 virtual PMReal GetStyleICFBoxTop(bool16 verticalGlyphs, bool16 usePointSizeNotScale = kFalse) const = 0;
 virtual PMReal GetStyleICFBoxBottom(bool16 verticalGlyphs, bool16 usePointSizeNotScale = kFalse) const = 0;

 virtual int32 GetWritingScript() const = 0;

 virtual void SetForSymbolHack() = 0;
};

#endif
 // __IDrawingStyle__