IPageItemScriptUtils.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 __IPageItemScriptUtils__
#define __IPageItemScriptUtils__

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

#include "PMPathPoint.h"
#include "ScriptData.h"
#include "IReferencePointData.h"

class IHierarchy;
class IScriptRequestData;
class ITextModel ;
class DOMAttributeValue;
class PMMatrix;

typedef K2Vector<UIDRef> UIDRefList ;

class IPageItemScriptUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPAGEITEMSCRIPTUTILS };

 typedef enum
 {
 kParentOnly = 0, // Always include the parents only
 kChildrenOnly, // Always include the children only
 kParentAndChildren, // Always include both the parents and the children
 kChildrenIfNotParent // If the parent supports it, just get the parent. If not, look into the children
 } MatchingPIOption;

 virtual ScriptID GetPageItemType( const IScript* script ) const = 0;

 virtual int32 CountPageItemChildren( IScript* parent, const IScriptRequestData* data ) const = 0;
 virtual UID GetNthPageItemChild( int32 piIndex, IScript* parent, const IScriptRequestData* data ) const = 0; //0-based index
 virtual UIDList GetEveryPageItemChild( IScript* parent, const IScriptRequestData* data, bool16 allChildren = kFalse) const = 0;
 virtual ErrorCode GetNthPageItemChild( int32 piIndex, IScript* parent, const IScriptRequestData* data, ScriptList& objectList ) const = 0; //0-based index
 virtual ErrorCode GetEveryPageItemChild( IScript* parent, const IScriptRequestData* data, ScriptList& objectList, bool16 allChildren = kFalse ) const = 0;
 
 virtual void GetListOfInlines( ITextModel* model, TextIndex start, TextIndex end, UIDList* itemList, const IScriptRequestData* data, bool16 checkLastCharacter = kTrue, bool16 allChildren = kFalse) const = 0;

 typedef ErrorCode (*CreatePageItemFunc)( IScriptRequestData* data, IScript* script, IPMUnknown* parent, const PMPointList& bounds, UIDRef& pageItem, const Transform::CoordinateSpace& boundsSpace ) ;
 virtual ErrorCode DoCreatePageItem( IScriptRequestData* data, IScript* script, CreatePageItemFunc callbackFunction ) const = 0 ;
 virtual ErrorCode PreparePageItemParent( IScriptRequestData* data, IPMUnknown* parent, UIDRef& parentRef ) const = 0;

 virtual UID GetComposedLayerUID(IHierarchy* pageItem, const RequestContext& context, bool16 useLastFrameIfOverset = kFalse) const = 0 ;
 virtual UID GetComposedSpreadUID(IHierarchy* pageItem, const RequestContext& context, bool16 useLastFrameIfOverset = kFalse) const = 0 ;

 virtual ErrorCode GetReferencePoint( IScript* pageItem, PMPoint* refPoint, IScriptRequestData* data = nil) const = 0;

 virtual ErrorCode GetSpreadOffsetPoint(IScript* pageItem, const RequestContext& context, PMPoint& offset) const = 0;

 virtual ErrorCode GetOffsetPoint(IScript* script, IScriptRequestData* data, PMPoint& offset) const = 0;

 virtual ErrorCode GetMeasurementPoint(ScriptListData& list, IScript* script, IScriptRequestData* data, PMPoint& point) const = 0;
 virtual ErrorCode GetCoordinates( const ScriptData& scriptData, PMPoint& coordinates, IScript* script, const EngineContext& context ) const = 0 ;

 virtual bool16 IsEditable( IPMUnknown* pageItem ) const = 0;
 virtual int32 FilterByGraphicAttribute( UIDList& piList, ClassID attr ) const = 0;

 virtual IScript* QueryPageItemParent( const IScript* script, const RequestContext& context ) const = 0;

 virtual ErrorCode GetMatchingPageItems(const RequestContext& context, ScriptList* inPageItems, ScriptList* outPageItems, PMIID iidToLookFor, MatchingPIOption whatToInclude) const = 0;

 virtual ErrorCode GetDefaultReferencePosition(const UIDList& itemList, IReferencePointData::ReferencePointPosition& refPosition) const = 0;
 virtual ErrorCode GetDefaultReferenceLocation(const UIDList& itemList, ReferencePointLocation& refLocation) const = 0;

 virtual ErrorCode AccessItemGeometry(IScriptRequestData* data, IScript* script, bool32 applyToTextWrap) = 0;

 virtual ErrorCode AccessPathGeometry(ScriptID propID, IScriptRequestData* data, IScript* script, bool32 applyToTextWrap) = 0;

 virtual ErrorCode AccessBoundingBox(ScriptID propID, IScriptRequestData* data, IScript* script) = 0;

 virtual ErrorCode AccessGraphicBounds(ScriptID propID, IScriptRequestData* data, IScript* script) = 0;

 virtual ErrorCode GetItemLayerMatrix(IPMUnknown *item, PMMatrix &m) const = 0;

 virtual ErrorCode SetItemGeometryMatrix(const PMMatrix &m, DOMAttributeValue &g) const = 0;

 virtual ErrorCode AccessItemTransform(IScriptRequestData* data, IScript* script, bool32 applyToTextWrap) = 0;
};

#endif // __IPageItemScriptUtils__