DeskLib 2.90a:Hourglass.h

Contents

• Introduction and Overview
• Functions
  • Hourglass_On
  • Hourglass_Start
  • Hourglass_Percentage
  • Hourglass_Off
  • Hourglass_Smash

Introduction and Overview

This declares function veneers for the Hourglass module.

Functions

---

Hourglass_On

void Hourglass_On(void );

Changes the mouse pointer to show the user that some delay will occur.

---

Hourglass_Start

void Hourglass_Start(int startdelay);

Changes the mouse pointer to show the user that some delay will occur.

The change will occur 'startdelay' centiseconds after the call, so if you only want to show the hourglass if the action takes more than half a second, you can call this with startdelay set to 50 and the user won't see the hourglass if you call Hourglass_Off in that half-second.

---

Hourglass_Percentage

void Hourglass_Percentage(int percent);

This indicates to the user that the delay is 'percent'% completed.

Don't wind people up by initially setting it to 99 and then waiting half an hour.

---

Hourglass_Off

void Hourglass_Off(void );

This turns off the hourglass, if it was set on. You need one Hourglass_Off call for each Hourglass_On.

---

Hourglass_Smash

void Hourglass_Smash(void );

This forces the indication of a delay to be removed.

Hourglass_Off must be called for each Hourglass_On or Hourglass_Start call made - this will turn it off no matter how many calls have been made to turn it on.