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

   1 ;
   2 ; tms.sh
   3 ;
   4 ; The Straylight Tearoff Menu Segment
   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 ;   tms_create
  32 ;   tms_recreate
  33 ;   tms_help
  34 ;   tms_init
  35
  36 ;---- Functions provided ----------------------------------------------------
  37
  38 ; --- tms_create ---
  39 ;
  40 ; On entry:     R0 == pointer to a menu block
  41 ;               R1 == pointer to event handler for the menu section
  42 ;               R2 == R10 value to pass to the event handler
  43 ;               R3 == R12 value to pass to the event handler
  44 ;
  45 ; On exit:      R0 == tearoff handle for this menu
  46 ;               VS and R0 == pointer to error block if it failed, as normal
  47 ;
  48 ; Use:          Creates a new menu, or adds sections to an existing one.
  49
  50                 IMPORT  tms_create
  51
  52 ; --- tms_recreate ---
  53 ;
  54 ; On entry:     --
  55 ;
  56 ; On exit:      --
  57 ;
  58 ; Use:          Recreates the existing menu structure, making changes where
  59 ;               appropriate.
  60
  61                 IMPORT  tms_recreate
  62
  63 ; --- tms_help ---
  64 ;
  65 ; On entry:     R0 == pointer to base message tag
  66 ;               R1 == index of menu item
  67 ;
  68 ; On exit:      --
  69 ;
  70 ; Use:          Adds a string to the help message found by adding the menu
  71 ;               item number to the base message tag.
  72
  73                 IMPORT  tms_help
  74
  75 ; --- tms_init ---
  76 ;
  77 ; On entry:     --
  78 ;
  79 ; On exit:      --
  80 ;
  81 ; Use:          Initialises the tearoff menu segment
  82
  83                 IMPORT  tms_init
  84
  85 ;----- That's all, folks ----------------------------------------------------
  86
  87         END