chiark / gitweb /
Initial revision
[ssr] / StraySrc / Libraries / Sapphire / csapph / h / gallery
1 /*
2  * gallery.h
3  *
4  * [Generated from gallery, 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 __gallery_h
15 #define __gallery_h
16
17 #ifndef __sapphire_h
18   #include "sapphire.h"
19 #endif
20
21 /*----- Overview ----------------------------------------------------------*
22  *
23  * Functions provided:
24  *
25  *  gallery_eventHandler
26  *  gallery_drawBox
27  *  gallery_removeBox
28  *  gallery_reset
29  */
30
31 /* --- gallery_eventHandler --- *
32  *
33  * On entry:    R0 == viewer handle
34  *              R1 == pointer to handler routine
35  *              R2 == R10 value to pass to handler
36  *              R3 == R12 value to pass to handler
37  *
38  * On exit:     --
39  *
40  * Use:         Sets up an event handler for the viewer, and adds in
41  *              gallery's own special processing for background drawing.
42  */
43
44 extern routine gallery_eventHandler;
45
46 /* --- gallery_drawBox --- *
47  *
48  * On entry:    R0-R3 == window relative coords of box to plot
49  *
50  * On exit:     --
51  *
52  * Use:         Draws a box to indicate tht this item hasn't been
53  *              displayed yet.  Use this routine to give a consistant
54  *              look to applications which use the gallery.
55  */
56
57 extern routine gallery_drawBox;
58
59 /* --- gallery_removeBox --- *
60  *
61  * On entry:    R0-R3 == window relative coords of box to remove
62  *
63  * On exit:     --
64  *
65  * Use:         Removes a previously draw temporary box.  It is assumed that
66  *              the background colour of the viewere is 1.
67  */
68
69 extern routine gallery_removeBox;
70
71 /* --- gallery_reset --- *
72  *
73  * On entry:    R0 == viewer handle
74  *
75  * On exit:     --
76  *
77  * Use:         Resets all the icons in the gallery to their `undrawn' state.
78  *              Use this before opening the window etc.
79  */
80
81 extern routine gallery_reset;
82
83 /*----- That's all, folks -------------------------------------------------*/
84
85 #endif