chiark - git - mdw - ssr/blob - StraySrc/Libraries/Sapphire/csapph/h/win

   1 /*
   2  * win.h
   3  *
   4  * [Generated from win, 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 __win_h
  15 #define __win_h
  16
  17 #ifndef __sapphire_h
  18   #include "sapphire.h"
  19 #endif
  20
  21 /*----- Overview ----------------------------------------------------------*
  22  *
  23  * Functions provided:
  24  *
  25  *  win_eventHandler
  26  *  win_removeEventHandler
  27  *  win_swapWindow
  28  *  win_windowDeleted
  29  *  win_unknownHandler
  30  *  win_removeUnknownHandler
  31  *  win_init
  32  */
  33
  34 /* --- win_eventHandler --- *
  35  *
  36  * On entry:    R0 == window handle
  37  *              R1 == pointer to routine to call
  38  *              R2 == R10 value to call routine with
  39  *              R3 == R12 value to call routine with
  40  *
  41  * On exit:     May return an error
  42  *
  43  * Use:         Adds a routine to the event handler list. Later added
  44  *              routines are called first. The event handing routine
  45  *              must preserve all the registers, but may alter the carry
  46  *              flag. If it returns with carry set, then no more event
  47  *              handlers, OR post-filters, will be called.
  48  */
  49
  50 extern routine win_eventHandler;
  51
  52 /* --- win_removeEventHandler --- *
  53  *
  54  * On entry:    R0 == window handle
  55  *              R1 == pointer to routine called
  56  *              R2 == R10 value routine is called with
  57  *              R3 == R12 value routine is called with
  58  *
  59  * On exit:     --
  60  *
  61  * Use:         Removes a routine to the event handler list.
  62  */
  63
  64 extern routine win_removeEventHandler;
  65
  66 /* --- win_swapWindow --- *
  67  *
  68  * On entry:    R0 == old window handle
  69  *              R1 == new window handle
  70  *
  71  * On exit:     --
  72  *
  73  * Use:         Searches for all the event handlers for window R0, and
  74  *              changes the window handle for R1.  This is designed for
  75  *              situations in wihich a window has been deleted and
  76  *              recreated.
  77  */
  78
  79 extern routine win_swapWindow;
  80
  81 /* --- win_windowDeleted --- *
  82  *
  83  * On entry:    R0 == window handle
  84  *
  85  * On exit:     --
  86  *
  87  * Use:         Removes all the event handlers associated with the given
  88  *              window handle.  It is intended to be used when a window
  89  *              has been deleted.
  90  */
  91
  92 extern routine win_windowDeleted;
  93
  94 /* --- win_unknownHandler --- *
  95  *
  96  * On entry:    R0 == pointer to routine to call
  97  *              R1 == R4 value to call routine with
  98  *              R2 == R10 value to call routine with
  99  *              R3 == R12 value to call routine with
 100  *
 101  * On exit:     May return an error
 102  *
 103  * Use:         Adds a rountine to the event handler list. Later added
 104  *              routines are called first. The event handing routine
 105  *              must preserve all the registers, but may alter the carry
 106  *              flag. If it returns with carry set, then no more event
 107  *              handlers, OR post-filters, will be called.
 108  */
 109
 110 extern routine win_unknownHandler;
 111
 112 /* --- win_removeUnknownHandler --- *
 113  *
 114  * On entry:    R0 == pointer to routine called
 115  *              R1 == R4 value routine is called with
 116  *              R2 == R10 value routine is called with
 117  *              R3 == R12 value routine is called with
 118  *
 119  * On exit:     --
 120  *
 121  * Use:         Removes a routine to the unknown handler list.
 122  */
 123
 124 extern routine win_removeUnknownHandler;
 125
 126 /* --- win_init --- *
 127  *
 128  * On entry:    --
 129  *
 130  * On exit:     --
 131  *
 132  * Use:         Initialises the win system.
 133  */
 134
 135 extern routine win_init;
 136
 137 /*----- That's all, folks -------------------------------------------------*/
 138
 139 #endif