134 lines
10 KiB
HTML
134 lines
10 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::Declaration</h1><hr/><h2>Description:</h2>
|
|
|
|
<br/><br/>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#9695">Declaration</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-function" href="#9697">Declaration</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">virtual</span> <a class="code-function" href="#9699">~Declaration</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">enum</span> nodeType <a class="code-function" href="#9701">getType</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#9703">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" >bool</span> <a class="code-function" href="#9706">iParse</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">_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 class="code-type" href="class_exml__filePos.html">exml::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <a class="code-type" href="class_exml__Document.html">exml::Document</a> & <span class="code-argument">_doc</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_exml__Declaration.html">exml::Declaration</a>* <a class="code-function" href="#9712">toDeclaration</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_exml__Declaration.html">exml::Declaration</a>* <a class="code-function" href="#9714">toDeclaration</a> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
<br/>
|
|
<h2>Object Hierarchy:<h2>
|
|
<pre>
|
|
+<a href="class_exml__Node.html">exml::Node</a><br/> +--> +<a href="class_exml__AttributeList.html">exml::AttributeList</a><br/> +--> exml::Declaration<br/> +--> <a href="class_exml__DeclarationXML.html">exml::DeclarationXML</a><br/></pre>
|
|
<h2>Detail:</h2>
|
|
<a id="9695"/><a id="9697"/><h3>Declaration</h3><pre>
|
|
+ <span class="code-function">Declaration</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Constructor<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="9699"/><h3>Declaration</h3><pre>
|
|
+ <span class="code-function">Declaration</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/></pre>
|
|
Constructor<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_name</span> </td><td> name of the declaration (xml, xml:xxxx ...)</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9701"/><h3>~Declaration</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Declaration</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Destructor<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="9703"/><h3>getType</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">enum</span> nodeType <span class="code-function">getType</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
get the node type.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>the type of the Node.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9706"/><h3>iGenerate</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <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/>
|
|
<a id="9712"/><h3>iParse</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">iParse</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">_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 class="code-type" href="class_exml__filePos.html">exml::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <a class="code-type" href="class_exml__Document.html">exml::Document</a> & <span class="code-argument">_doc</span>);<br/></pre>
|
|
parse the Current node [pure VIRUAL]<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_data</span> </td><td> data string to parse.</td></tr>
|
|
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">_pos</span> </td><td> position in the string to start parse, return the position end of parsing.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_caseSensitive</span> </td><td> Request a parsion of element that is not case sensitive (all element is in low case)</td></tr>
|
|
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">file</span> </td><td> parsing position (line x col x)</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>false if an error occured.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="9714"/><h3>toDeclaration</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_exml__Declaration.html">exml::Declaration</a>* <span class="code-function">toDeclaration</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Cast the element in a Declaration if it is possible.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>pointer on the class or NULL.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<h3>toDeclaration</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_exml__Declaration.html">exml::Declaration</a>* <span class="code-function">toDeclaration</span> (<span class="code-type" >void</span> <span class="code-argument"></span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
Cast the element in a Declaration if it is possible.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>pointer on the class or NULL.</td></tr></table>
|
|
</ul>
|
|
|
|
<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>
|