276 lines
16 KiB
HTML
276 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
|
<title>exml Library</title>
|
|
<link rel="stylesheet" href="base.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1>exml Library</h1>
|
|
<li>exml</li>
|
|
<ul>
|
|
<li><a href="exml__Attribute.html">Attribute</a></li>
|
|
<li><a href="exml__AttributeList.html">AttributeList</a></li>
|
|
<li><a href="exml__Comment.html">Comment</a></li>
|
|
<li><a href="exml__Declaration.html">Declaration</a></li>
|
|
<li><a href="exml__DeclarationXML.html">DeclarationXML</a></li>
|
|
<li><a href="exml__Document.html">Document</a></li>
|
|
<li><a href="exml__Element.html">Element</a></li>
|
|
<li><a href="exml__Node.html">Node</a></li>
|
|
<li><a href="exml__Text.html">Text</a></li>
|
|
<li><a href="exml__TextCDATA.html">TextCDATA</a></li>
|
|
<li><a href="exml__filePos.html">filePos</a></li>
|
|
</ul>
|
|
<li><a href="exml__nodeType.html">nodeType</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>Class: exml::Element</h1>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#Element">Element</a> (<span class="code-type">void</span>);<br>+ <a class="code-function" href="#Element">Element</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_value</span>);<br>+ <a class="code-function" href="#Element">Element</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_value</span>);<br>+ ~<a class="code-function" href="#Element">Element</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">size_t</span> <a class="code-function" href="#size">size</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#append">append</a> (Node * <span class="code-argument">_node</span>);<br>+ <span class="code-storage-keyword">const</span> <span class="code-storage-keyword">enum</span> nodeType <a class="code-function" href="#getType">getType</a> (<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);<br>+ Node * <a class="code-function" href="#getNode">getNode</a> (<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);<br>+ <span class="code-storage-keyword">const</span> Node * <a class="code-function" href="#getNode">getNode</a> (<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);<br>+ Element * <a class="code-function" href="#getElement">getElement</a> (<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);<br>+ <span class="code-storage-keyword">const</span> Element * <a class="code-function" href="#getElement">getElement</a> (<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);<br>+ Element * <a class="code-function" href="#getNamed">getNamed</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);<br>+ <span class="code-storage-keyword">const</span> Element * <a class="code-function" href="#getNamed">getNamed</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);<br>+ Element * <a class="code-function" href="#getNamed">getNamed</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_name</span>);<br>+ <span class="code-storage-keyword">const</span> Element * <a class="code-function" href="#getNamed">getNamed</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_name</span>);<br>+ <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <a class="code-function" href="#getText">getText</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">enum</span> nodeType <a class="code-function" href="#getType">getType</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#iParse">iParse</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>,<br/> <span class="code-type">int32_t</span> & <span class="code-argument">_pos</span>,<br/> <span class="code-type">bool</span> <span class="code-argument">_caseSensitive</span>,<br/> <a href="exml__filePos.html" class="code-type">exml::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <a href="exml__Document.html" class="code-type">exml::Document</a> & <span class="code-argument">_doc</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#iGenerate">iGenerate</a> (<a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>,<br/> <span class="code-type">int32_t</span> <span class="code-argument">_indent</span>);<br>+ <a href="exml__Element.html" class="code-type">exml::Element</a> * <a class="code-function" href="#toElement">toElement</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> <a href="exml__Element.html" class="code-type">exml::Element</a> * <a class="code-function" href="#toElement">toElement</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#clear">clear</a> (<span class="code-type">void</span>);<br># <span class="code-type">bool</span> <a class="code-function" href="#subParse">subParse</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>,<br/> <span class="code-type">int32_t</span> & <span class="code-argument">_pos</span>,<br/> <span class="code-type">bool</span> <span class="code-argument">_caseSensitive</span>,<br/> <a href="exml__filePos.html" class="code-type">exml::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <a href="exml__Document.html" class="code-type">exml::Document</a> & <span class="code-argument">_doc</span>,<br/> <span class="code-type">bool</span> <span class="code-argument">_mainNode</span>);<br></pre>
|
|
|
|
|
|
<h2>Object Hierarchy:</h2>
|
|
<pre>
|
|
<a href="">AttributeList</a>
|
|
+--> <b>exml::Element</b>
|
|
+--> <a href="exml__Document.html">exml::Document</a>
|
|
</pre>
|
|
<br/>
|
|
<h2>Detail:<h2>
|
|
<h3>exml::<a id="Element">Element</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">Element</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Constructor
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3>exml::<a id="Element">Element</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">Element</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_value</span>);</pre>
|
|
<br/>
|
|
Constructor
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_value</span> Element name;
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3>exml::<a id="Element">Element</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">Element</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_value</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3>exml::~<a id="Element">Element</a> ()</h3>
|
|
|
|
<pre>
|
|
~<span class="code-function">Element</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Destructor
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="size">size</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">size_t</span> <span class="code-function">size</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the number of sub element in the node (can be exml::Comment ; exml::Element ; exml::Text :exml::Declaration).
|
|
<br/><ul>
|
|
<b>Return:</b> a number >=0.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="append">append</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">append</span>(Node * <span class="code-argument">_node</span>);</pre>
|
|
<br/>
|
|
add a node at the element (not exml::Attribute (move in the attribute automaticly).
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_node</span> Pointer of the node to add.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getType">getType</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> <span class="code-storage-keyword">enum</span> nodeType <span class="code-function">getType</span>(<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getNode">getNode</a> ()</h3>
|
|
|
|
<pre>
|
|
Node * <span class="code-function">getNode</span>(<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);</pre>
|
|
<br/>
|
|
get the Node pointer of the element id.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_id</span> Id of the element.
|
|
<br/><b>Return:</b> Pointer on node.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getNode">getNode</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> Node * <span class="code-function">getNode</span>(<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getElement">getElement</a> ()</h3>
|
|
|
|
<pre>
|
|
Element * <span class="code-function">getElement</span>(<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);</pre>
|
|
<br/>
|
|
get the element casted in Element (if the node is not an element return NULL).
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_id</span> Id of the element.
|
|
<br/><b>Return:</b> Pointer on the element or NULL.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getElement">getElement</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> Element * <span class="code-function">getElement</span>(<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getNamed">getNamed</a> ()</h3>
|
|
|
|
<pre>
|
|
Element * <span class="code-function">getNamed</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);</pre>
|
|
<br/>
|
|
get an element with his name (work only with exml::Element)
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_name</span> Name of the element that is requested
|
|
<br/><b>Return:</b> Pointer on the element or NULL.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getNamed">getNamed</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> Element * <span class="code-function">getNamed</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_name</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getNamed">getNamed</a> ()</h3>
|
|
|
|
<pre>
|
|
Element * <span class="code-function">getNamed</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_name</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getNamed">getNamed</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> Element * <span class="code-function">getNamed</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_name</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getText">getText</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <span class="code-function">getText</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the internal data of the element (if the element has some sub node thay are converted in xml string == > like this it is not needed to use <![CDATA[...]]>
|
|
<br/><ul>
|
|
<b>Return:</b> the curent data string.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getType">getType</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">enum</span> nodeType <span class="code-function">getType</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="iParse">iParse</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">iParse</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>,
|
|
<span class="code-type">int32_t</span> & <span class="code-argument">_pos</span>,
|
|
<span class="code-type">bool</span> <span class="code-argument">_caseSensitive</span>,
|
|
<a href="exml__filePos.html" class="code-type">exml::filePos</a> & <span class="code-argument">_filePos</span>,
|
|
<a href="exml__Document.html" class="code-type">exml::Document</a> & <span class="code-argument">_doc</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="iGenerate">iGenerate</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">iGenerate</span>(<a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>,
|
|
<span class="code-type">int32_t</span> <span class="code-argument">_indent</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="toElement">toElement</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="exml__Element.html" class="code-type">exml::Element</a> * <span class="code-function">toElement</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="toElement">toElement</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> <a href="exml__Element.html" class="code-type">exml::Element</a> * <span class="code-function">toElement</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="clear">clear</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">clear</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="subParse">subParse</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">subParse</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_data</span>,
|
|
<span class="code-type">int32_t</span> & <span class="code-argument">_pos</span>,
|
|
<span class="code-type">bool</span> <span class="code-argument">_caseSensitive</span>,
|
|
<a href="exml__filePos.html" class="code-type">exml::filePos</a> & <span class="code-argument">_filePos</span>,
|
|
<a href="exml__Document.html" class="code-type">exml::Document</a> & <span class="code-argument">_doc</span>,
|
|
<span class="code-type">bool</span> <span class="code-argument">_mainNode</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
</div>
|
|
</body>
|
|
</html>
|