tbx  0.7.3
Public Member Functions | List of all members
tbx::Hourglass Class Reference

Display the RISC OS hour glass. More...

#include <hourglass.h>

Public Member Functions

 Hourglass (bool on=true)
 Construct an hour glass. More...
 
 ~Hourglass ()
 Hourglass destructor. More...
 
void on ()
 Turns hourglass on. More...
 
void off ()
 Turns the hourglass off. More...
 
void start (int delay)
 Starts the hourglass making it visible after the specified delay. More...
 
void percentage (int pc)
 Show a percentage below the hourglass. More...
 

Detailed Description

Display the RISC OS hour glass.

By default the hourglass doesn't actually appear until after 1/3 of a second.

Constructor & Destructor Documentation

tbx::Hourglass::Hourglass ( bool  on = true)

Construct an hour glass.

By default this turns the RISC OS hourglass on. Pass false as it's parameter to stop the hourglass starting immediately.

The destructor automatically turns it off

Parameters
ontrue to turn RISC OS hourglass on, false if hourglass isn't required immediatly;
tbx::Hourglass::~Hourglass ( )

Hourglass destructor.

This will automatically turn the hourglass off if it is on

Member Function Documentation

void tbx::Hourglass::off ( )

Turns the hourglass off.

Has no effect if it is not on

void tbx::Hourglass::on ( )

Turns hourglass on.

Has no effect if hourglass is already on

void tbx::Hourglass::percentage ( int  pc)

Show a percentage below the hourglass.

Parameters
pcpercentage to show from 0 to 99.
void tbx::Hourglass::start ( int  delay)

Starts the hourglass making it visible after the specified delay.

Parameters
delaydelay in centiseconds before hourglass appears. If delay is 0 it will suppress the hourglass.

The documentation for this class was generated from the following files: