home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD5.iso / workbench / libs / rexmooslib.lha / MOOS / Docs / english / rexx_intuition.doc < prev    next >
Encoding:
Text File  |  1997-02-03  |  6.3 KB  |  291 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. --background--
  6. rexx_intuition.library/Beep
  7. rexx_intuition.library/GetPubScreen
  8. rexx_intuition.library/ScreenToBack
  9. rexx_intuition.library/ScreenToFront
  10. rexx_intuition.library/SetPubScreen
  11. rexx_intuition.library/WBenchScreen
  12.  
  13.  
  14. --background--                                                  --background--
  15.  
  16.  $(C): (1996, Rocco Coluccelli, Bologna)
  17.  $VER: rexx_intuition.library 37.0 (31.01.97)
  18.  
  19.     rexx_intuition.library
  20.  
  21.     This sub-library of the rexxMOOS.library let ARexx programmers
  22.     use some function from the intuition.library.
  23.  
  24.         Beep()
  25.         GetPubScreen()
  26.         SetPubScreen()
  27.         WBenchScreen()
  28.  
  29.     NOTES
  30.  
  31.         Is part of the MOOS package.
  32.  
  33.     TODO
  34.  
  35.     BUGS
  36.  
  37. rexx_intuition.library/Beep                        rexx_intuition.library/Beep
  38.  
  39.     NAME
  40.  
  41.         Beep -- Flash the fronmost or all screen.
  42.  
  43.     SYNOPSIS
  44.  
  45.         Beep(options)
  46.  
  47.     FUNCTION
  48.  
  49.         "Beeps" the video display by flashing the background color of
  50.         the frontmost screen. Use this function when need to know of
  51.         an event that is not serious enough to require the use of a
  52.         requester.
  53.  
  54.     INPUTS
  55.  
  56.         options - "All/S"
  57.  
  58.             All - Flash all opened screens.
  59.  
  60.     RESULT
  61.  
  62.         A flash...
  63.  
  64.     EXAMPLE
  65.  
  66.         CALL Beep()
  67.  
  68.     NOTES
  69.  
  70.     SEE ALSO
  71.  
  72.         intuition.library/DisplayBeep()
  73.  
  74. rexx_intuition.library/GetPubScreen        rexx_intuition.library/GetPubScreen
  75.  
  76.     NAME
  77.  
  78.         GetPubScreen -- Get information about pubscreens.
  79.  
  80.     SYNOPSIS
  81.  
  82.         pubname = GetPubScreen(options)
  83.  
  84.     FUNCTION
  85.  
  86.         This function can retreive information about public screens
  87.         opened in the system, or frontmost public screen's name.
  88.  
  89.     INPUTS
  90.  
  91.         options - "Outstem,Default=Def/S"
  92.  
  93.             "Outstem" - The function can fill out any given stem with a
  94.                         list of all public screens opened in the system:
  95.  
  96.                             <stem.>count
  97.                                 The number of screen found.
  98.  
  99.                             <stem.>N
  100.                                 Nth public screen's name.
  101.  
  102.             "Default" - Current default public screen's name will be
  103.                         returned.
  104.  
  105.     RESULT
  106.  
  107.         In case of errors the function returns an empty string. Without
  108.         specifying the optional switch "Default" will be returned the
  109.         name of the frontmost public screen.
  110.  
  111.     EXAMPLE
  112.  
  113.         SAY GetPubScreen()
  114.  
  115.     NOTES
  116.  
  117.     SEE ALSO
  118.  
  119.         intuition.library/GetDefaultPubScreen(),
  120.         intuition.library/LockPubScreenList()
  121.  
  122. rexx_intuition.library/ScreenToBack        rexx_intuition.library/ScreenToBack
  123.  
  124.     NAME
  125.  
  126.         ScreenToBack -- Send a screen to the back of the display.
  127.  
  128.     SYNOPSIS
  129.  
  130.         success = ScreenToBack(screen)
  131.  
  132.     FUNCTION
  133.  
  134.         Sends the specified screen to the back of the display.
  135.  
  136.     INPUTS
  137.  
  138.         screen - The screen to send back. If not specified the function
  139.                  will send back the WorkBench screen.
  140.  
  141.     RESULT
  142.  
  143.         success - boolean value (1 mean all done, ok).
  144.  
  145.     EXAMPLE
  146.  
  147.         SAY ScreenToBack()
  148.  
  149.     NOTES
  150.  
  151.     SEE ALSO
  152.  
  153.         intuition.library/ScreenToBack(),
  154.         rexx_intuition.library/ScreenToFront()
  155.  
  156. rexx_intuition.library/ScreenToFront      rexx_intuition.library/ScreenToFront
  157.  
  158.     NAME
  159.  
  160.         ScreenToFront -- Make the specified screen the frontmost.
  161.  
  162.     SYNOPSIS
  163.  
  164.         success = ScreenToFront(screen)
  165.  
  166.     FUNCTION
  167.  
  168.         Brings the specified Screen to the front of the display.
  169.  
  170.     INPUTS
  171.  
  172.         screen - The screen to bring to front. If not specified the
  173.                  function will bring the WorkBench screen to front.
  174.  
  175.     RESULT
  176.  
  177.     EXAMPLE
  178.  
  179.         CALL ScreenToFront()
  180.  
  181.     NOTES
  182.  
  183.     SEE ALSO
  184.  
  185.         intuition.library/ScreenToFront(),
  186.         rexx_intuition.library/ScreenToBack()
  187.  
  188. rexx_intuition.library/SetPubScreen        rexx_intuition.library/SetPubScreen
  189.  
  190.     NAME
  191.  
  192.         SetPubScreen -- Set any datas about pubscreens.
  193.  
  194.     SYNOPSIS
  195.  
  196.         ret = SetPubScreen(options)
  197.  
  198.     FUNCTION
  199.  
  200.         Use this function to set the default public screen and/or the
  201.         new modes (Shanghai,...).
  202.  
  203.     INPUTS
  204.  
  205.         options - "PubName,Default=Def/S,Shanghai=Sh/S,
  206.                   PopPubScreen=Pop/S"
  207.  
  208.             "PubName" - A public screen name. If not provided the
  209.                         "Workbench" will be used.
  210.  
  211.             "Default" - The given "PubName" become the new default
  212.                         public screen.
  213.  
  214.             "Modes"   - Sets GLOBAL Intuition public screen modes:
  215.  
  216.                             "Shanghai=Sh"
  217.                                 Workbench windows are to be opened on
  218.                                 the default public screen.
  219.  
  220.                             "PopPubScreen=Pop"
  221.                                 When a visitor window is opened, the
  222.                                 public screen it opens on is to be
  223.                                 brought to the front.
  224.  
  225.                         Setting new modes, for all public screens, lets
  226.                         the function returns the old ones as result.
  227.  
  228.     RESULT
  229.  
  230.         Depends on the given options.
  231.  
  232.     EXAMPLE
  233.  
  234.         SAY SetPubScreen('Modes Sh')
  235.  
  236.     NOTES
  237.  
  238.     SEE ALSO
  239.  
  240.         intuition.library/SetDefaultPubScreen(),
  241.         intuition.library/SetPubScreenModes()
  242.  
  243. rexx_intuition.library/WBenchScreen        rexx_intuition.library/WBenchScreen
  244.  
  245.     NAME
  246.  
  247.         WBenchScreen -- Close the WorkBench screen.
  248.  
  249.     SYNOPSIS
  250.  
  251.         success = WBenchScreen()
  252.  
  253.     FUNCTION
  254.  
  255.         This function attempts to close the WorkBench screen.
  256.  
  257.     INPUTS
  258.  
  259.         options - "Close=C/S,Open=O/S,ToBack=B/S,ToFront=F/S"
  260.  
  261.             "Close"   - The function attempts to close the Workbench
  262.                         screen.
  263.  
  264.             "Open"    - Reopen the Workbench screen.
  265.  
  266.             "ToBack"  - Send the Workbench screen to back, if it is
  267.                         currently opened.
  268.  
  269.             "ToFront" - Make the Workbench's screen the frontmost, if
  270.                         it's opened.
  271.  
  272.     RESULT
  273.  
  274.         success - boolean value (1 mean all done, ok).
  275.  
  276.     EXAMPLE
  277.  
  278.         IF WBenchScreen('C') THEN
  279.             SAY "WorkBench screen closed..."
  280.  
  281.     NOTES
  282.  
  283.     SEE ALSO
  284.  
  285.         intuition.library/CloseWorkBench(), 
  286.         intuition.library/OpenWorkBench(),
  287.         intuition.library/WBenchToBack(),
  288.         intuition.library/WBenchToFront()
  289.  
  290.  
  291.