rom/intuition/helpcontrol.c

   1 /*
   2     Copyright © 1995-2013, 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 be
  25         changed for all members of the same help-group to make
  26         multiple-windows apps behave well.
  27
  28     INPUTS
  29         window - The window to affect. All windows of the same help-group
  30             will be affected as well.
  31         flags - HC_GADGETHELP or zero for turning help on or off.
  32
  33     RESULT
  34         None.
  35
  36     NOTES
  37         The WA_HelpGroup and WA_HelpGroupWindow tags are relevant to this
  38         function.
  39
  40     EXAMPLE
  41
  42     BUGS
  43
  44     SEE ALSO
  45         OpenWindowTagList()
  46
  47     INTERNALS
  48
  49 *****************************************************************************/
  50 {
  51     AROS_LIBFUNC_INIT
  52
  53     ULONG ilock;
  54     ULONG clearmask = 0;
  55     ULONG setmask = 0;
  56
  57     ASSERT_VALID_PTR(window);
  58
  59     SANITY_CHECK(window)
  60
  61     ilock = LockIBase(0);
  62
  63     if (flags & HC_GADGETHELP)
  64     {
  65         setmask |= HELPF_GADGETHELP;
  66     }
  67     else
  68     {
  69         clearmask |= HELPF_GADGETHELP;
  70     }
  71
  72 #define CHANGEHELPFLAGS(x) ( IW(x)->helpflags = (IW(x)->helpflags | setmask) & ~clearmask )
  73
  74     CHANGEHELPFLAGS(window);
  75
  76     if (IW(window)->helpflags & HELPF_ISHELPGROUP)
  77     {
  78         struct Screen *scr = IntuitionBase->FirstScreen;
  79
  80         for(; scr; scr = scr->NextScreen)
  81         {
  82             struct Window *win = scr->FirstWindow;
  83
  84             for(; win; win = win->NextWindow)
  85             {
  86                 if ( (IW(win)->helpflags & HELPF_ISHELPGROUP) &&
  87                         (IW(win)->helpgroup == IW(window)->helpgroup) )
  88                 {
  89                     CHANGEHELPFLAGS(win);
  90                 }
  91             }
  92         }
  93     }
  94
  95     UnlockIBase(ilock);
  96
  97     AROS_LIBFUNC_EXIT
  98 } /* HelpControl */