Initial revision
[ssr] / StraySrc / Libraries / Sapphire / csapph / h / wimp
CommitLineData
2ee739cc 1/*
2 * wimp.h
3 *
4 * [Generated from wimp, 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 __wimp_h
15#define __wimp_h
16
17#ifndef __sapphire_h
18 #include "sapphire.h"
19#endif
20
21/*----- Overview ----------------------------------------------------------*
22 *
23 * Functions provided:
24 *
25 * wimp_init
26 * wimp_taskHandle
27 * wimp_version
28 * wimp_strWidth
29 */
30
31/* --- wimp_init --- *
32 *
33 * On entry: R0 == pointer to application name
34 *
35 * On exit: --
36 *
37 * Use: Initialises the WindowManager, and stores away useful
38 * snippets of information, like the task handle we've been
39 * given. It also registers an exit handler so that the Wimp
40 * gets closed down.
41 */
42
43extern routine wimp_init;
44
45/* --- wimp_taskHandle --- *
46 *
47 * On entry: --
48 *
49 * On exit: R0 == the application's task handle
50 *
51 * Use: Returns the application's task handle.
52 */
53
54extern routine wimp_taskHandle;
55
56/* --- wimp_version --- *
57 *
58 * On entry: --
59 *
60 * On exit: R0 == the WIMP's version number (may not be the one the
61 * client asked for)
62 *
63 * Use: Returns the WindowManager's version number.
64 */
65
66extern routine wimp_version;
67
68/* --- wimp_strWidth --- *
69 *
70 * On entry: R0 == pointer to a string
71 *
72 * On exit: R0 == width of the string in OS units
73 *
74 * Use: Returns the width of a string, as it would be displayed in
75 * an icon (i.e. taking into account things like the current
76 * desktop font etc.) The width is exact, so if you want to
77 * e.g. draw a box round it, you'll have to add on a little
78 * clearance at each end. 8 OS units seems to be a good size
79 * for the clearance (so the total width you'd use is given by
80 * wimp_strWidth(string)+16, because it has two ends).
81 */
82
83extern routine wimp_strWidth;
84
85/*----- That's all, folks -------------------------------------------------*/
86
87#endif