<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csTextProgressMeter Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csTextProgressMeter Class Reference</h1><!-- doxytag: class="csTextProgressMeter" --><!-- doxytag: inherits="scfImplementation1< csTextProgressMeter, iProgressMeter >" -->The <a class="el" href="classcsTextProgressMeter.html" title="The csTextProgressMeter class displays a simple percentage-style textual progress...">csTextProgressMeter</a> class displays a simple percentage-style textual progress meter.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cspmeter_8h-source.html">csutil/cspmeter.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csTextProgressMeter:</div>
<div class="dynsection">
<p><center><img src="classcsTextProgressMeter__inherit__graph.png" border="0" usemap="#csTextProgressMeter__inherit__map" alt="Inheritance graph"></center>
<map name="csTextProgressMeter__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csTextProgressMeter, iProgressMeter \>" alt="" coords="67,161,488,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csTextProgressMeter \>" alt="" coords="5,84,312,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="331,7,387,33"><area shape="rect" href="structiProgressMeter.html" title="This is a general interface for a progress meter." alt="" coords="336,84,456,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="48,7,269,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsTextProgressMeter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#8ff224ce6dbc6d8eda0b9c70d74d6344">Abort</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abort the meter. <a href="#8ff224ce6dbc6d8eda0b9c70d74d6344"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#ca481cb2b1023f4f2cb299cf3ee4ac5c">csTextProgressMeter</a> (<a class="el" href="structiConsoleOutput.html">iConsoleOutput</a> *console, int total=100)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new progress meter. <a href="#ca481cb2b1023f4f2cb299cf3ee4ac5c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#3021d7174a4a1ecabeb65240ad7f2e69">Finalize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize the meter (i.e. we completed the task sooner than expected). <a href="#3021d7174a4a1ecabeb65240ad7f2e69"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#b12e87cdf06353d9345dfdd2e930ee1a">GetCurrent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current value of the meter (<= total). <a href="#b12e87cdf06353d9345dfdd2e930ee1a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#f829ab989da14f941b3c2fb8be173961">GetGranularity</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the refresh granularity. <a href="#f829ab989da14f941b3c2fb8be173961"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#f3049520d8b39e8761f28e542366ea11">GetTickScale</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the tick scale. <a href="#f3049520d8b39e8761f28e542366ea11"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#4d8c1c25ac3c0167d5df07125f029809">GetTotal</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the total element count represented by the meter. <a href="#4d8c1c25ac3c0167d5df07125f029809"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#67247d0f38529e975342b8413a390128">Reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the meter to 0%. <a href="#67247d0f38529e975342b8413a390128"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#0fc9fff3f43991b9b63787eeb62c026e">Restart</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the meter and print the initial tick mark ("0%"). <a href="#0fc9fff3f43991b9b63787eeb62c026e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#bc504ddfd051fd03156062241172f747">SetGranularity</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the refresh granularity. <a href="#bc504ddfd051fd03156062241172f747"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#e3f59ea198e81ebc2336da45a41380cf">SetProgressDescription</a> (const char *, const char *,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the id and description of what we are currently monitoring. <a href="#e3f59ea198e81ebc2336da45a41380cf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#9b991bcf42de8168818e2fb59fe0da2a">SetProgressDescriptionV</a> (const char *, const char *, va_list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the id and description of what we are currently monitoring. <a href="#9b991bcf42de8168818e2fb59fe0da2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#1784dd6bff6e402028c2a0e031f9cb36">SetTickScale</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the tick scale. <a href="#1784dd6bff6e402028c2a0e031f9cb36"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#beec6383a8cbcc88ea566ae2ea682041">SetTotal</a> (int n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the total element count represented by the meter and perform a reset. <a href="#beec6383a8cbcc88ea566ae2ea682041"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#e0032e0814b26ed9a22c228117b27003">Step</a> (unsigned int n=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increment the meter by n units (default 1) and print a tick mark. <a href="#e0032e0814b26ed9a22c228117b27003"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextProgressMeter.html#8b29bd4d8c470b4421589bbdb34390f5">~csTextProgressMeter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the progress meter. <a href="#8b29bd4d8c470b4421589bbdb34390f5"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classcsTextProgressMeter.html" title="The csTextProgressMeter class displays a simple percentage-style textual progress...">csTextProgressMeter</a> class displays a simple percentage-style textual progress meter.
<p>
By default, the meter is presented to the user by passing CS_MSG_INITIALIZATION to the system print function. This setting may be changed with the SetMessageType() method. After constructing a progress meter, call <a class="el" href="classcsTextProgressMeter.html#beec6383a8cbcc88ea566ae2ea682041" title="Set the total element count represented by the meter and perform a reset.">SetTotal()</a> to set the total number of steps represented by the meter. The default is 100. To animate the meter, call the <a class="el" href="classcsTextProgressMeter.html#e0032e0814b26ed9a22c228117b27003" title="Increment the meter by n units (default 1) and print a tick mark.">Step()</a> method each time a unit of work has been completed. At most <a class="el" href="classcsTextProgressMeter.html#e0032e0814b26ed9a22c228117b27003" title="Increment the meter by n units (default 1) and print a tick mark.">Step()</a> should be called 'total' times. Calling <a class="el" href="classcsTextProgressMeter.html#e0032e0814b26ed9a22c228117b27003" title="Increment the meter by n units (default 1) and print a tick mark.">Step()</a> more times than this will not break anything, but if you do so, then the meter will not accurately reflect the progress being made. Calling <a class="el" href="classcsTextProgressMeter.html#67247d0f38529e975342b8413a390128" title="Reset the meter to 0%.">Reset()</a> will reset the meter to zero, but will not update the display. <a class="el" href="classcsTextProgressMeter.html#67247d0f38529e975342b8413a390128" title="Reset the meter to 0%.">Reset()</a> is provided so that the meter can be re-used, but it is the client's responsibility to ensure that the display is in a meaningful state. For instance, the client should probably ensure that a newline '<br>
' has been printed before re-using a meter which has been reset. The complementary method <a class="el" href="classcsTextProgressMeter.html#0fc9fff3f43991b9b63787eeb62c026e" title="Reset the meter and print the initial tick mark ("0%").">Restart()</a> both resets the meter and prints the initial tick mark ("0%"). The meter does not print a newline after 100% has been reached, on the assumption that the client may wish to print some text on the same line on which the meter appeared. If the client needs a newline printed after 100% has been reached, then it is the client's responsibility to print it.
<p>Definition at line <a class="el" href="cspmeter_8h-source.html#l00055">55</a> of file <a class="el" href="cspmeter_8h-source.html">cspmeter.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ca481cb2b1023f4f2cb299cf3ee4ac5c"></a><!-- doxytag: member="csTextProgressMeter::csTextProgressMeter" ref="ca481cb2b1023f4f2cb299cf3ee4ac5c" args="(iConsoleOutput *console, int total=100)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csTextProgressMeter::csTextProgressMeter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiConsoleOutput.html">iConsoleOutput</a> * </td>
<td class="paramname"> <em>console</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>total</em> = <code>100</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs a new progress meter.
<p>
</div>
</div><p>
<a class="anchor" name="8b29bd4d8c470b4421589bbdb34390f5"></a><!-- doxytag: member="csTextProgressMeter::~csTextProgressMeter" ref="8b29bd4d8c470b4421589bbdb34390f5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual csTextProgressMeter::~csTextProgressMeter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroys the progress meter.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8ff224ce6dbc6d8eda0b9c70d74d6344"></a><!-- doxytag: member="csTextProgressMeter::Abort" ref="8ff224ce6dbc6d8eda0b9c70d74d6344" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextProgressMeter::Abort </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Abort the meter.
<p>
<p>Implements <a class="el" href="structiProgressMeter.html#4a409e88518bf95928f38dd7baba4f52">iProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="3021d7174a4a1ecabeb65240ad7f2e69"></a><!-- doxytag: member="csTextProgressMeter::Finalize" ref="3021d7174a4a1ecabeb65240ad7f2e69" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextProgressMeter::Finalize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finalize the meter (i.e. we completed the task sooner than expected).
<p>
<p>Implements <a class="el" href="structiProgressMeter.html#cac4e8a8ebf998fb46652df0def4a90b">iProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="b12e87cdf06353d9345dfdd2e930ee1a"></a><!-- doxytag: member="csTextProgressMeter::GetCurrent" ref="b12e87cdf06353d9345dfdd2e930ee1a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csTextProgressMeter::GetCurrent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current value of the meter (<= total).
<p>
<p>Implements <a class="el" href="structiProgressMeter.html#089cee3524d2f9ab320b76ce426bf976">iProgressMeter</a>.</p>
<p>Definition at line <a class="el" href="cspmeter_8h-source.html#l00108">108</a> of file <a class="el" href="cspmeter_8h-source.html">cspmeter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f829ab989da14f941b3c2fb8be173961"></a><!-- doxytag: member="csTextProgressMeter::GetGranularity" ref="f829ab989da14f941b3c2fb8be173961" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csTextProgressMeter::GetGranularity </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the refresh granularity.
<p>
<p>Implements <a class="el" href="structiProgressMeter.html#1da874825163dd1a86170373779a790c">iProgressMeter</a>.</p>
<p>Definition at line <a class="el" href="cspmeter_8h-source.html#l00118">118</a> of file <a class="el" href="cspmeter_8h-source.html">cspmeter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f3049520d8b39e8761f28e542366ea11"></a><!-- doxytag: member="csTextProgressMeter::GetTickScale" ref="f3049520d8b39e8761f28e542366ea11" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int csTextProgressMeter::GetTickScale </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the tick scale.
<p>
<p>Definition at line <a class="el" href="cspmeter_8h-source.html#l00080">80</a> of file <a class="el" href="cspmeter_8h-source.html">cspmeter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="4d8c1c25ac3c0167d5df07125f029809"></a><!-- doxytag: member="csTextProgressMeter::GetTotal" ref="4d8c1c25ac3c0167d5df07125f029809" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csTextProgressMeter::GetTotal </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the total element count represented by the meter.
<p>
<p>Implements <a class="el" href="structiProgressMeter.html#2e43d0128cc1eb26f8fd7f97ee6eac4d">iProgressMeter</a>.</p>
<p>Definition at line <a class="el" href="cspmeter_8h-source.html#l00106">106</a> of file <a class="el" href="cspmeter_8h-source.html">cspmeter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="67247d0f38529e975342b8413a390128"></a><!-- doxytag: member="csTextProgressMeter::Reset" ref="67247d0f38529e975342b8413a390128" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextProgressMeter::Reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the meter to 0%.
<p>
<p>Implements <a class="el" href="structiProgressMeter.html#16f05bdb0fd27e7cc3626fb9467d30a3">iProgressMeter</a>.</p>
<p>Definition at line <a class="el" href="cspmeter_8h-source.html#l00095">95</a> of file <a class="el" href="cspmeter_8h-source.html">cspmeter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="0fc9fff3f43991b9b63787eeb62c026e"></a><!-- doxytag: member="csTextProgressMeter::Restart" ref="0fc9fff3f43991b9b63787eeb62c026e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextProgressMeter::Restart </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the meter and print the initial tick mark ("0%").
<p>
<p>Implements <a class="el" href="structiProgressMeter.html#ff70c47a5a2a108891d1459e28f9ac2d">iProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="bc504ddfd051fd03156062241172f747"></a><!-- doxytag: member="csTextProgressMeter::SetGranularity" ref="bc504ddfd051fd03156062241172f747" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextProgressMeter::SetGranularity </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the refresh granularity.
<p>
Valid values are 1-100, inclusive. Default is 10. The meter is only refreshed after each "granularity" * number of units have passed. For instance, if granularity is 20, then * the meter will only be updated at most 5 times, or every 20%.
<p>Implements <a class="el" href="structiProgressMeter.html#31f78341fd497aaa707af35e29c7414e">iProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="e3f59ea198e81ebc2336da45a41380cf"></a><!-- doxytag: member="csTextProgressMeter::SetProgressDescription" ref="e3f59ea198e81ebc2336da45a41380cf" args="(const char *, const char *,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextProgressMeter::SetProgressDescription </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the id and description of what we are currently monitoring.
<p>
An id can be something like "crystalspace.engine.lighting.calculation". <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__util.html">Notes about string formatting in Crystal Space</a> </dd></dl>
<p>Implements <a class="el" href="structiProgressMeter.html#046c945d4edcd0a86ccb333cdcfbddc3">iProgressMeter</a>.</p>
<p>Definition at line <a class="el" href="cspmeter_8h-source.html#l00088">88</a> of file <a class="el" href="cspmeter_8h-source.html">cspmeter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9b991bcf42de8168818e2fb59fe0da2a"></a><!-- doxytag: member="csTextProgressMeter::SetProgressDescriptionV" ref="9b991bcf42de8168818e2fb59fe0da2a" args="(const char *, const char *, va_list)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextProgressMeter::SetProgressDescriptionV </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the id and description of what we are currently monitoring.
<p>
An id can be something like "crystalspace.engine.lighting.calculation". <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__util.html">Notes about string formatting in Crystal Space</a> </dd></dl>
<p>Implements <a class="el" href="structiProgressMeter.html#a096f1f49c79723ee5d08944f1914adf">iProgressMeter</a>.</p>
<p>Definition at line <a class="el" href="cspmeter_8h-source.html#l00090">90</a> of file <a class="el" href="cspmeter_8h-source.html">cspmeter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="1784dd6bff6e402028c2a0e031f9cb36"></a><!-- doxytag: member="csTextProgressMeter::SetTickScale" ref="1784dd6bff6e402028c2a0e031f9cb36" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csTextProgressMeter::SetTickScale </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the tick scale.
<p>
Valid values are 1-100, inclusive. Default is 2. A value of 1 means that each printed tick represents one unit, thus a total of 100 ticks will be printed. A value of 2 means that each tick represents two units, thus a total of 50 ticks will be printed, etc.
</div>
</div><p>
<a class="anchor" name="beec6383a8cbcc88ea566ae2ea682041"></a><!-- doxytag: member="csTextProgressMeter::SetTotal" ref="beec6383a8cbcc88ea566ae2ea682041" args="(int n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextProgressMeter::SetTotal </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the total element count represented by the meter and perform a reset.
<p>
<p>Implements <a class="el" href="structiProgressMeter.html#833a633b836c194ee6d62ffa0da2ecf3">iProgressMeter</a>.</p>
<p>Definition at line <a class="el" href="cspmeter_8h-source.html#l00104">104</a> of file <a class="el" href="cspmeter_8h-source.html">cspmeter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="e0032e0814b26ed9a22c228117b27003"></a><!-- doxytag: member="csTextProgressMeter::Step" ref="e0032e0814b26ed9a22c228117b27003" args="(unsigned int n=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextProgressMeter::Step </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>n</em> = <code>1</code> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increment the meter by n units (default 1) and print a tick mark.
<p>
<p>Implements <a class="el" href="structiProgressMeter.html#a8fac9876d95230426a00342e5558b25">iProgressMeter</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="cspmeter_8h-source.html">cspmeter.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
1088
