IWaxRunShape.h

//========================================================================================
// 
// $File$
// 
// Owner: Ric Kamicar
// 
// $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 __IWaxRunShape__
#define __IWaxRunShape__

#include "IPMUnknown.h"
#include "PMMatrix.h"
#include "DrawPassInfo.h"
#include "TextID.h"

class IGraphicsContext;

class IWaxRunShape : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IWAXRUNSHAPE };


 virtual void GetInkBounds(PMRect* pInkBounds, Text::DrawPassInfoList* passList) const = 0;

 virtual void GetWaxBounds(int32 offset, int32 length, K2Vector<PMPolygon4> *pSetOfBounds) const = 0;

 virtual bool16 GetHighlightBounds(int32 offset, int32 length, K2Vector<PMPolygon4> *pSetOfBounds, PMRect& highlightAdjust, const PMLineSeg& maxTopBottom) const = 0;

 virtual bool16 GetHighlightBoundsME(int32 runGlyphStartIndex, int32 start, int32 startInner, int32 end, int32 endInner,
 K2Vector<PMPolygon4> *pSetOfBounds, PMRect& highlightAdjust, const PMLineSeg& maxTopBottom) const = 0;

 virtual bool16 GetSelectionLine(PMLineSeg* pSelectionLine) const = 0;

 virtual bool16 GetHighlightLine(PMLineSeg* pHighlightLine, const PMLineSeg& maxTopBottom) const = 0;


 virtual void GetCaretLineAt(int32 offset, PMLineSeg* pCaretLine, const PMLineSeg& maxTopBottom) const = 0;

 virtual int32 GetSelectionMode() const = 0;
 virtual void SetSelectionMode(int32 mode) = 0;

 enum {
 kFlag_IsFirstStacked = 0x00000001,
 kFlag_IsLastStacked = 0x00000002,

 kFlag_ReservedForImplementors = 0xffff0000
 } WaxRunFlags;

 virtual int32 GetFlags() const = 0;
 virtual void SetFlags(int32 flags) = 0; // Caller must do any ANDing or ORing.

 virtual void GetBorderShadingHeight(int32 mode, PMLineSeg* pShadingHeight) const = 0;

};

#endif