IBookmarkUtils.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 __IBookmarkUtils__
#define __IBookmarkUtils__


#include "HyperlinkID.h"
#include "IPMUnknown.h"
#include "Utils.h"

class IBookMarkData;
 
#define BOOKMARKUTILS Utils<IBookmarkUtils>()

class IBookmarkUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IBOOKMARKUTILS };

 virtual int32 GetChildIndexFromParent(IDataBase *db, const UID parent, const UID child) = 0;

 virtual int32 GetBookmarkChildCount(UIDRef bookmarkRef) = 0;

 virtual UIDRef GetNthBookmarkOfParent(UIDRef bookmarkRef, int32 index) = 0;

 virtual void BuildListOfNestedBookmarks(IBookMarkData *bookmark, UIDList *nestedList) = 0;

 virtual bool16 IsBookmarkAParentOfUID(IDataBase *db, const UID parent, const UID child) = 0;
};


#endif // __IBookmarkUtils__