field_eg_choose()

Purpose

Selects an option from a menu with greyed-out options, and displays extra information

Old name

#define eg_choose field_eg_choose

Syntax

int field_eg_choose(mapnr, option, flags, extra_show, ban_list, ADDITIONAL)

Parameters

int mapnr

Number of map containing menu to display

 

int* option

Pointer to variable to hold the chosen field

 

int flags

Parameter affecting display

 

void (*extra_show) (int, int, int)

Function to call when a field is highlighted

 

short* ban_list

Array of integers, zero-terminated, giving fields to grey out

 

ADDITIONAL

Extra parameter for mnemonic map if in use

 

The parameter flags can take any one of the following values:

 

Value

Meaning

 

HAS_PULL_DOWN

Menu has a pull-down menu attached

 

PULL_DOWN

Menu is a pull-down menu

 

ABORT_FUNC_KEYS

Allows the use of the function keys to select an option

 

NR_KEYS

Allows the number keys to select an option

 

CURS_KEYS

Causes the <Ins>, <Del>, <Pg Up> and <Pg Dn> cursor keys to select the highlighted option and return with the global variable abort_code set to the appropriate value

 

NOT_MISSING_FIELD

Checks that the chosen field exists on the map

 

NO_WRAP

This makes field_choose() return with the value of the cursor key if the user tries to move outside the choice array

 

ABORT_MNEMONICS

This allows the use of a mnemonic map to get responses from the user. The mnemonic map must already be displayed on the screen and its number is given in the ADDITIONAL parameter

Description

The field_eg_choose() function allows you to select an option from a menu, to display extra information and to grey out field options. Many of the menu functions are implemented using this function.

Return values

Returns the value of the global variable abort_code

See also

map_g_choose()