/usr/share/doc/mia-2.0/libdoc/classCProgressCallback.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 | <!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>CProgressCallback 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">CProgressCallback Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__misc.html">Uncategorized</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>a class to provide a feedback mechanism to show progress
<a href="classCProgressCallback.html#details">More...</a></p>
<p><code>#include <<a class="el" href="callback_8hh_source.html">mia/core/callback.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for CProgressCallback:</div>
<div class="dyncontent">
<div class="center">
<img src="classCProgressCallback.png" usemap="#CProgressCallback_map" alt=""/>
<map id="CProgressCallback_map" name="CProgressCallback_map">
<area href="classCMsgStreamPrintCallback.html" title="a class to provide a feedback mechanism to show progress based on textual output " alt="CMsgStreamPrintCallback" shape="rect" coords="0,56,159,80"/>
</map>
</div></div>
<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:a03a2202063c46490363402e5330de41c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCProgressCallback.html#a03a2202063c46490363402e5330de41c">pulse</a> ()</td></tr>
<tr class="separator:a03a2202063c46490363402e5330de41c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f9f64665a5ba73fc2def28a43ca95d6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCProgressCallback.html#a5f9f64665a5ba73fc2def28a43ca95d6">set_range</a> (int range)</td></tr>
<tr class="separator:a5f9f64665a5ba73fc2def28a43ca95d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a786728e3a03111f7bd5e56ab8b994299"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCProgressCallback.html#a786728e3a03111f7bd5e56ab8b994299">update</a> (int step)</td></tr>
<tr class="separator:a786728e3a03111f7bd5e56ab8b994299"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0806da3a31dd67c600ccf43d3486d4f"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCProgressCallback.html#ae0806da3a31dd67c600ccf43d3486d4f">~CProgressCallback</a> ()</td></tr>
<tr class="separator:ae0806da3a31dd67c600ccf43d3486d4f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>a class to provide a feedback mechanism to show progress </p>
<p>This class is used as a base class in order to show feedback about the progress of certain operations that may take a long time. The indicator supports two modes of operation: If the number if steps is known beforehand, the indicator will act like a classical progress bar, and If the number of stels is unknown, some kind of change indicator is applied to show that "something happens". </p>
<p>Definition at line <a class="el" href="callback_8hh_source.html#l00041">41</a> of file <a class="el" href="callback_8hh_source.html">callback.hh</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae0806da3a31dd67c600ccf43d3486d4f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual CProgressCallback::~CProgressCallback </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a03a2202063c46490363402e5330de41c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CProgressCallback::pulse </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the progress indicator in some way to show that something is happening but without giving real target informations. </p>
</div>
</div>
<a class="anchor" id="a5f9f64665a5ba73fc2def28a43ca95d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CProgressCallback::set_range </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>range</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the maximum number of the possible steps some operatoion may take </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">range</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a786728e3a03111f7bd5e56ab8b994299"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CProgressCallback::update </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>step</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the progress indicator by using the given value - it should be less or equal to the value given in <a class="el" href="classCProgressCallback.html#a5f9f64665a5ba73fc2def28a43ca95d6">set_range()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">step</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="callback_8hh_source.html">callback.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>
|