home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #6 / amigamamagazinepolishissue1998.iso / coders / arexx / moos / docs / english / rexx_asl.doc < prev    next >
Text File  |  1997-03-25  |  13KB  |  409 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. --background--
  6. rexx_asl.library/AslFileReq
  7. rexx_asl.library/AslFontReq
  8. rexx_asl.library/AslScreenReq
  9.  
  10.  
  11. --background--                                                  --background--
  12.  
  13.  $(C): (1996, Rocco Coluccelli, Bologna)
  14.  $VER: rexx_asl.library 37.2 (15.03.97)
  15.  
  16.     rexx_asl.library
  17.  
  18.     This sub-library of the rexxMOOS.library let ARexx programmers
  19.     use the requesters created with the asl.library
  20.  
  21.         AslFileReq()
  22.         AslFontReq()
  23.         AslScreenReq()
  24.  
  25.     NOTES
  26.  
  27.         Is part of the MOOS package.
  28.  
  29.     TODO
  30.  
  31.         Support for IoErr() returning error conditions.
  32.  
  33.     BUGS
  34.  
  35. rexx_asl.library/AslFileReq                        rexx_asl.library/AslFileReq
  36.  
  37.     NAME
  38.  
  39.         AslFileReq -- Open an ASL file requester.
  40.  
  41.     SYNOPSIS
  42.  
  43.         ret = AslFileReq(filename,directory,options)
  44.  
  45.     FUNCTION
  46.  
  47.         This function open an ASL file requester to let users select
  48.         files, drawers, patterns, etc.
  49.  
  50.     INPUTS
  51.  
  52.         filename  - Initial contents of the file requester's "File" text
  53.                     gadget. Default is empty.
  54.  
  55.         directory - Initial contents of the file requester's Drawer text
  56.                     gadget. Default is empty.
  57.  
  58.         options   - "Pat/K,Stem/K,
  59.                      Left=X/K/N,Top=Y/K/N,Wid=W/K/N,Hei=H/K/N,
  60.                      Title/K,Ok/K,Cancel/K,Pub/K,
  61.                      RejectPat=RPat/K,AcceptPat=APat/K,
  62.                      PatGad/S,Save/S,Multi/S,NoFiles/S,NoIcons/S"
  63.  
  64.             "Pat"       - Initial contents of the file requester's
  65.                           Pattern text gadget. Default is #?.
  66.  
  67.             "Stem"      - The function may fill any given output stem with
  68.                           the following fields:
  69.  
  70.                             <stem.>FileName
  71.                                 Contents of File gadget on exit.
  72.  
  73.                             <stem.>Drawer
  74.                                 Contents of Drawer gadget on exit.
  75.  
  76.                             <stem.>Pattern
  77.                                 Contents of Pattern gadget on exit.
  78.  
  79.                             <stem.>n
  80.                                 Nth selected file.
  81.  
  82.                           This function support only "#" and "*" compound
  83.                           symbol's types (read the rexxMOOS documentation
  84.                           for details).
  85.  
  86.             "Left"      - Suggested left edge of requesting window.
  87.                           This parameter and the next three following
  88.                           may not work if the asl.library has been
  89.                           patched by something like ReqChange, RTPatch,
  90.                           or similar.
  91.  
  92.             "Top"       - Suggested top edge of requesting window.
  93.  
  94.             "Wid"       - Suggested width of requesting window.
  95.  
  96.             "Hei"       - Suggested height of requesting window.
  97.  
  98.             "Title"     - Title to use for the requesting window.
  99.  
  100.             "Ok"        - Replaces text for the "Ok" gadget (V38).
  101.  
  102.             "Cancel"    - Replaces text for the "Cancel" gadget (V38).
  103.  
  104.             "Pub"       - Preferred public screen to open the requester
  105.                           window in (by default the requester will open
  106.                           on the frontmost screen) (V38).
  107.  
  108.             "RejectPat" - Specifies an AmigaDOS pattern that is used to
  109.                           reject files. That is, any files with names
  110.                           matching this pattern are not included in the
  111.                           file list. Note that the pattern must have been.
  112.                           Default is ~(#?) which matches nothing. (V38)
  113.  
  114.             "AcceptPat" - Specifies an AmigaDOS pattern that is used to
  115.                           accept files. That is, only files with names
  116.                           matching this pattern are included in the file
  117.                           list. Default is #? (V38)
  118.  
  119.             "PatGad"    - Show the pattern gadget into the requester.
  120.  
  121.             "Save"      - Opens the requester into the "Save" mode
  122.                           (user can create new directories).
  123.  
  124.             "Multi"     - Let user select more than one file at a time.
  125.                           This option is really useful only specifying
  126.                           an output stem and disables the "Save" mode.
  127.  
  128.             "NoFiles"   - The requester doesn't show files. This is
  129.                           useful to let the user choose a destination
  130.                           directory.
  131.  
  132.             "NoIcons"   - The requester doesn't show icons.
  133.  
  134.     RESULT
  135.  
  136.         Giving an output "Stem", the function will return a boolean
  137.         value (1 mean all done, ok). Otherwise the last selected file,
  138.         or drawer, will be returned. The result may be an empty string
  139.         in case of errors, or if the user close the requester, or if
  140.         nothing has been selected.
  141.  
  142.     EXAMPLE
  143.  
  144.         SAY AslFileReq()
  145.  
  146.     NOTES
  147.  
  148.         Most options are available only starting with the version 38
  149.         of the Operating System.
  150.  
  151.     SEE ALSO
  152.  
  153.         asl.library/AslRequest()
  154.  
  155. rexx_asl.library/AslFontReq                        rexx_asl.library/AslFontReq
  156.  
  157.     NAME
  158.  
  159.         AslFontReq -- Open an ASL font requester.
  160.  
  161.     SYNOPSIS
  162.  
  163.         ret = AslFontReq(options)
  164.  
  165.     FUNCTION
  166.  
  167.         This function open an ASL font requester to let users select
  168.         fonts and their attributes.
  169.  
  170.     INPUTS
  171.  
  172.         options - "Name,Size/N,Style/K/N,Flags/K/N,Stem/K,
  173.                    Left=X/K/N,Top=Y/K/N,Wid=W/K/N,Hei=H/K/N,
  174.                    Title/K,Ok/K,Cancel/K,Pub/K,
  175.                    FrontPen=FP/K/N,BackPen=BP/K/N,DrawMode=DM/K/N,
  176.                    StyleGad/S,FPGad/S,BPGad/S,DMGad/S,
  177.                    MinH/K/N,MaxH/K/N,FixedWid/S"
  178.  
  179.             "Name"     - Initial contents of the font requester's
  180.                           Name text gadget. Default is none.
  181.  
  182.             "Size"     - Initial contents of the font requester's
  183.                          Size numeric gadget (fo_Attr.ta_YSize).
  184.                          Default is 8.
  185.  
  186.             "Style"    - Initial setting of the font requester's
  187.                          Style gadget (fo_Attr.ta_Style).
  188.                          Default is 0 (FS_NORMAL).
  189.  
  190.             "Flags"    - Initial setting of the font requester's
  191.                          Flags field (fo_Attr.ta_Flags).
  192.                          Default is 1 (FPF_ROMFONT).
  193.  
  194.             "Stem"     - The function may fill any given output stem with
  195.                          the following fields:
  196.  
  197.                             <stem.>Name
  198.  
  199.                             <stem.>YSize
  200.  
  201.                             <stem.>Style
  202.  
  203.                             <stem.>Flags
  204.  
  205.                             <stem.>FrontPen
  206.  
  207.                             <stem.>BackPen
  208.  
  209.                             <stem.>DrawMode
  210.  
  211.             "Left"     - See AslFileReq()
  212.  
  213.             "Top"      - See AslFileReq()
  214.  
  215.             "Wid"      - See AslFileReq()
  216.  
  217.             "Hei"      - See AslFileReq()
  218.  
  219.             "Title"    - See AslFileReq()
  220.  
  221.             "Ok"       - See AslFileReq()
  222.  
  223.             "Cancel"   - See AslFileReq()
  224.  
  225.             "Pub"      - See AslFileReq()
  226.  
  227.             "FrontPen" - Initial setting of the font requester's
  228.                          Front Color gadget (fo_FrontPen). This value
  229.                          also determines the color used to render the
  230.                          text in the sample font area. Default is 1.
  231.  
  232.             "BackPen"  - Initial setting of the font requester's
  233.                          Back Color gadget (fo_BackPen). This value
  234.                          also determines the color used to render
  235.                          the background of the sample font area.
  236.                          Default is 0.
  237.  
  238.             "DrawMode" - Initial setting of the font requester's Mode
  239.                          gadget (fo_DrawMode). Default is JAM1. (V38)
  240.  
  241.             "StyleGad" - Use this switch to cause the requester to
  242.                          display the Style checkboxes. (V38)
  243.  
  244.             "FPGad"    - Use this switch to cause the requester to
  245.                          display the Front Color selection gadget. (V38)
  246.  
  247.             "BPGad"    - Use this switch to cause the requester to
  248.                          display the Back Color selection gadget. (V38)
  249.  
  250.             "DMGad"    - Use this switch to cause the requester to
  251.                          display the Mode cycle gadget. (V38)
  252.  
  253.             "MinH"     - The minimum font height to let the user
  254.                          select. Default is 5.
  255.  
  256.             "MaxH"     - The maximum font height to let the user
  257.                          select. Default is 24.
  258.  
  259.             "FixedWid" - Use this switch to cause the requester to
  260.                          only display fixed-width fonts. (V38)
  261.  
  262.     RESULT
  263.  
  264.         Giving an output "Stem", the function will return a boolean
  265.         value (1 mean all done, ok). Otherwise the selected font will
  266.         be returned connected with the selected size by a "/".
  267.         The result may be an empty string in case of errors, or if the
  268.         user close the requester, or if nothing has been selected.
  269.  
  270.     EXAMPLE
  271.  
  272.         SAY AslFontReq()
  273.  
  274.     NOTES
  275.  
  276.         Most options are available only starting with the version 38
  277.         of the Operating System.
  278.  
  279.     SEE ALSO
  280.  
  281.         asl.library/AslRequest()
  282.  
  283. rexx_asl.library/AslScreenReq                    rexx_asl.library/AslScreenReq
  284.  
  285.     NAME
  286.  
  287.         AslScreenReq -- Open an ASL file requester.
  288.  
  289.     SYNOPSIS
  290.  
  291.         ret = AslScreenReq(options)
  292.  
  293.     FUNCTION
  294.  
  295.         This function open an ASL file requester to let users select
  296.         files, drawers, patterns.
  297.  
  298.     INPUTS
  299.  
  300.         options - "ID/N,Width/N,Height/N,Depth/K/N,Overscan/K/N,Stem/K,
  301.                    Left=X/K/N,Top=Y/K/N,Wid=W/K/N,Hei=H/K/N,
  302.                    Title/K,Ok/K,Cancel/K,Pub/K,
  303.                    AScrollGad/S,DepthGad/S,OverscanGad/S,
  304.                    WidthGad/S,HeightGad/S,
  305.                    MinW/K/N,MaxW/K/N,MinH/K/N,MaxH/K/N,MinD/K/N,MaxD/K/N"
  306.  
  307.             "ID"          - Initial setting of the Mode list view gadget
  308.                             (sm_DisplayID). Default is 0 (LORES_KEY).
  309.  
  310.             "Width"       - Initial setting of the Width gadget
  311.                             (sm_DisplayWidth). Default is 640.
  312.  
  313.             "Height"      - Initial setting of the Height gadget
  314.                             (sm_DisplayHeight). Default is 200.
  315.  
  316.             "Depth"       - Initial setting of the Colors gadget
  317.                             (sm_DisplayDepth). Default is 2.
  318.  
  319.             "Overscan"    - Initial setting of the Overscan Type 
  320.                             cycle gadget (sm_OverscanType).
  321.                             Default is 0 (OSCAN_TEXT).
  322.  
  323.             "Stem"        - The function may fill any given output stem with
  324.                             the following fields:
  325.  
  326.                                 <stem.>DisplayID
  327.  
  328.                                 <stem.>DisplayWidth
  329.  
  330.                                 <stem.>DisplayHeight
  331.  
  332.                                 <stem.>DisplayDepth
  333.  
  334.                                 <stem.>OverscanType
  335.  
  336.                                 <stem.>AutoScroll
  337.  
  338.             "Left"        - See AslFileReq
  339.  
  340.             "Top"         - See AslFileReq()
  341.  
  342.             "Wid"         - See AslFileReq()
  343.  
  344.             "Hei"         - See AslFileReq()
  345.  
  346.             "Title"       - See AslFileReq()
  347.  
  348.             "Ok"          - See AslFileReq()
  349.  
  350.             "Cancel"      - See AslFileReq()
  351.  
  352.             "Pub"         - See AslFileReq()
  353.  
  354.             "AScrollGad"  - Use this switch to cause the requester to
  355.                             display the AutoScroll checkbox.
  356.  
  357.             "DepthGad"    - Use this switch to cause the requester to
  358.                             display the Depth gadget.
  359.  
  360.             "OverscanGad" - Use this switch to cause the requester to
  361.                             display the Overscan gadget.
  362.  
  363.             "WidthGad"    - Use this switch to cause the requester to
  364.                             display the Width gadget.
  365.  
  366.             "HeightGad"   - Use this switch to cause the requester to
  367.                             display the Height gadget.
  368.  
  369.             "MinW"        - The minimum display width to let the user
  370.                             choose. Default is 16.
  371.  
  372.             "MaxW"        - The maximum display width to let the user
  373.                             choose. Default is 16368.
  374.  
  375.             "MinH"        - The minimum display height to let the user
  376.                             choose. Default is 16.
  377.  
  378.             "MaxH"        - The maximum display height to let the user
  379.                             choose. Default is 16384.
  380.  
  381.             "MinD"        - The minimum display depth to let the user
  382.                             choose. Default is 1.
  383.  
  384.             "MaxD"        - The maximum display depth to let the user
  385.                             choose. Default is 24.
  386.  
  387.     RESULT
  388.  
  389.         Giving an output "Stem", the function will return a boolean
  390.         value (1 mean all done, ok). Otherwise the selected screen ID
  391.         will be returned. The result may be an empty string
  392.         in case of errors, or if the user close the requester, or if
  393.         nothing has been selected.
  394.  
  395.     EXAMPLE
  396.  
  397.         SAY AslScreenReq()
  398.  
  399.     NOTES
  400.  
  401.         This function is available only starting with the version 38
  402.         of the Operating System.
  403.  
  404.     SEE ALSO
  405.  
  406.         asl.library/AslRequest()
  407.  
  408.  
  409.