Documentation from hourglass.h

Introduction	[top]

ROV - Easy applications from C

Copyright - © Jason Tribbeck / 7th ARM 1994-2001

Contributing authors - Jason Tribbeck

File - hourglass.h

Type - helper

Description

The hourglass helper provides an interface to the Hourglass module.

hourglass_on	[top]

Turn the hourglass on.

void hourglass_on(void);

See also: hourglass_start()

hourglass_off	[top]

Turn the hourglass off.

Note - The hourglass maintains a count of the number of on and off calls. This means that if you want to turn the hourglass off, you must call hourglass_off() the same number of times as hourglass_on(). If you need to forcibly turn the hourglass off, call hourglass_smash().

void hourglass_off(void);

See also: hourglass_smash()

hourglass_percentage	[top]

Set the hourglass to a percentage.

Parameters:

 - int percent - the value (0 to 100)

void hourglass_percentage(int percent);

hourglass_smash	[top]

Forcibly smash the hourglass.

void hourglass_smash(void);

See also: hourglass_off()

hourglass_start	[top]

Start the hourglass after a delay.

Parameters:

 - int delay - the time to delay in centiseconds.

void hourglass_start(int delay);

hourglass_leds	[top]

Set the hourglass LED state.

Parameters:

 - int state - the LED state.

void hourglass_leds(int state);

See also: hourglass_on()

Generated Thu Feb 7 23:22:51 2002