<!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: csutil/cspmeter.h Source File (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><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>csutil/cspmeter.h</h1><a href="cspmeter_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 1999,2000 by Eric Sunshine <sunshine@sunshineco.com></span> <a name="l00003"></a>00003 <span class="comment"> Writen by Eric Sunshine <sunshine@sunshineco.com></span> <a name="l00004"></a>00004 <span class="comment"></span> <a name="l00005"></a>00005 <span class="comment"> This library is free software; you can redistribute it and/or</span> <a name="l00006"></a>00006 <span class="comment"> modify it under the terms of the GNU Library General Public</span> <a name="l00007"></a>00007 <span class="comment"> License as published by the Free Software Foundation; either</span> <a name="l00008"></a>00008 <span class="comment"> version 2 of the License, or (at your option) any later version.</span> <a name="l00009"></a>00009 <span class="comment"></span> <a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span> <a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span> <a name="l00014"></a>00014 <span class="comment"></span> <a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public</span> <a name="l00016"></a>00016 <span class="comment"> License along with this library; if not, write to the Free</span> <a name="l00017"></a>00017 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span> <a name="l00018"></a>00018 <span class="comment">*/</span> <a name="l00019"></a>00019 <a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_CSPMETER_H__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSPMETER_H__</span> <a name="l00022"></a>00022 <span class="preprocessor"></span> <a name="l00027"></a>00027 <span class="preprocessor">#include "csextern.h"</span> <a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span> <a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="pmeter_8h.html" title="General progress meter interface.">ivaria/pmeter.h</a>"</span> <a name="l00030"></a>00030 <a name="l00031"></a>00031 <span class="keyword">struct </span><a class="code" href="structiConsoleOutput.html" title="This is the Crystal Space Console interface.">iConsoleOutput</a>; <a name="l00032"></a>00032 <a name="l00055"></a><a class="code" href="classcsTextProgressMeter.html">00055</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsTextProgressMeter.html" title="The csTextProgressMeter class displays a simple percentage-style textual progress...">csTextProgressMeter</a> : <a name="l00056"></a>00056 <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a><csTextProgressMeter, iProgressMeter> <a name="l00057"></a>00057 { <a name="l00058"></a>00058 <span class="keyword">private</span>: <a name="l00059"></a>00059 <a class="code" href="structiConsoleOutput.html" title="This is the Crystal Space Console interface.">iConsoleOutput</a>* console; <a name="l00060"></a>00060 <span class="keywordtype">int</span> granularity; <a name="l00061"></a>00061 <span class="keywordtype">int</span> tick_scale; <a name="l00062"></a>00062 <span class="keywordtype">int</span> total; <a name="l00063"></a>00063 <span class="keywordtype">int</span> current; <a name="l00064"></a>00064 <span class="keywordtype">int</span> anchor; <a name="l00065"></a>00065 <a name="l00066"></a>00066 <span class="keyword">public</span>: <a name="l00068"></a>00068 <a class="code" href="classcsTextProgressMeter.html" title="The csTextProgressMeter class displays a simple percentage-style textual progress...">csTextProgressMeter</a> (<a class="code" href="structiConsoleOutput.html" title="This is the Crystal Space Console interface.">iConsoleOutput</a>* console, <span class="keywordtype">int</span> total = 100); <a name="l00070"></a>00070 <span class="keyword">virtual</span> ~<a class="code" href="classcsTextProgressMeter.html" title="The csTextProgressMeter class displays a simple percentage-style textual progress...">csTextProgressMeter</a> (); <a name="l00071"></a>00071 <a name="l00078"></a>00078 <span class="keywordtype">void</span> SetTickScale (<span class="keywordtype">int</span>); <a name="l00080"></a><a class="code" href="classcsTextProgressMeter.html#f3049520d8b39e8761f28e542366ea11">00080</a> <span class="keywordtype">int</span> GetTickScale ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> tick_scale; } <a name="l00081"></a>00081 <a name="l00087"></a>00087 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a> (3, 4) <a name="l00088"></a><a class="code" href="classcsTextProgressMeter.html#e3f59ea198e81ebc2336da45a41380cf">00088</a> SetProgressDescription (const <span class="keywordtype">char</span>*, const <span class="keywordtype">char</span>*, ...) { } <a name="l00089"></a>00089 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a> (3, 0) <a name="l00090"></a><a class="code" href="classcsTextProgressMeter.html#9b991bcf42de8168818e2fb59fe0da2a">00090</a> SetProgressDescriptionV (const <span class="keywordtype">char</span>*, const <span class="keywordtype">char</span>*, va_list) { } <a name="l00091"></a>00091 <a name="l00093"></a>00093 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Step (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> n = 1); <a name="l00095"></a><a class="code" href="classcsTextProgressMeter.html#67247d0f38529e975342b8413a390128">00095</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Reset () { current = 0; anchor = 0; } <a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Restart (); <a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Abort (); <a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Finalize (); <a name="l00102"></a>00102 <a name="l00104"></a><a class="code" href="classcsTextProgressMeter.html#beec6383a8cbcc88ea566ae2ea682041">00104</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetTotal (<span class="keywordtype">int</span> n) { total = n; Reset(); } <a name="l00106"></a><a class="code" href="classcsTextProgressMeter.html#4d8c1c25ac3c0167d5df07125f029809">00106</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetTotal ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> total; } <a name="l00108"></a><a class="code" href="classcsTextProgressMeter.html#b12e87cdf06353d9345dfdd2e930ee1a">00108</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetCurrent ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> current; } <a name="l00109"></a>00109 <a name="l00116"></a>00116 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetGranularity (<span class="keywordtype">int</span>); <a name="l00118"></a><a class="code" href="classcsTextProgressMeter.html#f829ab989da14f941b3c2fb8be173961">00118</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetGranularity ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> granularity; } <a name="l00119"></a>00119 }; <a name="l00120"></a>00120 <a name="l00121"></a>00121 <span class="preprocessor">#endif // __CS_CSPMETER_H__</span> </pre></div><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>