home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 326.lha / DateRequester / ReadMe.pp / ReadMe
Encoding:
Text File  |  1990-01-03  |  4.3 KB  |  123 lines
  1.     Amiga Date Requester
  2.     Mark R. Rinfret, 10/03/89
  3.  
  4. The contents of this package will provide you with 
  5.  
  6.     - AmigaDOS date support functions
  7.     - A date requester which can be added to your programs.
  8.     - A standalone ARexx-driven date requester program which can be
  9.       called from ARexx macro files.
  10.     - Some limited Intuition support functions required by this package.
  11.  
  12.  
  13. The date requester module is dependent upon the ARP support library. The
  14. arexx requester program requires that you have ARexx installed on your
  15. system.
  16.  
  17.  
  18. What it does -
  19.  
  20.     The MRDateReq module provides you with Intuition-based support for
  21. soliciting a date value from the user. It supports both point-and-click
  22. selection of date values and direct entry (typing) of the individual
  23. components. All useful components of a date are available after the
  24. request is satisfied.
  25.  
  26.     The RxDateReq module provides an ARexx execution framework for the 
  27. date requester. At this time, it is not reentrant/shareable, but it can
  28. be told the unique rexx port name to be used upon startup. The example
  29. script, "test", illustrates one method for generating the unique port
  30. name.
  31.  
  32.     The RxDateReq module works in three phases. First, certain parameters
  33. are initialized using 'set' commands. Next, the date requester is
  34. activated. At this time, program is under control of the date requester.
  35. Finally, the results of the request can be polled using a variety of
  36. 'get' commands. As of this writing, the RxDateReq module responds to the 
  37. following instructions:
  38.  
  39. 'exit'
  40.  
  41.     Shut down the date requester.
  42.  
  43. 'getdate'
  44.  
  45.     This command retrieves a formatted string representing the date
  46. portion (year, month, day) of the user's response to 'request'. The
  47. returned value will be found in the result variable. Be sure to use
  48. "options results" in order to be able to retrieve the value.
  49.  
  50. 'getformat'
  51.  
  52.     This command retrieves the current date format name and stores it in
  53. the result variable. See 'setformat' for the possible name values
  54. returned.
  55.  
  56. 'getfulldate' <stem name>
  57.  
  58.     This command retrieves all date components in a compound variable
  59. whose base name is <stem name>. In addition to the 6 components listed
  60. under 'setfulldate', element 7 will contain an index for the day of the
  61. week, where 0 = Sunday. Example:
  62.  
  63.     'getfulldate' "finaldate"
  64.     say "The weekday index was " finaldate.7
  65.  
  66. 'gettime'
  67.  
  68.     The time component of the current date value (hour,minute,second) is
  69. retrieved as a formatted string and placed in the result variable.
  70.  
  71. 'request'
  72.  
  73.     This command activates the date requester. The requester will remain
  74. in control until the user selects either the OK or CANCEL gadget.
  75.  
  76. 'setformat' "International" | "DOS" | "USA" | "Canadian"
  77.  
  78.     This sets the date presentation format. Note that only the unique
  79. portion of one of the format names need be passed (e.g. "Int" or "I") in
  80. order for it to be recognized.
  81.  
  82. 'setfulldate' <stem name>
  83.  
  84.     This command allows the macro to preset a default date value. The
  85. components of the date are expected to be in a compound variable whose
  86. base name is <stem name>. Prior to calling 'setfulldate', the macro must
  87. initialize the compound variable:
  88.  
  89.     defdate = 0
  90.     defdate.1 = 1989    /* year */
  91.     defdate.2 = 10      /* month */
  92.     defdate.3 = 5       /* day */
  93.     defdate.4 = 14      /* hour */
  94.     defdate.5 = 20      /* minute */
  95.     defdate.6 = 30      /* second */
  96.     'setfulldate' defdate
  97.     
  98. 'setprompt' <prompt string>
  99.  
  100.     This sets the prompt message that appears in the date requester. For
  101. example:
  102.             'setprompt' "Please select the date:" 
  103.  
  104. Credits
  105.  
  106.     This package contains or depends upon several user-contributed algorithms,
  107. libraries, etc. If I left your name out, please give me a holler and I'll
  108. add you to the credits list.  Contributors:
  109.  
  110.     Thad Floryan            - date routines
  111.     Charlie Heath, et al    - ARP library
  112.     William Hawes           - ARexx!
  113.     Inovatronics            - PowerWindows Intuition code generation
  114.     Doug Merrit             - date routines
  115.     Radical Eye Software    - MinRexx (I'd still be floundering,
  116.                               otherwise)
  117.  
  118.  
  119. This package is CopyRight ) 1989, Mark Rinfret.  You are free to use/
  120. modify/redistribute this code for any purposes, private or commercial, as
  121. long as the above credits are distributed with this package.
  122. Redistribution to the public sector must include all source.
  123.