class DOM_ProcessingInstruction : public DOM_Node

The ProcessingInstruction interface represents a "processing instruction", used in XML as a way to keep processor-specific information in the text of the document

Inheritance:

Public

	Constructors and assignment operator DOM_ProcessingInstruction () Default constructor for DOM_ProcessingInstruction DOM_ProcessingInstruction (const DOM_ProcessingInstruction &other) Copy constructor DOM_ProcessingInstruction& operator = (const DOM_ProcessingInstruction &other) Assignment operator DOM_ProcessingInstruction& operator = (const DOM_NullPtr *val) Assignment operator
	Destructor. ~DOM_ProcessingInstruction () Destructor for DOM_processingInstruction
	Get functions. DOMString getTarget () const The target of this processing instruction DOMString getData () const The content of this processing instruction
	Set functions. void setData (const DOMString &data) Sets the content of this processing instruction

Inherited from DOM_Node:

Public

Cloning function.

DOM_Node cloneNode(bool deep) const

Returns a duplicate of this node

Constructors and assignment operators

DOM_Node()

Default constructor for DOM_Node

DOM_Node(const DOM_Node &other)

Copy constructor

DOM_Node& operator = (const DOM_Node &other)

Assignment operator

DOM_Node& operator = (const DOM_NullPtr *val)

Assignment operator

Equality and Inequality operators.

bool operator == (const DOM_Node & other) const

The equality operator

bool operator == (const DOM_NullPtr *other) const

Compare with a pointer

bool operator != (const DOM_Node & other) const

The inequality operator

bool operator != (const DOM_NullPtr * other) const

Compare with a pointer

Functions to modify the DOM Node.

DOM_Node insertBefore(const DOM_Node &newChild, const DOM_Node &refChild)

Inserts the node newChild before the existing child node refChild

DOM_Node replaceChild(const DOM_Node &newChild, const DOM_Node &oldChild)

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node

DOM_Node removeChild(const DOM_Node &oldChild)

Removes the child node indicated by oldChild from the list of children, and returns it

DOM_Node appendChild(const DOM_Node &newChild)

Adds the node newChild to the end of the list of children of this node

Query functions.

bool hasChildNodes() const

This is a convenience method to allow easy determination of whether a node has any children

bool isNull() const

Test whether this node is null

Constructors and assignment operator

DOM_ProcessingInstruction()

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(const DOM_ProcessingInstruction &other)

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.

Parameters:

other - The object to be copied.

DOM_ProcessingInstruction& operator = (const DOM_ProcessingInstruction &other)

Assignment operator.

Parameters:

other - The object to be copied.

DOM_ProcessingInstruction& operator = (const DOM_NullPtr *val)

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.

Parameters:

val. - Only a value of 0, or null, is allowed.

Destructor.

~DOM_ProcessingInstruction()

Destructor for DOM_processingInstruction. The object being destroyed is the reference object, not the underlying PI node itself.

Get functions.

DOMString getTarget() const

The target of this processing instruction. XML defines this as being the first token following the markup that begins the processing instruction.

DOMString getData() 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 ?>.

Throws:

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Set functions.

void setData(const DOMString &data)

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 ?>.

Parameters:

data - The string containing the processing instruction

This class has no child classes.

alphabetic index hierarchy of classes