EntityReference nodes will appear in the structure
* model when an entity reference is in the source document, or when the user
* wishes to insert an entity reference.
*
* The expansion of the entity will appear as child nodes of the entity
* reference node. The expansion may be just simple text, or it may
* be more complex, containing additional entity refs.
*
*/
class CDOM_EXPORT DOM_EntityReference: public DOM_Node {
public:
/** @name Constructors and assignment operator */
//@{
/**
* Default constructor for DOM_EntityReference. The resulting object does not
* refer to an actual Entity Reference node; it will compare == to 0, and is similar
* to a null object reference variable in Java. It may subsequently be
* assigned to refer to an actual entity reference node.
*
* New entity reference nodes are created by DOM_Document::createEntityReference().
*
*/
DOM_EntityReference();
/**
* Copy constructor. Creates a new DOM_EntityReference that refers to the
* same underlying node as the original.
*
* @param other The object to be copied.
*/
DOM_EntityReference(const DOM_EntityReference &other);
/**
* Assignment operator.
*
* @param other The object to be copied.
*/
DOM_EntityReference & operator = (const DOM_EntityReference &other);
/**
* Assignment operator. This overloaded variant is provided for
* the sole purpose of setting a DOM_Node reference variable to
* zero. Nulling out a reference variable in this way will decrement
* the reference count on the underlying Node object that the variable
* formerly referenced. This effect is normally obtained when reference
* variable goes out of scope, but zeroing them can be useful for
* global instances, or for local instances that will remain in scope
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
* @param val Only a value of 0, or null, is allowed.
*/
DOM_EntityReference & operator = (const DOM_NullPtr *val);
//@}
/** @name Destructor. */
//@{
/**
* Destructor for DOM_EntityReference. The object being destroyed is the reference
* object, not the underlying entity reference node itself.
*
*/
~DOM_EntityReference();
//@}
protected:
DOM_EntityReference(EntityReferenceImpl *impl);
friend class DOM_Document;
};
XERCES_CPP_NAMESPACE_END
#endif