<!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: csProgressPulse 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>csProgressPulse Class Reference</h1><!-- doxytag: class="csProgressPulse" -->The <a class="el" href="classcsProgressPulse.html" title="The csProgressPulse class provides a simple twirling textual cursor built out of...">csProgressPulse</a> class provides a simple twirling textual cursor built out of the characters '-', '\', '|', and '/'.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="csppulse_8h-source.html">csutil/csppulse.h</a>></code>
<p>
<p>
<a href="classcsProgressPulse-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsProgressPulse.html#2e42fdffc417e2fff8c85074c1e9916e">csProgressPulse</a> (<a class="el" href="structiConsoleOutput.html">iConsoleOutput</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new progress pulse. <a href="#2e42fdffc417e2fff8c85074c1e9916e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsProgressPulse.html#de09a99438260aca2202f8e0e2b88d17">Erase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Erase the pulse indicator. <a href="#de09a99438260aca2202f8e0e2b88d17"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsProgressPulse.html#7e5dbc1729a0cfd918716230342a9d48">Reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the state and erase the indicator. <a href="#7e5dbc1729a0cfd918716230342a9d48"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsProgressPulse.html#f711ccbd8ac610467e0fbc8ceb8cb6e4">Step</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increment the progress by one pulse. <a href="#f711ccbd8ac610467e0fbc8ceb8cb6e4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsProgressPulse.html#4fbb3b18982d418dab5861892d1e6c38">~csProgressPulse</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the progress pulse. <a href="#4fbb3b18982d418dab5861892d1e6c38"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classcsProgressPulse.html" title="The csProgressPulse class provides a simple twirling textual cursor built out of...">csProgressPulse</a> class provides a simple twirling textual cursor built out of the characters '-', '\', '|', and '/'.
<p>
This type of functionality is generally used as a sort of pulse beat during indeterminately lengthy computational operations in order to let the user know that progress is being made and that the program is not hanging. By default, the pulse beat is presented to the user by passing CS_MSG_INITIALIZATION to the system print function. This setting may be changed with the SetMessageType() method. To animate the pulse object, call the <a class="el" href="classcsProgressPulse.html#f711ccbd8ac610467e0fbc8ceb8cb6e4" title="Increment the progress by one pulse.">Step()</a> method each time a unit of work has been completed. At each step a backspace (\b) followed by one of the pulse characters (-, \, |, or /) is printed, except for the very first step, in which case the backspace is omitted. <a class="el" href="classcsProgressPulse.html#de09a99438260aca2202f8e0e2b88d17" title="Erase the pulse indicator.">Erase()</a> clears the pulse, if necessary, by printing a backspace, followed by a space (' '), followed by one more backspace. <a class="el" href="classcsProgressPulse.html#7e5dbc1729a0cfd918716230342a9d48" title="Reset the state and erase the indicator.">Reset()</a> erases the pulse and then resets the state. <a class="el" href="classcsProgressPulse.html#de09a99438260aca2202f8e0e2b88d17" title="Erase the pulse indicator.">Erase()</a> is called automatically by the destructor.
<p>Definition at line <a class="el" href="csppulse_8h-source.html#l00047">47</a> of file <a class="el" href="csppulse_8h-source.html">csppulse.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="2e42fdffc417e2fff8c85074c1e9916e"></a><!-- doxytag: member="csProgressPulse::csProgressPulse" ref="2e42fdffc417e2fff8c85074c1e9916e" args="(iConsoleOutput *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csProgressPulse::csProgressPulse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiConsoleOutput.html">iConsoleOutput</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs a new progress pulse.
<p>
</div>
</div><p>
<a class="anchor" name="4fbb3b18982d418dab5861892d1e6c38"></a><!-- doxytag: member="csProgressPulse::~csProgressPulse" ref="4fbb3b18982d418dab5861892d1e6c38" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csProgressPulse::~csProgressPulse </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroys the progress pulse.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="de09a99438260aca2202f8e0e2b88d17"></a><!-- doxytag: member="csProgressPulse::Erase" ref="de09a99438260aca2202f8e0e2b88d17" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csProgressPulse::Erase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Erase the pulse indicator.
<p>
</div>
</div><p>
<a class="anchor" name="7e5dbc1729a0cfd918716230342a9d48"></a><!-- doxytag: member="csProgressPulse::Reset" ref="7e5dbc1729a0cfd918716230342a9d48" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csProgressPulse::Reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the state and erase the indicator.
<p>
</div>
</div><p>
<a class="anchor" name="f711ccbd8ac610467e0fbc8ceb8cb6e4"></a><!-- doxytag: member="csProgressPulse::Step" ref="f711ccbd8ac610467e0fbc8ceb8cb6e4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csProgressPulse::Step </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increment the progress by one pulse.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="csppulse_8h-source.html">csppulse.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
>
916
