View source code
Display the source code in std/xml.d from which this page was generated on
github.
Improve this page
Quickly fork, edit online, and submit a pull request for this page.
Requires a signed-in GitHub account. This works well for small changes.
If you'd like to make larger changes you may want to consider using
local clone.
Page wiki
View or edit the community-maintained wiki page associated with this page.
Class std.xml.ElementParser
Class for parsing an XML element.
Inherits from
-
(base class)Object
Fields
Name | Type | Description |
---|---|---|
onEndTag
|
void delegate(const(Element)) |
Register a handler which will be called whenever an end tag is
encountered which matches the specified name. You can also pass null as
the name, in which case the handler will be called for any unmatched
end tag .
|
onStartTag
|
void delegate(ElementParser) |
Register a handler which will be called whenever a start tag is
encountered which matches the specified name. You can also pass null as
the name, in which case the handler will be called for any unmatched
start tag .
|
Properties
Name | Type | Description |
---|---|---|
onCData
[set]
|
void delegate(string) |
Register a handler which will be called whenever a character data
segment is encountered.
|
onComment
[set]
|
void delegate(string) |
Register a handler which will be called whenever a comment is
encountered.
|
onPI
[set]
|
void delegate(string) |
Register a handler which will be called whenever a processing
instruction is encountered.
|
onText
[set]
|
void delegate(string) |
Register a handler which will be called whenever text is encountered.
|
onXI
[set]
|
void delegate(string) |
Register a handler which will be called whenever an XML instruction is
encountered.
|
tag
[get]
|
const(Tag) |
The Tag at the start of the element being parsed. You can read this to
determine the tag 's name and attributes.
|
Methods
Name | Description |
---|---|
onTextRaw
|
Register an alternative handler which will be called whenever text
is encountered. This differs from onText in that onText will decode
the text, whereas onTextRaw will not. This allows you to make design
choices, since onText will be more accurate, but slower, while
onTextRaw will be faster, but less accurate. Of course, you can
still call decode () within your handler , if you want, but you'd
probably want to use onTextRaw only in circumstances where you
know that decoding is unnecessary.
|
parse
|
Parse an XML element. |
toString
|
Returns that part of the element which has already been parsed |
factory
|
Create instance of class specified by the fully qualified name
classname .
The class must either have no constructors or have
a default constructor.
|
opCmp
|
Compare with another Object obj.
|
opEquals
|
Returns !=0 if this object does have the same contents as obj.
|
toHash
|
Compute hash function for Object .
|
toString
|
Convert Object to a human readable string.
|
Standards
Note that you cannot construct instances of this class directly. You can
construct a DocumentParser
(which is a subclass of ElementParser
), but
otherwise, Instances of ElementParser
will be created for you by the
library, and passed your way via onStartTag
handlers.
Authors
Janice Caron