home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #6 / amigamamagazinepolishissue1998.iso / coders / arexx / moos / docs / english / rexx_intuition.doc < prev    next >
Text File  |  1997-03-25  |  5KB  |  223 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. --background--
  6. rexx_intuition.library/Beep
  7. rexx_intuition.library/GetPubScreen
  8. rexx_intuition.library/SetPubScreen
  9. rexx_intuition.library/WBenchScreen
  10.  
  11.  
  12. --background--                                                  --background--
  13.  
  14.  $(C): (1996, Rocco Coluccelli, Bologna)
  15.  $VER: rexx_intuition.library 37.3 (15.03.97)
  16.  
  17.     rexx_intuition.library
  18.  
  19.     This sub-library of the rexxMOOS.library let ARexx programmers
  20.     use some function from the intuition.library.
  21.  
  22.         Beep()
  23.         GetPubScreen()
  24.         SetPubScreen()
  25.         WBenchScreen()
  26.  
  27.     NOTES
  28.  
  29.         Is part of the MOOS package.
  30.  
  31.     TODO
  32.  
  33.     BUGS
  34.  
  35. rexx_intuition.library/Beep                        rexx_intuition.library/Beep
  36.  
  37.     NAME
  38.  
  39.         Beep -- Flash the fronmost or all screen.
  40.  
  41.     SYNOPSIS
  42.  
  43.         Beep(options)
  44.  
  45.     FUNCTION
  46.  
  47.         "Beeps" the video display by flashing the background color of
  48.         the frontmost screen. Use this function when need to know of
  49.         an event that is not serious enough to require the use of a
  50.         requester.
  51.  
  52.     INPUTS
  53.  
  54.         options - "All/S"
  55.  
  56.             All - Flash all opened screens.
  57.  
  58.     RESULT
  59.  
  60.         A flash...
  61.  
  62.     EXAMPLE
  63.  
  64.         CALL Beep()
  65.  
  66.     NOTES
  67.  
  68.     SEE ALSO
  69.  
  70.         intuition.library/DisplayBeep()
  71.  
  72. rexx_intuition.library/GetPubScreen        rexx_intuition.library/GetPubScreen
  73.  
  74.     NAME
  75.  
  76.         GetPubScreen -- Get information about pubscreens.
  77.  
  78.     SYNOPSIS
  79.  
  80.         pubname = GetPubScreen(options)
  81.  
  82.     FUNCTION
  83.  
  84.         This function can retreive information about public screens
  85.         opened in the system, or frontmost public screen's name.
  86.  
  87.     INPUTS
  88.  
  89.         options - "Outstem,Default=Def/S"
  90.  
  91.             "Outstem" - The function can fill out any given stem with a
  92.                         list of all public screens opened in the system:
  93.  
  94.                             <stem.>n
  95.                                 Nth public screen's name.
  96.  
  97.                         This function supports "#" and "*" stems types
  98.                         (read the rexxMOOS documentation for details).
  99.  
  100.             "Default" - Current default public screen's name will be
  101.                         returned.
  102.  
  103.     RESULT
  104.  
  105.         In case of errors the function returns an empty string. Without
  106.         specifying the optional switch "Default" will be returned the
  107.         name of the frontmost public screen.
  108.  
  109.     EXAMPLE
  110.  
  111.         SAY GetPubScreen()
  112.  
  113.     NOTES
  114.  
  115.     SEE ALSO
  116.  
  117.         intuition.library/GetDefaultPubScreen(),
  118.         intuition.library/LockPubScreenList()
  119.  
  120. rexx_intuition.library/SetPubScreen        rexx_intuition.library/SetPubScreen
  121.  
  122.     NAME
  123.  
  124.         SetPubScreen -- Set any data about pubscreens.
  125.  
  126.     SYNOPSIS
  127.  
  128.         ret = SetPubScreen(options)
  129.  
  130.     FUNCTION
  131.  
  132.         Use this function to set the default public screen and/or the
  133.         new modes (Shanghai,...).
  134.  
  135.     INPUTS
  136.  
  137.         options - "PubName,Default=Def/S,Shanghai=Sh/S,
  138.                   PopPubScreen=Pop/S"
  139.  
  140.             "PubName" - A public screen name. If not provided the
  141.                         "Workbench" will be used.
  142.  
  143.             "Default" - The given "PubName" become the new default
  144.                         public screen.
  145.  
  146.             "Modes"   - Sets GLOBAL Intuition public screen modes:
  147.  
  148.                             "Shanghai=Sh"
  149.                                 Workbench windows are to be opened on
  150.                                 the default public screen.
  151.  
  152.                             "PopPubScreen=Pop"
  153.                                 When a visitor window is opened, the
  154.                                 public screen it opens on is to be
  155.                                 brought to the front.
  156.  
  157.                         Setting new modes, for all public screens, lets
  158.                         the function returns the old ones as result.
  159.  
  160.     RESULT
  161.  
  162.         Depends on the given options.
  163.  
  164.     EXAMPLE
  165.  
  166.         SAY SetPubScreen('Modes Sh')
  167.  
  168.     NOTES
  169.  
  170.     SEE ALSO
  171.  
  172.         intuition.library/SetDefaultPubScreen(),
  173.         intuition.library/SetPubScreenModes()
  174.  
  175. rexx_intuition.library/WBenchScreen        rexx_intuition.library/WBenchScreen
  176.  
  177.     NAME
  178.  
  179.         WBenchScreen -- Close the WorkBench screen.
  180.  
  181.     SYNOPSIS
  182.  
  183.         success = WBenchScreen()
  184.  
  185.     FUNCTION
  186.  
  187.         This function attempts to close the WorkBench screen.
  188.  
  189.     INPUTS
  190.  
  191.         options - "Close=C/S,Open=O/S,ToBack=B/S,ToFront=F/S"
  192.  
  193.             "Close"   - The function attempts to close the Workbench
  194.                         screen.
  195.  
  196.             "Open"    - Reopen the Workbench screen.
  197.  
  198.             "ToBack"  - Send the Workbench screen to back, if it is
  199.                         currently opened.
  200.  
  201.             "ToFront" - Make the Workbench's screen the frontmost, if
  202.                         it's opened.
  203.  
  204.     RESULT
  205.  
  206.         success - boolean value (1 mean all done, ok).
  207.  
  208.     EXAMPLE
  209.  
  210.         IF WBenchScreen('C') THEN
  211.             SAY "WorkBench screen closed..."
  212.  
  213.     NOTES
  214.  
  215.     SEE ALSO
  216.  
  217.         intuition.library/CloseWorkBench(), 
  218.         intuition.library/OpenWorkBench(),
  219.         intuition.library/WBenchToBack(),
  220.         intuition.library/WBenchToFront()
  221.  
  222.  
  223.