home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #6 / amigamamagazinepolishissue1998.iso / coders / arexx / moos / docs / english / rexx_misc.doc < prev    next >
Text File  |  1997-03-25  |  8KB  |  347 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. --background--
  6. rexx_misc.library/GetMouse
  7. rexx_misc.library/GetUniqueID
  8. rexx_misc.library/Phonemes
  9. rexx_misc.library/ReadClip
  10. rexx_misc.library/Speak
  11. rexx_misc.library/WBInfo
  12. rexx_misc.library/WriteClip
  13.  
  14.  
  15. --background--                                                  --background--
  16.  
  17.  $(C): (1996, Rocco Coluccelli, Bologna)
  18.  $VER: rexx_misc.library 37.1 (24.03.97)
  19.  
  20.     rexx_misc.library
  21.  
  22.     This sub-library of the rexxMOOS.library include functions from
  23.     several Amiga system libraries and devices.
  24.  
  25.         GetUniqueID()
  26.         Phonemes()
  27.         ReadClip()
  28.         Speak()
  29.         WBInfo()
  30.         WriteClip()
  31.  
  32.     NOTES
  33.  
  34.         Is part of the MOOS package.
  35.  
  36.     TODO
  37.  
  38.     BUGS
  39.  
  40. rexx_misc.library/GetMouse                          rexx_misc.library/GetMouse
  41.  
  42.     NAME
  43.  
  44.         GetMouse -- Read the mouse pointer position.
  45.  
  46.     SYNOPSIS
  47.  
  48.         ret = GetMouse(options)
  49.  
  50.     FUNCTION
  51.  
  52.         The function returns the position of the mouse pointer into the
  53.         current screen.
  54.  
  55.     INPUTS
  56.  
  57.         options - "PosX=X/S,PosY=Y/S"
  58.  
  59.             "PosX" - The result value is the "x" coordinate.
  60.  
  61.             "PosY" - The result value is the "y" coordinate.
  62.  
  63.     RESULT
  64.  
  65.         The returned value depends on the options switchs.
  66.  
  67.     EXAMPLE
  68.  
  69.         SAY GetMouse('X')
  70.  
  71.     SEE ALSO
  72.  
  73.         intuition/intuitionbase.h
  74.  
  75. rexx_misc.library/GetUniqueID                    rexx_misc.library/GetUniqueID
  76.  
  77.     NAME
  78.  
  79.         GetUniqueID -- return a relatively unique number. (V39)
  80.  
  81.     SYNOPSIS
  82.  
  83.         id = GetUniqueID()
  84.  
  85.     FUNCTION
  86.  
  87.         Returns a unique value each time it is called. This is useful for
  88.         things that need unique ID such as the GadgetHelp ID, etc. Note
  89.         that this is only unique for 4,294,967,295 calls to this function.
  90.         Under normal use this is not a problem. This function is safe in
  91.         interrupts.
  92.  
  93.     INPUTS
  94.  
  95.     RESULT
  96.  
  97.         An unsigned long integer.
  98.  
  99.     EXAMPLE
  100.  
  101.         temp = "t:tmp." || GetUniqueID()
  102.         SAY temp
  103.  
  104.     NOTES
  105.  
  106.         This function is only available from the version 39 of the
  107.         utility.library. On systems using older versions of the library
  108.         the returned value... (NOT YET IMPLEMENTED).
  109.  
  110.     SEE ALSO
  111.  
  112.         utility.library/GetUniqueID()
  113.  
  114. rexx_misc.library/Phonemes                          rexx_misc.library/Phonemes
  115.  
  116.     NAME
  117.  
  118.         Phonemes -- Convert a string into narrator device phonemes.
  119.  
  120.     SYNOPSIS
  121.  
  122.         str = Phonemes(string)
  123.  
  124.     FUNCTION
  125.  
  126.         This function converts the given text string into a string of
  127.         phonetic codes suitable as input to the narrator device.
  128.  
  129.     INPUTS
  130.  
  131.         string - Using the version 37 of the translator.library the
  132.                  given string might be only an english text string.
  133.                  The new translator.library (V42) accepts string of
  134.                  any language.
  135.  
  136.     RESULT
  137.  
  138.         str - The phonetic representation of the given string. In case
  139.               of errors an empty string will be returned.
  140.  
  141.     EXAMPLE
  142.  
  143.         SAY Phonemes("Do you like MOOS?")
  144.  
  145.     BUGS
  146.  
  147.         There's a dangerous bug into the new translator.library (V42).
  148.         Its Translate() function goes over the buffer limits and this
  149.         has required a run-around: the allocated buffer is three times
  150.         the dimension of the given text string.
  151.  
  152.     SEE ALSO
  153.  
  154.         translator.library/Translate(), rexx_misc.library/Speak()
  155.  
  156. rexx_misc.library/ReadClip                          rexx_misc.library/ReadClip
  157.  
  158.     NAME
  159.  
  160.         ReadClip -- Read text stored into the clipboard.
  161.  
  162.     SYNOPSIS
  163.  
  164.         str = ReadClip(options)
  165.  
  166.     FUNCTION
  167.  
  168.         This function read the FTXT chunk of any clip stored into the
  169.         clipboards at a given unit number.
  170.  
  171.     INPUTS
  172.  
  173.         options - "Unit/N"
  174.  
  175.             "Unit" - Any number into the range 0-255 is valid.
  176.                      (default is 0)
  177.  
  178.     RESULT
  179.  
  180.         str - If the clip entry selected using "Unit" has a valid IFF
  181.               FORM..FTXT structure then the stored text is returned
  182.               otherwise an empty string.
  183.  
  184.     EXAMPLE
  185.  
  186.         SAY ReadClip()
  187.  
  188.     SEE ALSO
  189.  
  190.         clipboard.device/CMD_READ, rexx_misc.library/WriteClip()
  191.  
  192. rexx_misc.library/Speak                                rexx_misc.library/Speak
  193.  
  194.     NAME
  195.  
  196.         Speak -- Speaks using the narrator device. (V37)
  197.  
  198.     SYNOPSIS
  199.  
  200.         success = Speak(string,options)
  201.  
  202.     FUNCTION
  203.  
  204.         This function opens the narrator.device to say the given text
  205.         string (or its phoneme representation).
  206.  
  207.     INPUTS
  208.  
  209.         string  - A normal text string, or its phoneme representation.
  210.  
  211.         options - "Phoneme=PH/S,Rate/K/N,Pitch/K/N,Freq/K/N,Vol/K/N,
  212.                    Female/S,Robot/S,Nat/S,Enth/K/N,Pert/K/N"
  213.  
  214.             "Phoneme" - Use this switch to signal that the given string
  215.                         has already been translated into its phonetic
  216.                         representation. By default the function converts
  217.                         the given text using the translator.library.
  218.  
  219.             "Rate"    - Speaking rate, words per minute, can vary from
  220.                         40 up to 400 (default 150).
  221.  
  222.             "Pitch"   - The voice pitch, can vary from 65 up to 320
  223.                         (default 110).
  224.  
  225.             "Freq"    - The minimum accepted value for the sampling
  226.                         frequency is 5000 (Hz) up to a maximum of
  227.                         28000 (default 22200).
  228.  
  229.             "Vol"     - The volume may vary from 0 up to 64 (default 64).
  230.  
  231.             "Female"  - The default vocal tract is "Male", but it can be
  232.                         changed to "Female" using this switch.
  233.  
  234.             "Robot"   - This switch select a monotone pitch contours.
  235.  
  236.             "Nat"     - This switch select the natural pitch contours.
  237.  
  238.             "Enth"    - The default value for the "enthusiasm" is 32, but
  239.                         it may vary from 0 up to 255.
  240.  
  241.             "Pert"    - To add a "perturbation" to the generated voice
  242.                         can be specified a value from 0 up to 255
  243.                         (default 0).
  244.  
  245.     RESULT
  246.  
  247.         success - boolean value (1 mean all done, ok).
  248.  
  249.     EXAMPLE
  250.  
  251.         opt = 'freq 23500 enth 255 rate 80'
  252.         CALL Speak("Daddy? What does 'formatting C:' mean?",opt)
  253.  
  254.     NOTES
  255.  
  256.         This function requires the version 37 of the narrator.device.
  257.  
  258.     SEE ALSO
  259.  
  260.         rexx_misc.library/Phonemes(), narrator.device
  261.  
  262. rexx_misc.library/WBInfo                              rexx_misc.library/WBInfo
  263.  
  264.     NAME
  265.  
  266.         WBInfo -- Bring up the Information requester. (V39)
  267.  
  268.     SYNOPSIS
  269.  
  270.         success = WBInfo(pathname)
  271.  
  272.     FUNCTION
  273.  
  274.         This is the function that Workbench calls to bring up the Icon
  275.         Information requester. External applications may also call this
  276.         requester.
  277.  
  278.     INPUTS
  279.  
  280.         pathname - The icon path name (without ".info"). The function is
  281.                    able to bring up the information requester for every
  282.                    file, directory, device, including "#?.info", but may
  283.                    be really useful only on those provided with an icon.
  284.  
  285.     RESULT
  286.  
  287.         success - boolean value (1 mean all done, ok).
  288.  
  289.     EXAMPLE
  290.  
  291.         CALL WBInfo("SYS:System/Format")
  292.  
  293.     NOTES
  294.  
  295.         This function is only available from the version 39 of the
  296.         wb.library.
  297.  
  298.     BUGS
  299.  
  300.         Into this release, the function returns "0" only if the given
  301.         path doesn't exist, no matter if the requester has been opened.
  302.  
  303.     SEE ALSO
  304.  
  305.         wb.library/WBInfo()
  306.  
  307. rexx_misc.library/WriteClip                        rexx_misc.library/WriteClip
  308.  
  309.     NAME
  310.  
  311.         WriteClip -- Write text into the clipboard.
  312.  
  313.     SYNOPSIS
  314.  
  315.         success = WriteClip(text,options)
  316.  
  317.     FUNCTION
  318.  
  319.         This function write the given "text" into any clipboard unit.
  320.  
  321.     INPUTS
  322.  
  323.         text    - It might be a normal block of text, but the function
  324.                   doesn't check which kind of data will be really stored
  325.                   into the clip.
  326.  
  327.         options - "Unit/N"
  328.  
  329.             "Unit" - Any number into the range 0-255 is valid.
  330.                      (default is 0)
  331.  
  332.     RESULT
  333.  
  334.         success - boolean value (1 mean all done, ok).
  335.  
  336.     EXAMPLE
  337.  
  338.         SAY WriteClip("The text for the clip...")
  339.  
  340.     BUGS
  341.  
  342.     SEE ALSO
  343.  
  344.         clipboard.device/CMD_WRITE, rexx_misc.library/ReadClip()
  345.  
  346.  
  347.