6
6
td.postheader { font-family: sans-serif }
7
7
tr.address { font-family: sans-serif }
8
8
body { background: #ffffff; color: black; }
9
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QAbstractXmlReceiver Class Reference<br /><sup><sup>[<a href="qtxmlpatterns.html">QtXmlPatterns</a> module]</sup></sup></h1><p>The QAbstractXmlReceiver class provides a callback interface for transforming the output of a <a href="qxmlquery.html">QXmlQuery</a>. <a href="#details">More...</a></p>
10
<p>Inherited by <a href="qxmlserializer.html">QXmlSerializer</a>.</p><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#QAbstractXmlReceiver">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#atomicValue">atomicValue</a></b> (<i>self</i>, QVariant)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#attribute">attribute</a></b> (<i>self</i>, QXmlName, QStringRef)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#characters">characters</a></b> (<i>self</i>, QStringRef)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#comment">comment</a></b> (<i>self</i>, QString)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#endDocument">endDocument</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#endElement">endElement</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#endOfSequence">endOfSequence</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#namespaceBinding">namespaceBinding</a></b> (<i>self</i>, QXmlName)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#processingInstruction">processingInstruction</a></b> (<i>self</i>, QXmlName, QString)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#startDocument">startDocument</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#startElement">startElement</a></b> (<i>self</i>, QXmlName)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#startOfSequence">startOfSequence</a></b> (<i>self</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QAbstractXmlReceiver class provides a callback interface for transforming the output of a <a href="qxmlquery.html">QXmlQuery</a>.</p>
11
<p>QAbstractXmlReceiver is an abstract base class that provides a callback interface for receiving an <a href="#xquery-sequence">XQuery sequence</a>, usually the output of an <a href="qxmlquery.html">QXmlQuery</a>, and transforming that sequence into a structure of your choosing, usually XML. Consider the example:</p>
12
<pre> QXmlQuery query;
9
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QAbstractXmlReceiver Class Reference<br /><sup><sup>[<a href="qtxmlpatterns.html">QtXmlPatterns</a> module]</sup></sup></h1><p>The QAbstractXmlReceiver class provides a callback interface for
10
transforming the output of a <a href="qxmlquery.html">QXmlQuery</a>. <a href="#details">More...</a></p>
12
<p>Inherited by <a href="qxmlserializer.html">QXmlSerializer</a>.</p><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#QAbstractXmlReceiver">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#atomicValue">atomicValue</a></b> (<i>self</i>, QVariant)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#attribute">attribute</a></b> (<i>self</i>, QXmlName, QStringRef)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#characters">characters</a></b> (<i>self</i>, QStringRef)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#comment">comment</a></b> (<i>self</i>, QString)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#endDocument">endDocument</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#endElement">endElement</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#endOfSequence">endOfSequence</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#namespaceBinding">namespaceBinding</a></b> (<i>self</i>, QXmlName)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#processingInstruction">processingInstruction</a></b> (<i>self</i>, QXmlName, QString)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#startDocument">startDocument</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#startElement">startElement</a></b> (<i>self</i>, QXmlName)</li><li><div class="fn" /><b><a href="qabstractxmlreceiver.html#startOfSequence">startOfSequence</a></b> (<i>self</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QAbstractXmlReceiver class provides a callback interface for
13
transforming the output of a <a href="qxmlquery.html">QXmlQuery</a>.</p>
14
<p>QAbstractXmlReceiver is an abstract base class that provides a
15
callback interface for receiving an <a href="#xquery-sequence">XQuery sequence</a>, usually the output of an
16
<a href="qxmlquery.html">QXmlQuery</a>, and transforming that
17
sequence into a structure of your choosing, usually XML. Consider
19
<pre class="highlightedCode brush: cpp">
13
21
query.setQuery("doc('index.html')/html/body/p[1]");
15
23
QXmlSerializer serializer(query, myOutputDevice);
16
query.evaluateTo(&serializer);</pre>
17
<p>First it constructs a <a href="qxmlquery.html">query</a> that gets the first paragraph from document <tt>index.html</tt>. Then it constructs an <a href="qxmlserializer.html">XML serializer</a> with the <a href="qxmlquery.html">query</a> and <a href="qiodevice.html">myOutputDevice</a> (Note the <a href="qxmlserializer.html">serializer</a> is an <i>XML receiver</i>, ie a subclass of QAbstractXmlReceiver). Finally, it <a href="qxmlquery.html#evaluateTo">evaluates</a> the <a href="qxmlquery.html">query</a>, producing an ordered sequence of calls to the <a href="qxmlserializer.html">serializer's</a> callback functions. The sequence of callbacks transforms the query output to XML and writes it to <a href="qiodevice.html">myOutputDevice</a>.</p>
18
<p>Although the example uses <a href="qxmlquery.html">QXmlQuery</a> to produce the sequence of callbacks to functions in QAbstractXmlReceiver, you can call the callback functions directly as long as your sequence of calls represents a valid <a href="#xquery-sequence">XQuery sequence</a>.</p>
19
<a name="xquery-sequence" /><a name="xquery-sequences" />
24
query.evaluateTo(&serializer);
26
<p>First it constructs a <a href="qxmlquery.html">query</a> that
27
gets the first paragraph from document <tt>index.html</tt>. Then it
28
constructs an <a href="qxmlserializer.html">XML serializer</a> with
29
the <a href="qxmlquery.html">query</a> and <a href="qiodevice.html">myOutputDevice</a> (Note the <a href="qxmlserializer.html">serializer</a> is an <i>XML receiver</i>, ie
30
a subclass of QAbstractXmlReceiver). Finally, it <a href="qxmlquery.html#evaluateTo">evaluates</a> the <a href="qxmlquery.html">query</a>, producing an ordered sequence of calls
31
to the <a href="qxmlserializer.html">serializer's</a> callback
32
functions. The sequence of callbacks transforms the query output to
33
XML and writes it to <a href="qiodevice.html">myOutputDevice</a>.</p>
34
<p>Although the example uses <a href="qxmlquery.html">QXmlQuery</a>
35
to produce the sequence of callbacks to functions in
36
QAbstractXmlReceiver, you can call the callback functions directly
37
as long as your sequence of calls represents a valid <a href="#xquery-sequence">XQuery sequence</a>.</p>
38
<a id="xquery-sequence" name="xquery-sequence" /><a id="xquery-sequences" name="xquery-sequences" />
20
39
<h3>XQuery Sequences</h3>
21
<p>An XQuery <i>sequence</i> is an ordered collection of zero, one, or many <i>items</i>. Each <i>item</i> is either an <i>atomic value</i> or a <i>node</i>. An <i>atomic value</i> is a simple data value.</p>
40
<p>An XQuery <i>sequence</i> is an ordered collection of zero, one,
41
or many <i>items</i>. Each <i>item</i> is either an <i>atomic
42
value</i> or a <i>node</i>. An <i>atomic value</i> is a simple data
22
44
<p>There are six kinds of <i>nodes</i>.</p>
24
46
<li>An <i>Element Node</i> represents an XML element.</li>
25
47
<li>An <i>Attribute Node</i> represents an XML attribute.</li>
26
48
<li>A <i>Document Node</i> represents an entire XML document.</li>
27
<li>A <i>Text Node</i> represents character data (element content).</li>
28
<li>A <i>Processing Instruction Node</i> represents an XML processing instruction, which is used in an XML document to tell the application reading the document to perform some action. A typical example is to use a processing instruction to tell the application to use a particular XSLT stylesheet to display the document.</li>
49
<li>A <i>Text Node</i> represents character data (element
51
<li>A <i>Processing Instruction Node</i> represents an XML
52
processing instruction, which is used in an XML document to tell
53
the application reading the document to perform some action. A
54
typical example is to use a processing instruction to tell the
55
application to use a particular XSLT stylesheet to display the
29
57
<li>And a <i>Comment node</i> represents an XML comment.</li>
31
<p>The <i>sequence</i> of <i>nodes</i> and <i>atomic values</i> obeys the following rules. Note that <i>Namespace Node</i> refers to a special <i>Attribute Node</i> with name <i>xmlns</i>.</p>
59
<p>The <i>sequence</i> of <i>nodes</i> and <i>atomic values</i>
60
obeys the following rules. Note that <i>Namespace Node</i> refers
61
to a special <i>Attribute Node</i> with name <i>xmlns</i>.</p>
33
<li>Each <i>node</i> appears in the <i>sequence</i> before its children and their descendants appear.</li>
34
<li>A <i>node</i>'s descendants appear in the <i>sequence</i> before any of its siblings appear.</li>
35
<li>A <i>Document Node</i> represents an entire document. Zero or more <i>Document Nodes</i> can appear in a <i>sequence</i>, but they can only be top level items (i.e., a <i>Document Node</i> can't be a child of another <i>node</i>.</li>
36
<li><i>Namespace Nodes</i> immediately follow the <i>Element Node</i> with which they are associated.</li>
37
<li><i>Attribute Nodes</i> immediately follow the <i>Namespace Nodes</i> of the element with which they are associated, or...</li>
38
<li>If there are no <i>Namespace Nodes</i> following an element, then the <i>Attribute Nodes</i> immediately follow the element.</li>
39
<li>An <i>atomic value</i> can only appear as a top level <i>item</i>, i.e., it can't appear as a child of a <i>node</i>.</li>
40
<li><i>Processing Instruction Nodes</i> do not have children, and their parent is either a <i>Document Node</i> or an <i>Element Node</i>.</li>
41
<li><i>Comment Nodes</i> do not have children, and their parent is either a <i>Document Node</i> or an <i>Element Node</i>.</li>
63
<li>Each <i>node</i> appears in the <i>sequence</i> before its
64
children and their descendants appear.</li>
65
<li>A <i>node</i>'s descendants appear in the <i>sequence</i>
66
before any of its siblings appear.</li>
67
<li>A <i>Document Node</i> represents an entire document. Zero or
68
more <i>Document Nodes</i> can appear in a <i>sequence</i>, but
69
they can only be top level items (i.e., a <i>Document Node</i>
70
can't be a child of another <i>node</i>.</li>
71
<li><i>Namespace Nodes</i> immediately follow the <i>Element
72
Node</i> with which they are associated.</li>
73
<li><i>Attribute Nodes</i> immediately follow the <i>Namespace
74
Nodes</i> of the element with which they are associated, or...</li>
75
<li>If there are no <i>Namespace Nodes</i> following an element,
76
then the <i>Attribute Nodes</i> immediately follow the
78
<li>An <i>atomic value</i> can only appear as a top level
79
<i>item</i>, i.e., it can't appear as a child of a
81
<li><i>Processing Instruction Nodes</i> do not have children, and
82
their parent is either a <i>Document Node</i> or an <i>Element
84
<li><i>Comment Nodes</i> do not have children, and their parent is
85
either a <i>Document Node</i> or an <i>Element Node</i>.</li>
43
<p>The <i>sequence</i> of <i>nodes</i> and <i>atomic values</i> is sent to an QAbstractXmlReceiver (<a href="qxmlserializer.html">QXmlSerializer</a> in the example above) as a sequence of calls to the receiver's callback functions. The mapping of callback functions to sequence items is as follows.</p>
87
<p>The <i>sequence</i> of <i>nodes</i> and <i>atomic values</i> is
88
sent to an QAbstractXmlReceiver (<a href="qxmlserializer.html">QXmlSerializer</a> in the example above) as a
89
sequence of calls to the receiver's callback functions. The mapping
90
of callback functions to sequence items is as follows.</p>
45
<li><a href="qabstractxmlreceiver.html#startDocument">startDocument</a>() and <a href="qabstractxmlreceiver.html#endDocument">endDocument</a>() are called for each <i>Document Node</i> in the <i>sequence</i>. <a href="qabstractxmlreceiver.html#endDocument">endDocument</a>() is not called until all the <i>Document Node's</i> children have appeared in the <i>sequence</i>.</li>
46
<li><a href="qabstractxmlreceiver.html#startElement">startElement</a>() and <a href="qabstractxmlreceiver.html#endElement">endElement</a>() are called for each <i>Element Node</i>. <a href="qabstractxmlreceiver.html#endElement">endElement</a>() is not called until all the <i>Element Node's</i> children have appeared in the <i>sequence</i>.</li>
47
<li><a href="qabstractxmlreceiver.html#attribute">attribute</a>() is called for each <i>Attribute Node</i>.</li>
48
<li><a href="qabstractxmlreceiver.html#comment">comment</a>() is called for each <i>Comment Node</i>.</li>
49
<li><a href="qabstractxmlreceiver.html#characters">characters</a>() is called for each <i>Text Node</i>.</li>
50
<li><a href="qabstractxmlreceiver.html#processingInstruction">processingInstruction</a>() is called for each <i>Processing Instruction Node</i>.</li>
51
<li><a href="qabstractxmlreceiver.html#namespaceBinding">namespaceBinding</a>() is called for each <i>Namespace Node</i>.</li>
52
<li><a href="qabstractxmlreceiver.html#atomicValue">atomicValue</a>() is called for each <i>atomic value</i>.</li>
92
<li><a href="qabstractxmlreceiver.html#startDocument">startDocument</a>() and
93
<a href="qabstractxmlreceiver.html#endDocument">endDocument</a>()
94
are called for each <i>Document Node</i> in the <i>sequence</i>.
95
<a href="qabstractxmlreceiver.html#endDocument">endDocument</a>()
96
is not called until all the <i>Document Node's</i> children have
97
appeared in the <i>sequence</i>.</li>
98
<li><a href="qabstractxmlreceiver.html#startElement">startElement</a>() and
99
<a href="qabstractxmlreceiver.html#endElement">endElement</a>() are
100
called for each <i>Element Node</i>. <a href="qabstractxmlreceiver.html#endElement">endElement</a>() is not
101
called until all the <i>Element Node's</i> children have appeared
102
in the <i>sequence</i>.</li>
103
<li><a href="qabstractxmlreceiver.html#attribute">attribute</a>()
104
is called for each <i>Attribute Node</i>.</li>
105
<li><a href="qabstractxmlreceiver.html#comment">comment</a>() is
106
called for each <i>Comment Node</i>.</li>
107
<li><a href="qabstractxmlreceiver.html#characters">characters</a>()
108
is called for each <i>Text Node</i>.</li>
109
<li><a href="qabstractxmlreceiver.html#processingInstruction">processingInstruction</a>()
110
is called for each <i>Processing Instruction Node</i>.</li>
111
<li><a href="qabstractxmlreceiver.html#namespaceBinding">namespaceBinding</a>()
112
is called for each <i>Namespace Node</i>.</li>
113
<li><a href="qabstractxmlreceiver.html#atomicValue">atomicValue</a>() is called
114
for each <i>atomic value</i>.</li>
54
116
<p>For a complete explanation of XQuery sequences, visit <a href="http://www.w3.org/TR/xpath-datamodel/">XQuery Data Model</a>.</p>
55
<p>See also <a href="http://www.w3.org/TR/xpath-datamodel/">W3C XQuery 1.0 and XPath 2.0 Data Model (XDM)</a>, <a href="qxmlserializer.html">QXmlSerializer</a>, and <a href="qxmlresultitems.html">QXmlResultItems</a>.</p>
56
117
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QAbstractXmlReceiver" />QAbstractXmlReceiver.__init__ (<i>self</i>)</h3><p>Constructs an abstract xml receiver.</p>
57
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/~QAbstractXmlReceiver" />
58
<h3 class="fn"><a name="atomicValue" />QAbstractXmlReceiver.atomicValue (<i>self</i>, QVariant)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when an atomic value appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>. The <i>value</i> is a simple <a href="qvariant.html">data value</a>. It is guaranteed to be <a href="qvariant.html#isValid">valid</a>.</p>
59
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/attribute" />
60
<h3 class="fn"><a name="attribute" />QAbstractXmlReceiver.attribute (<i>self</i>, <a href="qxmlname.html">QXmlName</a>, QStringRef)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when an attribute node appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>. <i>name</i> is the <a href="qxmlname.html">attribute name</a> and the <i>value</i> string contains the attribute value.</p>
61
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/characters" />
62
<h3 class="fn"><a name="characters" />QAbstractXmlReceiver.characters (<i>self</i>, QStringRef)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a text node appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>. The <i>value</i> contains the text. Adjacent text nodes may not occur in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>, i.e., this callback must not be called twice in a row.</p>
63
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/comment" />
64
<h3 class="fn"><a name="comment" />QAbstractXmlReceiver.comment (<i>self</i>, QString)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a comment node appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>. The <i>value</i> is the comment text, which must not contain the string "--".</p>
65
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/endDocument" />
66
<h3 class="fn"><a name="endDocument" />QAbstractXmlReceiver.endDocument (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when the end of a document node appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.</p>
67
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/endElement" />
68
<h3 class="fn"><a name="endElement" />QAbstractXmlReceiver.endElement (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when the end of an element node appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.</p>
69
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/endOfSequence" />
120
<h3 class="fn"><a name="atomicValue" />QAbstractXmlReceiver.atomicValue (<i>self</i>, QVariant)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when an atomic value appears in the
121
<a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.
122
The <i>value</i> is a simple <a href="qvariant.html">data
123
value</a>. It is guaranteed to be <a href="qvariant.html#isValid">valid</a>.</p>
126
<h3 class="fn"><a name="attribute" />QAbstractXmlReceiver.attribute (<i>self</i>, <a href="qxmlname.html">QXmlName</a>, QStringRef)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when an attribute node appears in the
127
<a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.
128
<i>name</i> is the <a href="qxmlname.html">attribute name</a> and
129
the <i>value</i> string contains the attribute value.</p>
132
<h3 class="fn"><a name="characters" />QAbstractXmlReceiver.characters (<i>self</i>, QStringRef)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a text node appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>. The
133
<i>value</i> contains the text. Adjacent text nodes may not occur
134
in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>, i.e.,
135
this callback must not be called twice in a row.</p>
138
<h3 class="fn"><a name="comment" />QAbstractXmlReceiver.comment (<i>self</i>, QString)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a comment node appears in the
139
<a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.
140
The <i>value</i> is the comment text, which must not contain the
144
<h3 class="fn"><a name="endDocument" />QAbstractXmlReceiver.endDocument (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when the end of a document node appears
145
in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.</p>
148
<h3 class="fn"><a name="endElement" />QAbstractXmlReceiver.endElement (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when the end of an element node appears
149
in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.</p>
70
152
<h3 class="fn"><a name="endOfSequence" />QAbstractXmlReceiver.endOfSequence (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called once only, right after the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a> ends.</p>
71
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/namespaceBinding" />
72
<h3 class="fn"><a name="namespaceBinding" />QAbstractXmlReceiver.namespaceBinding (<i>self</i>, <a href="qxmlname.html">QXmlName</a>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a namespace binding is in scope of an element. A namespace is defined by a URI. In the <a href="qxmlname.html">QXmlName</a> <i>name</i>, the value of <a href="qxmlname.html#namespaceUri">QXmlName.namespaceUri</a>() is that URI. The value of <a href="qxmlname.html#prefix">QXmlName.prefix</a>() is the prefix that the URI is bound to. The local name is insignificant and can be an arbitrary value.</p>
73
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/processingInstruction" />
74
<h3 class="fn"><a name="processingInstruction" />QAbstractXmlReceiver.processingInstruction (<i>self</i>, <a href="qxmlname.html">QXmlName</a>, QString)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a processing instruction appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>. A processing instruction is used in an XML document to tell the application reading the document to perform some action. A typical example is to use a processing instruction to tell the application to use a particular XSLT stylesheet to process the document.</p>
75
<pre> <?xml-stylesheet type="test/xsl" href="formatter.xsl"?></pre>
76
<p><i>target</i> is the <a href="qxmlname.html">name</a> of the processing instruction. Its <i>prefix</i> and <i>namespace URI</i> must both be empty. Its <i>local name</i> is the target. In the above example, the name is <i>xml-stylesheet</i>.</p>
77
<p>The <i>value</i> specifies the action to be taken. Note that the <i>value</i> must not contain the string "?>". In the above example, the <i>value</i> is <i>type="test/xsl" href="formatter.xsl</i>.</p>
78
<p>Generally, use of processing instructions should be avoided, because they are not namespace aware and in many contexts are stripped out anyway. Processing instructions can often be replaced with elements from a custom namespace.</p>
79
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/startDocument" />
80
<h3 class="fn"><a name="startDocument" />QAbstractXmlReceiver.startDocument (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a document node appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.</p>
81
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/startElement" />
82
<h3 class="fn"><a name="startElement" />QAbstractXmlReceiver.startElement (<i>self</i>, <a href="qxmlname.html">QXmlName</a>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a new element node appears in the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>. <i>name</i> is the valid <a href="qxmlname.html">name</a> of the node element.</p>
83
<a name="//apple_ref/cpp/instm/QAbstractXmlReceiver/startOfSequence" />
84
<h3 class="fn"><a name="startOfSequence" />QAbstractXmlReceiver.startOfSequence (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called once only, right before the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a> begins.</p>
85
<p /><address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt 4.7.7 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2010</td><td align="right" width="25%">Qt 4.6.3</td></tr></table></div></address></body></html>
b'\\ No newline at end of file'
155
<h3 class="fn"><a name="namespaceBinding" />QAbstractXmlReceiver.namespaceBinding (<i>self</i>, <a href="qxmlname.html">QXmlName</a>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a namespace binding is in scope of
156
an element. A namespace is defined by a URI. In the <a href="qxmlname.html">QXmlName</a> <i>name</i>, the value of <a href="qxmlname.html#namespaceUri">QXmlName.namespaceUri</a>() is that
157
URI. The value of <a href="qxmlname.html#prefix">QXmlName.prefix</a>() is the prefix that
158
the URI is bound to. The local name is insignificant and can be an
162
<h3 class="fn"><a name="processingInstruction" />QAbstractXmlReceiver.processingInstruction (<i>self</i>, <a href="qxmlname.html">QXmlName</a>, QString)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a processing instruction appears in
163
the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>. A
164
processing instruction is used in an XML document to tell the
165
application reading the document to perform some action. A typical
166
example is to use a processing instruction to tell the application
167
to use a particular XSLT stylesheet to process the document.</p>
168
<pre class="highlightedCode brush: cpp">
169
<?xml-stylesheet type="test/xsl" href="formatter.xsl"?>
171
<p><i>target</i> is the <a href="qxmlname.html">name</a> of the
172
processing instruction. Its <i>prefix</i> and <i>namespace URI</i>
173
must both be empty. Its <i>local name</i> is the target. In the
174
above example, the name is <i>xml-stylesheet</i>.</p>
175
<p>The <i>value</i> specifies the action to be taken. Note that the
176
<i>value</i> must not contain the string "?>". In the above
177
example, the <i>value</i> is <i>type="test/xsl"
178
href="formatter.xsl</i>.</p>
179
<p>Generally, use of processing instructions should be avoided,
180
because they are not namespace aware and in many contexts are
181
stripped out anyway. Processing instructions can often be replaced
182
with elements from a custom namespace.</p>
185
<h3 class="fn"><a name="startDocument" />QAbstractXmlReceiver.startDocument (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a document node appears in the
186
<a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.</p>
189
<h3 class="fn"><a name="startElement" />QAbstractXmlReceiver.startElement (<i>self</i>, <a href="qxmlname.html">QXmlName</a>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called when a new element node appears in the
190
<a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>.
191
<i>name</i> is the valid <a href="qxmlname.html">name</a> of the
195
<h3 class="fn"><a name="startOfSequence" />QAbstractXmlReceiver.startOfSequence (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>This callback is called once only, right before the <a href="qabstractxmlreceiver.html#xquery-sequence">sequence</a>
197
<address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt 4.8.1 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2010</td><td align="right" width="25%">Qt 4.7.0</td></tr></table></div></address></body></html>
b'\\ No newline at end of file'
added
removed
doc/html/qabstractxmlreceiver.html
