;
; tmsMain.sh
;
; The Straylight Tearoff Menu Segment
;
; © 1994-1998 Straylight
;

;----- Licensing note -------------------------------------------------------
;
; This file is part of Straylight's Sapphire library.
;
; Sapphire is free software; you can redistribute it and/or modify
; it under the terms of the GNU General Public License as published by
; the Free Software Foundation; either version 2, or (at your option)
; any later version.
;
; Sapphire is distributed in the hope that it will be useful,
; but WITHOUT ANY WARRANTY; without even the implied warranty of
; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
; GNU General Public License for more details.
;
; You should have received a copy of the GNU General Public License
; along with Sapphire.  If not, write to the Free Software Foundation,
; 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

;----- Overview -------------------------------------------------------------
;
; Functions provided:
;
;  tms__closeMenu
;  tms__updateItem
;  tmsh__subWaiting
;  tmsh__openSub
;  tms__cleanUp
;  tms__wSpace
;  tms__update
;  tms__eventHandler
;  tms_help

; --- tms__closeMenu ---
;
; On entry:	R2 == pointer to menu to close
;		R10 == pointer to the menu we are currently over
;
; On exit:	--
;
; Use:		Closes the menu structure pointed to, and destroys it

		IMPORT	tms__closeMenu

; --- tms__updateItem ---
;
; On entry:	R7 == pointer to the item to highlight
;		R10 == pointer to the menu
;
; On exit:	--
;
; Use:		Forces an update of the textual part of an item.

		IMPORT	tms__updateItem

; --- tmsh__subWaiting ---
;
; On entry:	--
;
; On exit:	CS if we're waiting for a submenu, CC otherwise
;
; Use:		Informs transWin if a submenu is expected.

		IMPORT	tmsh__subWaiting

; --- tmsh__openSub ---
;
; On entry:	R0 == window handle to open
;
; On exit:	--
;
; Use:		Opens the given window as a submenu from a tms menu.

		IMPORT	tmsh__openSub

; --- tms__cleanUp ---
;
; On entry:	R0 == handle idle handler is called with (the menu)
;
; On exit:	--
;
; Use:		Called to clean up the system when the pointer has left
;		a menu.

		IMPORT	tms__cleanUp

; --- tms__update ---
;
; On entry:	R0 == flags (as for doRedraw)
;		R10 == pointer to the menu
;
; On exit:	--
;
; Use:		Updates the entire menu.

		IMPORT	tms__update

; --- tms__eventHandler ---
;
; On entry:	R0 == event, as returned from Wimp_Poll
;		R1 == pointer to the event block
;		R10 == pointer to the menu
;
; On exit:	--
;
; Use:		Deals with the event that has been sent to my window

		IMPORT	tms__eventHandler

; --- tms_help ---
;
; On entry:	R0 == pointer to base message tag
;		R1 == index of menu item
;
; On exit:	--
;
; Use:		Adds a string to the help message found by adding the menu
;		item number to the base message tag.

		IMPORT	tms_help

		IMPORT	tms__wSpace

;----- That's all, folks ----------------------------------------------------

		END