DOMObjectReference Class Reference

#include <DOMObjectReference.h>

Public Types
typedef object_type	data_type

Public Member Functions
	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)

Detailed Description

This is a helper class for DOMAttributeValue. It encapsulates information about an inter-object reference in INX. A reference consists of:

1. A key that represents the element being referenced.
2. A pointer to the referenced element.
3. The position of this reference in its associated ReferenceList. Note: Values can contain lists of other values. A reference's position value is determined after the hierarchy is flattened.

   Author

   Steve Pellegrin

   See Also

   DOMAttributeValue

Constructor & Destructor Documentation

DOMObjectReference::DOMObjectReference

(

)

Constructs an empty reference

DOMObjectReference::DOMObjectReference	(	const WideString &	key,
		uint32	position
	)

Constructs an unresolved reference.

Parameters

key	IN the key that identifies the object being referenced.
position	IN the reference's position in its list.

DOMObjectReference::DOMObjectReference	(	const WideString &	key,
		IDOMElement *	element
	)

Constructs a resolved reference.

Parameters

key	IN the key that identifies the object being referenced.
element	IN the referenced element.

DOMObjectReference::DOMObjectReference

(

const DOMObjectReference &

other

)

Constructs a reference that is a copy of another

Parameters

other

IN the reference to copy.

DOMObjectReference::~DOMObjectReference

(

)

Destructor

Member Function Documentation

const WideString& DOMObjectReference::GetKey

(

)

const

Get the reference's key

Returns

The key.

uint32 DOMObjectReference::GetPosition

(

)

const

Get the reference's position

Returns

The position.

bool16 DOMObjectReference::IsResolved

(

)

const

Determine whether the reference is resolved.

Returns

kTrue if resolved, kFalse if not.

DOMObjectReference& DOMObjectReference::operator=

(

const DOMObjectReference &

other

)

Assign the value of another reference to this one.

Parameters

other

IN Another reference.

bool16 DOMObjectReference::operator==

(

const DOMObjectReference &

other

)

const

Tests the reference for equality with another.

Parameters

other

IN Another reference.

IDOMElement* DOMObjectReference::QueryElement

(

)

const

Get the reference's element

Returns

The element (may be nil)

void DOMObjectReference::SetElement

(

IDOMElement *

element

)

Sets the reference's element.

Parameters

element

IN The element.