The <statline.h> header file


  
This header file contains the following functions:
ST_angle            ST_batt             ST_busy             ST_eraseHelp
ST_folder           ST_graph            ST_helpMsg          ST_modKey
ST_precision        ST_readOnly         ST_refDsp           ST_showHelp
ST_stack
and the following predefined types:
Bool                ST_ACTIVITIES       ST_FLAGS

Functions


void ST_helpMsg (char *msg);

Displays message in the status line.

ST_helpMsg displays the message msg in the status line, also setting a status flag indicating that a message is being displayed.

void ST_showHelp (char *msg);

Displays message in the status line.

ST_showHelp is an alias name for ST_helpMsg, known from DoorsOS.

short ST_eraseHelp (void);

Redraws the status line.

If the status flags indicate that a help message is being displayed, this function redraws the status line, effectively removing the message. Returns TRUE or FALSE, depending of whether redrawing was performed or not.

void ST_busy (short mode);

Sets the BUSY indicator in the status line.

ST_busy sets the program status indicator to idle, busy or paused, depending of whether mode is ST_IDLE, ST_BUSY or ST_PAUSED (these constants are defined in enum ST_FLAGS). This indicator would be displayed in the status line. In the idle mode, the number of entry/answer pairs in the history area would be displayed, else words "BUSY" or "PAUSE" would be displayed. If ST_busy is called with argument ST_NORMAL, the indicator would be erased. Note that the TIOS event handler always sets "BUSY" indicator before calling an event to an application, and clears it when the application returns from handling the event.

NOTE: Alternative mode names ACTIVITY_IDLE, ACTIVITY_BUSY and ACTIVITY_PAUSED known from DoorsOS will also be accepted, and these constants are defined in enum ST_ACTIVITIES.

void ST_batt (short mode);

Sets the battery low indicator in the status line.

ST_batt sets the battery low indicator to nothing, BATT with light background, or BATT with dark background, depending of whether mode is ST_BATT_OK, ST_BATT_LOW or ST_BATT_REPLACE (these constants are defined in enum ST_FLAGS). This indicator would be displayed in the status line.

void ST_angle (short mode);

Sets the angle mode indicator in the status line.

ST_angle sets the angle mode indicator to RAD or DEG, depending of whether mode is ST_RAD or ST_DEG (these constants are defined in enum ST_FLAGS). This indicator would be displayed in the status line. Note that this command acts only to the displayed status; it would not change the actual current angle mode (use MO_digestOption if you want to change angle mode).

void ST_folder (char *name);

Sets the folder name indicator in the status line.

ST_folder sets the folder name indicator to name, i.e. displays the given folder name (converted to uppercase letters) at the beginning of the status line. Note that this command acts only to the displayed status; it would not change the actual current folder (use routines for vat.h for changing the current folder).

void ST_graph (short mode);

Sets the graph mode indicator in the status line.

ST_angle sets the graph mode indicator to FUNC, PAR, POL, SEQ, 3D or DE, depending of whether mode is ST_FUNC, ST_PAR, ST_POL, ST_SQR, ST_3D or ST_DE (these constants are defined in enum ST_FLAGS). This indicator would be displayed in the status line. Note that this command acts only to the displayed status; it would not change the actual current graph mode.

void ST_modKey (short flags);

Sets the modifier key indicator in the status line.

ST_modKey sets the modifier key indicator to nothing, 2nd, shift, diamond, alpha, shifted alpha lock or alpha lock, depending of whehter mode is ST_NONE, ST_2ND, ST_SHIFT, ST_DIAMOND, ST_ALPHA, ST_SH_A_LOCK or ST_A_LOCK (these constants are defined in enum ST_FLAGS). This indicator would be displayed in the status line. This function has a very limited usage, because it is called very often from AutoInt 1, so if interrupts are enabled, the modifier key indicator will be changed very soon depending of actual state of the keyboard.

void ST_precision (short mode);

Sets the precision mode indicator in the status line.

ST_precision sets the precision mode indicator to AUTO, EXACT or APPROX, depending of whether mode is ST_AUTO, ST_EXACT or ST_APPROX (these constants are defined in enum ST_FLAGS). This indicator would be displayed in the status line. Note that this command acts only to the displayed status; it would not change the actual current precision mode.

void ST_stack (short index, short total);

Sets the history pairs indicator in the status line.

ST_stack sets the displayed number of entry/answer pairs in the history area to index/total. This indicator would be displayed in the status line only if the current program activity status (set by ST_busy) is ST_IDLE. Note that this command acts only to the displayed status; it would not change the actual number of entries in the history area, nor the capacity of the history area.

void ST_readOnly (short mode);

Sets the "read only" (or "locked") indicator in the status line.

ST_readOnly sets the "read only" ("locked") indicator in the status line if the mode is non-zero, else resets the indicator. But note that this indicator appears only when you open a variable in a text editor, and that this routine does not set or change the read-only state of the text currently being edited. This function is called from TE_indicateReadOnly.

void ST_refDsp (short msg_no);

Displays a system message in the status line.

ST_refDsp displays various system messages (determined by msg_no) in the status line (this function calls ST_helpMsg). Here is the list of used messages:

1TYPE OR USE left right up down + [ENTER]=OK AND [ESC]=CANCEL
2USE up AND down TO OPEN CHOICES
3USE left right up down + [ENTER]=OK AND [ESC]=CANCEL
4TYPE + [ENTER]=OK AND [ESC]=CANCEL
5USE left right up down OR TYPE + [ESC]=CANCEL
6USE left right up down + [ENTER]=OK AND [ESC]=CANCEL, OR DRAG
7DATA PLACED IN VARIABLE SYSDATA
8DATA PLACED IN HOME SCREEN HISTORY
9[ENTER]=OK AND [ESC]=CANCEL
10empty
11USE left right + [ENTER]=OK AND [ESC]=CANCEL
12USE left right + [ENTER]=OK AND [ESC]=CANCEL
13USE [2ND] [KEYS] OR [ESC]=CANCEL


Constants and predefined types


enum Bool

Bool is enumerated type for describing true or false values. It is defined as

enum Bool {FALSE, TRUE};

enum ST_FLAGS

ST_FLAGS is enumerated type which contains codes of various modes which are possible to set into the status line using various functions defined in this header file. ST_FLAGS is defined as
enum ST_FLAGS {ST_IDLE = 0, ST_BUSY = 1, ST_PAUSE = 2, ST_CLEAR = 3,
  ST_NORMAL = 3, ST_NOTHING = 0, ST_BATT = 1, ST_BATT_DARK = 2, ST_BATT_OK = 0,
  ST_BATT_LOW = 1, ST_BATT_REPLACE = 2, ST_RAD = 0, ST_DEG = 1, ST_FUNC = 0,
  ST_PAR = 2, ST_POL = 3, ST_SEQ = 4, ST_3D = 5, ST_DE = 6, ST_NONE = 0,
  ST_2ND = 1, ST_SHIFT = 2, ST_DIAMOND = 4, ST_ALPHA = 8, ST_SH_A_LOCK = 16,
  ST_A_LOCK = 32, ST_AUTO = 0, ST_EXACT=1, ST_APPROX=2};
Some of these values (like ST_BATT_DARK) are deprecated, and they are included only for the compatibility with previous versions of TIGCCLIB.

enum ST_ACTIVITIES

ST_ACTIVITIES is enumerated type which contains some alias names known from DoorsOS. It is defined here as
enum ST_ACTIVITIES {ACTIVITY_IDLE, ACTIVITY_BUSY, ACTIVITY_PAUSED,
  ACTIVITY_NORMAL};

Return to the main index