Initial revision

[ssr] / StraySrc / Libraries / Sapphire / csapph / h / keyString

/*
 * keyString.h
 *
 * [Generated from keyString, 25 September 1996]
 */

#if !defined(__CC_NORCROFT) || !defined(__arm)
  #error You must use the Norcroft ARM Compiler for Sapphire programs
#endif

#pragma include_only_once
#pragma force_top_level

#ifndef __keyString_h
#define __keyString_h

#ifndef __sapphire_h
  #include "sapphire.h"
#endif

/*----- Overview ----------------------------------------------------------*
 *
 * Functions provided:
 *
 *  keyString
 */

/* --- keyString --- *
 *
 * On entry:	R0 == key number, from Straylight extended keymap
 *		R1 == 0 => return full shortcuts (for e.g. writable icons)
 *		      1 => return abbreviated shortcuts (for e.g. menus)
 *
 * On exit:	CS if key number was recognised, and
 *		  R0 == pointer to short cut string
 *		else CC and
 *		  R0 corrupted
 *
 * Use:		Translates a key number into a string suitable for
 *		displaying to a user, and returns a pointer to the
 *		translated string.
 */

extern routine keyString;

/*----- That's all, folks -------------------------------------------------*/

#endif