home *** CD-ROM | disk | FTP | other *** search
/ Chip 1999 January / Chip_1999-01_cd.bin / zkuste / delphi / D1 / GCAL.ZIP / readme.txt < prev   
Text File  |  1997-02-10  |  8KB  |  205 lines
  1. TGregCalendar
  2. =============
  3.  
  4. Version 1.06 (20 December 1996)
  5. Freeware for Delphi 1.0 and 2.0
  6. Copyright (c) 1996 Greg Lief
  7.  
  8. ----------------------------------------------------------------------------
  9.  
  10. 1.  Description
  11. 2.  Installation
  12. 3.  New Properties
  13. 4.  New Method
  14. 5.  New Event
  15. 6.  Copyright Notice
  16. 7.  Disclaimer
  17. 8.  Technical Support
  18. 9.  Revision History
  19. 10. Comments
  20.  
  21. ----------------------------------------------------------------------------
  22.  
  23. 1. Description
  24. ==============
  25.  
  26. Delphi includes a nice calendar component (TCalendar) on the Samples
  27. component page. Although it handles much of the grunt work for us,
  28. TCalendar has some glaring deficiencies, the biggest of which is the
  29. user's inability to navigate beyond the currently displayed month.
  30.  
  31. Plugging that hole was the original intent of the TGregCalendar
  32. component, which includes a customized KeyDown method that handles the
  33. following keys: PgUp, PgDn, Ctrl-PgUp, Ctrl-PgDn, arrows.  (The user can
  34. also right-click upon the calendar to navigate by month and year.)
  35.  
  36. However, I have also added some other niceties, including the ability to
  37. change the color for the selected date and attach a label which will
  38. display the current month and year.  There is a built-in popup menu which
  39. allows the user another way to navigate through the calendar. You can
  40. also display the current month and year in the caption of the form upon
  41. which the calendar resides (via the UseFormCaption property). Last, but
  42. far from least, you can also designate "special days", which can display
  43. icons or bitmaps and have associated text.
  44.  
  45.  
  46. 2. Installation
  47. ===============
  48.  
  49. A. Choose the Component | Install menu option (or if you are using
  50.    Delphi 1.0, the Options | Install Components menu option).
  51.  
  52. B. Click upon the Add Button, and select either GCAL16.DCU (Delphi 1) or
  53.    GCAL32.DCU (Delphi 2).
  54.  
  55. C. Press OK twice.
  56.  
  57. D. After your component library is recompiled, you will find a new
  58.    tab entitled "Greg Lief", with the TGregCalendar icon upon it.
  59.  
  60. The included DEMO.ZIP file contains a sample project that uses
  61. TGregCalendar, along with several supporting icons and bitmaps.
  62.  
  63.  
  64. 3. New Properties
  65. =================
  66.  
  67. Except as noted, all properties are available at design-time.
  68.  
  69. Caption -- This is a TLabel component which, if used, will be updated
  70. with the current calendar month and year as the user navigates.
  71.  
  72. CenterDates -- This dictates whether or not to center the dates within
  73. each cell.  If you set this to False, the dates will be displayed in
  74. the lower-right corner of the cells, which I feel is preferable when
  75. you are using special days (see below).
  76.  
  77. CloseOnDoubleClick -- If set to True, a double-click upon the calendar
  78. will cause the form upon which it resides to close.  This is ideal when
  79. you are using the calendar in a pop-up date entry dialog.
  80.  
  81. Menu -- If you plug a menuitem into this property, the navigation items
  82. on the popup menu will be added to that menuitem.  This is useful if you
  83. want to the user to be able to navigate within the menu from an existing
  84. menu.
  85.  
  86. SelectedBGColor -- This color will be used to draw the background
  87. of the currently selected date cell. The default is clHighlight.
  88.  
  89. SelectedFGColor -- This color is used to draw the currently selected
  90. date (i.e., the number). The default is clWhite.
  91.  
  92. SpecialDays (run-time only) -- This is a list of special days.  Each
  93. special day can have an attached icon or bitmap, as well as descriptive
  94. text.  As written, the text will be displayed to the user in the
  95. form of the calendar's Hint property.  (See the AddSpecialDay method
  96. below for instructions on how to create special days.)
  97.  
  98. UseFormCaption -- If set to True, the current calendar month and year
  99. will be continuously updated in the caption of the form upon which the
  100. calendar resides.  This can be used in conjunction with the Caption
  101. property, although I cannot imagine why you would need both of them.
  102.  
  103.  
  104. 4. New Method
  105. =============
  106.  
  107. AddSpecialDay -- Use this method to create special days.  It accepts three
  108. parameters:
  109.  
  110.    1. A TDateTime variable representing the desired date ;
  111.    2. A string containing the name of the .ICO or .BMP file to display for
  112.       that date.
  113.    3. A string containing additional descriptive information about that
  114.       date.  If used, this will be available to the user in the form
  115.       of the calendar's Hint property.
  116.  
  117.  
  118. 5. New Event
  119. ============
  120.  
  121. OnChangeMonth -- this is called whenever the user crosses a month
  122. boundary navigating within the calendar.  This hook is provided in case
  123. the Caption or UseFormCaption properties are not sufficient for your
  124. particular situation.
  125.  
  126.  
  127. 6. Copyright Notice
  128. ===================
  129.  
  130. This component is fully functional.  My copyright notice will appear
  131. when you drop it upon a form at design-time, but that will not occur at
  132. run-time.
  133.  
  134.  
  135. 7. Disclaimer
  136. =============
  137.  
  138. It is unfortunate that we live in a litigous society in which the
  139. lawyers are generally the only winners.  However, that makes the
  140. following verbiage necessary:
  141.  
  142. "THE CODE FOR THIS COMPONENT IS PROVIDED TO YOU AS IS BY ITS AUTHOR,
  143. GREG LIEF. THE AUTHOR HAS TESTED THE COMPONENT AND FEELS THAT IT WORKS
  144. AS BILLED, BUT MAKES ABSOLUTELY NO GUARANTEES OR WARRANTEES OF ANY KIND.
  145. IN OTHER WORDS, YOU ARE USING THIS ENTIRELY AT YOUR OWN RISK.  NEITHER
  146. THE AUTHOR NOR ANY OTHER ORGANIZATION WILL BE HELD RESPONSIBLE FOR ANY
  147. DIRECT OR INDIRECT DAMAGE RESULTING FROM THE USE OF EITHER THIS
  148. COMPONENT OR ANY DERIVATIVES THEREOF."
  149.  
  150.  
  151. 8. Technical Support
  152. ====================
  153.  
  154. The reason I am making this component available as freeware because I
  155. feel that it will be of use to other Delphi developers. However, always
  156. remember the old maxim "you get what you pay for".  In other words, do
  157. not get carried away by expecting technical support, because you will be
  158. sadly disappointed.
  159.  
  160.  
  161. 9. Revision History
  162. ===================
  163.  
  164. Dec 20, 1996 -- added Menu property (thanks Keith!)
  165.  
  166. Dec 19, 1996 -- substituted SelectedColor property with SelectedBGColor
  167.                 and SelectedFGColor properties for greater control
  168.  
  169. Dec 07, 1996 -- added "System Date" option to integrated popup menu
  170.  
  171. Dec 06, 1996 -- added support for Home and End keys to jump to first and
  172.                 last days of current month
  173.  
  174. Nov 06, 1996 -- a) added pop-up menu to move by month/year and show
  175.                    description for special days
  176.  
  177.                 b) attached label was not being redisplayed if CalendarDate
  178.                    property was changed programmatically.  Fixed.
  179.  
  180. Sep 12, 1996 -- removed logic which shrunk the column headings
  181.  
  182. Sep 09, 1996 -- initial public release
  183.  
  184.  
  185. 10. Comments
  186. ============
  187.  
  188. If you find this component useful, I would appreciate hearing from you
  189. via e-mail (greglief@teleport.com).
  190.  
  191. I would also greatly appreciate your taking the time to evaluate the
  192. Delphi Object Lessons technical journal, for which I serve as Executive
  193. Editor.  More information and a sample issue are available at URL
  194. http://www.teleport.com/~ol/djournal.shtml.
  195.  
  196. If you would like to learn how to create your own components, you should
  197. strongly consider the Delphi Training Tour component creation seminar,
  198. designed by yours truly.  For more information, visit URL
  199. http://www.teleport.com/~ol/dtt.shtml.
  200.  
  201. The most updated version of this component can always be found at my
  202. personal web site (http://www.teleport.com/~greglief).
  203.  
  204. *** over and out ***
  205.