<!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>NisusWrtTextInternal::Footnote Struct 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('structNisusWrtTextInternal_1_1Footnote.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="#friends">Friends</a> | <a href="structNisusWrtTextInternal_1_1Footnote-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">NisusWrtTextInternal::Footnote Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Internal structure: use to store a footnote. <a href="structNisusWrtTextInternal_1_1Footnote.html#details">More...</a></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:a472603f880158d1c9fbce74a98655d70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#a472603f880158d1c9fbce74a98655d70">Footnote</a> ()</td></tr> <tr class="memdesc:a472603f880158d1c9fbce74a98655d70"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a472603f880158d1c9fbce74a98655d70">More...</a><br /></td></tr> <tr class="separator:a472603f880158d1c9fbce74a98655d70"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a844511afaf2648cea4d44b9e13670f8f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#a844511afaf2648cea4d44b9e13670f8f">getTextLabel</a> (int actId) const</td></tr> <tr class="memdesc:a844511afaf2648cea4d44b9e13670f8f"><td class="mdescLeft"> </td><td class="mdescRight">returns a label corresponding to a note ( or nothing if we can use numbering note) <a href="#a844511afaf2648cea4d44b9e13670f8f">More...</a><br /></td></tr> <tr class="separator:a844511afaf2648cea4d44b9e13670f8f"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:aaa89dd893432443ffbd49169836d1ecf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#aaa89dd893432443ffbd49169836d1ecf">m_number</a></td></tr> <tr class="memdesc:aaa89dd893432443ffbd49169836d1ecf"><td class="mdescLeft"> </td><td class="mdescRight">the note number <a href="#aaa89dd893432443ffbd49169836d1ecf">More...</a><br /></td></tr> <tr class="separator:aaa89dd893432443ffbd49169836d1ecf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e1900c53a432c02e75ff3a8082026aa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#a5e1900c53a432c02e75ff3a8082026aa">m_paragraph</a> [2]</td></tr> <tr class="memdesc:a5e1900c53a432c02e75ff3a8082026aa"><td class="mdescLeft"> </td><td class="mdescRight">the paragraph position in the footnote zone (first and last) <a href="#a5e1900c53a432c02e75ff3a8082026aa">More...</a><br /></td></tr> <tr class="separator:a5e1900c53a432c02e75ff3a8082026aa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaca44282841b180b7a0387d2c1de95ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structNisusWrtStruct_1_1Position.html">NisusWrtStruct::Position</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#aaca44282841b180b7a0387d2c1de95ba">m_textPosition</a></td></tr> <tr class="memdesc:aaca44282841b180b7a0387d2c1de95ba"><td class="mdescLeft"> </td><td class="mdescRight">the text position <a href="#aaca44282841b180b7a0387d2c1de95ba">More...</a><br /></td></tr> <tr class="separator:aaca44282841b180b7a0387d2c1de95ba"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa010522b96b34236ad73d684a9fbd309"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#aa010522b96b34236ad73d684a9fbd309">m_textLabel</a></td></tr> <tr class="memdesc:aa010522b96b34236ad73d684a9fbd309"><td class="mdescLeft"> </td><td class="mdescRight">the label in the text <a href="#aa010522b96b34236ad73d684a9fbd309">More...</a><br /></td></tr> <tr class="separator:aa010522b96b34236ad73d684a9fbd309"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abc1a9d4721cdc9ca5a26bb394e0d24e7"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#abc1a9d4721cdc9ca5a26bb394e0d24e7">m_noteLabel</a></td></tr> <tr class="memdesc:abc1a9d4721cdc9ca5a26bb394e0d24e7"><td class="mdescLeft"> </td><td class="mdescRight">the label in the note <a href="#abc1a9d4721cdc9ca5a26bb394e0d24e7">More...</a><br /></td></tr> <tr class="separator:abc1a9d4721cdc9ca5a26bb394e0d24e7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a29541ace96c137ec6ea2db484c54d050"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#a29541ace96c137ec6ea2db484c54d050">m_parsed</a></td></tr> <tr class="memdesc:a29541ace96c137ec6ea2db484c54d050"><td class="mdescLeft"> </td><td class="mdescRight">a flag to know if the footnote is parsed <a href="#a29541ace96c137ec6ea2db484c54d050">More...</a><br /></td></tr> <tr class="separator:a29541ace96c137ec6ea2db484c54d050"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad01f75d15bf355719e5e1bb65e9378b3"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#ad01f75d15bf355719e5e1bb65e9378b3">m_extra</a></td></tr> <tr class="memdesc:ad01f75d15bf355719e5e1bb65e9378b3"><td class="mdescLeft"> </td><td class="mdescRight">some extra debuging information <a href="#ad01f75d15bf355719e5e1bb65e9378b3">More...</a><br /></td></tr> <tr class="separator:ad01f75d15bf355719e5e1bb65e9378b3"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:a1a9c6be72ab6f44e226ab9c0405d4204"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html#a1a9c6be72ab6f44e226ab9c0405d4204">operator<<</a> (std::ostream &o, <a class="el" href="structNisusWrtTextInternal_1_1Footnote.html">Footnote</a> const &ft)</td></tr> <tr class="memdesc:a1a9c6be72ab6f44e226ab9c0405d4204"><td class="mdescLeft"> </td><td class="mdescRight">operator<< <a href="#a1a9c6be72ab6f44e226ab9c0405d4204">More...</a><br /></td></tr> <tr class="separator:a1a9c6be72ab6f44e226ab9c0405d4204"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Internal structure: use to store a footnote. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a472603f880158d1c9fbce74a98655d70"></a> <h2 class="memtitle"><span class="permalink"><a href="#a472603f880158d1c9fbce74a98655d70">◆ </a></span>Footnote()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">NisusWrtTextInternal::Footnote::Footnote </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructor. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a844511afaf2648cea4d44b9e13670f8f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a844511afaf2648cea4d44b9e13670f8f">◆ </a></span>getTextLabel()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::string NisusWrtTextInternal::Footnote::getTextLabel </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>actId</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>returns a label corresponding to a note ( or nothing if we can use numbering note) </p> </div> </div> <h2 class="groupheader">Friends And Related Function Documentation</h2> <a id="a1a9c6be72ab6f44e226ab9c0405d4204"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1a9c6be72ab6f44e226ab9c0405d4204">◆ </a></span>operator<<</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::ostream& operator<< </td> <td>(</td> <td class="paramtype">std::ostream & </td> <td class="paramname"><em>o</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structNisusWrtTextInternal_1_1Footnote.html">Footnote</a> const & </td> <td class="paramname"><em>ft</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">friend</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>operator<< </p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a id="ad01f75d15bf355719e5e1bb65e9378b3"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad01f75d15bf355719e5e1bb65e9378b3">◆ </a></span>m_extra</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string NisusWrtTextInternal::Footnote::m_extra</td> </tr> </table> </div><div class="memdoc"> <p>some extra debuging information </p> <p class="reference">Referenced by <a class="el" href="namespaceNisusWrtTextInternal.html#ad8ebc6fb940c37c6fbe01891448fe086">NisusWrtTextInternal::operator<<()</a>, and <a class="el" href="classNisusWrtText.html#a5a0abb68c76220c1c3d1eb6f06b8fc80">NisusWrtText::readFootnotes()</a>.</p> </div> </div> <a id="abc1a9d4721cdc9ca5a26bb394e0d24e7"></a> <h2 class="memtitle"><span class="permalink"><a href="#abc1a9d4721cdc9ca5a26bb394e0d24e7">◆ </a></span>m_noteLabel</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string NisusWrtTextInternal::Footnote::m_noteLabel</td> </tr> </table> </div><div class="memdoc"> <p>the label in the note </p> <p class="reference">Referenced by <a class="el" href="namespaceNisusWrtTextInternal.html#ad8ebc6fb940c37c6fbe01891448fe086">NisusWrtTextInternal::operator<<()</a>, and <a class="el" href="classNisusWrtText.html#a5a0abb68c76220c1c3d1eb6f06b8fc80">NisusWrtText::readFootnotes()</a>.</p> </div> </div> <a id="aaa89dd893432443ffbd49169836d1ecf"></a> <h2 class="memtitle"><span class="permalink"><a href="#aaa89dd893432443ffbd49169836d1ecf">◆ </a></span>m_number</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NisusWrtTextInternal::Footnote::m_number</td> </tr> </table> </div><div class="memdoc"> <p>the note number </p> <p class="reference">Referenced by <a class="el" href="namespaceNisusWrtTextInternal.html#ad8ebc6fb940c37c6fbe01891448fe086">NisusWrtTextInternal::operator<<()</a>, and <a class="el" href="classNisusWrtText.html#a5a0abb68c76220c1c3d1eb6f06b8fc80">NisusWrtText::readFootnotes()</a>.</p> </div> </div> <a id="a5e1900c53a432c02e75ff3a8082026aa"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5e1900c53a432c02e75ff3a8082026aa">◆ </a></span>m_paragraph</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int NisusWrtTextInternal::Footnote::m_paragraph[2]</td> </tr> </table> </div><div class="memdoc"> <p>the paragraph position in the footnote zone (first and last) </p> <p class="reference">Referenced by <a class="el" href="namespaceNisusWrtTextInternal.html#ad8ebc6fb940c37c6fbe01891448fe086">NisusWrtTextInternal::operator<<()</a>, and <a class="el" href="classNisusWrtText.html#a5a0abb68c76220c1c3d1eb6f06b8fc80">NisusWrtText::readFootnotes()</a>.</p> </div> </div> <a id="a29541ace96c137ec6ea2db484c54d050"></a> <h2 class="memtitle"><span class="permalink"><a href="#a29541ace96c137ec6ea2db484c54d050">◆ </a></span>m_parsed</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool NisusWrtTextInternal::Footnote::m_parsed</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">mutable</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>a flag to know if the footnote is parsed </p> </div> </div> <a id="aa010522b96b34236ad73d684a9fbd309"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa010522b96b34236ad73d684a9fbd309">◆ </a></span>m_textLabel</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string NisusWrtTextInternal::Footnote::m_textLabel</td> </tr> </table> </div><div class="memdoc"> <p>the label in the text </p> <p class="reference">Referenced by <a class="el" href="namespaceNisusWrtTextInternal.html#ad8ebc6fb940c37c6fbe01891448fe086">NisusWrtTextInternal::operator<<()</a>, and <a class="el" href="classNisusWrtText.html#a5a0abb68c76220c1c3d1eb6f06b8fc80">NisusWrtText::readFootnotes()</a>.</p> </div> </div> <a id="aaca44282841b180b7a0387d2c1de95ba"></a> <h2 class="memtitle"><span class="permalink"><a href="#aaca44282841b180b7a0387d2c1de95ba">◆ </a></span>m_textPosition</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structNisusWrtStruct_1_1Position.html">NisusWrtStruct::Position</a> NisusWrtTextInternal::Footnote::m_textPosition</td> </tr> </table> </div><div class="memdoc"> <p>the text position </p> <p class="reference">Referenced by <a class="el" href="namespaceNisusWrtTextInternal.html#ad8ebc6fb940c37c6fbe01891448fe086">NisusWrtTextInternal::operator<<()</a>, and <a class="el" href="classNisusWrtText.html#a5a0abb68c76220c1c3d1eb6f06b8fc80">NisusWrtText::readFootnotes()</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="NisusWrtText_8cxx.html">NisusWrtText.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:49 for libmwaw by <a href="http://www.doxygen.org/index.html"> doxygen</a> 1.8.13</small></address> </body> </html>