chiark - git - mdw - ssr/blob - StraySrc/Libraries/Sapphire/sh/gallery

   1 ;
   2 ; gallery.sh
   3 ;
   4 ; Background-drawing viewers
   5 ;
   6 ; © 1995-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 ;  gallery_eventHandler
  32 ;  gallery_drawBox
  33 ;  gallery_removeBox
  34 ;  gallery_reset
  35
  36                 [       :LNOT::DEF:gallery__dfn
  37                 GBLL    gallery__dfn
  38
  39 ; --- gallery_eventHandler ---
  40 ;
  41 ; On entry:     R0 == viewer handle
  42 ;               R1 == pointer to handler routine
  43 ;               R2 == R10 value to pass to handler
  44 ;               R3 == R12 value to pass to handler
  45 ;
  46 ; On exit:      --
  47 ;
  48 ; Use:          Sets up an event handler for the viewer, and adds in
  49 ;               gallery's own special processing for background drawing.
  50
  51                 IMPORT  gallery_eventHandler
  52
  53 ; --- gallery_drawBox ---
  54 ;
  55 ; On entry:     R0-R3 == window relative coords of box to plot
  56 ;
  57 ; On exit:      --
  58 ;
  59 ; Use:          Draws a box to indicate tht this item hasn't been
  60 ;               displayed yet.  Use this routine to give a consistant
  61 ;               look to applications which use the gallery.
  62
  63                 IMPORT  gallery_drawBox
  64
  65 ; --- gallery_removeBox ---
  66 ;
  67 ; On entry:     R0-R3 == window relative coords of box to remove
  68 ;
  69 ; On exit:      --
  70 ;
  71 ; Use:          Removes a previously draw temporary box.  It is assumed that
  72 ;               the background colour of the viewere is 1.
  73
  74                 IMPORT  gallery_removeBox
  75
  76 ; --- gallery_reset ---
  77 ;
  78 ; On entry:     R0 == viewer handle
  79 ;
  80 ; On exit:      --
  81 ;
  82 ; Use:          Resets all the icons in the gallery to their `undrawn' state.
  83 ;               Use this before opening the window etc.
  84
  85                 IMPORT  gallery_reset
  86
  87                 ]
  88
  89 ;----- That's all, folks ----------------------------------------------------
  90
  91                 END