ProcessingInstruction interface represents a "processing
* instruction", used in XML as a way to keep processor-specific information
* in the text of the document.
*/
class CDOM_EXPORT DOM_ProcessingInstruction: public DOM_Node {
public:
/** @name Constructors and assignment operator */
//@{
/**
* Default constructor for DOM_ProcessingInstruction. The resulting object
* does not refer to an actual PI 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 PI node.
*
* New Processing Instruction nodes are created by DOM_Document::createProcessingInstruction().
*
*
*/
DOM_ProcessingInstruction();
/**
* Copy constructor. Creates a new DOM_ProcessingInstruction that refers to the
* same underlying node as the original. See also DOM_Node::clone(),
* which will copy the actual PI node, rather than just creating a new
* reference to the original node.
*
* @param other The object to be copied.
*/
DOM_ProcessingInstruction(const DOM_ProcessingInstruction &other);
/**
* Assignment operator.
*
* @param other The object to be copied.
*/
DOM_ProcessingInstruction & operator = (const DOM_ProcessingInstruction &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_ProcessingInstruction & operator = (const DOM_NullPtr *val);
//@}
/** @name Destructor. */
//@{
/**
* Destructor for DOM_processingInstruction. The object being destroyed is the reference
* object, not the underlying PI node itself.
*
*/
~DOM_ProcessingInstruction();
//@}
/** @name Get functions. */
//@{
/**
* The target of this processing instruction.
*
* XML defines this as being the
* first token following the markup that begins the processing instruction.
*/
DOMString getTarget() const;
/**
* The content of this processing instruction.
*
* This is from the first non
* white space character after the target to the character immediately
* preceding the ?>.
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
*/
DOMString getData() const;
//@}
/** @name Set functions. */
//@{
/**
* Sets the content of this processing instruction.
*
* This is from the first non
* white space character after the target to the character immediately
* preceding the ?>.
* @param data The string containing the processing instruction
*/
void setData(const DOMString &data);
//@}
protected:
DOM_ProcessingInstruction(ProcessingInstructionImpl *impl);
friend class DOM_Document;
};
XERCES_CPP_NAMESPACE_END
#endif