mdw@git.distorted.org.uk Git - ssr/blob - StraySrc/Libraries/Core/TearSupt/h/tearSupt

   1 /*
   2  * tearSupt.h
   3  *
   4  * Tearoff support code
   5  *
   6  * © 1994-1998 Straylight
   7  */
   8
   9 /*----- Licensing note ----------------------------------------------------*
  10  *
  11  * This file is part of Straylight's Tearoff Menu System (TMS), but it's
  12  * distributed with Straylight's core libraries (corelib).
  13  *
  14  * TMS is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2, or (at your option)
  17  * any later version.
  18  *
  19  * TMS is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with Corelib.  If not, write to the Free Software Foundation,
  26  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 #ifndef __tearSupport_h
  30 #define __tearSupport_h
  31
  32 /* --- tearSupport_init --- *
  33  *
  34  * Arguments:   --
  35  *
  36  * Returns:     --
  37  *
  38  * Use:         Initialises tearSupport
  39  */
  40
  41 void tearSupport_init(void);
  42
  43 /* --- tearSupport_opened --- *
  44  *
  45  * Arguments:   task == task handle of task which opened tearoff menu
  46  *
  47  * Returns:     --
  48  *
  49  * Use:         Informs TearSupport that a transient tearoff menu has been
  50  *              opened, and which task owns the menu.
  51  */
  52
  53 void tearSupport_opened(int task);
  54
  55 /* --- tearSupport_closed --- *
  56  *
  57  * Arguments:   --
  58  *
  59  * Returns:     --
  60  *
  61  * Use:         Informs TearSupport that the transient tearoff menu has been
  62  *              closed, and that support is no longer required for it.
  63  */
  64
  65 void tearSupport_closed(void);
  66
  67 /* --- tearSupport_switch ---
  68  *
  69  * Arguments:   sw == 1 to disable, 0 to enable trapping
  70  *
  71  * Returns:     --
  72  *
  73  * Use:         Enables or disables trapping of Wimp_CreateMenu while a
  74  *              transient tearoff menu is open.  This is intended to allow
  75  *              use of Wimp_CreateMenu by the transient tearoff owner while
  76  *              a transient tearoff is open (e.g. to close Wimp menus).
  77  */
  78
  79 void tearSupport_switch(int sw);
  80
  81 #endif