Initial revision

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

/*
 * tspr.h
 *
 * [Generated from tspr, 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 __tspr_h
#define __tspr_h

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

/*----- Overview ----------------------------------------------------------*
 *
 * Functions provided:
 *
 *  tspr_getSprAddr
 *  tspr_borderWidths
 *  tspr_adjustBox
 */

/* --- tspr_getSprAddr --- *
 *
 * On entry:	--
 *
 * On exit:	R0 == pointer to tool sprites, or 0 if none
 *
 * Use:		Returns a pointer to the toolsprites. If the user is using
 *		RISC OS 2, or there are no toolsprites defined, then
 *		0 is returned.
 */

extern routine tspr_getSprAddr;

/* --- tspr_borderWidths --- *
 *
 * On entry:	--
 *
 * On exit:	R0 == title bar height
 *		R1 == vertical scroll bar width
 *		R2 == horizontal scroll bar height
 *
 * Use:		Return the width of window tools by looking at the
 *		sprites associated with them, rather than creating
 *		a temporary window.
 */

extern routine tspr_borderWidths;

/* --- tspr_adjustBox --- *
 *
 * On entry:	R1 == pointer to Wimp_OpenWindow block to modify
 *
 * On exit:	Block updated in place
 *
 * Use:		Updates the open block to ensure that the window is opened
 *		on the screen.
 */

extern routine tspr_adjustBox;

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

#endif