rom/intuition/alohaworkbench.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_LH1(void, AlohaWorkbench,
  15
  16 /*  SYNOPSIS */
  17          AROS_LHA(struct MsgPort *, wbmsgport, A0),
  18
  19 /*  LOCATION */
  20          struct IntuitionBase *, IntuitionBase, 67, Intuition)
  21
  22 /*  FUNCTION
  23         The WorkBench program wants to call this function to signal
  24         Intuition that it is active or shutting down.
  25         Intuition then uses the MsgPort to tell the WorkBench to open or
  26         close its windows if the user called OpenWorkbench() or
  27         CloseWorkbench().
  28
  29         When the MsgPort is non-NULL Intuition will send IntuiMessages to
  30         it with the Class field set to WBENCHMESSAGE and Code field set to
  31         either WBENCHOPEN or WBENCHCLOSE. Intuition assumes that when the
  32         WorkBench task replies this messages, it already has opened/closed
  33         its windows.
  34
  35     INPUTS
  36         wbmsgport - The MsgPort of the (initialized) WorkBench task or
  37                     NULL if the task is shutting down.
  38
  39     RESULT
  40         None.
  41
  42     NOTES
  43         This function is obsolete and should not be used directly by the
  44         Workbench Application. Use workbench.library/RegisterWorkbench()
  45         instead!
  46
  47     EXAMPLE
  48
  49     BUGS
  50
  51     SEE ALSO
  52         workbench.library/RegisterWorkbench()
  53
  54     INTERNALS
  55
  56     HISTORY
  57
  58 *****************************************************************************/
  59 {
  60     AROS_LIBFUNC_INIT
  61
  62     /* Save MsgPort into private IntuitionBase */
  63     DEBUG_ALOHAWORKBENCH(dprintf("AlohaWorkbench: MsgPort %p\n",
  64                      wbmsgport));
  65     GetPrivIBase(IntuitionBase)->WorkBenchMP = wbmsgport;
  66
  67     AROS_LIBFUNC_EXIT
  68 } /* AlohaWorkbench */