<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>MWAWPropertyHandlerEncoder Class Reference documentation</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search'); }); </script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('classMWAWPropertyHandlerEncoder.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | <a href="classMWAWPropertyHandlerEncoder-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">MWAWPropertyHandlerEncoder Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>write in librevenge::RVNGBinaryData a list of tags/and properties <a href="classMWAWPropertyHandlerEncoder.html#details">More...</a></p> <p><code>#include <<a class="el" href="MWAWPropertyHandler_8hxx_source.html">MWAWPropertyHandler.hxx</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a2eaad1207eb08db40ef2c0ab6b595e27"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#a2eaad1207eb08db40ef2c0ab6b595e27">MWAWPropertyHandlerEncoder</a> ()</td></tr> <tr class="memdesc:a2eaad1207eb08db40ef2c0ab6b595e27"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#a2eaad1207eb08db40ef2c0ab6b595e27">More...</a><br /></td></tr> <tr class="separator:a2eaad1207eb08db40ef2c0ab6b595e27"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a719cb5382587e2f5170ba324743b7555"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#a719cb5382587e2f5170ba324743b7555">insertElement</a> (const char *psName)</td></tr> <tr class="memdesc:a719cb5382587e2f5170ba324743b7555"><td class="mdescLeft"> </td><td class="mdescRight">inserts an element <a href="#a719cb5382587e2f5170ba324743b7555">More...</a><br /></td></tr> <tr class="separator:a719cb5382587e2f5170ba324743b7555"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ada5affec8e217d226f9c2498e2906ef9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#ada5affec8e217d226f9c2498e2906ef9">insertElement</a> (const char *psName, const librevenge::RVNGPropertyList &xPropList)</td></tr> <tr class="memdesc:ada5affec8e217d226f9c2498e2906ef9"><td class="mdescLeft"> </td><td class="mdescRight">inserts an element given a property list <a href="#ada5affec8e217d226f9c2498e2906ef9">More...</a><br /></td></tr> <tr class="separator:ada5affec8e217d226f9c2498e2906ef9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a81b7fb8ecabf236601b474a606e59dcd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#a81b7fb8ecabf236601b474a606e59dcd">characters</a> (librevenge::RVNGString const &sCharacters)</td></tr> <tr class="memdesc:a81b7fb8ecabf236601b474a606e59dcd"><td class="mdescLeft"> </td><td class="mdescRight">writes a list of characters <a href="#a81b7fb8ecabf236601b474a606e59dcd">More...</a><br /></td></tr> <tr class="separator:a81b7fb8ecabf236601b474a606e59dcd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad610d2b5f6fb4f90ad41f2e7bfcaa7ef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#ad610d2b5f6fb4f90ad41f2e7bfcaa7ef">getData</a> (librevenge::RVNGBinaryData &data)</td></tr> <tr class="memdesc:ad610d2b5f6fb4f90ad41f2e7bfcaa7ef"><td class="mdescLeft"> </td><td class="mdescRight">retrieves the data <a href="#ad610d2b5f6fb4f90ad41f2e7bfcaa7ef">More...</a><br /></td></tr> <tr class="separator:ad610d2b5f6fb4f90ad41f2e7bfcaa7ef"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a1f54cfcb09b1d7d8fe31dc448d6e3d70"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#a1f54cfcb09b1d7d8fe31dc448d6e3d70">writeLong</a> (long val)</td></tr> <tr class="memdesc:a1f54cfcb09b1d7d8fe31dc448d6e3d70"><td class="mdescLeft"> </td><td class="mdescRight">adds a long value if f <a href="#a1f54cfcb09b1d7d8fe31dc448d6e3d70">More...</a><br /></td></tr> <tr class="separator:a1f54cfcb09b1d7d8fe31dc448d6e3d70"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1281251ef70fbd107683120d9f287113"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#a1281251ef70fbd107683120d9f287113">writeString</a> (const librevenge::RVNGString &name)</td></tr> <tr class="memdesc:a1281251ef70fbd107683120d9f287113"><td class="mdescLeft"> </td><td class="mdescRight">adds a string: size and string <a href="#a1281251ef70fbd107683120d9f287113">More...</a><br /></td></tr> <tr class="separator:a1281251ef70fbd107683120d9f287113"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af7ea1fe7d26a964c98e4a501586cf3fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#af7ea1fe7d26a964c98e4a501586cf3fe">writeProperty</a> (const char *key, const librevenge::RVNGProperty &prop)</td></tr> <tr class="memdesc:af7ea1fe7d26a964c98e4a501586cf3fe"><td class="mdescLeft"> </td><td class="mdescRight">adds a property: a string key, a string corresponding to value <a href="#af7ea1fe7d26a964c98e4a501586cf3fe">More...</a><br /></td></tr> <tr class="separator:af7ea1fe7d26a964c98e4a501586cf3fe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5f9e84f485e475867859819378ed3113"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#a5f9e84f485e475867859819378ed3113">writePropertyList</a> (const librevenge::RVNGPropertyList &prop)</td></tr> <tr class="memdesc:a5f9e84f485e475867859819378ed3113"><td class="mdescLeft"> </td><td class="mdescRight">adds a property list: int #prop followed by the different properties <a href="#a5f9e84f485e475867859819378ed3113">More...</a><br /></td></tr> <tr class="separator:a5f9e84f485e475867859819378ed3113"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a79b933c5200aae4d7cef5b465f4a2b6b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#a79b933c5200aae4d7cef5b465f4a2b6b">writePropertyListVector</a> (const librevenge::RVNGPropertyListVector &vect)</td></tr> <tr class="memdesc:a79b933c5200aae4d7cef5b465f4a2b6b"><td class="mdescLeft"> </td><td class="mdescRight">adds a property vector: a int: #vect followed by vect[0], vect[1], ... <a href="#a79b933c5200aae4d7cef5b465f4a2b6b">More...</a><br /></td></tr> <tr class="separator:a79b933c5200aae4d7cef5b465f4a2b6b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:a6ef4ebeecbc44c965ee76a073d5df853"><td class="memItemLeft" align="right" valign="top">std::stringstream </td><td class="memItemRight" valign="bottom"><a class="el" href="classMWAWPropertyHandlerEncoder.html#a6ef4ebeecbc44c965ee76a073d5df853">m_f</a></td></tr> <tr class="memdesc:a6ef4ebeecbc44c965ee76a073d5df853"><td class="mdescLeft"> </td><td class="mdescRight">the streamfile <a href="#a6ef4ebeecbc44c965ee76a073d5df853">More...</a><br /></td></tr> <tr class="separator:a6ef4ebeecbc44c965ee76a073d5df853"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>write in librevenge::RVNGBinaryData a list of tags/and properties </p> <p>In order to be read by writerperfect, we must code document consisting in tag and propertyList in an intermediar format:</p><ul> <li>[string:s]: an int length(s) follow by the length(s) characters of string s</li> <li>[property:p]: a string value p.getStr() ( for a basic property )</li> <li>[propertyList:pList]: a int: #pList followed by -+ 'p',pList[i].key(),pList[i] for a basic child -+ 'v',pList[i].key(),*(pList.child(pList[i].key())) for a vector child</li> <li>[propertyListVector:v]: a int: #v followed by v[0], v[1], ...</li> <li>[binaryData:d]: a int32 d.size() followed by the data content</li> <li>[insertElement:name]: char 'E', [string] name</li> <li>[insertElement:name proplist:prop]: char 'S', [string] name, prop</li> <li>[characters:s ]: char 'T', [string] s<ul> <li>if len(s)==0, we write nothing</li> <li>the string is written as is (ie. we do not escaped any characters). </li> </ul> </li> </ul> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a2eaad1207eb08db40ef2c0ab6b595e27"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2eaad1207eb08db40ef2c0ab6b595e27">◆ </a></span>MWAWPropertyHandlerEncoder()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">MWAWPropertyHandlerEncoder::MWAWPropertyHandlerEncoder </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>constructor </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a81b7fb8ecabf236601b474a606e59dcd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a81b7fb8ecabf236601b474a606e59dcd">◆ </a></span>characters()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void MWAWPropertyHandlerEncoder::characters </td> <td>(</td> <td class="paramtype">librevenge::RVNGString const & </td> <td class="paramname"><em>sCharacters</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>writes a list of characters </p> </div> </div> <a id="ad610d2b5f6fb4f90ad41f2e7bfcaa7ef"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad610d2b5f6fb4f90ad41f2e7bfcaa7ef">◆ </a></span>getData()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool MWAWPropertyHandlerEncoder::getData </td> <td>(</td> <td class="paramtype">librevenge::RVNGBinaryData & </td> <td class="paramname"><em>data</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>retrieves the data </p> </div> </div> <a id="a719cb5382587e2f5170ba324743b7555"></a> <h2 class="memtitle"><span class="permalink"><a href="#a719cb5382587e2f5170ba324743b7555">◆ </a></span>insertElement() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void MWAWPropertyHandlerEncoder::insertElement </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>psName</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>inserts an element </p> </div> </div> <a id="ada5affec8e217d226f9c2498e2906ef9"></a> <h2 class="memtitle"><span class="permalink"><a href="#ada5affec8e217d226f9c2498e2906ef9">◆ </a></span>insertElement() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void MWAWPropertyHandlerEncoder::insertElement </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>psName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const librevenge::RVNGPropertyList & </td> <td class="paramname"><em>xPropList</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>inserts an element given a property list </p> </div> </div> <a id="a1f54cfcb09b1d7d8fe31dc448d6e3d70"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1f54cfcb09b1d7d8fe31dc448d6e3d70">◆ </a></span>writeLong()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void MWAWPropertyHandlerEncoder::writeLong </td> <td>(</td> <td class="paramtype">long </td> <td class="paramname"><em>val</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>adds a long value if f </p> <p class="reference">Referenced by <a class="el" href="classMWAWPropertyHandlerEncoder.html#a5f9e84f485e475867859819378ed3113">writePropertyList()</a>, <a class="el" href="classMWAWPropertyHandlerEncoder.html#a79b933c5200aae4d7cef5b465f4a2b6b">writePropertyListVector()</a>, and <a class="el" href="classMWAWPropertyHandlerEncoder.html#a1281251ef70fbd107683120d9f287113">writeString()</a>.</p> </div> </div> <a id="af7ea1fe7d26a964c98e4a501586cf3fe"></a> <h2 class="memtitle"><span class="permalink"><a href="#af7ea1fe7d26a964c98e4a501586cf3fe">◆ </a></span>writeProperty()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void MWAWPropertyHandlerEncoder::writeProperty </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>key</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const librevenge::RVNGProperty & </td> <td class="paramname"><em>prop</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>adds a property: a string key, a string corresponding to value </p> <p class="reference">Referenced by <a class="el" href="classMWAWPropertyHandlerEncoder.html#a5f9e84f485e475867859819378ed3113">writePropertyList()</a>.</p> </div> </div> <a id="a5f9e84f485e475867859819378ed3113"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5f9e84f485e475867859819378ed3113">◆ </a></span>writePropertyList()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void MWAWPropertyHandlerEncoder::writePropertyList </td> <td>(</td> <td class="paramtype">const librevenge::RVNGPropertyList & </td> <td class="paramname"><em>prop</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>adds a property list: int #prop followed by the different properties </p> <p class="reference">Referenced by <a class="el" href="classMWAWPropertyHandlerEncoder.html#ada5affec8e217d226f9c2498e2906ef9">insertElement()</a>, and <a class="el" href="classMWAWPropertyHandlerEncoder.html#a79b933c5200aae4d7cef5b465f4a2b6b">writePropertyListVector()</a>.</p> </div> </div> <a id="a79b933c5200aae4d7cef5b465f4a2b6b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a79b933c5200aae4d7cef5b465f4a2b6b">◆ </a></span>writePropertyListVector()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void MWAWPropertyHandlerEncoder::writePropertyListVector </td> <td>(</td> <td class="paramtype">const librevenge::RVNGPropertyListVector & </td> <td class="paramname"><em>vect</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>adds a property vector: a int: #vect followed by vect[0], vect[1], ... </p> <p class="reference">Referenced by <a class="el" href="classMWAWPropertyHandlerEncoder.html#a5f9e84f485e475867859819378ed3113">writePropertyList()</a>.</p> </div> </div> <a id="a1281251ef70fbd107683120d9f287113"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1281251ef70fbd107683120d9f287113">◆ </a></span>writeString()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void MWAWPropertyHandlerEncoder::writeString </td> <td>(</td> <td class="paramtype">const librevenge::RVNGString & </td> <td class="paramname"><em>name</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>adds a string: size and string </p> <p class="reference">Referenced by <a class="el" href="classMWAWPropertyHandlerEncoder.html#a81b7fb8ecabf236601b474a606e59dcd">characters()</a>, <a class="el" href="classMWAWPropertyHandlerEncoder.html#a719cb5382587e2f5170ba324743b7555">insertElement()</a>, <a class="el" href="classMWAWPropertyHandlerEncoder.html#af7ea1fe7d26a964c98e4a501586cf3fe">writeProperty()</a>, and <a class="el" href="classMWAWPropertyHandlerEncoder.html#a5f9e84f485e475867859819378ed3113">writePropertyList()</a>.</p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a id="a6ef4ebeecbc44c965ee76a073d5df853"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6ef4ebeecbc44c965ee76a073d5df853">◆ </a></span>m_f</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::stringstream MWAWPropertyHandlerEncoder::m_f</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>the streamfile </p> <p class="reference">Referenced by <a class="el" href="classMWAWPropertyHandlerEncoder.html#a81b7fb8ecabf236601b474a606e59dcd">characters()</a>, <a class="el" href="classMWAWPropertyHandlerEncoder.html#ad610d2b5f6fb4f90ad41f2e7bfcaa7ef">getData()</a>, <a class="el" href="classMWAWPropertyHandlerEncoder.html#a719cb5382587e2f5170ba324743b7555">insertElement()</a>, <a class="el" href="classMWAWPropertyHandlerEncoder.html#a1f54cfcb09b1d7d8fe31dc448d6e3d70">writeLong()</a>, <a class="el" href="classMWAWPropertyHandlerEncoder.html#a5f9e84f485e475867859819378ed3113">writePropertyList()</a>, and <a class="el" href="classMWAWPropertyHandlerEncoder.html#a1281251ef70fbd107683120d9f287113">writeString()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="MWAWPropertyHandler_8hxx_source.html">MWAWPropertyHandler.hxx</a></li> <li><a class="el" href="MWAWPropertyHandler_8cxx.html">MWAWPropertyHandler.cxx</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <hr size="1"><address style="align: right;"><small> Generated on Mon Feb 11 2019 22:20:46 for libmwaw by <a href="http://www.doxygen.org/index.html"> doxygen</a> 1.8.13</small></address> </body> </html>