Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
stdex/classstdex_1_1global__progress.html

530 lines
27 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::global_progress&lt; T &gt; Class Template 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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1global__progress.html">global_progress</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classstdex_1_1global__progress-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::global_progress&lt; T &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Global progress indicator base class.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="progress_8hpp_source.html">stdex/progress.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stdex::global_progress&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classstdex_1_1global__progress.png" usemap="#stdex::global_5Fprogress_3C_20T_20_3E_map" alt=""/>
<map id="stdex::global_5Fprogress_3C_20T_20_3E_map" name="stdex::global_5Fprogress_3C_20T_20_3E_map">
<area href="classstdex_1_1progress.html" title="Progress indicator base class." alt="stdex::progress&lt; T &gt;" shape="rect" coords="0,0,182,24"/>
<area href="classstdex_1_1progress__switcher.html" title="Progress indicator switcher." alt="stdex::progress_switcher&lt; T &gt;" shape="rect" coords="0,112,182,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0ffa6fafa04588c0df06d077ae51d037" id="r_a0ffa6fafa04588c0df06d077ae51d037"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ffa6fafa04588c0df06d077ae51d037">global_progress</a> (<a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *host=NULL)</td></tr>
<tr class="memdesc:a0ffa6fafa04588c0df06d077ae51d037"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a progress indicator. <br /></td></tr>
<tr class="separator:a0ffa6fafa04588c0df06d077ae51d037"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec91532fde2500a5458a397f91c88769" id="r_aec91532fde2500a5458a397f91c88769"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aec91532fde2500a5458a397f91c88769">attach</a> (<a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *host)</td></tr>
<tr class="memdesc:aec91532fde2500a5458a397f91c88769"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attach to a host progress indicator. <br /></td></tr>
<tr class="separator:aec91532fde2500a5458a397f91c88769"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2c5391aa2f1f30e72a700768bc52f84" id="r_aa2c5391aa2f1f30e72a700768bc52f84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa2c5391aa2f1f30e72a700768bc52f84">detach</a> ()</td></tr>
<tr class="memdesc:aa2c5391aa2f1f30e72a700768bc52f84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detach host progress indicator. <br /></td></tr>
<tr class="separator:aa2c5391aa2f1f30e72a700768bc52f84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac68b491c62861fae1b16abb3477cb9c1" id="r_ac68b491c62861fae1b16abb3477cb9c1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac68b491c62861fae1b16abb3477cb9c1">set_global_range</a> (T start, T end)</td></tr>
<tr class="memdesc:ac68b491c62861fae1b16abb3477cb9c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set global extend of the progress indicator. <br /></td></tr>
<tr class="separator:ac68b491c62861fae1b16abb3477cb9c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a242009bce7ac595975bbfd703ec58c3b" id="r_a242009bce7ac595975bbfd703ec58c3b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a242009bce7ac595975bbfd703ec58c3b">set_section_range</a> (T start, T end)</td></tr>
<tr class="memdesc:a242009bce7ac595975bbfd703ec58c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set section extend of the progress indicator. <br /></td></tr>
<tr class="separator:a242009bce7ac595975bbfd703ec58c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89b7116003ab3b6344d90f130c14933e" id="r_a89b7116003ab3b6344d90f130c14933e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a89b7116003ab3b6344d90f130c14933e">set_text</a> (const char *msg)</td></tr>
<tr class="memdesc:a89b7116003ab3b6344d90f130c14933e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set progress indicator text. <br /></td></tr>
<tr class="separator:a89b7116003ab3b6344d90f130c14933e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb204b820637c19b494976af4a284704" id="r_afb204b820637c19b494976af4a284704"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb204b820637c19b494976af4a284704">set_range</a> (T start, T end)</td></tr>
<tr class="memdesc:afb204b820637c19b494976af4a284704"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set local extend of the progress indicator. <br /></td></tr>
<tr class="separator:afb204b820637c19b494976af4a284704"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76e66104444c77b89b687b4ad4945e8e" id="r_a76e66104444c77b89b687b4ad4945e8e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a76e66104444c77b89b687b4ad4945e8e">set</a> (T value)</td></tr>
<tr class="memdesc:a76e66104444c77b89b687b4ad4945e8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set local current progress. <br /></td></tr>
<tr class="separator:a76e66104444c77b89b687b4ad4945e8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32350e02d5904867402187e81a3c4a26" id="r_a32350e02d5904867402187e81a3c4a26"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a32350e02d5904867402187e81a3c4a26">show</a> (bool show=true)</td></tr>
<tr class="memdesc:a32350e02d5904867402187e81a3c4a26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Show or hide progress. <br /></td></tr>
<tr class="separator:a32350e02d5904867402187e81a3c4a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74a5ea9089ff7b7015ea4a2071f3113e" id="r_a74a5ea9089ff7b7015ea4a2071f3113e"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a74a5ea9089ff7b7015ea4a2071f3113e">cancel</a> ()</td></tr>
<tr class="memdesc:a74a5ea9089ff7b7015ea4a2071f3113e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query whether user requested abort. <br /></td></tr>
<tr class="separator:a74a5ea9089ff7b7015ea4a2071f3113e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a9332b719bebfb257865080cf58ebaf01" id="r_a9332b719bebfb257865080cf58ebaf01"><td class="memItemLeft" align="right" valign="top"><a id="a9332b719bebfb257865080cf58ebaf01" name="a9332b719bebfb257865080cf58ebaf01"></a>
<a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>m_host</b></td></tr>
<tr class="separator:a9332b719bebfb257865080cf58ebaf01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33fba14f43065383c39e44301912d990" id="r_a33fba14f43065383c39e44301912d990"><td class="memItemLeft" align="right" valign="top"><a id="a33fba14f43065383c39e44301912d990" name="a33fba14f43065383c39e44301912d990"></a>
<a class="el" href="structstdex_1_1interval.html">interval</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_local</b></td></tr>
<tr class="separator:a33fba14f43065383c39e44301912d990"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f5cb88fa6e7f1922c3497675bc4df4d" id="r_a5f5cb88fa6e7f1922c3497675bc4df4d"><td class="memItemLeft" align="right" valign="top"><a id="a5f5cb88fa6e7f1922c3497675bc4df4d" name="a5f5cb88fa6e7f1922c3497675bc4df4d"></a>
<a class="el" href="structstdex_1_1interval.html">interval</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_global</b></td></tr>
<tr class="separator:a5f5cb88fa6e7f1922c3497675bc4df4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc4f7acdf6ddfd0e15d5c5fde686b2ef" id="r_afc4f7acdf6ddfd0e15d5c5fde686b2ef"><td class="memItemLeft" align="right" valign="top"><a id="afc4f7acdf6ddfd0e15d5c5fde686b2ef" name="afc4f7acdf6ddfd0e15d5c5fde686b2ef"></a>
<a class="el" href="structstdex_1_1interval.html">interval</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_section</b></td></tr>
<tr class="separator:afc4f7acdf6ddfd0e15d5c5fde686b2ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T&gt;<br />
class stdex::global_progress&lt; T &gt;</div><p>Global progress indicator base class. </p>
<p>Use to report progress of a phase or section as a part of a whole progress. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0ffa6fafa04588c0df06d077ae51d037" name="a0ffa6fafa04588c0df06d077ae51d037"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ffa6fafa04588c0df06d077ae51d037">&#9670;&#160;</a></span>global_progress()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::global_progress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *</td> <td class="paramname"><span class="paramname"><em>host</em><span class="paramdefsep"> = </span><span class="paramdefval">NULL</span></span></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>Constructs a progress indicator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>Host progress indicator </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aec91532fde2500a5458a397f91c88769" name="aec91532fde2500a5458a397f91c88769"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec91532fde2500a5458a397f91c88769">&#9670;&#160;</a></span>attach()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *</td> <td class="paramname"><span class="paramname"><em>host</em></span></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>Attach to a host progress indicator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>Host progress indicator </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a74a5ea9089ff7b7015ea4a2071f3113e" name="a74a5ea9089ff7b7015ea4a2071f3113e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74a5ea9089ff7b7015ea4a2071f3113e">&#9670;&#160;</a></span>cancel()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::cancel </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Query whether user requested abort. </p>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#a03380c822297092b3bb9867deee26202">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<a id="aa2c5391aa2f1f30e72a700768bc52f84" name="aa2c5391aa2f1f30e72a700768bc52f84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2c5391aa2f1f30e72a700768bc52f84">&#9670;&#160;</a></span>detach()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; * <a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::detach </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></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>Detach host progress indicator. </p>
<dl class="section return"><dt>Returns</dt><dd>Old host progress indicator </dd></dl>
</div>
</div>
<a id="a76e66104444c77b89b687b4ad4945e8e" name="a76e66104444c77b89b687b4ad4945e8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76e66104444c77b89b687b4ad4945e8e">&#9670;&#160;</a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::set </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set local current progress. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Current value of the progress. Must be between start and end parameters provided in <a class="el" href="#afb204b820637c19b494976af4a284704" title="Set local extend of the progress indicator.">set_range()</a> call. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#acf3a29daf22709bf7e94e864c8be95a1">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<a id="ac68b491c62861fae1b16abb3477cb9c1" name="ac68b491c62861fae1b16abb3477cb9c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac68b491c62861fae1b16abb3477cb9c1">&#9670;&#160;</a></span>set_global_range()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::set_global_range </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>start</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>end</em></span>&#160;)</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>Set global extend of the progress indicator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Minimum value of the progress </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">end</td><td>Maximum value of the progress </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afb204b820637c19b494976af4a284704" name="afb204b820637c19b494976af4a284704"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb204b820637c19b494976af4a284704">&#9670;&#160;</a></span>set_range()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::set_range </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>start</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>end</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set local extend of the progress indicator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Minimum value of the progress </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">end</td><td>Maximum value of the progress </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#afbb1513bdb20340ebb21bd988f4e424a">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<a id="a242009bce7ac595975bbfd703ec58c3b" name="a242009bce7ac595975bbfd703ec58c3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a242009bce7ac595975bbfd703ec58c3b">&#9670;&#160;</a></span>set_section_range()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::set_section_range </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>start</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>end</em></span>&#160;)</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>Set section extend of the progress indicator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Minimum value of the progress </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">end</td><td>Maximum value of the progress </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a89b7116003ab3b6344d90f130c14933e" name="a89b7116003ab3b6344d90f130c14933e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89b7116003ab3b6344d90f130c14933e">&#9670;&#160;</a></span>set_text()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::set_text </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>msg</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set progress indicator text. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Text to display </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#a2cab8b5ac137d16fced31ee205264b01">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<a id="a32350e02d5904867402187e81a3c4a26" name="a32350e02d5904867402187e81a3c4a26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32350e02d5904867402187e81a3c4a26">&#9670;&#160;</a></span>show()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1global__progress.html">stdex::global_progress</a>&lt; T &gt;::show </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>show</em><span class="paramdefsep"> = </span><span class="paramdefval">true</span></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Show or hide progress. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">show</td><td>Shows or hides progress indicator </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#ab6e57aed9e7a18a501e8a63cef199d8e">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="progress_8hpp_source.html">progress.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 2 2024 11:12:54 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink