mdw@git.distorted.org.uk Git - ssr/blob - StraySrc/Libraries/Sapphire/sh/keyString

   1 ;
   2 ; keyString.sh
   3 ;
   4 ; Translating key codes to strings
   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 ;  keyString
  32
  33                 [       :LNOT::DEF:keyString__dfn
  34                 GBLL    keyString__dfn
  35
  36 ; --- keyString ---
  37 ;
  38 ; On entry:     R0 == key number, from Straylight extended keymap
  39 ;               R1 == 0 => return full shortcuts (for e.g. writable icons)
  40 ;                     1 => return abbreviated shortcuts (for e.g. menus)
  41 ;
  42 ; On exit:      CS if key number was recognised, and
  43 ;                 R0 == pointer to short cut string
  44 ;               else CC and
  45 ;                 R0 corrupted
  46 ;
  47 ; Use:          Translates a key number into a string suitable for
  48 ;               displaying to a user, and returns a pointer to the
  49 ;               translated string.
  50
  51                 IMPORT  keyString
  52
  53                 ]
  54
  55 ;----- That's all, folks ----------------------------------------------------
  56
  57                 END