50 lines
16 KiB
HTML
50 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><!-- use theme color or fallback -->
|
|
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
|
|
<head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "./",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="./nav.js"></script><script type="text/javascript" src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"></link><title>Xml - API Reference</title><meta name="description" content="Cross-platform Xml API."/></head><body><style>
|
|
a, code .type {
|
|
color: #24afc4;
|
|
}
|
|
.navbar .brand {
|
|
display: inline-block;
|
|
float: none;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
|
|
background: #24afc4;
|
|
color: #ffffff;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
.navbar .container {
|
|
width: 940px ;
|
|
}
|
|
@media (max-width: 767px) {
|
|
.navbar .container {
|
|
width: auto;
|
|
}
|
|
}
|
|
@media (max-width: 979px) and (min-width: 768px) {
|
|
.navbar .container {
|
|
width: 724px;
|
|
}
|
|
}
|
|
@media (min-width: 1200px) {
|
|
.navbar .container {
|
|
width: 1170px;
|
|
}
|
|
}
|
|
.navbar .container img {
|
|
margin: 5px 0 0 4px;
|
|
}
|
|
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="./">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Xml</h1><h4><small><a href="./">no package</a></small></h4> <p class="availability"><hr/><em>Available on Neko, macOS, Linux, Windows</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>Cross-platform Xml API.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://haxe.org/manual/std-Xml.html">https://haxe.org/manual/std-Xml.html</a></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="nodeName"></a><h3><p><code><span class="label">read only</span><span class="label">write only</span><a href="./Xml.html#nodeName"><span class="identifier">nodeName</span></a>:<a class="type" title="The basic String class." href="./String.html">String</a></code></p></h3><div class="doc"><p>Returns the node name of an Element.</p></div></div><div class="field "><a name="nodeType"></a><h3><p><code><span class="label">read only</span><a href="./Xml.html#nodeType"><span class="identifier">nodeType</span></a>:<a class="type" title="Xml node types." href="./XmlType.html">XmlType</a></code></p></h3><div class="doc"><p>Returns the type of the Xml Node. This should be used before
|
|
accessing other functions since some might raise an exception
|
|
if the node type is not correct.</p></div></div><div class="field "><a name="nodeValue"></a><h3><p><code><span class="label">read only</span><span class="label">write only</span><a href="./Xml.html#nodeValue"><span class="identifier">nodeValue</span></a>:<a class="type" title="The basic String class." href="./String.html">String</a></code></p></h3><div class="doc"><p>Returns the node value. Only works if the Xml node is not an Element or a Document.</p></div></div><div class="field "><a name="parent"></a><h3><p><code><span class="label">read only</span><a href="./Xml.html#parent"><span class="identifier">parent</span></a>:<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Returns the parent object in the Xml hierarchy.
|
|
The parent can be <code>null</code>, an Element or a Document.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="addChild"></a><h3><p><code><a href="#addChild"><span class="identifier">addChild</span></a> (<span style="white-space:nowrap">x:<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></span>):<a class="type" title="The standard Void type." href="./Void.html">Void</a></code></p></h3><div class="doc"><p>Adds a child node to the Document or Element.
|
|
A child node can only be inside one given parent node, which is indicated by the <code>parent</code> property.
|
|
If the child is already inside this Document or Element, it will be moved to the last position among the Document or Element's children.
|
|
If the child node was previously inside a different node, it will be moved to this Document or Element.</p></div></div><div class="field "><a name="attributes"></a><h3><p><code><a href="#attributes"><span class="identifier">attributes</span></a> ():<a class="type" title="An Iterator is a structure that permits iteration over elements of type T." href="./Iterator.html">Iterator</a><<a class="type" title="The basic String class." href="./String.html">String</a>></code></p></h3><div class="doc"><p>Returns an <code><a href="./Iterator.html">Iterator</a></code> on all the attribute names.</p></div></div><div class="field "><a name="elements"></a><h3><p><code><a href="#elements"><span class="identifier">elements</span></a> ():<a class="type" title="An Iterator is a structure that permits iteration over elements of type T." href="./Iterator.html">Iterator</a><<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a>></code></p></h3><div class="doc"><p>Returns an iterator of all child nodes which are Elements.
|
|
Only works if the current node is an Element or a Document.</p></div></div><div class="field "><a name="exists"></a><h3><p><code><a href="#exists"><span class="identifier">exists</span></a> (<span style="white-space:nowrap">att:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></p></h3><div class="doc"><p>Tells if the Element node has a given attribute.
|
|
Attributes are case-sensitive.</p></div></div><div class="field "><a name="firstElement"></a><h3><p><code><a href="#firstElement"><span class="identifier">firstElement</span></a> ():<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Returns the first child node which is an Element.</p></div></div><div class="field "><a name="get"></a><h3><p><code><a href="#get"><span class="identifier">get</span></a> (<span style="white-space:nowrap">att:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="The basic String class." href="./String.html">String</a></code></p></h3><div class="doc"><p>Get the given attribute of an Element node. Returns <code>null</code> if not found.
|
|
Attributes are case-sensitive.</p></div></div><div class="field "><a name="removeChild"></a><h3><p><code><a href="#removeChild"><span class="identifier">removeChild</span></a> (<span style="white-space:nowrap">x:<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></p></h3><div class="doc"><p>Removes a child from the Document or Element.
|
|
Returns true if the child was successfuly removed.</p></div></div><div class="field "><a name="set"></a><h3><p><code><a href="#set"><span class="identifier">set</span></a> (<span style="white-space:nowrap">att:<a class="type" title="The basic String class." href="./String.html">String</a>,</span> <span style="white-space:nowrap">value:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="The standard Void type." href="./Void.html">Void</a></code></p></h3><div class="doc"><p>Set the given attribute value for an Element node.
|
|
Attributes are case-sensitive.</p></div></div></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="CData"></a><h3><p><code><span class="label">static</span><span class="label">read only</span><a href="./Xml.html#CData"><span class="identifier">CData</span></a>:<a class="type" title="Xml node types." href="./XmlType.html">XmlType</a><span> = XmlType.CData</span></code></p></h3><div class="doc"><p>XML character data type.</p></div></div><div class="field "><a name="Comment"></a><h3><p><code><span class="label">static</span><span class="label">read only</span><a href="./Xml.html#Comment"><span class="identifier">Comment</span></a>:<a class="type" title="Xml node types." href="./XmlType.html">XmlType</a><span> = XmlType.Comment</span></code></p></h3><div class="doc"><p>XML comment type.</p></div></div><div class="field "><a name="DocType"></a><h3><p><code><span class="label">static</span><span class="label">read only</span><a href="./Xml.html#DocType"><span class="identifier">DocType</span></a>:<a class="type" title="Xml node types." href="./XmlType.html">XmlType</a><span> = XmlType.DocType</span></code></p></h3><div class="doc"><p>XML doctype element type.</p></div></div><div class="field "><a name="Document"></a><h3><p><code><span class="label">static</span><span class="label">read only</span><a href="./Xml.html#Document"><span class="identifier">Document</span></a>:<a class="type" title="Xml node types." href="./XmlType.html">XmlType</a><span> = XmlType.Document</span></code></p></h3><div class="doc"><p>XML document type.</p></div></div><div class="field "><a name="Element"></a><h3><p><code><span class="label">static</span><span class="label">read only</span><a href="./Xml.html#Element"><span class="identifier">Element</span></a>:<a class="type" title="Xml node types." href="./XmlType.html">XmlType</a><span> = XmlType.Element</span></code></p></h3><div class="doc"><p>XML element type.</p></div></div><div class="field "><a name="PCData"></a><h3><p><code><span class="label">static</span><span class="label">read only</span><a href="./Xml.html#PCData"><span class="identifier">PCData</span></a>:<a class="type" title="Xml node types." href="./XmlType.html">XmlType</a><span> = XmlType.PCData</span></code></p></h3><div class="doc"><p>XML parsed character data type.</p></div></div><div class="field "><a name="ProcessingInstruction"></a><h3><p><code><span class="label">static</span><span class="label">read only</span><a href="./Xml.html#ProcessingInstruction"><span class="identifier">ProcessingInstruction</span></a>:<a class="type" title="Xml node types." href="./XmlType.html">XmlType</a><span> = XmlType.ProcessingInstruction</span></code></p></h3><div class="doc"><p>XML processing instruction type.</p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="createCData"></a><h3><p><code><span class="label">static</span><a href="#createCData"><span class="identifier">createCData</span></a> (<span style="white-space:nowrap">data:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Creates a node of the given type.</p></div></div><div class="field "><a name="createComment"></a><h3><p><code><span class="label">static</span><a href="#createComment"><span class="identifier">createComment</span></a> (<span style="white-space:nowrap">data:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Creates a node of the given type.</p></div></div><div class="field "><a name="createDocType"></a><h3><p><code><span class="label">static</span><a href="#createDocType"><span class="identifier">createDocType</span></a> (<span style="white-space:nowrap">data:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Creates a node of the given type.</p></div></div><div class="field "><a name="createDocument"></a><h3><p><code><span class="label">static</span><a href="#createDocument"><span class="identifier">createDocument</span></a> ():<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Creates a node of the given type.</p></div></div><div class="field "><a name="createElement"></a><h3><p><code><span class="label">static</span><a href="#createElement"><span class="identifier">createElement</span></a> (<span style="white-space:nowrap">name:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Creates a node of the given type.</p></div></div><div class="field "><a name="createPCData"></a><h3><p><code><span class="label">static</span><a href="#createPCData"><span class="identifier">createPCData</span></a> (<span style="white-space:nowrap">data:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Creates a node of the given type.</p></div></div><div class="field "><a name="createProcessingInstruction"></a><h3><p><code><span class="label">static</span><a href="#createProcessingInstruction"><span class="identifier">createProcessingInstruction</span></a> (<span style="white-space:nowrap">data:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Creates a node of the given type.</p></div></div><div class="field "><a name="parse"></a><h3><p><code><span class="label">static</span><a href="#parse"><span class="identifier">parse</span></a> (<span style="white-space:nowrap">str:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="Cross-platform Xml API." href="./Xml.html">Xml</a></code></p></h3><div class="doc"><p>Parses the String into an Xml document.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">© 2017 <a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html> |