Initial revision
[ssr] / StraySrc / Libraries / Sapphire / csapph / h / buttons
CommitLineData
2ee739cc 1/*
2 * buttons.h
3 *
4 * [Generated from buttons, 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 __buttons_h
15#define __buttons_h
16
17#ifndef __sapphire_h
18 #include "sapphire.h"
19#endif
20
21/*----- Overview ----------------------------------------------------------*
22 *
23 * Functions provided:
24 *
25 * buttons_setup
26 *
27 * Macros provided:
28 *
29 * BUTTON
30 * BUTEND
31 * BCANCEL
32 * BOK
33 * BHELP
34 * BGAP
35 */
36
37/* --- buttons_setup --- *
38 *
39 * On entry: R0 == dialogue box handle
40 * R1 == pointer to buttons block
41 * R2 == buttons base icon
42 * R3 == number of buttons to allow
43 *
44 * On exit: R2 == buttons flag mask
45 * R3 == cancel button icon, or -1
46 *
47 * Use: Sets up a dialogue box's buttons according to a buttons
48 * block.
49 */
50
51extern routine buttons_setup;
52
53/*----- Macros ------------------------------------------------------------*/
54
55/* --- Macro: BUTTON --- *
56 *
57 * Arguments: msg == message tag to put in button
58 *
59 * Use: Inserts a text button into a buttons definition block.
60 */
61
62/* --- Macro: BCANCEL --- *
63 *
64 * Arguments: text == optional text string (default is `Cancel')
65 *
66 * Use: Inserts a cancel button into a buttons definition block.
67 */
68
69/* --- Macro: BOK --- *
70 *
71 * Arguments: --
72 *
73 * Use: Inserts an OK button into a buttons definition block.
74 */
75
76/* --- Macro: BHELP --- *
77 *
78 * Arguments: --
79 *
80 * Use: Inserts a help button into a buttons definition block.
81 */
82
83/* --- Macro: BGAP --- *
84 *
85 * Arguments: --
86 *
87 * Use: Omits a button in a buttons definition block.
88 */
89
90/* --- Macro: BUTEND --- *
91 *
92 * Arguments: --
93 *
94 * Use: Terminates a buttons definition block.
95 */
96
97/*----- Button block formats ----------------------------------------------*/
98
99#define bFlag_cancel ((1<<0))
100
101#define bFlag_ok ((1<<1))
102
103#define bFlag_help ((1<<2))
104
105#define bFlag_text ((1<<3))
106
107#define bFlag_last ((1<<31))
108
109/*----- That's all, folks -------------------------------------------------*/
110
111#endif