IMasterSpreadUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Brendan O'Shea
// 
// $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 __IMasterSpreadUtils__
#define __IMasterSpreadUtils__

#include "MasterPageID.h"
#include "IPMUnknown.h"
#include "Utils.h"

#include "ICommand.h"
#include "UIDList.h"
#include "IShape.h"
#include "PMMatrix.h"
 
class IStringListControlData;
class IMasterSpreadList;
class IDocument;
class ICallback;
class IMasterPage;


class IMasterSpreadUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IMASTERSPREADUTILS };
 
 virtual bool16 _IsFrontViewAMaster() = 0;

 virtual void BuildMasterSpreadList(IStringListControlData *stringData, UIDList *masterUIDs, bool16 bIncludeNone, UID excludeUID) = 0;

 virtual bool16 IsAnAncestorOf(IMasterSpreadList *masterList, UID masterA, UID masterB) = 0;

 virtual void GetAncestorsOf(IMasterSpreadList *masterSpreadList, UID masterUID, UIDList *ancestors) = 0;
 
 virtual void TopoSortMasterSpread(IMasterSpreadList *masterSpreadList, UIDList* sortedList) = 0;
 
 virtual bool16 IsMasterAppliedToPage(UID masterUID, IPMUnknown* page) const = 0;

 virtual UIDList GetUnusedMasterUIDs(IDocument *doc) = 0;

 virtual int32 CountPagesWithMaster(UIDList *masterUIDs, int32 *mastersWithMaster = nil, UIDList *pageUIDs = nil) = 0;


 virtual bool16 OverrideMasterPageItem(const UIDRef masterItem, 
 const UIDRef pageToOverrideOn,
 ICommand::Undoability undoability = ICommand::kAutoUndo,
 UIDRef *overriddenItem = nil) = 0; 

 virtual bool16 IsMasterItemOverriddenOnPage(const UIDRef masterItem, const UIDRef startPageUIDRef) = 0;

 virtual ICommand *CreateOverrideMasterPageItemsCmd( const UIDList& spreadsOrPages, ICallback* masterItemCollector = nil, int32 drwMgrFlags = IShape::kSkipChildren + IShape::kSkipHiddenAndLockedLayers ) const = 0;


 virtual void AppendMasterPageItems(IDataBase * db, UID theSpread, 
 const UIDList & onThesePages, 
 const PMRectCollection & pageBounds,
 UIDList & masterItems, 
 UIDList & pages, 
 PMMatrixCollection & offsets,
 ICallback* masterItemCollector = nil, 
 int32 drwMgrFlags = IShape::kSkipChildren + IShape::kSkipHiddenAndLockedLayers) const = 0;


 virtual PMMatrix CalculateMasterSpreadToDrawingSpreadMatrix( const IMasterPage* drawingPage, UIDRef masterPage = kInvalidUIDRef /*if already known*/) const = 0;

};


#endif // __IMasterSpreadUtils__