Initial revision
[ssr] / StraySrc / Libraries / Sapphire / csapph / h / ibicon
CommitLineData
2ee739cc 1/*
2 * ibicon.h
3 *
4 * [Generated from ibicon, 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 __ibicon_h
15#define __ibicon_h
16
17#ifndef __sapphire_h
18 #include "sapphire.h"
19#endif
20
21/*----- Overview ----------------------------------------------------------*
22 *
23 * Functions provided:
24 *
25 * ibicon_create
26 * ibicon_changeSprite
27 * ibicon_changeText
28 * ibicon_remove
29 * ibicon_init
30 */
31
32/* --- ibicon_create --- *
33 *
34 * On entry: R0 == pointer to sprite name
35 * R1 == pointer to text buffer (must be writable if you
36 * intend to change the text)
37 * R2 == icon bar position indicator (`window handle')
38 * R3 == icon bar priority/icon handle
39 * R4 == pointer to event handler
40 * R5 == value to pass in R10
41 * R6 == value to pass in R12
42 *
43 * On exit: R0 == ibicon icon handle
44 * May return an error
45 *
46 * Use: Places an icon on the icon bar. Your handler is called when
47 * an event occurs on the icon. On entry to the handler, R10
48 * and R12 are set up as for above, R0 is the event type, and
49 * R1 is the ibicon pointer.
50 */
51
52extern routine ibicon_create;
53
54/* --- ibicon_changeSprite --- *
55 *
56 * On entry: R0 == ibicon pointer
57 * R1 == pointer to sprite name
58 *
59 * On exit: --
60 *
61 * Use: Changes the sprite of the ibicon passed to it.
62 */
63
64extern routine ibicon_changeSprite;
65
66/* --- ibicon_changeText --- *
67 *
68 * On entry: R0 == ibicon pointer
69 * R1 == pointer to new text
70 *
71 * On exit: --
72 *
73 * Use: Changes the sprite of the ibicon passed to it.
74 */
75
76extern routine ibicon_changeText;
77
78/* --- ibicon_remove --- *
79 *
80 * On entry: R0 == ibicon icon handle
81 *
82 * On exit: --
83 *
84 * Use: Removes the given icon from the icon bar.
85 */
86
87extern routine ibicon_remove;
88
89/* --- ibicon_init --- *
90 *
91 * On entry: --
92 *
93 * On exit: --
94 *
95 * Use: Initialises the ibicon unit.
96 */
97
98extern routine ibicon_init;
99
100/*----- Event types -------------------------------------------------------*/
101
102#define ibEvent_select 0
103#define ibEvent_menu 1
104#define ibEvent_adjust 2
105#define ibEvent_save 3
106#define ibEvent_load 4
107#define ibEvent_help 5
108
109/*----- That's all, folks -------------------------------------------------*/
110
111#endif