171 lines
12 KiB
HTML
171 lines
12 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">
|
|
<link rel="stylesheet" href="menu.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1><a href="index.html">exml library</a></h1>
|
|
<h4><a href="http://github.com/heeroyui/exml/"> [ sources ]</a></h4>
|
|
<h3>API:</h3> <div id="menu">
|
|
<ul class="niveau1">
|
|
<li><a href="namespace_exml.html">exml</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<br/><h3>Associate libraries:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="../ewol/index.html">ewol</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../ejson/index.html">ejson</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../etk/index.html">etk</a></li>
|
|
</ul></div>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>class: exml::AttributeList</h1><hr/><h2>Description:</h2>
|
|
|
|
<br/><br/>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#9659">AttributeList</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-function" href="#9661">AttributeList</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_value</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#9663">~AttributeList</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
# <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><exml::Attribute*> <a class="code-member" href="#9665">m_listAttribute</a>;<br/>+ size_t <a class="code-function" href="#9666">sizeAttribute</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#9668">appendAttribute</a> (<a class="code-type" href="class_exml__Attribute.html">exml::Attribute</a>* <span class="code-argument">_attr</span>);<br/>+ Attribute* <a class="code-function" href="#9670">getAttr</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/>+ <span class="code-storage-keyword">const</span> Attribute* <a class="code-function" href="#9672">getAttr</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <a class="code-function" href="#9674">getAttribute</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_name</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#9676">existAttribute</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_name</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#9678">setAttribute</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_name</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_value</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#9681">iGenerate</a> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_indent</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#9684">clear</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
<br/>
|
|
<h2>Object Hierarchy:<h2>
|
|
<pre>
|
|
+<a href="class_exml__Node.html">exml::Node</a><br/> +--> exml::AttributeList<br/> +--> <a href="class_exml__Declaration.html">exml::Declaration</a><br/> +--> <a href="class_exml__Element.html">exml::Element</a><br/></pre>
|
|
<h2>Detail:</h2>
|
|
<a id="9659"/><a id="9661"/><h3>AttributeList</h3><pre>
|
|
+ <span class="code-function">AttributeList</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Constructor<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="9663"/><h3>AttributeList</h3><pre>
|
|
+ <span class="code-function">AttributeList</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_value</span>);<br/></pre>
|
|
Constructor<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> Node value;</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9665"/><h3>~AttributeList</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~AttributeList</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Destructor<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="9666"/><h3>m_listAttribute</h3><pre>
|
|
# <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><exml::Attribute*> <span class="code-member">m_listAttribute</span>;<br/></pre>
|
|
|
|
list of all attribute<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="9668"/><h3>sizeAttribute</h3><pre>
|
|
+ size_t <span class="code-function">sizeAttribute</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
get the number of attribute in the Node<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>Nulber of attribute >=0</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9670"/><h3>appendAttribute</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">appendAttribute</span> (<a class="code-type" href="class_exml__Attribute.html">exml::Attribute</a>* <span class="code-argument">_attr</span>);<br/></pre>
|
|
add attribute on the List<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_attr</span> </td><td> Pointer on the attribute</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9672"/><h3>getAttr</h3><pre>
|
|
+ Attribute* <span class="code-function">getAttr</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>);<br/></pre>
|
|
get attribute whith his ID<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_id</span> </td><td> Identifier of the attribute 0<= _id < sizeAttribute()</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>Pointer on the attribute or NULL</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9674"/><h3>getAttr</h3><pre>
|
|
+ <span class="code-storage-keyword">const</span> Attribute* <span class="code-function">getAttr</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_id</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="9676"/><h3>getAttribute</h3><pre>
|
|
+ <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-function">getAttribute</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_name</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
get the attribute value with searching in the List with his name<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_name</span> </td><td> Attribute Name.</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>Value of the attribute or no data in the string</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9678"/><h3>existAttribute</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">existAttribute</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_name</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
check if an attribute exist or not with his name.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_name</span> </td><td> Attribute Name.</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>true if the attribute exist or False</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9681"/><h3>setAttribute</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setAttribute</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_name</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_value</span>);<br/></pre>
|
|
Sen A new attribute or replace data of the previous one<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_name</span> </td><td> Name of the attribute</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_value</span> </td><td> Value of the attribute</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9684"/><h3>iGenerate</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">iGenerate</span> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_indent</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
generate a string with the tree of the xml<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">_data</span> </td><td> string where to add the elements</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">current</span> </td><td> indentation of the file</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>false if an error occured.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<h3>clear</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">clear</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
clear the Node<br/>
|
|
<br/>
|
|
<hr/>
|
|
</div>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</body>
|
|
</html>
|