/usr/include/crystalspace-2.0/csutil/csppulse.h is in libcrystalspace-dev 2.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | /*
Copyright (C) 1999 by Eric Sunshine <sunshine@sunshineco.com>
Writen by Eric Sunshine <sunshine@sunshineco.com>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __CS_CSPPULSE_H__
#define __CS_CSPPULSE_H__
/**\file
* Pulsing progress indicator
*/
#include "csextern.h"
struct iConsoleOutput;
/**
* The csProgressPulse class provides a simple twirling textual cursor built
* out of the characters '-', '\', '|', and '/'. 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 Step() 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. Erase() clears the
* pulse, if necessary, by printing a backspace, followed by a space (' '),
* followed by one more backspace. Reset() erases the pulse and then resets
* the state. Erase() is called automatically by the destructor.
*/
class CS_CRYSTALSPACE_EXPORT csProgressPulse
{
private:
iConsoleOutput* console;
int state;
bool drawn;
public:
/// Constructs a new progress pulse.
csProgressPulse(iConsoleOutput*);
/// Destroys the progress pulse.
~csProgressPulse();
/// Increment the progress by one pulse.
void Step();
/// Erase the pulse indicator.
void Erase();
/// Reset the state and erase the indicator.
void Reset();
};
#endif // __CS_CSPPULSE_H__
|