IFrameUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __IFrameUtils__
#define __IFrameUtils__

#include "TextID.h"
#include "IPMUnknown.h"
#include "Utils.h"
#include "UIDRef.h"
#include "PMTypes.h"

class IGraphicsContext;
class IHandleShape;
class ILayoutControlData;
class IMultiColumnTextFrame;
class ITextFrameColumn;
class ITextModel;
class UIDList;
class PMRect;
class PMMatrix;
class GraphicsData;

const PMReal kThreadHandleSize = 8.0;



class IFrameUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IFRAMEUTILS };


 enum { kTF_InLink = 1, kTF_OutLink = 2, kTF_Overset = 4 };


 virtual bool16 GetFrameThreadBBox(IHandleShape* shape, const PMMatrix& theMatrix, PMRect& bounds) = 0;


 virtual UID GetTextFrameUID(IPMUnknown* graphicFrame, int32 *textflags = nil) = 0;

 virtual bool16 IsTextFrame(IPMUnknown* graphicFrame, int32* textflags = nil) = 0;


 virtual void GetUIDListOfInlines(IMultiColumnTextFrame* frame, bool16 doDropCaps, UIDList* resultList) = 0;
 virtual void GetUIDListOfInlines(ITextFrameColumn* frame, bool16 doDropCaps, UIDList* resultList) = 0;

 virtual void GetUIDListOfPlacedPageItem(IMultiColumnTextFrame* frame, bool16 doDropCaps, UIDList* resultList, ClassID itemClassID = kInvalidClass) = 0;
 virtual void GetUIDListOfPlacedPageItem(ITextFrameColumn* frame, bool16 doDropCaps, UIDList* resultList, ClassID itemClassID = kInvalidClass) = 0;


 virtual void GetFrameThreadsBBox(GraphicsData *gd, const UIDList& frameLists, PMRect& invalRect) = 0;

 virtual void DrawSelectedFrameEdges(GraphicsData *gd, const UIDList& frameLists) = 0;


 virtual void DrawSelectedAnchorThreads(GraphicsData *gd, const UIDList& anchors) = 0;

 virtual UIDList CheckForAnchorInText(ITextModel *model, TextIndex start, TextIndex end, UIDRef *pOtherFrame = nil, TextIndex *pLocation = nil) = 0;

 virtual bool16 IsPageItemAnchoredObject(UIDRef pageItem, UIDRef *pOwningFrame = nil, UIDRef *pOwningStory = nil, TextIndex *pAnchorLocation = nil) = 0;

};


#endif // __IFrameUtils__