IPageItemUtils.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 __IPageItemUtils__
#define __IPageItemUtils__

#include "GenericID.h"
#include "IPMUnknown.h"
#include "Utils.h"

class ICommand;
class IControlView;
class IDataBase;
class IDocumentLayer;
class IGeometry;
class IGraphicFrameData;
class IHandleShape;
class IHierarchy;
class IItemContext;
class IPathGeometry;
class IScrapItem;
class ISpread;
class ISubject;
class IDocument;
class PMUnknownRefList;
class UIDList;
class LazyNotificationData;

// Includes
#include "PMRect.h"
#include "PMLine.h"
#include "IGeometry.h"
#include "PathSelectionList.h"
#include "PMPathPoint.h"
#include "K2Vector.h"

class IPageItemUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPAGEITEMUTILS };

 enum InvalidateCacheType
 { 
 kInvalidateAll,
 kInvalidateGuides,
 kInvalidateNonGuides
 };


 
 virtual void InvalidatePageItemCache(IDocument * doc, InvalidateCacheType type = kInvalidateAll) const = 0;

 virtual void InvalidatePageItemCacheForSpread(ISpread *spread, InvalidateCacheType type = kInvalidateAll) const = 0;


 virtual void NotifyDocumentObservers(IDataBase* iDataBase, ClassID theChange, const PMIID& interestedIn, void* changedBy, LazyNotificationData* data = nil) const = 0;

 virtual void NotifyDocumentObservers(ISubject* originalSubject, IDataBase* iDataBase, ClassID theChange, const PMIID& interestedIn, void* changedBy, LazyNotificationData* data = nil) const = 0;
 
 virtual void GetTextFrameHandlePositions(IHandleShape* shape, PMPoint *point1, PMPoint *point2) const = 0;


 virtual void SortDisplayList(UIDList *items) = 0;

 virtual IHierarchy *QueryInlineParentPageItem(IHierarchy *itemHierarchy) const = 0;

 virtual UID GetFirstPageItemUID(IDataBase *db, UID pageItemUID) const= 0;

 virtual UIDList* StripIfParentIsLocked(UIDList* items) = 0;

 virtual IHierarchy* QueryPlacedItemParentPageItem(IHierarchy *itemHierarchy) const = 0;

 virtual IHierarchy *QueryInlineImmediateParentPageItem(IHierarchy *itemHierarchy) const = 0;
};

#endif // __IPageItemUtils__