Qt 4.8
Public Functions | Private Functions | Friends | List of all members
QDomProcessingInstruction Class Reference

The QDomProcessingInstruction class represents an XML processing instruction. More...

#include <qdom.h>

Inheritance diagram for QDomProcessingInstruction:
QDomNode

Public Functions

QString data () const
 Returns the content of this processing instruction. More...
 
QDomNode::NodeType nodeType () const
 Returns ProcessingInstructionNode. More...
 
QDomProcessingInstructionoperator= (const QDomProcessingInstruction &)
 Assigns x to this processing instruction. More...
 
 QDomProcessingInstruction ()
 Constructs an empty processing instruction. More...
 
 QDomProcessingInstruction (const QDomProcessingInstruction &x)
 Constructs a copy of x. More...
 
void setData (const QString &d)
 Sets the data contained in the processing instruction to d. More...
 
QString target () const
 Returns the target of this processing instruction. More...
 
- Public Functions inherited from QDomNode
QDomNode appendChild (const QDomNode &newChild)
 Appends newChild as the node's last child. More...
 
QDomNamedNodeMap attributes () const
 Returns a named node map of all attributes. More...
 
QDomNodeList childNodes () const
 Returns a list of all direct child nodes. More...
 
void clear ()
 Converts the node into a null node; if it was not a null node before, its type and contents are deleted. More...
 
QDomNode cloneNode (bool deep=true) const
 Creates a deep (not shallow) copy of the QDomNode. More...
 
int columnNumber () const
 For nodes created by QDomDocument::setContent(), this function returns the column number in the XML document where the node was parsed. More...
 
QDomNode firstChild () const
 Returns the first child of the node. More...
 
QDomElement firstChildElement (const QString &tagName=QString()) const
 Returns the first child element with tag name tagName if tagName is non-empty; otherwise returns the first child element. More...
 
bool hasAttributes () const
 Returns true if the node has attributes; otherwise returns false. More...
 
bool hasChildNodes () const
 Returns true if the node has one or more children; otherwise returns false. More...
 
QDomNode insertAfter (const QDomNode &newChild, const QDomNode &refChild)
 Inserts the node newChild after the child node refChild. More...
 
QDomNode insertBefore (const QDomNode &newChild, const QDomNode &refChild)
 Inserts the node newChild before the child node refChild. More...
 
bool isAttr () const
 Returns true if the node is an attribute; otherwise returns false. More...
 
bool isCDATASection () const
 Returns true if the node is a CDATA section; otherwise returns false. More...
 
bool isCharacterData () const
 Returns true if the node is a character data node; otherwise returns false. More...
 
bool isComment () const
 Returns true if the node is a comment; otherwise returns false. More...
 
bool isDocument () const
 Returns true if the node is a document; otherwise returns false. More...
 
bool isDocumentFragment () const
 Returns true if the node is a document fragment; otherwise returns false. More...
 
bool isDocumentType () const
 Returns true if the node is a document type; otherwise returns false. More...
 
bool isElement () const
 Returns true if the node is an element; otherwise returns false. More...
 
bool isEntity () const
 Returns true if the node is an entity; otherwise returns false. More...
 
bool isEntityReference () const
 Returns true if the node is an entity reference; otherwise returns false. More...
 
bool isNotation () const
 Returns true if the node is a notation; otherwise returns false. More...
 
