IHierarchy.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 __IHIERARCHY__
#define __IHIERARCHY__

#include "IPMUnknown.h"
#include "GenericID.h"

class UIDList;

class IHierarchy : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHIERARCHY };

 enum
 {
 kAtTheEnd = -1
 };
 
 enum
 {
 kIncludeHidden = 0x00000001 
 };
 
 virtual IHierarchy *QueryChild(int32 n) const = 0;

 virtual UID GetChildUID(int32 n) const = 0;
 
 virtual int32 GetChildIndex(const IHierarchy * p) const = 0;

 virtual int32 GetChildCount() const = 0;

 virtual IHierarchy *QueryParent() const = 0;

 virtual UID GetParentUID() const = 0;
 
 virtual void SetParent(IHierarchy *newParent) = 0;
 
 virtual IHierarchy *QueryRoot() const = 0;

 virtual UID GetRootUID() const = 0;

 virtual void SetRootUID(UID newRoot) = 0;

 virtual void Add(IHierarchy *newChild, int32 pos = kAtTheEnd) = 0;
 
 virtual void Move(IHierarchy *childToMove, int32 to) = 0; 

 virtual void Remove(IHierarchy *childToRemove) = 0;
 
 virtual void Remove(UID childToRemove) = 0;

 virtual bool16 IsLessThan(IHierarchy * item) = 0;

 virtual void GetDescendents(UIDList *resultList, const PMIID& interfaceID, int32 flags = 0) const = 0;
 
 virtual void GetAncestors(UIDList *resultList, const PMIID& interfaceID) const = 0;

 virtual UID GetLayerUID() const = 0;

 virtual UID GetSpreadUID() const = 0;
 
#ifdef DEBUG

 virtual bool16 IsValid() = 0;
#endif
};

#endif