Initial revision
[ssr] / StraySrc / Libraries / Sapphire / csapph / h / saveWarn
CommitLineData
2ee739cc 1/*
2 * saveWarn.h
3 *
4 * [Generated from saveWarn, 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 __saveWarn_h
15#define __saveWarn_h
16
17#ifndef __sapphire_h
18 #include "sapphire.h"
19#endif
20
21/*----- Overview ----------------------------------------------------------*
22 *
23 * Functions provided:
24 *
25 * saveWarn
26 * saveWarn_saved
27 * saveWarn_close
28 */
29
30/* --- saveWarn --- *
31 *
32 * On entry: R0 == estimated size of data
33 * R1 == file type of the data
34 * R2 == pointer to name of the file
35 * R3 == pointer to handler block
36 * R4 == value to pass to handlers in R10
37 * R5 == value to pass to handlers in R12
38 * R6 == flags (in bottom two bits)
39 *
40 * On exit: --
41 *
42 * Use: Displays a warning box allowing the user to save a modified
43 * document. The flags in R6 are as follows:
44 *
45 * Bit 0 File is safe; don't give a warning
46 * Bit 1 File's name is sensible; display it in the warning
47 *
48 * The handler block is the same as that passed to saveAs (q.v.)
49 * with an extra entry point on the very beginning, which is
50 * expected to remove the document from memory. This entry
51 * point is not passed any arguments except for R10 and R12.
52 *
53 * In order for the system to work, you must call various
54 * saveWarn routines from your saveAs entry points:
55 *
56 * saveWarn_saved from saEntry__success
57 * saveWarn_close from saEntry__closed
58 */
59
60extern routine saveWarn;
61
62/* --- saveWarn_saved --- *
63 *
64 * On entry: --
65 *
66 * On exit: --
67 *
68 * Use: Informs saveWarn that the document has been saved. If
69 * saveWarn is not operating, this call is ignored. You should
70 * only call this routine if the document is *safe*, rather than
71 * RAM transferred to another application, for example.
72 */
73
74extern routine saveWarn_saved;
75
76/* --- saveWarn_close --- *
77 *
78 * On entry: --
79 *
80 * On exit: --
81 *
82 * Use: Informs saveWarn that the save dialogue box has been closed.
83 * If the document is now saved, then it is removed from
84 * memory.
85 */
86
87extern routine saveWarn_close;
88
89/*----- That's all, folks -------------------------------------------------*/
90
91#endif