DOMObjectReference.h

//========================================================================================
// 
// $File$
// 
// Owner: Steve Pellegrin
// 
// $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 __DOMObjectReference_h__
#define __DOMObjectReference_h__

// Adobe Patent or Adobe Patent Pending Invention Included Within this File
// Adobe patent application tracking B234, entitled Method and apparatus for formatting portion of content, inventors: Craig Rainwater, Steve Pellegrin, Robin Briggs 


#include "K2Vector.h"

class WideString;
class IDOMElement;

class DOMObjectReference
{
public:
 typedef object_type data_type;

public:
 DOMObjectReference();
 DOMObjectReference(const WideString & key, uint32 position);
 DOMObjectReference(const WideString & key, IDOMElement *element);
 DOMObjectReference(const DOMObjectReference &other);
 ~DOMObjectReference();

 const WideString &GetKey() const;

 uint32 GetPosition() const;

 IDOMElement *QueryElement() const;

 bool16 IsResolved() const;

 void SetElement(IDOMElement *element);

 bool16 operator==(const DOMObjectReference &other) const;

 DOMObjectReference &operator=(const DOMObjectReference &other);

private:
 void Copy(const DOMObjectReference &other);

private:
 WideString fKey;
 uint32 fPosition;
 InterfacePtr<IDOMElement> fElement;
};

typedef K2Vector<DOMObjectReference> DOMObjectReferenceList;

#endif // __DOMObjectReference_h__