IHierarchyUtils.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 __IHierarchyUtils__
#define __IHierarchyUtils__

#include "GenericID.h"
#include "IPMUnknown.h"
#include "Utils.h"
#include "IHierarchy.h" // for kAtTheEnd

class IHierarchyUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHIERARCHYUTILS };

 virtual ErrorCode AddToHierarchy(IDataBase *db, UID itemToAdd, UID parent, int32 pos = IHierarchy::kAtTheEnd) = 0;

 virtual ErrorCode AddToHierarchy(const UIDRef& itemToAdd, UID parent, int32 pos = IHierarchy::kAtTheEnd) = 0;

 virtual ErrorCode RemoveFromHierarchy(const UIDRef& itemToRemove) = 0;

 virtual void FilterItemsFromOtherSpreads(UID keepSpreadUID, UIDList* itemList) = 0;

 virtual void CollapsePageUIDsToSpreadUIDs(const UIDList& pageUIDList, UIDList* spreadUIDList, const bool16 bCompleteSpreadsOnly) = 0;

 virtual void ExpandSpreadUIDsToPageUIDs(const UIDList& spreadUIDList, UIDList* pageUIDList) = 0;
 
 virtual void ExpandPageUIDToSection(const UIDRef& pageRef, UIDList* pageUIDList, const bool16 bRequireNamedLayout) = 0;

 virtual void CollapsePageUIDsToSections(const UIDList& pageUIDList, K2Vector<UIDList>& pagesBySection, const bool16 bRequireNamedLayout) = 0;

 virtual IHierarchy * QueryEffectiveHierarchyParent(IHierarchy* pi) const = 0;
};


#endif // __IHierarchyUtils__