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

   1 /*
   2  * pane.h
   3  *
   4  * [Generated from pane, 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 __pane_h
  15 #define __pane_h
  16
  17 #ifndef __sapphire_h
  18   #include "sapphire.h"
  19 #endif
  20
  21 /*----- Overview ----------------------------------------------------------*
  22  *
  23  * Functions provided:
  24  *
  25  *  pane_add
  26  *  pane_remove
  27  *  pane_closed
  28  *  pane_deleted
  29  *  pane_swap
  30  *  pane_open
  31  *  pane_init
  32  */
  33
  34 /* --- pane_add --- *
  35  *
  36  * On entry:    R0 == window handle of parent window
  37  *              R1 == icon handle in parent window
  38  *              R2 == window handle of pane window
  39  *
  40  * On exit:     May return an error
  41  *
  42  * Use:         This call registers a pane to be associated with the given
  43  *              window. The pane is always opened to fit exactly within
  44  *              the given icon -- border widths are taken into account
  45  *              if there are scroll bars etc.
  46  *
  47  *              You must call pane_closed if the parent window is closed,
  48  *              since there is no way for pane to trap this occurence.
  49  */
  50
  51 extern routine pane_add;
  52
  53 /* --- pane_remove --- *
  54  *
  55  * On entry:    R0 == window handle for which pane was registered
  56  *              R1 == window handle of the pane window itself
  57  *
  58  * On exit:     --
  59  *
  60  * Use:         Removes the pane from the given window. This call will
  61  *              close the given pane, but will not actually delete it
  62  *              (ie. with a Wimp_DeleteWindow).
  63  */
  64
  65 extern routine pane_remove;
  66
  67 /* --- pane_closed --- *
  68  *
  69  * On entry:    R0 == window handle of parent
  70  *
  71  * On exit:     --
  72  *
  73  * Use:         Informs pane that a parent window has closed.
  74  *              All associated panes are then closed.
  75  */
  76
  77 extern routine pane_closed;
  78
  79 /* --- pane_deleted --- *
  80  *
  81  * On entry:    R0 == window handle of parent
  82  *
  83  * On exit:     --
  84  *
  85  * Use:         Informs pane that a parent window has been deleted.
  86  *              All associated panes are then closed, and there
  87  *              registration with the pane library module is
  88  *              terminated.
  89  */
  90
  91 extern routine pane_deleted;
  92
  93 /* --- pane_swap --- *
  94  *
  95  * On entry:    R0 == window handle of parent window
  96  *              R1 == icon handle within parent window
  97  *              R2 == window handle of new pane
  98  *
  99  * On exit:     --
 100  *
 101  * Use:         This call will replace the pane in associated with icon R1
 102  *              in window R0, with the pane in R2.
 103  *
 104  *              The exisiting pane is closed, and the new pane is
 105  *              opened in it's place. No error is generated if the existing
 106  *              pane does not exist; this allows the caller to delete the
 107  *              window before doing the swap.
 108  */
 109
 110 extern routine pane_swap;
 111
 112 /* --- pane_open --- *
 113  *
 114  * On entry:    R0 == window handle
 115  *
 116  * On exit:     --
 117  *
 118  * Use:         Opens all the panes associated with the given window.
 119  */
 120
 121 extern routine pane_open;
 122
 123 /* --- pane_init --- *
 124  *
 125  * On entry:    --
 126  *
 127  * On exit:     --
 128  *
 129  * Use:         Initialises the pane unit.
 130  */
 131
 132 extern routine pane_init;
 133
 134 /*----- That's all, folks -------------------------------------------------*/
 135
 136 #endif