---

DOM_ProcessingInstruction Class Reference

Inheritance diagram for DOM_ProcessingInstruction:

List of all members.

Public Methods
Constructors and assignment operator
	DOM_ProcessingInstruction ()
	DOM_ProcessingInstruction (const DOM_ProcessingInstruction &other)
DOM_ProcessingInstruction &	operator= (const DOM_ProcessingInstruction &other)
DOM_ProcessingInstruction &	operator= (const DOM_NullPtr *val)
Destructor.
	~DOM_ProcessingInstruction ()
Get functions.
DOMString	getTarget () const
DOMString	getData () const
Set functions.
void	setData (const DOMString &data)
Protected Methods
	DOM_ProcessingInstruction (ProcessingInstructionImpl *impl)
Friends
class	DOM_Document

---

Detailed Description

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

---

Constructor & Destructor Documentation

DOM_ProcessingInstruction::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::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::~DOM_ProcessingInstruction (    )

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

---

Member Function Documentation

DOMString DOM_ProcessingInstruction::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 ?>. Exceptions: DOMException  NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

DOMString DOM_ProcessingInstruction::getTarget (    )  const

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

DOM_ProcessingInstruction & 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. Reimplemented from DOM_Node.

DOM_ProcessingInstruction & DOM_ProcessingInstruction::operator= (  const DOM_ProcessingInstruction &    other )

Assignment operator. Parameters: other  The object to be copied.

void DOM_ProcessingInstruction::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

---

The documentation for this class was generated from the following files:

• DOM_ProcessingInstruction.hpp
• DOM_ProcessingInstruction.cpp

---