csTextProgressMeter Class Reference
The csTextProgressMeter class displays a simple percentage-style textual progress meter. More...
#include <cspmeter.h>
Inheritance diagram for csTextProgressMeter:
Public Methods | |
| csTextProgressMeter (iConsoleOutput *console, int total=100) | |
| Constructs a new progress meter. | |
| virtual | ~csTextProgressMeter () |
| Destroys the progress meter. | |
| void | SetTickScale (int) |
| Set the tick scale. More... | |
| int | GetTickScale () const |
| Get the tick scale. | |
| virtual void | SetProgressDescription (const char *, const char *,...) |
| Set the id and description of what we are currently monitoring. More... | |
| virtual void | SetProgressDescriptionV (const char *, const char *, va_list) |
| Set the id and description of what we are currently monitoring. More... | |
| virtual void | Step () |
| Increment the meter by one unit and print a tick mark. | |
| virtual void | Reset () |
| Reset the meter to 0%. | |
| virtual void | Restart () |
| Reset the meter and print the initial tick mark ("0%"). | |
| virtual void | Abort () |
| Abort the meter. | |
| virtual void | Finalize () |
| Finalize the meter (i.e. we completed the task sooner than expected). | |
| virtual void | SetTotal (int n) |
| Set the total element count represented by the meter and perform a reset. | |
| virtual int | GetTotal () const |
| Get the total element count represented by the meter. | |
| virtual int | GetCurrent () const |
| Get the current value of the meter (<= total). | |
| virtual void | SetGranularity (int) |
| Set the refresh granularity. More... | |
| virtual int | GetGranularity () const |
| Get the refresh granularity. | |
Public Attributes | |
| SCF_DECLARE_IBASE | |
Detailed Description
The csTextProgressMeter class displays a simple percentage-style textual progress meter.
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 SetTotal() to set the total number of steps represented by the meter. The default is 100. To animate the meter, call the Step() method each time a unit of work has been completed. At most Step() should be called 'total' times. Calling Step() 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 Reset() will reset the meter to zero, but will not update the display. Reset() 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 '
' has been printed before re-using a meter which has been reset. The complementary method Restart() 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.
Member Function Documentation
|
|
Set the refresh granularity. 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%. Reimplemented from iProgressMeter. |
|
|
Set the id and description of what we are currently monitoring. An id can be something like "crystalspace.engine.lighting.calculation". Reimplemented from iProgressMeter. |
|
|
Set the id and description of what we are currently monitoring. An id can be something like "crystalspace.engine.lighting.calculation". Reimplemented from iProgressMeter. |
|
|
Set the tick scale. 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. |
The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000