/usr/share/doc/mia-2.0/libdoc/classCFixedWidthOutput.html is in libmia-2.0-doc 2.0.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | <!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"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>CFixedWidthOutput Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CFixedWidthOutput Class Reference<div class="ingroups"><a class="el" href="group__logging.html">Logging and debugguing</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>This class provides formatted writing to a text console.
<a href="classCFixedWidthOutput.html#details">More...</a></p>
<p><code>#include <<a class="el" href="fixedwidthoutput_8hh_source.html">mia/core/fixedwidthoutput.hh</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:ab38e4d1b094c616928f7db439eb7151a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFixedWidthOutput.html#ab38e4d1b094c616928f7db439eb7151a">CFixedWidthOutput</a> (std::ostream &os, size_t width)</td></tr>
<tr class="separator:ab38e4d1b094c616928f7db439eb7151a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72a4ab88863097001f19016deb2a815d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFixedWidthOutput.html#a72a4ab88863097001f19016deb2a815d">newline</a> ()</td></tr>
<tr class="separator:a72a4ab88863097001f19016deb2a815d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae97221f5f4aa389e11203b58750e1fc2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFixedWidthOutput.html#ae97221f5f4aa389e11203b58750e1fc2">pop_offset</a> ()</td></tr>
<tr class="separator:ae97221f5f4aa389e11203b58750e1fc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ade64966f2c14a8c18141346e4c54c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFixedWidthOutput.html#a3ade64966f2c14a8c18141346e4c54c3">push_offset</a> (size_t offset)</td></tr>
<tr class="separator:a3ade64966f2c14a8c18141346e4c54c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac88e2d8f89c066a2a33d1948485a02de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFixedWidthOutput.html#ac88e2d8f89c066a2a33d1948485a02de">reset_offset</a> ()</td></tr>
<tr class="separator:ac88e2d8f89c066a2a33d1948485a02de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4539197854aa63ccd671905dc97e72b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFixedWidthOutput.html#a4539197854aa63ccd671905dc97e72b8">set_linecontinue</a> (bool value)</td></tr>
<tr class="separator:a4539197854aa63ccd671905dc97e72b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f6052d0ba7f310df08a98d5be9deab6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCFixedWidthOutput.html#a5f6052d0ba7f310df08a98d5be9deab6">write</a> (const std::string &text)</td></tr>
<tr class="separator:a5f6052d0ba7f310df08a98d5be9deab6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class provides formatted writing to a text console. </p>
<p>This class is used to write output to a ostream and the text is formatted to not exeed the given width (e.g. the width of the text console stdout. The class is used to write out the formated help of <a class="el" href="classCCmdOptionList.html" title="The class to hold the list of options. ">CCmdOptionList</a>. </p>
<p>Definition at line <a class="el" href="fixedwidthoutput_8hh_source.html#l00039">39</a> of file <a class="el" href="fixedwidthoutput_8hh_source.html">fixedwidthoutput.hh</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab38e4d1b094c616928f7db439eb7151a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CFixedWidthOutput::CFixedWidthOutput </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>width</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the class </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>the output stream to write to </td></tr>
<tr><td class="paramname">width</td><td>the maximal width of an output line </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a72a4ab88863097001f19016deb2a815d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFixedWidthOutput::newline </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Force a line break. </p>
</div>
</div>
<a class="anchor" id="ae97221f5f4aa389e11203b58750e1fc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFixedWidthOutput::pop_offset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>restore the last offset </p>
</div>
</div>
<a class="anchor" id="a3ade64966f2c14a8c18141346e4c54c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFixedWidthOutput::push_offset </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a new offset from the left margin, the original offset is stored in a stack, </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac88e2d8f89c066a2a33d1948485a02de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFixedWidthOutput::reset_offset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the offset to zero and clear the offset stack. </p>
</div>
</div>
<a class="anchor" id="a4539197854aa63ccd671905dc97e72b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFixedWidthOutput::set_linecontinue </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to true if <a class="el" href="classCFixedWidthOutput.html#a72a4ab88863097001f19016deb2a815d">newline()</a> should insert '\' to indicate a continuing line (e.g. for writing code examples that don't fit on one line) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5f6052d0ba7f310df08a98d5be9deab6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFixedWidthOutput::write </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write the text to the output. New line '\n' and tabulators '\t' are honoured. At a new-line the line start positionis set to the actual offset. If a word doesn't fit the current line, a line break is inserted automatically. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fixedwidthoutput_8hh_source.html">fixedwidthoutput.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:09 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|