IStyleGroupHierarchy.h

//========================================================================================
// 
// $File$
// 
// Owner: Sanjay Kumar
// 
// $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 __IStyleGroupHierarchy__
#define __IStyleGroupHierarchy__

#include "IPMUnknown.h"
#include "GenericID.h"
#include "TextID.h"
class UIDList;

class IStyleGroupHierarchy : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISTYLEGROUPHIERARCHY };

 enum
 {
 kAtTheEnd = -1
 };

 enum HierarchyTypeEnum
 {
 kHierarchyTypeUnknown = 0,

 kHierarchyTypeRoot = 1,

 kHierarchyTypeStyle = 2,

 kHierarchyTypeStyleGroup = 3
 };

 enum SortFlag
 {
 kSortAscending = 0x00000001,

 kSortDescending = 0x00000002,

 kSortImmediateChildren = 0x00000004,

 kSortHierarchy = 0x00000008,

 kSortAscendingHierarchy = kSortAscending|kSortHierarchy
 };

 virtual IStyleGroupHierarchy *QueryChild(int32 n) const = 0;

 virtual UID GetChildUID(int32 n) const = 0;

 virtual int32 GetChildIndex(const IStyleGroupHierarchy * p) const = 0;

 virtual int32 GetChildCount() const = 0;

 virtual IStyleGroupHierarchy *QueryParent() const = 0;

 virtual UID GetParentUID() const = 0;


 virtual IStyleGroupHierarchy *QueryRoot() const = 0;

 virtual UID GetRootUID() const = 0;


 virtual void Add(IStyleGroupHierarchy *newChild, int32 pos = kAtTheEnd) = 0;

 virtual void Move(IStyleGroupHierarchy *childToMove, int32 to) = 0;

 virtual void Remove(IStyleGroupHierarchy *childToRemove) = 0;

 virtual void Remove(UID childToRemove) = 0;

 virtual bool16 IsLessThan(IStyleGroupHierarchy * item) const = 0;

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

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

 virtual UID FindByName(const PMString& nodeName) const = 0;

 virtual void Sort(SortFlag flag = kSortAscendingHierarchy) = 0;

 virtual PMString GetName(bool16 translated = kFalse) const = 0;

 virtual PMString GetLocation(bool16 translated = kFalse) const = 0;

 virtual PMString GetFullPath(bool16 translated = kFalse) const = 0;

 virtual HierarchyTypeEnum GetHierarchyType() const = 0;

#ifdef DEBUG

 virtual bool16 IsValid() const = 0;
#endif

 virtual void SetParent(IStyleGroupHierarchy *newParent) = 0;

 virtual void SetRootUID(UID newRoot) = 0;

};

#endif