rom/intuition/helpcontrol.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5 */
   6
   7 #include "intuition_intern.h"
   8
   9 /*****************************************************************************
  10
  11     NAME */
  12 #include <proto/intuition.h>
  13
  14     AROS_LH2(void, HelpControl,
  15
  16 /*  SYNOPSIS */
  17          AROS_LHA(struct Window *, window, A0),
  18          AROS_LHA(ULONG          , flags, D0),
  19
  20 /*  LOCATION */
  21          struct IntuitionBase *, IntuitionBase, 138, Intuition)
  22
  23 /*  FUNCTION
  24     Turn on or off Gadget-Help for your window. Gadget-Help will also
  25     be changed for all members of the same help-group to make
  26     multiple-windows apps to behave well.
  27
  28     INPUTS
  29     window - The window to affect. All windows of the same help-goup will
  30         be affected as well.
  31     flags - HC_GADGETHELP or zero for turning help on or off.
  32
  33     RESULT
  34     None. Toggles gadget-help of one or more windows to on or off.
  35
  36     NOTES
  37
  38     EXAMPLE
  39
  40     BUGS
  41
  42     SEE ALSO
  43     WA_HelpGroup
  44
  45     INTERNALS
  46
  47 *****************************************************************************/
  48 {
  49     AROS_LIBFUNC_INIT
  50
  51     ULONG ilock;
  52     ULONG clearmask = 0;
  53     ULONG setmask = 0;
  54
  55     ASSERT_VALID_PTR(window);
  56
  57     SANITY_CHECK(window)
  58
  59     ilock = LockIBase(0);
  60
  61     if (flags & HC_GADGETHELP)
  62     {
  63         setmask |= HELPF_GADGETHELP;
  64     }
  65     else
  66     {
  67         clearmask |= HELPF_GADGETHELP;
  68     }
  69
  70 #define CHANGEHELPFLAGS(x) ( IW(x)->helpflags = (IW(x)->helpflags | setmask) & ~clearmask )
  71
  72     CHANGEHELPFLAGS(window);
  73
  74     if (IW(window)->helpflags & HELPF_ISHELPGROUP)
  75     {
  76         struct Screen *scr = IntuitionBase->FirstScreen;
  77
  78         for(; scr; scr = scr->NextScreen)
  79         {
  80             struct Window *win = scr->FirstWindow;
  81
  82             for(; win; win = win->NextWindow)
  83             {
  84                 if ( (IW(win)->helpflags & HELPF_ISHELPGROUP) &&
  85                         (IW(win)->helpgroup == IW(window)->helpgroup) )
  86                 {
  87                     CHANGEHELPFLAGS(win);
  88                 }
  89             }
  90         }
  91     }
  92
  93     UnlockIBase(ilock);
  94
  95     AROS_LIBFUNC_EXIT
  96 } /* HelpControl */