ISpread.h

//========================================================================================
// 
// $File$
// 
// Owner: Zak_Williamson
// 
// $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 __ISPREAD__
#define __ISPREAD__

#include "IPMUnknown.h"
#include "SpreadID.h"
#include "PMRect.h"
#include "TransformTypes.h"

class IDocumentLayer;
class ISpreadLayer;
class IHierarchy;
class IGeometry;
class UIDList;
class IColumns;

class ItemManipulator
{
public:
 virtual bool16 ManipulateItem(IHierarchy * itemHier) = 0;
};

class LayerMask
{
public:
 virtual bool16 MaskOutLayer(IHierarchy * layerHier) = 0;
};

class ISpread : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISPREAD };

 typedef enum { kDefaultBinding = -1, kBindingAtBeginning = 0, kBindingAtEnd = -2} BindingLocation;
 typedef enum { kDefaultBindingSide = -1, kLeftSideOfBinding = 0, kRightSideOfBinding = -2} BindingSide;
 typedef enum { kFollowMasterColorUID = 1 } PageColorLabel;

 virtual ISpreadLayer * QueryLayer(const IDocumentLayer * docLayer, int32 * pPos = nil, bool16 wantGuideLayer = kFalse) const = 0;

 virtual IHierarchy * QueryPagesLayer() const = 0;
 
 enum { kAtTheEnd = -1 };

 virtual void GetItemsOnPage(int32 pgPos, UIDList * items, bool16 bIncludePage = kTrue, bool16 bIncludePasteboard = kFalse, bool16 bIncludeBleedAndSlug = kTrue) const = 0;

 virtual void PartitionPageItems( UIDList* partition[], bool16 bIncludePage, int32 pasteboardIndex, bool16 bIncludeBleedAndSlug) const = 0;

 virtual void PartitionPageItems( const K2Vector<PMRect>& rects, const K2Vector<PMMatrix>& rect2SpreadTransforms, UIDList* partition_[], int32 pasteboardIndex) const = 0;

 virtual int32 GetNumPages() const = 0;

 virtual IGeometry * QueryNthPage(int32 n) const = 0;

 virtual UID GetNthPageUID(int32 n) const = 0;

 virtual IGeometry * QueryNearestPage(const PBPMPoint& pt, int32 * pageIndex) const = 0;

 virtual int32 GetPageIndex(UID pageID) const = 0;

 virtual bool16 ForEachItem(ItemManipulator * manipulator, LayerMask * layerMask = nil) const = 0;

 virtual PMRect GetPagesBounds( const Transform::CoordinateSpace& coordinateSpace) const = 0;

 virtual PMRect GetPagesAndItemsBounds( const Transform::CoordinateSpace& coordinateSpace, bool16 includeGuides = kFalse) const = 0;


 virtual PMPoint GetSpreadZeroPoint() const = 0;
 
 virtual IColumns * QueryNearestColumnBounds(const PBPMPoint& pt, bool16 bIsVertical, PMRect * pColumnBounds = nil,
 int32 * pPageIndex = nil, int32 * pColumnIndex = nil) const = 0;
};

#endif