diff options
Diffstat (limited to 'zenxml/doc/namespacezen.html')
| -rw-r--r-- | zenxml/doc/namespacezen.html | 613 |
1 files changed, 613 insertions, 0 deletions
diff --git a/zenxml/doc/namespacezen.html b/zenxml/doc/namespacezen.html new file mode 100644 index 00000000..c05f255c --- /dev/null +++ b/zenxml/doc/namespacezen.html @@ -0,0 +1,613 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<title>zen::Xml: zen Namespace Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> + +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + <td id="projectlogo"><img alt="Logo" src="zenXml.png"/></td> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">zen::Xml + + </div> + <div id="projectbrief">Simple C++ XML Processing</div> + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.8.0 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="namespaces.html"><span>Namespace List</span></a></li> + <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +</div> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">zen Namespace Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>The zen::Xml namespace. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classzen_1_1_xml_out.html">XmlOut</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Proxy class to conveniently convert user data into XML structure. <a href="classzen_1_1_xml_out.html#details">More...</a><br/></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classzen_1_1_xml_in.html">XmlIn</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Proxy class to conveniently convert XML structure to user data. <a href="classzen_1_1_xml_in.html#details">More...</a><br/></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classzen_1_1_xml_element.html">XmlElement</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An XML element. <a href="classzen_1_1_xml_element.html#details">More...</a><br/></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classzen_1_1_xml_doc.html">XmlDoc</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The complete XML document. <a href="classzen_1_1_xml_doc.html#details">More...</a><br/></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structzen_1_1_xml_error.html">XmlError</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Exception base class for zen::Xml. <a href="structzen_1_1_xml_error.html#details">More...</a><br/></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structzen_1_1_xml_file_error.html">XmlFileError</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Exception thrown due to failed file I/O. <a href="structzen_1_1_xml_file_error.html#details">More...</a><br/></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structzen_1_1_xml_parsing_error.html">XmlParsingError</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Exception thrown due to an XML parsing error. <a href="structzen_1_1_xml_parsing_error.html#details">More...</a><br/></td></tr> +<tr><td colspan="2"><h2><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a900c1fb290f0eedc24354c487145dbee"><td class="memTemplParams" colspan="2">template<class String > </td></tr> +<tr class="memitem:a900c1fb290f0eedc24354c487145dbee"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacezen.html#a900c1fb290f0eedc24354c487145dbee">load</a> (const String &filename, <a class="el" href="classzen_1_1_xml_doc.html">XmlDoc</a> &doc)</td></tr> +<tr class="memdesc:a900c1fb290f0eedc24354c487145dbee"><td class="mdescLeft"> </td><td class="mdescRight">Load XML document from a file. <a href="#a900c1fb290f0eedc24354c487145dbee"></a><br/></td></tr> +<tr class="memitem:adeeb6b2318097382ae47aa939fc15d4d"><td class="memTemplParams" colspan="2">template<class String > </td></tr> +<tr class="memitem:adeeb6b2318097382ae47aa939fc15d4d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacezen.html#adeeb6b2318097382ae47aa939fc15d4d">save</a> (const <a class="el" href="classzen_1_1_xml_doc.html">XmlDoc</a> &doc, const String &filename, const std::string &lineBreak="\r\n", const std::string &indent=" ")</td></tr> +<tr class="memdesc:adeeb6b2318097382ae47aa939fc15d4d"><td class="mdescLeft"> </td><td class="mdescRight">Save XML document to a file. <a href="#adeeb6b2318097382ae47aa939fc15d4d"></a><br/></td></tr> +<tr class="memitem:a2bdcecfe7435ef11cedbce47d4e72ee1"><td class="memTemplParams" colspan="2">template<class T > </td></tr> +<tr class="memitem:a2bdcecfe7435ef11cedbce47d4e72ee1"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacezen.html#a2bdcecfe7435ef11cedbce47d4e72ee1">readStruc</a> (const <a class="el" href="classzen_1_1_xml_element.html">XmlElement</a> &input, T &value)</td></tr> +<tr class="memdesc:a2bdcecfe7435ef11cedbce47d4e72ee1"><td class="mdescLeft"> </td><td class="mdescRight">Convert XML element to structured user data. <a href="#a2bdcecfe7435ef11cedbce47d4e72ee1"></a><br/></td></tr> +<tr class="memitem:a29ddb823fe0a195f19a64448881b8bf6"><td class="memTemplParams" colspan="2">template<class T > </td></tr> +<tr class="memitem:a29ddb823fe0a195f19a64448881b8bf6"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacezen.html#a29ddb823fe0a195f19a64448881b8bf6">writeStruc</a> (const T &value, <a class="el" href="classzen_1_1_xml_element.html">XmlElement</a> &output)</td></tr> +<tr class="memdesc:a29ddb823fe0a195f19a64448881b8bf6"><td class="mdescLeft"> </td><td class="mdescRight">Convert structured user data into an XML element. <a href="#a29ddb823fe0a195f19a64448881b8bf6"></a><br/></td></tr> +<tr class="memitem:acaf85ab94b61882f957afcd355386bff"><td class="memTemplParams" colspan="2">template<class T > </td></tr> +<tr class="memitem:acaf85ab94b61882f957afcd355386bff"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacezen.html#acaf85ab94b61882f957afcd355386bff">readText</a> (const std::string &input, T &value)</td></tr> +<tr class="memdesc:acaf85ab94b61882f957afcd355386bff"><td class="mdescLeft"> </td><td class="mdescRight">Convert text to user data - used by XML elements and attributes. <a href="#acaf85ab94b61882f957afcd355386bff"></a><br/></td></tr> +<tr class="memitem:a2ce2998296871fc2f4718ceceb22a23f"><td class="memTemplParams" colspan="2">template<class T > </td></tr> +<tr class="memitem:a2ce2998296871fc2f4718ceceb22a23f"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacezen.html#a2ce2998296871fc2f4718ceceb22a23f">writeText</a> (const T &value, std::string &output)</td></tr> +<tr class="memdesc:a2ce2998296871fc2f4718ceceb22a23f"><td class="mdescLeft"> </td><td class="mdescRight">Convert user data into text - used by XML elements and attributes. <a href="#a2ce2998296871fc2f4718ceceb22a23f"></a><br/></td></tr> +<tr class="memitem:a4ba7bbaa14a787b07fc13da9145aabe2"><td class="memTemplParams" colspan="2">template<class String > </td></tr> +<tr class="memitem:a4ba7bbaa14a787b07fc13da9145aabe2"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacezen.html#a4ba7bbaa14a787b07fc13da9145aabe2">saveStream</a> (const std::string &stream, const String &filename)</td></tr> +<tr class="memdesc:a4ba7bbaa14a787b07fc13da9145aabe2"><td class="mdescLeft"> </td><td class="mdescRight">Save byte stream to a file. <a href="#a4ba7bbaa14a787b07fc13da9145aabe2"></a><br/></td></tr> +<tr class="memitem:a04fe23c3bd9b7d03309620b5ea763607"><td class="memTemplParams" colspan="2">template<class String > </td></tr> +<tr class="memitem:a04fe23c3bd9b7d03309620b5ea763607"><td class="memTemplItemLeft" align="right" valign="top">std::string </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacezen.html#a04fe23c3bd9b7d03309620b5ea763607">loadStream</a> (const String &filename)</td></tr> +<tr class="memdesc:a04fe23c3bd9b7d03309620b5ea763607"><td class="mdescLeft"> </td><td class="mdescRight">Load byte stream from a file. <a href="#a04fe23c3bd9b7d03309620b5ea763607"></a><br/></td></tr> +<tr class="memitem:afaa4920e275078e6c8009fbdf58b57ee"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacezen.html#afaa4920e275078e6c8009fbdf58b57ee">serialize</a> (const <a class="el" href="classzen_1_1_xml_doc.html">XmlDoc</a> &doc, const std::string &lineBreak="\r\n", const std::string &indent=" ")</td></tr> +<tr class="memdesc:afaa4920e275078e6c8009fbdf58b57ee"><td class="mdescLeft"> </td><td class="mdescRight">Save XML document as a byte stream. <a href="#afaa4920e275078e6c8009fbdf58b57ee"></a><br/></td></tr> +<tr class="memitem:a6cf1ec0b57fc1ae9aa95761800e67ec7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacezen.html#a6cf1ec0b57fc1ae9aa95761800e67ec7">parse</a> (const std::string &stream, <a class="el" href="classzen_1_1_xml_doc.html">XmlDoc</a> &doc)</td></tr> +<tr class="memdesc:a6cf1ec0b57fc1ae9aa95761800e67ec7"><td class="mdescLeft"> </td><td class="mdescRight">Load XML document from a byte stream. <a href="#a6cf1ec0b57fc1ae9aa95761800e67ec7"></a><br/></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><p>The zen::Xml namespace. </p> +</div><hr/><h2>Function Documentation</h2> +<a class="anchor" id="a900c1fb290f0eedc24354c487145dbee"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class String > </div> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="namespacezen.html#a900c1fb290f0eedc24354c487145dbee">zen::load</a> </td> + <td>(</td> + <td class="paramtype">const String & </td> + <td class="paramname"><em>filename</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">XmlDoc & </td> + <td class="paramname"><em>doc</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Load XML document from a file. </p> +<p>Convenience function that does nothing more than calling <a class="el" href="namespacezen.html#a04fe23c3bd9b7d03309620b5ea763607" title="Load byte stream from a file.">loadStream()</a> and <a class="el" href="namespacezen.html#a6cf1ec0b57fc1ae9aa95761800e67ec7" title="Load XML document from a byte stream.">parse()</a>.</p> +<dl class=""><dt><b>Template Parameters:</b></dt><dd> + <table class=""> + <tr><td class="paramname">String</td><td>Arbitrary string-like type: e.g. std::string, wchar_t*, char[], wchar_t, wxString, MyStringClass, ... </td></tr> + </table> + </dd> +</dl> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">filename</td><td>Input file name </td></tr> + <tr><td class="paramname">doc</td><td>The XML document to load </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt><b>Exceptions:</b></dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="structzen_1_1_xml_file_error.html" title="Exception thrown due to failed file I/O.">XmlFileError</a></td><td></td></tr> + <tr><td class="paramname"><a class="el" href="structzen_1_1_xml_parsing_error.html" title="Exception thrown due to an XML parsing error.">XmlParsingError</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a04fe23c3bd9b7d03309620b5ea763607"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class String > </div> + <table class="memname"> + <tr> + <td class="memname">std::string <a class="el" href="namespacezen.html#a04fe23c3bd9b7d03309620b5ea763607">zen::loadStream</a> </td> + <td>(</td> + <td class="paramtype">const String & </td> + <td class="paramname"><em>filename</em></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Load byte stream from a file. </p> +<dl class=""><dt><b>Template Parameters:</b></dt><dd> + <table class=""> + <tr><td class="paramname">String</td><td>Arbitrary string-like type: e.g. std::string, wchar_t*, char[], wchar_t, wxString, MyStringClass, ... </td></tr> + </table> + </dd> +</dl> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">filename</td><td>Input file name </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns:</dt><dd>Output byte stream </dd></dl> +<dl class="exception"><dt><b>Exceptions:</b></dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="structzen_1_1_xml_file_error.html" title="Exception thrown due to failed file I/O.">XmlFileError</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a6cf1ec0b57fc1ae9aa95761800e67ec7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="namespacezen.html#a6cf1ec0b57fc1ae9aa95761800e67ec7">zen::parse</a> </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">XmlDoc & </td> + <td class="paramname"><em>doc</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Load XML document from a byte stream. </p> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">stream</td><td>Input byte stream </td></tr> + <tr><td class="paramname">doc</td><td>Output XML document </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt><b>Exceptions:</b></dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="structzen_1_1_xml_parsing_error.html" title="Exception thrown due to an XML parsing error.">XmlParsingError</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a2bdcecfe7435ef11cedbce47d4e72ee1"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="namespacezen.html#a2bdcecfe7435ef11cedbce47d4e72ee1">zen::readStruc</a> </td> + <td>(</td> + <td class="paramtype">const XmlElement & </td> + <td class="paramname"><em>input</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">T & </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Convert XML element to structured user data. </p> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">input</td><td>The input XML element. </td></tr> + <tr><td class="paramname">value</td><td>Conversion target value. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns:</dt><dd>"true" if value was read successfully. </dd></dl> + +</div> +</div> +<a class="anchor" id="acaf85ab94b61882f957afcd355386bff"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="namespacezen.html#acaf85ab94b61882f957afcd355386bff">zen::readText</a> </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>input</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">T & </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Convert text to user data - used by XML elements and attributes. </p> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">input</td><td>Input text. </td></tr> + <tr><td class="paramname">value</td><td>Conversion target value. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns:</dt><dd>"true" if value was read successfully. </dd></dl> + +</div> +</div> +<a class="anchor" id="adeeb6b2318097382ae47aa939fc15d4d"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class String > </div> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="namespacezen.html#adeeb6b2318097382ae47aa939fc15d4d">zen::save</a> </td> + <td>(</td> + <td class="paramtype">const XmlDoc & </td> + <td class="paramname"><em>doc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const String & </td> + <td class="paramname"><em>filename</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>lineBreak</em> = <code>"\r\n"</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>indent</em> = <code>"    "</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Save XML document to a file. </p> +<p>Convenience function that does nothing more than calling <a class="el" href="namespacezen.html#afaa4920e275078e6c8009fbdf58b57ee" title="Save XML document as a byte stream.">serialize()</a> and <a class="el" href="namespacezen.html#a4ba7bbaa14a787b07fc13da9145aabe2" title="Save byte stream to a file.">saveStream()</a>.</p> +<dl class=""><dt><b>Template Parameters:</b></dt><dd> + <table class=""> + <tr><td class="paramname">String</td><td>Arbitrary string-like type: e.g. std::string, wchar_t*, char[], wchar_t, wxString, MyStringClass, ... </td></tr> + </table> + </dd> +</dl> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">doc</td><td>The XML document to save </td></tr> + <tr><td class="paramname">filename</td><td>Output file name </td></tr> + <tr><td class="paramname">lineBreak</td><td>Line break, default: carriage return + new line </td></tr> + <tr><td class="paramname">indent</td><td>Indentation, default: four space characters </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt><b>Exceptions:</b></dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="structzen_1_1_xml_file_error.html" title="Exception thrown due to failed file I/O.">XmlFileError</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a4ba7bbaa14a787b07fc13da9145aabe2"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class String > </div> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="namespacezen.html#a4ba7bbaa14a787b07fc13da9145aabe2">zen::saveStream</a> </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const String & </td> + <td class="paramname"><em>filename</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Save byte stream to a file. </p> +<dl class=""><dt><b>Template Parameters:</b></dt><dd> + <table class=""> + <tr><td class="paramname">String</td><td>Arbitrary string-like type: e.g. std::string, wchar_t*, char[], wchar_t, wxString, MyStringClass, ... </td></tr> + </table> + </dd> +</dl> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">stream</td><td>Input byte stream </td></tr> + <tr><td class="paramname">filename</td><td>Output file name </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt><b>Exceptions:</b></dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="structzen_1_1_xml_file_error.html" title="Exception thrown due to failed file I/O.">XmlFileError</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="afaa4920e275078e6c8009fbdf58b57ee"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string <a class="el" href="namespacezen.html#afaa4920e275078e6c8009fbdf58b57ee">zen::serialize</a> </td> + <td>(</td> + <td class="paramtype">const XmlDoc & </td> + <td class="paramname"><em>doc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>lineBreak</em> = <code>"\r\n"</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>indent</em> = <code>"    "</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Save XML document as a byte stream. </p> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">doc</td><td>Input XML document </td></tr> + <tr><td class="paramname">lineBreak</td><td>Line break, default: carriage return + new line </td></tr> + <tr><td class="paramname">indent</td><td>Indentation, default: four space characters </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns:</dt><dd>Output byte stream </dd></dl> + +</div> +</div> +<a class="anchor" id="a29ddb823fe0a195f19a64448881b8bf6"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="namespacezen.html#a29ddb823fe0a195f19a64448881b8bf6">zen::writeStruc</a> </td> + <td>(</td> + <td class="paramtype">const T & </td> + <td class="paramname"><em>value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">XmlElement & </td> + <td class="paramname"><em>output</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Convert structured user data into an XML element. </p> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">value</td><td>The value to be converted. </td></tr> + <tr><td class="paramname">output</td><td>The output XML element. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a2ce2998296871fc2f4718ceceb22a23f"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="namespacezen.html#a2ce2998296871fc2f4718ceceb22a23f">zen::writeText</a> </td> + <td>(</td> + <td class="paramtype">const T & </td> + <td class="paramname"><em>value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::string & </td> + <td class="paramname"><em>output</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Convert user data into text - used by XML elements and attributes. </p> +<dl class="params"><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramname">value</td><td>The value to be converted. </td></tr> + <tr><td class="paramname">output</td><td>Output text. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +</div><!-- contents --> + + +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.0 +</small></address> + +</body> +</html> |