IBookMarkData.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 __IBookMarkData__
#define __IBookMarkData__

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

class IBookMarkData : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_IBOOKMARKDATA };

 virtual void operator =(const IBookMarkData *other) = 0;


 virtual void SetName(const PMString &bookMark) = 0;

 virtual PMString GetName() const = 0;
 

 virtual void SetIndentLevel(int32 newIndentLevel) = 0;

 virtual int32 GetIndentLevel() const = 0;


 virtual void SetContainingBookMarkUID(UID parentBookMark) = 0;

 virtual UID GetContainingBookMarkUID() const = 0;


 virtual void AddChild(UID childBookmark) = 0;

 virtual void RemoveChild(UID childBookmark) = 0;


 virtual void MoveChild(const UID child, int32 newIndex) = 0;


 virtual int32 GetChildCount() const = 0;


 virtual UID GetNthChild(int32 childIndex) const = 0;


 virtual int32 GetChildWithUID(const UID child) const = 0;
 // Use for locating a specified hyperlink


 virtual void SetDestinationUID(const UID dest) = 0;

 virtual UID GetDestinationUID() const = 0;


 virtual void GotoDestination() const = 0;


 virtual ErrorCode ValidateBookmark() = 0;

 virtual void Invariant() const = 0;

 virtual void Invalidate() = 0;

 virtual void AddConversionData(UID parentBookMark, UID destinationUID) = 0;
};

#endif