Initial revision
[ssr] / StraySrc / Libraries / Sapphire / sh / transWin
1 ;
2 ; transWin.sh
3 ;
4 ; Transient window handling
5 ;
6 ; © 1994-1998 Straylight
7 ;
8
9 ;----- Licensing note -------------------------------------------------------
10 ;
11 ; This file is part of Straylight's Sapphire library.
12 ;
13 ; Sapphire is free software; you can redistribute it and/or modify
14 ; it under the terms of the GNU General Public License as published by
15 ; the Free Software Foundation; either version 2, or (at your option)
16 ; any later version.
17 ;
18 ; Sapphire is distributed in the hope that it will be useful,
19 ; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ; GNU General Public License for more details.
22 ;
23 ; You should have received a copy of the GNU General Public License
24 ; along with Sapphire. If not, write to the Free Software Foundation,
25 ; 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26
27 ;----- Overview -------------------------------------------------------------
28 ;
29 ; Functions provided:
30 ;
31 ; transWin_subWaiting
32 ; transWin_openSub
33 ; transWin_register
34 ; transWin_close
35 ; transWin_init
36
37 [ :LNOT::DEF:transWin__dfn
38 GBLL transWin__dfn
39
40 ; --- transWin_subWaiting ---
41 ;
42 ; On entry: --
43 ;
44 ; On exit: CS if a submenu is waiting to be opened, CC otherwise
45 ;
46 ; Use: Informs the caller whether the menu system is waiting for
47 ; a submenu to be attached.
48
49 IMPORT transWin_subWaiting
50
51 ; --- transWin_openSub ---
52 ;
53 ; On entry: R0 == window handle to open
54 ;
55 ; On exit: --
56 ;
57 ; Use: Opens the given window as a submenu.
58
59 IMPORT transWin_openSub
60
61 ; --- transWin_register ---
62 ;
63 ; On entry: R0 == window handle to register
64 ;
65 ; On exit: --
66 ;
67 ; Use: Registers a window as being the current transient window.
68
69 IMPORT transWin_register
70
71 ; --- transWin_close ---
72 ;
73 ; On entry: R0 == window handle to close
74 ;
75 ; On exit: --
76 ;
77 ; Use: Closes the current transient window.
78
79 IMPORT transWin_close
80
81 ; --- transWin_init ---
82 ;
83 ; On entry: --
84 ;
85 ; On exit: --
86 ;
87 ; Use: Initialises the transWin system.
88
89 IMPORT transWin_init
90
91 ]
92
93 ;----- That's all, folks ----------------------------------------------------
94
95 END