rom/intuition/screentoback.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     Move a screen behind all other screens.
   7 */
   8
   9 #include "intuition_intern.h"
  10
  11 /*****************************************************************************
  12
  13     NAME */
  14 #include <proto/intuition.h>
  15
  16         AROS_LH1(void, ScreenToBack,
  17
  18 /*  SYNOPSIS */
  19         AROS_LHA(struct Screen *, screen, A0),
  20
  21 /*  LOCATION */
  22         struct IntuitionBase *, IntuitionBase, 41, Intuition)
  23
  24 /*  FUNCTION
  25         Move a screen behind all other screens. If the screen is in a
  26         group, the screen will be moved behind all other screens in the
  27         group only. If the screen is the parent of a group, the whole
  28         group will be moved in the back.
  29
  30     INPUTS
  31         screen - Move this screen.
  32
  33     RESULT
  34         You will see the screen move behind all other screens. If some
  35         screen before this screen occupies the whole display, then it
  36         will disappear completely. If all other screens occupy only part
  37         of the display, the screen will appear behind the screens.
  38
  39     NOTES
  40
  41     EXAMPLE
  42
  43     BUGS
  44
  45     SEE ALSO
  46         ScreenToFront(), ScreenDepth()
  47
  48     INTERNALS
  49
  50 *****************************************************************************/
  51 {
  52     AROS_LIBFUNC_INIT
  53
  54     ScreenDepth ( screen, SDEPTH_TOBACK, NULL );
  55
  56     AROS_LIBFUNC_EXIT
  57 } /* ScreenToBack */