ILayoutUtils.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 __ILayoutUtils__
#define __ILayoutUtils__



#include "LayoutID.h"
#include "IPMUnknown.h"
#include "Utils.h"

#include "PMRect.h"
#include "ILayoutControlData.h"
#include "ISnapTo.h" // SnapType
#include "UIDRef.h"
#include "PMMatrix.h"
#include "UIDList.h"
#include "HitTestDragConstants.h"
#include "TransformTypes.h"

class IControlView;
class IDocument;
class ISpread;
class IWindow;
class IViewPort;
class IHierarchy;
class IMargins;
class IColumns;
class IMasterSpreadList;
class IStringListControlData;
class IRulerData;
class IGraphicsContext;
class IDataExchangeHandler;
class IPanorama;
class ISpreadList;
class ICommand;
class ILayoutData;
class ISnapTo;
class IWorkspace;
class IFrameList;
class IUIDListData;

enum PageType {
 kLeftPage = 0,
 kUnisexPage,
 kRightPage };

enum DocPageBinding {
 kDefaultBinding = -1,
 kLeftToRightBinding,
 kRightToLeftBinding };

class ILayoutUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILAYOUTUTILS };

 virtual bool16 FindDocument(const UIDRef& docRef) = 0;//SEIssue <sheridan>

 virtual UID GetOwnerPageUID(const IHierarchy* pageItemHier, bool16 enlargeForSlug = kFalse) = 0;

 virtual UID GetDrawingPageUID(const IHierarchy* pageItemHier, bool16 enlargeForSlug = kFalse) = 0;

 virtual void EnlargePagesRectBySlug(IDataBase *db, PMRect& pageRect, int32 pageIndex, int32 spreadPageCount, PageType pageType, bool16 bPrintingOrExporting = kFalse, int32 trueSpreadPageCount = 0) = 0;

 virtual UID GetIntersectingPageUID(const UIDRef& spreadRef, const PBPMRect& itemBounds, bool16 enlargeForSlug = kFalse, const Transform::CoordinateSpace &coordinateSpace = Transform::PasteboardCoordinates()) = 0;

 virtual PageType GetPageType(const UIDRef& pageRef) = 0;


 virtual DocPageBinding GetDocumentPageBinding(const UIDRef& docRef) = 0;

 virtual IPMUnknown *QueryParentFor(const IPMUnknown *pUnknown, const PMIID &rIID) = 0;

 virtual IPMUnknown *QueryOutermostParentFor(const IPMUnknown *pUnknown, const PMIID &rIID) = 0;

 virtual int32 GetMaxSpreadSize(const ISpread *theSpread = nil,
 bool16 bFactorInIslandness = kTrue,
 bool16 bFactorInFirstOddPage = kTrue,
 bool16 bFactorInPagesPerSpreadPref = kTrue) = 0;

 // For now, hard code the limits on spreads & pages. Eventually, these should
 // come from a resource. TODO : convert the tagged into real functions, initialized from
 // a resource
 //
 virtual int32 GetMinNumPages() = 0;
 virtual int32 GetMaxNumPages() = 0; /* CONVERT TO RESOURCE BASED */
 virtual int32 GetMinPagesPerSpread() = 0;
 virtual int32 GetMaxPagesPerSpread() = 0; /* CONVERT TO RESOURCE BASED */
 virtual int32 GetMinPageWidth() = 0; /* CONVERT TO RESOURCE BASED */
 virtual int32 GetMaxPageWidth() = 0; /* 18 Feet. CONVERT TO RESOURCE BASED */
 virtual int32 GetMinPageLength() = 0; /* CONVERT TO RESOURCE BASED */
 virtual int32 GetMaxPageLength() = 0; /* 18 Feet. CONVERT TO RESOURCE BASED */

 virtual bool16 DoesPageHaveContent(const UIDList& pageUIDList) = 0;

 virtual IMargins* QueryMargins(int32 whichPage, const ISpread* currentSpread) = 0;

 virtual IColumns* Query_Columns(int32 whichPage, const ISpread* currentSpread) = 0;

 virtual ICommand* MakeShuffleCmd(IDocument* doc,
 const UIDRef& firstSpread = UIDRef::gNull,
 const UIDRef& lastSpread = UIDRef::gNull) = 0;

 virtual bool16 IsAMaster(UID spreadOrPageUID, IDataBase *db) = 0;

 virtual void InvalidateViews(IDocument* document) = 0;

 virtual IPMUnknown* SpreadQueryHitTestPageItemNew(const ISpread* mySpread, const PBPMPoint& where, ClassID handlerClass, const PMIID& interfaceID, int16 tolerance = kHitTestTolerance) = 0;

#ifdef ID_DEPRECATED

 virtual void M2MValidateAll(IDataBase* db) = 0;
#endif

};


#endif // __ILayoutUtils__