home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #6 / amigamamagazinepolishissue1998.iso / coders / arexx / moos / docs / english / rexx_reqtools.doc < prev    next >
Text File  |  1997-03-25  |  25KB  |  701 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. --background--
  6. rexx_reqtools.library/RqtEasyReq
  7. rexx_reqtools.library/RqtFileReq
  8. rexx_reqtools.library/RqtFontReq
  9. rexx_reqtools.library/RqtLongReq
  10. rexx_reqtools.library/RqtPaletteReq
  11. rexx_reqtools.library/RqtScreenReq
  12. rexx_reqtools.library/RqtStringReq
  13.  
  14.  
  15. --background--                                                  --background--
  16.  
  17.  $(C): (1996, Rocco Coluccelli, Bologna)
  18.  $VER: rexx_reqtools.library 38.1 (15.03.97)
  19.  
  20.     rexx_reqtools.library
  21.  
  22.     This sub-library of the rexxMOOS.library let ARexx programmers
  23.     use the requesters created with the reqtools.library
  24.  
  25.         RqtEasyReq()
  26.         RqtFileReq()
  27.         RqtFontReq()
  28.         RqtLongReq()
  29.         RqtPaletteReq()
  30.         RqtScreenReq()
  31.         RqtStringReq()
  32.  
  33.     NOTES
  34.  
  35.         Is part of the MOOS package.
  36.  
  37.     TODO
  38.  
  39.         Support for IoErr() returning error conditions.
  40.  
  41.     BUGS
  42.  
  43. rexx_reqtools.library/RqtEasyReq              rexx_reqtools.library/RqtEasyReq
  44.  
  45.     NAME
  46.  
  47.         RqtEasyReq -- Open the reqtools easy requester.
  48.  
  49.     SYNOPSIS
  50.  
  51.         ret = RqtEasyReq(bodytext,options)
  52.  
  53.     FUNCTION
  54.  
  55.         This function puts up a requester for you and waits for a response
  56.         from the user. The function may also return an IDCMP flag or a
  57.         value corresponding with one of other possible responses. You can
  58.         satisfy the requester with the following keyboard shortcuts: "Y"
  59.         or Left Amiga "V" for a positive response, ESC, "N", "R" or Left
  60.         Amiga "B" for a negative response.
  61.  
  62.     INPUTS
  63.  
  64.         bodytext - Is the text block that will be showed into the
  65.                    requester window. It can contain newlines ('0a'x) so
  66.                    the text will appear on multiple lines.
  67.  
  68.         options  - "Gads,Title/K,Pub/K,IDCMP/K,
  69.                     ReqPos/K,Xoff/K/N,Yoff/K/N,
  70.                     Flags/K,Default=Def/K/N"
  71.  
  72.             "Gads"    - All the possible responses, separated by a "|".
  73.                         The character "_" can be used to define keyboard
  74.                         shortcuts for each gadget. Eg: "_Ok|M_aybe|_No".
  75.                         Is not required to define any gadget for the
  76.                         requester until some IDCMP flags have been
  77.                         specified. The reason is that the requester
  78.                         can be closed only if the user chooses one of
  79.                         the possible responses, or if any IDCMP event
  80.                         occur. By default is created the gadget "Ok".
  81.  
  82.                         IMPORTANT: the shortcuts defined in this way take
  83.                         precedence of the default shortcuts! It is for
  84.                         example not wise to use a 'N' for a positive
  85.                         response! Pick your shortcuts carefully!
  86.  
  87.             "Title"   - Title of requester window, default is "Request"
  88.                         unless the requester has less than 2 responses,
  89.                         then the default title is "Information". The
  90.                         given text might be always included beetween
  91.                         quotes (',") also if it doesn't contain spaces.
  92.  
  93.             "Pub"     - Preferred public screen to open the requester
  94.                         window in.
  95.  
  96.             "IDCMP"   - Extra IDCMP flags to return on. If one these
  97.                         IDCMP flags causes the requester to abort the
  98.                         return code will equal the flag in question.
  99.                         In this version are supported the following:
  100.  
  101.                             DISKINSERTED
  102.                             DISKREMOVED
  103.                             INACTIVEWINDOW
  104.                             MOUSEBUTTONS
  105.                             NEWPREFS
  106.                             RAWKEY
  107.                             VANILLAKEY
  108.  
  109.                         More flags may be specified at the same time
  110.                         if separated by "|".
  111.  
  112.             "ReqPos"  - The requester will always remain in the visible
  113.                         part of the screen, so if you use the Workbench
  114.                         2.0 ScreenMode preferences editor to enlarge your
  115.                         Workbench screen and you scroll around, the
  116.                         requester will always appear in the part you can
  117.                         see. One of the following:
  118.  
  119.                             POINTER    - Requester appears where the
  120.                                          mouse pointer is (default).
  121.                             CENTERSCR  - Requester is centered on the
  122.                                          screen.
  123.                             CENTERWIN  - Requester is centered in the
  124.                                          window associated with your
  125.                                          process.
  126.                             TOPLEFTSCR - Requester appears at the top
  127.                                          left of the screen.
  128.                             TOPLEFTWIN - Requester appears at the top
  129.                                          left of the window.
  130.  
  131.                         CENTERSCR and TOPLEFTSCR also apply to the visible
  132.                         part of the screen. So if you use one of these the
  133.                         requester will be appear in the center or the top
  134.                         left off what you can see of the screen as opposed
  135.                         to the entire screen.
  136.  
  137.                         CENTERWIN and TOPLEFTWIN fall back to CENTERSCR or
  138.                         TOPLEFTSCR respectively when there is no parent
  139.                         window. So you can safely use these without
  140.                         worrying about the existence of a window.
  141.  
  142.             "Xoff"    - Offset of left edge of requester relative to
  143.                         position specified with "ReqPos" (does not
  144.                         offset the requester when "ReqPos=pointer").
  145.  
  146.             "Yoff"    - Offset of top edge of requester relative to
  147.                         position specified with "ReqPos" (does not
  148.                         offset the requester when "ReqPos=pointer").
  149.  
  150.             "Flags"   - More flags can be specified if separated by "|".
  151.                         For the Easy requester are supported:
  152.  
  153.                             NORETURNKEY - turn off the RETURN key as
  154.                                           shortcut for positive response.
  155.                             LAMIGAQUAL  - keyboard shortcuts are limited
  156.                                           to Left Amiga "V" and "B", ESC
  157.                                           and RETURN.
  158.                             CENTERTEXT  - centers each line of body text
  159.                                           in the requester window. Useful
  160.                                           for about requesters.
  161.  
  162.                         If NORETURNKEY is not set the RETURN key is also
  163.                         accepted as a shortcut for the positive response
  164.                         (can be changed using "Default", see below). The
  165.                         response that will be selected when you press
  166.                         RETURN will be printed in bold.
  167.  
  168.                         The LAMIGAQUAL flag should be used when you put up
  169.                         a requester for a destructive action (to delete
  170.                         something, for example). When it is set the
  171.                         keyboard shortcuts are limited to Left Amiga "V"
  172.                         and "B" so it is harder to accidently select
  173.                         something you will regret. Note that the RETURN
  174.                         and ESC key remain active! To disable the RETURN
  175.                         key use the NORETURNKEY flag. The ESC key cannot
  176.                         be disabled.
  177.  
  178.             "Default" - Response value that will be returned when the
  179.                         user presses the return key. Will be ignored if
  180.                         the NORETURNKEY flag is set. The text for this
  181.                         response will be printed in bold. (default is 1)
  182.  
  183.     RESULT
  184.  
  185.         ret - The value "1" (TRUE) for leftmost (positive) response, then
  186.               each consecutive response will return 1 more, the rightmost
  187.               response will return 0 (FALSE), so 1,2,3,...,num-1,0.
  188.               If any IDCMP flag has been specified and the corresponding
  189.               event happens then its value will be returned.
  190.  
  191.     EXAMPLE
  192.  
  193.         SAY RqtEasyReq("Insert a disk",'IDCMP DiskInserted')
  194.  
  195.     SEE ALSO
  196.  
  197.         reqtools.library/rtEZRequest()
  198.  
  199. rexx_reqtools.library/RqtFileReq              rexx_reqtools.library/RqtFileReq
  200.  
  201.     NAME
  202.  
  203.         RqtFileReq -- Open the reqtools file requester.
  204.  
  205.     SYNOPSIS
  206.  
  207.         ret = RqtFileReq(filename,directory,options)
  208.  
  209.     FUNCTION
  210.  
  211.         Get a directory and filename(s), or just a directory from the user.
  212.  
  213.     INPUTS
  214.  
  215.         filename  - The initial value for the file gadget content.
  216.  
  217.         directory - The initial value for the drawer gadget content.
  218.  
  219.         options   - "Dir/K,Pat/K,Ok/K,Title/K,Pub/K,
  220.                      ReqPos/K,Xoff/K/N,Yoff/K/N,Hei/K/N,
  221.                      Stem/K,Flags/K,VolReq/K"
  222.  
  223.             "Dir"    - Initial drawer from which open the requester.
  224.  
  225.             "Pat"    - The accepted pattern. It will be showed into the
  226.                        pattern gadget specifying the flag PATGAD.
  227.  
  228.             "Ok"     - A raplacement string for the "Ok" gadget. It can
  229.                        be 6 characters long.
  230.  
  231.             "Title"  - Title of requester window.
  232.  
  233.             "Pub"    - See RqtEasyReq()
  234.  
  235.             "ReqPos" - See RqtEasyReq()
  236.  
  237.             "Xoff"   - See RqtEasyReq()
  238.  
  239.             "Yoff"   - See RqtEasyReq()
  240.  
  241.             "Hei"    - Suggested height of file requester window.
  242.  
  243.             "Stem"   - The function may fill any given output stem with
  244.                        the following fields:
  245.  
  246.                         <stem.>FileName
  247.  
  248.                         <stem.>Drawer
  249.  
  250.                         <stem.>Pattern
  251.  
  252.                         <stem.>n
  253.                             Nth selected file. (See MULTI below)
  254.  
  255.                        This function support only "#" and "*" compound
  256.                        symbol's types (read the rexxMOOS documentation
  257.                        for details).
  258.  
  259.             "Flags"  - More flags can be specified if separated by "|".
  260.                        For this requester are supported:
  261.  
  262.                         MULTI   - Allow multiple files to be selected.
  263.                                   This option flag is usefull only
  264.                                   giving a stem where the selected
  265.                                   files/dirs will be written in.
  266.                         SELDIRS - Set this flag if you wish to enable
  267.                                   the selecting of dirs as well as files.
  268.                         SAVE    - Set this if you are using the
  269.                                   requester to save or delete something.
  270.                                   Double-clicking will be disabled so it
  271.                                   is harder to make a mistake and select
  272.                                   the wrong file. If the user enters a
  273.                                   non-existent directory in the drawer
  274.                                   string gadget, a requester will appear
  275.                                   asking if the dir should be created.
  276.                         NOFILES - Set this if you want to use the
  277.                                   requester to allow the user to select a
  278.                                   directory rather than a file. Ideal for
  279.                                   getting a destination dir. May be used
  280.                                   with the flags MULTI and SELDIRS.
  281.                         PATGAD  - When this is set a pattern gadget will
  282.                                   be added to the requester.
  283.  
  284.             "VolReq" - Use this option keyword to turn the file
  285.                        requester into a volume/assign disk requester.
  286.                        It can be used to get a device name ("DF0:",
  287.                        "DH1:",...) or an assign ("C:", "FONTS:",...) from
  288.                        the user. Note that the user may edit the
  289.                        disk/assign names, or enter a new one. Note also
  290.                        that the real device name is returned, not the
  291.                        name of the volume in the device. The following
  292.                        flags can be specified (separated by "|"):
  293.  
  294.                         NOASSIGNS - Do not include the assigns in
  295.                                     the list, only the real devices.
  296.                         NODISKS   - Do not include devices, just
  297.                                     show the assigns.
  298.                         ALLDISKS  - Show all devices. By default are
  299.                                     showed only those devices which have
  300.                                     valid disks inserted into them. So if
  301.                                     you have no disk in drive DF0: it will
  302.                                     not show up. Set this flag if you do
  303.                                     want these devices included.
  304.     RESULT
  305.  
  306.         ret - The function always returns the last selected dir/file or
  307.               an empty string if the user has deleted the requester.
  308.               Note that the user may enter manually a filename and it
  309.               couldn't exists.
  310.  
  311.     EXAMPLE
  312.  
  313.         SAY RqtFileReq()
  314.  
  315.     SEE ALSO
  316.  
  317.         reqtools.library/rtFileRequest()
  318.  
  319. rexx_reqtools.library/RqtFontReq              rexx_reqtools.library/RqtFontReq
  320.  
  321.     NAME
  322.  
  323.         RqtFontReq -- Open the reqtools font requester.
  324.  
  325.     SYNOPSIS
  326.  
  327.         ret = RqtFontReq(options)
  328.  
  329.     FUNCTION
  330.  
  331.         Let the user select a font and a style (optional).
  332.  
  333.     INPUTS
  334.  
  335.         options  - "Ok/K,Title/K,Pub/K,
  336.                     ReqPos/K,Xoff/K/N,Yoff/K/N,Hei/K/N,
  337.                     Stem/K,Flags/K,SampleH/K/N,MinH/K/N,MaxH/K/N"
  338.  
  339.             "Ok"      - See RqtFileReq()
  340.  
  341.             "Title"   - Title of requester window.
  342.  
  343.             "Pub"     - See RqtEasyReq()
  344.  
  345.             "ReqPos"  - See RqtEasyReq()
  346.  
  347.             "Xoff"    - See RqtEasyReq()
  348.  
  349.             "Yoff"    - See RqtEasyReq()
  350.  
  351.             "Hei"     - Suggested height of file requester window.
  352.  
  353.             "Stem"    - The function may fill any given output stem with
  354.                         the following fields:
  355.  
  356.                             <stem.>Name
  357.  
  358.                             <stem.>YSize
  359.  
  360.                             <stem.>Style
  361.  
  362.                             <stem.>Flags
  363.  
  364.             "Flags"   - More flags can be specified if separated by "|".
  365.                         For this requester are supported:
  366.  
  367.                             FIXEDWID - Only show fixed-width fonts.
  368.                             COLORS   - Show color fonts also.
  369.                             PALETTE  - Change the screen's palette
  370.                                        to match that of a selected
  371.                                        color font.
  372.                             SCALEGAD - Allow fonts to be scaled
  373.                                        when they don't exist in the
  374.                                        requested size.
  375.                             STYLEGAD - Include gadgets so the user
  376.                                        may select the font's style.
  377.  
  378.             "SampleH" - Height of font sample display in pixels.
  379.                         (default 24)
  380.  
  381.             "MinH"    - Minimum font size displayed.
  382.  
  383.             "MaxH"    - Maximum font size displayed.
  384.  
  385.     RESULT
  386.  
  387.         ret - The function always returns the selected font/size or
  388.               an empty string if the user has deleted the requester.
  389.               Note that the user may enter manually a font/size that
  390.               don't exists in the system.
  391.  
  392.     EXAMPLE
  393.  
  394.         SAY RqtFontReq('Flags=Scale|Size')
  395.  
  396.     SEE ALSO
  397.  
  398.         reqtools.library/rtFontRequest()
  399.  
  400. rexx_reqtools.library/RqtLongReq              rexx_reqtools.library/RqtLongReq
  401.  
  402.     NAME
  403.  
  404.         RqtLongReq -- Open the reqtools getlong requester.
  405.  
  406.     SYNOPSIS
  407.  
  408.         ret = RqtLongReq(bodytext,options)
  409.  
  410.     FUNCTION
  411.  
  412.         Puts up a requester to get a signed number from the user.
  413.  
  414.     INPUTS
  415.  
  416.         bodytext - See RqtEasyReq()
  417.  
  418.         options  - "Number/N,Gads,Title/K,Pub/K,IDCMP/K,
  419.                     ReqPos/K,Xoff/K/N,Yoff/K/N,Wid/K/N,
  420.                     Flags/K,Min/K/N,Max/K/N,Hidden/S"
  421.  
  422.             "Number" - The initial value showed into the input gadget.
  423.  
  424.             "Gads"   - See RqtEasyReq()
  425.  
  426.             "Title"  - See RqtEasyReq()
  427.  
  428.             "Pub"    - See RqtEasyReq()
  429.  
  430.             "IDCMP"  - See RqtEasyReq()
  431.  
  432.             "ReqPos" - See RqtEasyReq()
  433.  
  434.             "Xoff"   - See RqtEasyReq()
  435.  
  436.             "Yoff"   - See RqtEasyReq()
  437.  
  438.             "Wid"    - Width of requester window in pixels. This is only
  439.                        a suggestion. Requester's window can't go below a
  440.                        certain width.
  441.  
  442.             "Flags"  - More flags can be specified if separated by "|".
  443.                        For the Easy requester are supported:
  444.  
  445.                         HIGHLIGHT  - Highlight text above the gadget.
  446.                                      You will normally only want to use
  447.                                      this if you also turned off the
  448.                                      window backfilling.
  449.                         CENTERTEXT - See RqtEasyReq()
  450.  
  451.             "Min"    - Minimum allowed value. If the user tries to enter
  452.                        a smaller value the requester will refuse it.
  453.  
  454.             "Max"    - Maximum allowed value, higher values are refused.
  455.  
  456.             "Hidden" - Use this to switch on invisible typing. Very
  457.                        useful if you need to get something like a code
  458.                        number from the user.
  459.  
  460.     RESULT
  461.  
  462.         ret - The number entered. See RqtEasyReq() for the returned values
  463.               in case of any IDCMP flag or other gadgets added.
  464.  
  465.     EXAMPLE
  466.  
  467.         SAY RqtLongReq("Insert a number",100)
  468.  
  469.     SEE ALSO
  470.  
  471.         reqtools.library/rtGetLong()
  472.  
  473. rexx_reqtools.library/RqtPaletteReq        rexx_reqtools.library/RqtPaletteReq
  474.  
  475.     NAME
  476.  
  477.         RqtPaletteReq -- Open the reqtools palette requester.
  478.  
  479.     SYNOPSIS
  480.  
  481.         ret = RqtPaletteReq(options)
  482.  
  483.     FUNCTION
  484.  
  485.         Put up a palette requester so the user can change the screen's
  486.         colors. The colors are changed in the viewport of the screen the
  487.         requester will appear on, so that is where you will find them
  488.         after the palette requester returns. The selected color is
  489.         returned, so you can also use this requester to let the user
  490.         select a color.
  491.  
  492.     INPUTS
  493.  
  494.         options  - "Color/N,Title/K,Pub/K,IDCMP/K,
  495.                     ReqPos/K,Xoff/K/N,Yoff/K/N"
  496.  
  497.             "Color"  - Initially selected color of palette.
  498.                        (default is 1)
  499.  
  500.             "Title"  - See RqtEasyReq()
  501.  
  502.             "Pub"    - See RqtEasyReq()
  503.  
  504.             "IDCMP"  - See RqtEasyReq()
  505.  
  506.             "ReqPos" - See RqtEasyReq()
  507.  
  508.             "Xoff"   - See RqtEasyReq()
  509.  
  510.             "Yoff"   - See RqtEasyReq()
  511.  
  512.     RESULT
  513.  
  514.         ret - The color number of the selected color or -1 if the user
  515.               canceled the requester. See RqtEasyReq() for the returned
  516.               values in case of any IDCMP flag or other gadgets added.
  517.  
  518.     EXAMPLE
  519.  
  520.         SAY RqtPaletteReq()
  521.  
  522.     SEE ALSO
  523.  
  524.         reqtools.library/rtPaletteRequest()
  525.  
  526. rexx_reqtools.library/RqtScreenReq          rexx_reqtools.library/RqtScreenReq
  527.  
  528.     NAME
  529.  
  530.         RqtScreenReq -- Open the reqtools screen mode requester.
  531.  
  532.     SYNOPSIS
  533.  
  534.         ret = RqtScreenReq(options)
  535.  
  536.     FUNCTION
  537.  
  538.         The user will be able to pick a screen mode by name, enter the
  539.         size and the number of colors (bitplane depth).
  540.  
  541.     INPUTS
  542.  
  543.         options  - "Ok/K,Title/K,Pub/K,
  544.                     ReqPos/K,Xoff/K/N,Yoff/K/N,Hei/K/N,
  545.                     Stem/K,Flags/K,MinW/K/N,MaxW/K/N,
  546.                     MinH/K/N,MaxH/K/N,MinD/K/N,MaxD/K/N"
  547.  
  548.             "Ok"     - See RqtFileReq()
  549.  
  550.             "Title"  - Title of requester window.
  551.  
  552.             "Pub"    - See RqtEasyReq()
  553.  
  554.             "ReqPos" - See RqtEasyReq()
  555.  
  556.             "Xoff"   - See RqtEasyReq()
  557.  
  558.             "Yoff"   - See RqtEasyReq()
  559.  
  560.             "Hei"    - Suggested height of file requester window.
  561.  
  562.             "Stem"   - The function may fill any given output stem with
  563.                        the following fields:
  564.  
  565.                         <stem.>DisplayID
  566.  
  567.                         <stem.>DisplayWidth
  568.  
  569.                         <stem.>DisplayHeight
  570.  
  571.                         <stem.>DisplayDepth
  572.  
  573.                         <stem.>OverscanType
  574.  
  575.                         <stem.>AutoScroll
  576.  
  577.             "Flags"  - More flags can be specified if separated by "|".
  578.                        For this requester are supported:
  579.  
  580.                         OVERSCANGAD - Add an overscan cycle gadget to
  581.                                       the requester.
  582.                         ASCROLLGAD  - Add an autoscroll checkbox gadget
  583.                                       to the requester.
  584.                         SIZEGADS    - Add width and height gadgets to the
  585.                                       requester. If you do not add these
  586.                                       gadgets the width and height
  587.                                       returned will be the default values
  588.                                       for the selected overscan type.
  589.                         DEPTHGAD    - Add a depth slider gadget to the
  590.                                       requester. If you do not add a
  591.                                       depth gadget, the depth returned
  592.                                       will be the maximum depth this
  593.                                       mode can be opened in.
  594.                         NONSTDMODES - Include all modes. Unless this flag
  595.                                       is set the function will exclude
  596.                                       nonstandard modes. Nonstandard modes
  597.                                       are presently HAM and EHB
  598.                                       (ExtraHalfBrite). So unless you are
  599.                                       picking a mode to do some rendering
  600.                                       in leave this flag unset. Without
  601.                                       this flag set the mode returned will
  602.                                       be a normal bitplaned mode.
  603.                         GUIMODES    - Set this flag if you are getting
  604.                                       a screen mode to open a user
  605.                                       interface screen in. The modes
  606.                                       shown will be standard modes with
  607.                                       a high enough resolution (minumum
  608.                                       640 pixels). If this flag is set
  609.                                       the NONSTDMODES flag is ignored.
  610.                         ALLGADS     - Add all gadgets. Is the same as
  611.                                       specifying ASCROLLGAD, DEPTHGAD,
  612.                                       OVERSCANGAD and SIZEGADS.
  613.  
  614.             "MinW"   - The minimum display width allowed.
  615.  
  616.             "MaxW"   - The maximum display width allowed.
  617.  
  618.             "MinH"   - The minimum display height allowed.
  619.  
  620.             "MaxH"   - The maximum display height allowed.
  621.  
  622.             "MinD"   - The minimum display depth allowed. Modes with
  623.                         a minimum display depth lower than this value
  624.                         will not be included in the list.
  625.  
  626.             "MaxD"   - The maximum display depth allowed.
  627.  
  628.     RESULT
  629.  
  630.         ret - The function returns the displayID of the selected screen
  631.               mode or 0 if the user has deleted requester.
  632.  
  633.     EXAMPLE
  634.  
  635.         SAY RqtScreenReq()
  636.  
  637.     SEE ALSO
  638.  
  639.         reqtools.library/rtScreenModeRequester()
  640.  
  641. rexx_reqtools.library/RqtStringReq          rexx_reqtools.library/RqtStringReq
  642.  
  643.     NAME
  644.  
  645.         RqtStringReq -- Open the reqtools getstring requester.
  646.  
  647.     SYNOPSIS
  648.  
  649.         ret = RqtStringReq(bodytext,string,options)
  650.  
  651.     FUNCTION
  652.  
  653.         Puts up a string requester to get a line of text from the user.
  654.  
  655.     INPUTS
  656.  
  657.         bodytext - See RqtEasyReq()
  658.  
  659.         string   - The initial string ready to be edited.
  660.  
  661.         options  - "Gads,Title/K,Pub/K,IDCMP/K,
  662.                     ReqPos/K,Xoff/K/N,Yoff/K/N,Wid/K/N,
  663.                     Flags/K,MaxL/K/N,Hidden/S"
  664.  
  665.             "Gads"   - See RqtEasyReq()
  666.  
  667.             "Title"  - See RqtEasyReq()
  668.  
  669.             "Pub"    - See RqtEasyReq()
  670.  
  671.             "IDCMP"  - See RqtEasyReq()
  672.  
  673.             "ReqPos" - See RqtEasyReq()
  674.  
  675.             "Xoff"   - See RqtEasyReq()
  676.  
  677.             "Yoff"   - See RqtEasyReq()
  678.  
  679.             "Wid"    - See RqtLongReq()
  680.  
  681.             "Flags"  - See RqtLongReq()
  682.  
  683.             "MaxL"   - Maximum accepted length for the entered string.
  684.  
  685.             "Hidden" - See RqtLongReq()
  686.  
  687.     RESULT
  688.  
  689.         ret - The string entered. See RqtEasyReq() for the returned values
  690.               in case of any IDCMP flag or other gadgets added.
  691.  
  692.     EXAMPLE
  693.  
  694.         SAY RqtStringReq("Edit the following:","edit me...")
  695.  
  696.     SEE ALSO
  697.  
  698.         reqtools.library/rtGetString()
  699.  
  700.  
  701.