home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 2: Collection B / 17Bit_Collection_B.iso / files / 2254.dms / in.adf / docs / ReqAsk.doc.pp < prev    next >
Encoding:
Text File  |  1990-09-13  |  3.6 KB  |  122 lines
  1.  
  2.  
  3.         ReqAsk V1.1              User manual               ReqAsk V1.1
  4.  
  5.  
  6.         NAME 
  7.             ReqAsk 
  8.  
  9.         SYNOPSIS 
  10.             ReqAsk [BODYFMT/A] Bodytext [[GADFMT] Gadgettext]
  11.                    [[TITLE] Titlestring] [[VAR] Variablename ]
  12.                    [GLOBAL] 
  13.  
  14.         DESCRIPTION 
  15.             NOTE: This program only works with OS 2.04! 
  16.  
  17.             ReqAsk  is  a  replacement for Commodores Ask command. The
  18.             major  difference  between  ReqAsk  and Ask is that ReqAsk
  19.             opens  a requester. It also allows more than two different
  20.             answers,  and they can be whatever you like. The requester
  21.             is the normal one used by e.g. Workbench.  
  22.  
  23.         OPTIONS 
  24.             You  must  supply  a  bodytext.  The  other arguments have
  25.             default  values. The keywords (see below) is only required
  26.             if  you do not enter the strings in the ordering as above.
  27.             Strings only need to be quoted if they contain spaces.  
  28.  
  29.             BODYFMT 
  30.                 This  is  a  string containing the text that should be
  31.                 shown   in  the  requester.   This  argument  must  be
  32.                 present.  If  you  want  a linefeed in the text, enter
  33.                 "*n"  which  will  be transformed to a normal LF char.
  34.                 An empty string like "" isn't accpeted by ReqAsk.  
  35.  
  36.             GADGETFMT 
  37.                 This  argument  specifies what gadgets you want in the
  38.                 requester.  To  specify more that one gadget, separate
  39.                 the   gadgets   with   a   vertical  bar  ("|").  E.g.
  40.                 "Ok|Cancel"  gives  two gadgets, leftmost called "Ok",
  41.                 while the rightmost is called "Cancel".  
  42.  
  43.                 The  returned value (see below on how to obtain it) is
  44.                 as  follows:  The  rightmost gadget has a return value
  45.                 of  zero.  This should be a negative response (such as
  46.                 cancel).  The other gadgets (if any), will be numbered
  47.                 -  from  left  to  right  -  with  increasing  number,
  48.                 starting  with  1.  Thus,  if you have a gadget format
  49.                 like:   "Yes|Maybe|No|Just  kiddin!",  clicking  "Yes"
  50.                 will  return  1, "Maybe" returns 2, "No" returns 3 and
  51.                 finally "Just kiddin!" returns 0.  
  52.  
  53.                 Default   is   two   gadgets   named  "Yes"  and  "No"
  54.                 ("Yes|No").  
  55.  
  56.             TITLE 
  57.                 This  optional  string  specifies  the  title  in  the
  58.  
  59.  
  60.                                     Page 1
  61.  
  62.  
  63.         ReqAsk V1.1              User manual               ReqAsk V1.1
  64.  
  65.  
  66.                 requester  window.  It defaults to "System Request" if
  67.                 none is specified.  
  68.  
  69.             VAR 
  70.                 This  string  lets you specify in which local variable
  71.                 the  result  will be stored (as a numeric string). The
  72.                 default name is "ReqAskResult".  
  73.  
  74.             GLOBAL 
  75.                 By  default,  ReqAsk  will place the answer in a local
  76.                 environment  variable.  But this has one drawback: You
  77.                 can't  access  the  result  easily  from ARexx. If you
  78.                 have  set  this  flag,  it  will be quite easy. Simply
  79.                 peek in the ENV: directory.  :) 
  80.  
  81.         EXAMPLE 
  82.             ReqAsk "Do you like this program?" 
  83.             If $GetAskResult EQ 0
  84.                Echo "Why not??"
  85.             Else
  86.                Echo "I thought you would! :)"
  87.             EndIf
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.                                     Page 2
  121.  
  122.