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

   1 /*
   2  * keyString.h
   3  *
   4  * [Generated from keyString, 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 __keyString_h
  15 #define __keyString_h
  16
  17 #ifndef __sapphire_h
  18   #include "sapphire.h"
  19 #endif
  20
  21 /*----- Overview ----------------------------------------------------------*
  22  *
  23  * Functions provided:
  24  *
  25  *  keyString
  26  */
  27
  28 /* --- keyString --- *
  29  *
  30  * On entry:    R0 == key number, from Straylight extended keymap
  31  *              R1 == 0 => return full shortcuts (for e.g. writable icons)
  32  *                    1 => return abbreviated shortcuts (for e.g. menus)
  33  *
  34  * On exit:     CS if key number was recognised, and
  35  *                R0 == pointer to short cut string
  36  *              else CC and
  37  *                R0 corrupted
  38  *
  39  * Use:         Translates a key number into a string suitable for
  40  *              displaying to a user, and returns a pointer to the
  41  *              translated string.
  42  */
  43
  44 extern routine keyString;
  45
  46 /*----- That's all, folks -------------------------------------------------*/
  47
  48 #endif