bool isNull () const
 Returns true if this node is null (i.e. More...
 
bool isProcessingInstruction () const
 Returns true if the node is a processing instruction; otherwise returns false. More...
 
bool isSupported (const QString &feature, const QString &version) const
 Returns true if the DOM implementation implements the feature feature and this feature is supported by this node in the version version; otherwise returns false. More...
 
bool isText () const
 Returns true if the node is a text node; otherwise returns false. More...
 
QDomNode lastChild () const
 Returns the last child of the node. More...
 
QDomElement lastChildElement (const QString &tagName=QString()) const
 Returns the last child element with tag name tagName if tagName is non-empty; otherwise returns the last child element. More...
 
int lineNumber () const
 For nodes created by QDomDocument::setContent(), this function returns the line number in the XML document where the node was parsed. More...
 
QString localName () const
 If the node uses namespaces, this function returns the local name of the node; otherwise it returns an empty string. More...
 
QDomNode namedItem (const QString &name) const
 Returns the first direct child node for which nodeName() equals name. More...
 
QString namespaceURI () const
 Returns the namespace URI of this node or an empty string if the node has no namespace URI. More...
 
QDomNode nextSibling () const
 Returns the next sibling in the document tree. More...
 
QDomElement nextSiblingElement (const QString &taName=QString()) const
 Returns the next sibling element with tag name tagName if tagName is non-empty; otherwise returns any next sibling element. More...
 
QString nodeName () const
 Returns the name of the node. More...
 
NodeType nodeType () const
 Returns the type of the node. More...
 
QString nodeValue () const
 Returns the value of the node. More...
 
void normalize ()
 Calling normalize() on an element converts all its children into a standard form. More...
 
bool operator!= (const QDomNode &) const
 Returns true if n and this DOM node are not equal; otherwise returns false. More...
 
QDomNodeoperator= (const QDomNode &)
 Assigns a copy of n to this DOM node. More...
 
bool operator== (const QDomNode &) const
 Returns true if n and this DOM node are equal; otherwise returns false. More...
 
QDomDocument ownerDocument () const
 Returns the document to which this node belongs. More...
 
QDomNode parentNode () const
 Returns the parent node. More...
 
QString prefix () const
 Returns the namespace prefix of the node or an empty string if the node has no namespace prefix. More...
 
QDomNode previousSibling () const
 Returns the previous sibling in the document tree. More...
 
QDomElement previousSiblingElement (const QString &tagName=QString()) const
 Returns the previous sibilng element with tag name tagName if tagName is non-empty; otherwise returns any previous sibling element. More...
 
 QDomNode ()
 Constructs a null node. More...
 
 QDomNode (const QDomNode &)
 Constructs a copy of n. More...
 
QDomNode removeChild (const QDomNode &oldChild)
 Removes oldChild from the list of children. More...
 
QDomNode replaceChild (const QDomNode &newChild, const QDomNode &oldChild)
 Replaces oldChild with newChild. More...
 
void save (QTextStream &, int) const
 Writes the XML representation of the node and all its children to the stream str. More...
 
void save (QTextStream &, int, EncodingPolicy) const
 If encodingPolicy is QDomNode::EncodingFromDocument, this function behaves as save(QTextStream &str, int indent). More...
 
void setNodeValue (const QString &)
 Sets the node's value to v. More...
 
void setPrefix (const QString &pre)
 If the node has a namespace prefix, this function changes the namespace prefix of the node to pre. More...
 
QDomAttr toAttr () const
 Converts a QDomNode into a QDomAttr. More...
 
QDomCDATASection toCDATASection () const
 Converts a QDomNode into a QDomCDATASection. More...
 
QDomCharacterData toCharacterData () const
 Converts a QDomNode into a QDomCharacterData. More...
 
QDomComment toComment () const
 Converts a QDomNode into a QDomComment. More...
 
QDomDocument toDocument () const
 Converts a QDomNode into a QDomDocument. More...
 
QDomDocumentFragment toDocumentFragment () const
 Converts a QDomNode into a QDomDocumentFragment. More...
 
QDomDocumentType toDocumentType () const
 Converts a QDomNode into a QDomDocumentType. More...
 
QDomElement toElement () const
 Converts a QDomNode into a QDomElement. More...
 
QDomEntity toEntity () const
 Converts a QDomNode into a QDomEntity. More...
 
QDomEntityReference toEntityReference () const
 Converts a QDomNode into a QDomEntityReference. More...
 
QDomNotation toNotation () const
 Converts a QDomNode into a QDomNotation. More...
 
QDomProcessingInstruction toProcessingInstruction () const
 Converts a QDomNode into a QDomProcessingInstruction. More...
 
QDomText toText () const
 Converts a QDomNode into a QDomText. More...
 
 ~QDomNode ()
 Destroys the object and frees its resources. More...
 

Private Functions

 QDomProcessingInstruction (QDomProcessingInstructionPrivate *)
 

Friends

class QDomDocument
 
class QDomNode
 

Additional Inherited Members

- Public Types inherited from QDomNode
enum  EncodingPolicy { EncodingFromDocument = 1, EncodingFromTextStream = 2 }
 This enum specifies how QDomNode::save() determines what encoding to use when serializing. More...
 
enum  NodeType {
  ElementNode = 1, AttributeNode = 2, TextNode = 3, CDATASectionNode = 4,
  EntityReferenceNode = 5, EntityNode = 6, ProcessingInstructionNode = 7, CommentNode = 8,
  DocumentNode = 9, DocumentTypeNode = 10, DocumentFragmentNode = 11, NotationNode = 12,
  BaseNode = 21, CharacterDataNode = 22
}
 This enum defines the type of the node: More...
 
- Protected Functions inherited from QDomNode
 QDomNode (QDomNodePrivate *)
 Constructs a new node for the data n. More...
 
- Protected Variables inherited from QDomNode
QDomNodePrivateimpl
 

Detailed Description

The QDomProcessingInstruction class represents an XML processing instruction.

Note
This class or function is reentrant.
Attention
Module: QtXml

Processing instructions are used in XML to keep processor-specific information in the text of the document.

The XML declaration that appears at the top of an XML document, typically <?xml version='1.0' encoding='UTF-8'?>, is treated by QDom as a processing instruction. This is unfortunate, since the XML declaration is not a processing instruction; among other differences, it cannot be inserted into a document anywhere but on the first line.

Do not use this function to create an xml declaration, since although it has the same syntax as a processing instruction, it isn't, and might not be treated by QDom as such.

The content of the processing instruction is retrieved with data() and set with setData(). The processing instruction's target is retrieved with target().

For further information about the Document Object Model see Level 1 and Level 2 Core. For a more general introduction of the DOM implementation see the QDomDocument documentation.

Definition at line 648 of file qdom.h.

Constructors and Destructors

◆ QDomProcessingInstruction() [1/3]

QDomProcessingInstruction::QDomProcessingInstruction ( )

Constructs an empty processing instruction.

Use QDomDocument::createProcessingInstruction() to create a processing instruction with content.

Definition at line 6217 of file qdom.cpp.

6218  : QDomNode()
6219 {
6220 }
QDomNode()
Constructs a null node.
Definition: qdom.cpp:2057

◆ QDomProcessingInstruction() [2/3]

QDomProcessingInstruction::QDomProcessingInstruction ( const QDomProcessingInstruction x)

Constructs a copy of x.

The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode().

Definition at line 6229 of file qdom.cpp.

6230  : QDomNode(x)
6231 {
6232 }
QDomNode()
Constructs a null node.
Definition: qdom.cpp:2057

◆ QDomProcessingInstruction() [3/3]

QDomProcessingInstruction::QDomProcessingInstruction ( QDomProcessingInstructionPrivate n)
private

Definition at line 6234 of file qdom.cpp.

6235  : QDomNode(n)
6236 {
6237 }
QDomNode()
Constructs a null node.
Definition: qdom.cpp:2057

Functions

◆ data()

QString QDomProcessingInstruction::data ( ) const

Returns the content of this processing instruction.

See also
setData() target()

Definition at line 6277 of file qdom.cpp.

6278 {
6279  if (!impl)
6280  return QString();
6281  return impl->nodeValue();
6282 }
The QString class provides a Unicode character string.
Definition: qstring.h:83
QString nodeValue() const
Definition: qdom.cpp:143
QDomNodePrivate * impl
Definition: qdom.h:243

◆ nodeType()

QDomNode::NodeType QDomProcessingInstruction::nodeType ( ) const
inline

Returns ProcessingInstructionNode.

Definition at line 663 of file qdom.h.

◆ operator=()

QDomProcessingInstruction & QDomProcessingInstruction::operator= ( const QDomProcessingInstruction x)

Assigns x to this processing instruction.

The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode().

Definition at line 6246 of file qdom.cpp.

6247 {
6249 }
The QDomProcessingInstruction class represents an XML processing instruction.
Definition: qdom.h:648
QDomNode & operator=(const QDomNode &)
Assigns a copy of n to this DOM node.
Definition: qdom.cpp:2096

◆ setData()

void QDomProcessingInstruction::setData ( const QString d)

Sets the data contained in the processing instruction to d.

See also
data()

Definition at line 6289 of file qdom.cpp.

6290 {
6291  if (!impl)
6292  return;
6293  impl->setNodeValue(d);
6294 }
QDomNodePrivate * impl
Definition: qdom.h:243
virtual void setNodeValue(const QString &v)
Definition: qdom.cpp:144

◆ target()

QString QDomProcessingInstruction::target ( ) const

Returns the target of this processing instruction.

See also
data()

Definition at line 6265 of file qdom.cpp.

6266 {
6267  if (!impl)
6268  return QString();
6269  return impl->nodeName();
6270 }
The QString class provides a Unicode character string.
Definition: qstring.h:83
QDomNodePrivate * impl
Definition: qdom.h:243
QString nodeName() const
Definition: qdom.cpp:142

Friends and Related Functions

◆ QDomDocument

friend class QDomDocument
friend

Definition at line 668 of file qdom.h.

◆ QDomNode

friend class QDomNode
friend

Definition at line 669 of file qdom.h.


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