IAdornmentShape.h

//========================================================================================
// 
// $File$
// 
// Owner: Heath Lynn
// 
// $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.
// 
// 
// Purpose:
// This is the interface used to add adornments to page items. For an example see...
// 
//========================================================================================

#ifndef __IAdornmentShape__
#define __IAdornmentShape__

#include "IPMUnknown.h"
#include "IGraphicsContext.h"
#include "IShape.h"

class IAdornmentShape : public IPMUnknown
{

public:

 enum { kDefaultIID = IID_IADORNMENTSHAPE };
 
 enum AdornmentDrawOrder
 {
 kNone = 0,
 kBeforeShape = 1,
 kAfterFill = 2,
 kBeforeTextBackground = 4,
 kBeforeText = 8,
 kBeforeTextForeground = 16,
 kAfterTextForeground = 32,
 kBeforeStroke = 64,
 kAfterStroke = 128,
 kAfterShape = 256,

 kBeforeFill = 512, // Corresponds to kAfterFill
 kBeforeContent = 1024, // Before content, whatever that content is (text/graphic).
 kAfterContent = 2048, // After content, whatever that content is (text/graphic).

 kAfterEndShape = 4096, // After kEndShapeMessage

 kAfterSpread = 8192,

 kAllAdornmentFlags = 16383
 };

 enum AdornmentDrawNumber
 {
 kNumberOfAdornments = 14
 };

 virtual AdornmentDrawOrder GetDrawOrderBits() = 0;

 virtual void DrawAdornment
 (
 IShape* iShape, // owning page item
 AdornmentDrawOrder drawOrder, // for items that registered for more than one order
 GraphicsData* gd,
 int32 flags
 ) = 0;


 virtual PMRect GetPaintedAdornmentBounds
 (
 IShape* iShape,
 AdornmentDrawOrder drawOrder,
 const PMRect& itemBounds, // This is the painted bounds of the owing page item
 const PMMatrix& innertoview // NOTE: this is inner to view not pb to view
 ) = 0;

 virtual PMRect GetPrintedAdornmentBounds
 (
 IShape* iShape,
 AdornmentDrawOrder drawOrder,
 const PMRect& itemBounds, // This is the painted bounds of the owing page item
 const PMMatrix& innertoview // NOTE: this is inner to view not pb to view
 ) = 0;

 virtual void AddToContentInkBounds(IShape* iShape, PMRect* inOutBounds) = 0;

 virtual PMReal GetPriority() = 0;

 virtual void Inval
 (
 IShape* iShape,
 AdornmentDrawOrder drawOrder,
 GraphicsData* gd, 
 ClassID reasonForInval, 
 int32 flags
 ) = 0;
 
 virtual bool16 WillPrint() = 0;

 virtual bool16 WillDraw
 (
 IShape* iShape, // owning page item
 AdornmentDrawOrder drawOrder, // for items that registered for more than one order
 GraphicsData* gd,
 int32 flags
 ) = 0;

 virtual bool16 HitTest
 ( 
 IShape* iShape, // The owning page item 
 AdornmentDrawOrder adornmentDrawOrder, // In case this adornment is used more than once
 IControlView * layoutView,
 const PMRect& mouseRect
 ) = 0; 
 

};

#endif