chiark / gitweb /
Initial revision
[ssr] / StraySrc / Libraries / Sapphire / csapph / h / menu
1 /*
2  * menu.h
3  *
4  * [Generated from menu, 25 September 1996]
5  */
6
7 #if !defined(__CC_NORCROFT) || !defined(__arm)
8   #error You must use the Norcroft ARM Compiler for Sapphire programs
9 #endif
10
11 #pragma include_only_once
12 #pragma force_top_level
13
14 #ifndef __menu_h
15 #define __menu_h
16
17 #ifndef __sapphire_h
18   #include "sapphire.h"
19 #endif
20
21 /*----- Overview ----------------------------------------------------------*
22  *
23  * Functions provided:
24  *
25  *  menu_create
26  *  menu_help
27  *  menu_init
28  */
29
30 /* --- menu_create --- *
31  *
32  * On entry:    R0 == pointer to menu definition table
33  *              R1 == event handler to use
34  *              R2 == R10 value for handler
35  *              R3 == R12 value for handler
36  *
37  * On exit:     --
38  *
39  * Use:         Creates a menu from the given menu definition
40  *              table. If this call is called more than once before
41  *              a menu is opened then the menu definiton are concatenated
42  *              into a large menu. Only the first menu title read is
43  *              taken notice of. Notice therefore, that the call doesn't
44  *              actually open a menu.
45  */
46
47 extern routine menu_create;
48
49 /* --- menu_help --- *
50  *
51  * On entry:    R0 == pointer to base message tag
52  *              R1 == index of menu item
53  *
54  * On exit:     --
55  *
56  * Use:         Adds a string to the help message found by adding the menu
57  *              item number to the base message tag.
58  */
59
60 extern routine menu_help;
61
62 /* --- menu_init --- *
63  *
64  * On entry:    --
65  *
66  * On exit:     --
67  *
68  * Use:         Initialises the menu system.
69  */
70
71 extern routine menu_init;
72
73 /*----- That's all, folks -------------------------------------------------*/
74
75 #endif