[Win32forth-cvs] win32forth/src/lib Calendar.f,1.2,1.3

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/win32forth/win32forth/src/lib
In directory sc8-pr-cvs9.sourceforge.net:/tmp/cvs-serv21234/win32forth/src/lib

Modified Files:
	Calendar.f 
Log Message:
gah: Marked up comments on styles and format

Index: Calendar.f
===================================================================
RCS file: /cvsroot/win32forth/win32forth/src/lib/Calendar.f,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** Calendar.f	11 Jun 2006 09:03:49 -0000	1.2
--- Calendar.f	29 Jun 2006 10:47:28 -0000	1.3
***************
*** 1,2 ****
--- 1,4 ----
+ \ $Id$
+ 
  anew -Calendar.f

***************
*** 168,268 ****
                  ;M

- /*
- Date and Time Picker Control Styles
- 
- The window styles listed here are specific to date and time picker controls.
- 
- Constants
- DTS_APPCANPARSE
- Allows the owner to parse user input and take necessary action. It enables users to edit
- within the client area of the control when they press the F2 key. The control sends
- DTN_USERSTRING notification messages when users are finished.
- 
- DTS_LONGDATEFORMAT
- Displays the date in long format. The default format string for this style is
- defined by LOCALE_SLONGDATEFORMAT, which produces output like "Friday, April 19, 1996".
- 
- DTS_RIGHTALIGN
- The drop-down month calendar will be right-aligned with the control instead of
- left-aligned, which is the default.
- 
- DTS_SHOWNONE
- It is possible to have no date currently selected in the control. With this style,
- the control displays a check box that users can check once they have entered or selected
- a date. Until this check box is checked, the application will not be able to retrieve
-  the date from the control because, in essence, the control has no date. This state can
-  be set with the DTM_SETSYSTEMTIME message or queried with the DTM_GETSYSTEMTIME message.
- 
- DTS_SHORTDATEFORMAT
- Displays the date in short format. The default format string for this style is defined
- by LOCALE_SSHORTDATE, which produces output like "4/19/96".
- 
- DTS_SHORTDATECENTURYFORMAT
- Version 5.80. Similar to the DTS_SHORTDATEFORMAT style, except the year is a
- four-digit field. The default format string for this style is based on LOCALE_SSHORTDATE.
-  The output looks like: "4/19/1996".
- 
- DTS_TIMEFORMAT
- Displays the time. The default format string for this style is defined by
- LOCALE_STIMEFORMAT, which produces output like "5:31:42 PM".
- 
- DTS_UPDOWN
- Places an up-down control to the right of the DTP control to modify date-time values.
- This style can be used in place of the drop-down month calendar, which is the default
- style.
- 
- Remarks
- 
- The DTS_XXXFORMAT styles that define the display format cannot be combined. If none of
- the format styles are suitable, use a DTM_SETFORMAT message to define a custom format.
- */
- 
  :M WindowStyle: ( -- style )
  \ *G Get the window style of the control. Default style is: WS_BORDER.
                  WindowStyle: super WS_BORDER or style or ;M
- /*
- Format Strings
- A DTP format string consists of a series of elements that represent a particular piece of
- information and define its display format. The elements will be displayed in the order
- they appear in the format string.

! Date and time format elements will be replaced by the actual date and time. They are
! defined by the following groups of characters:
! 
! Element     Description
! "d"     The one- or two-digit day.
! "dd"    The two-digit day. Single-digit day values are preceded by a zero.
! "ddd"   The three-character weekday abbreviation.
! "dddd"  The full weekday name.
! "h"     The one- or two-digit hour in 12-hour format.
! "hh"    The two-digit hour in 12-hour format. Single-digit values are preceded by a zero.
! "H"     The one- or two-digit hour in 24-hour format.
! "HH"    The two-digit hour in 24-hour format. Single-digit values are preceded by a zero.
! "m"     The one- or two-digit minute.
! "mm"    The two-digit minute. Single-digit values are preceded by a zero.
! "M"     The one- or two-digit month number.
! "MM"    The two-digit month number. Single-digit values are preceded by a zero.
! "MMM"   The three-character month abbreviation.
! "MMMM"  The full month name.
! "t"     The one-letter AM/PM abbreviation (that is, AM is displayed as "A").
! "tt"    The two-letter AM/PM abbreviation (that is, AM is displayed as "AM").
! "yy"    The last two digits of the year (that is, 1996 would be displayed as "96").
! "yyyy"  The full year (that is, 1996 would be displayed as "1996").

- To make the information more readable, you can add body text to the format string by
- enclosing it in single quotes. Spaces and punctuation marks do not need to be quoted.

- Note   Nonformat characters that are not delimited by single quotes will result in
- unpredictable display by the DTP control.

- For example, to display the current date with the format
- "'Today is: 04:22:31 Tuesday Mar 23, 1996", the format string is
- "'Today is: 'hh':'m':'s dddd MMM dd', 'yyyy". To include a single quote in your body text,
- use two consecutive single quotes. For example, "'Don''t forget' MMM dd',' yyyy" produces
- output that looks like: Don't forget Mar 23, 1996. It is not necessary to use quotes
- with the comma, so "'Don''t forget' MMM dd, yyyy" is also valid, and produces the same
- output.

- */

  :M SetCustomFormat:   ( z"format"  -- )
--- 170,228 ----
                  ;M

  :M WindowStyle: ( -- style )
  \ *G Get the window style of the control. Default style is: WS_BORDER.
                  WindowStyle: super WS_BORDER or style or ;M

! \ *P Date and Time Picker Control Styles
! \ **
! \ ** The window styles listed here are specific to date and time picker controls.
! \ **
! \ ** Constants
! \ ** DTS_APPCANPARSE
! \ ** Allows the owner to parse user input and take necessary action. It enables users to edit
! \ ** within the client area of the control when they press the F2 key. The control sends
! \ ** DTN_USERSTRING notification messages when users are finished.
! \ **
! \ ** DTS_LONGDATEFORMAT
! \ ** Displays the date in long format. The default format string for this style is
! \ ** defined by LOCALE_SLONGDATEFORMAT, which produces output like "Friday, April 19, 1996".
! \ **
! \ ** DTS_RIGHTALIGN
! \ ** The drop-down month calendar will be right-aligned with the control instead of
! \ ** left-aligned, which is the default.
! \ **
! \ ** DTS_SHOWNONE
! \ ** It is possible to have no date currently selected in the control. With this style,
! \ ** the control displays a check box that users can check once they have entered or selected
! \ ** a date. Until this check box is checked, the application will not be able to retrieve
! \ **  the date from the control because, in essence, the control has no date. This state can
! \ **  be set with the DTM_SETSYSTEMTIME message or queried with the DTM_GETSYSTEMTIME message.
! \ **
! \ ** DTS_SHORTDATEFORMAT
! \ ** Displays the date in short format. The default format string for this style is defined
! \ ** by LOCALE_SSHORTDATE, which produces output like "4/19/96".
! \ **
! \ ** DTS_SHORTDATECENTURYFORMAT
! \ ** Version 5.80. Similar to the DTS_SHORTDATEFORMAT style, except the year is a
! \ ** four-digit field. The default format string for this style is based on LOCALE_SSHORTDATE.
! \ **  The output looks like: "4/19/1996".
! \ **
! \ ** DTS_TIMEFORMAT
! \ ** Displays the time. The default format string for this style is defined by
! \ ** LOCALE_STIMEFORMAT, which produces output like "5:31:42 PM".
! \ **
! \ ** DTS_UPDOWN
! \ ** Places an up-down control to the right of the DTP control to modify date-time values.
! \ ** This style can be used in place of the drop-down month calendar, which is the default
! \ ** style.
! \ **
! \ ** Remarks
! \ **
! \ ** The DTS_XXXFORMAT styles that define the display format cannot be combined. If none of
! \ ** the format styles are suitable, use a DTM_SETFORMAT message to define a custom format.

  :M SetCustomFormat:   ( z"format"  -- )
***************
*** 271,274 ****
--- 231,276 ----
                  ;M

+ \ *P Format Strings
+ \ ** A DTP format string consists of a series of elements that represent a particular piece of
+ \ ** information and define its display format. The elements will be displayed in the order
+ \ ** they appear in the format string.
+ \ **
+ \ ** Date and time format elements will be replaced by the actual date and time. They are
+ \ ** defined by the following groups of characters:
+ \ **
+ \ ** Element     Description
+ \ ** "d"     The one- or two-digit day.
+ \ ** "dd"    The two-digit day. Single-digit day values are preceded by a zero.
+ \ ** "ddd"   The three-character weekday abbreviation.
+ \ ** "dddd"  The full weekday name.
+ \ ** "h"     The one- or two-digit hour in 12-hour format.
+ \ ** "hh"    The two-digit hour in 12-hour format. Single-digit values are preceded by a zero.
+ \ ** "H"     The one- or two-digit hour in 24-hour format.
+ \ ** "HH"    The two-digit hour in 24-hour format. Single-digit values are preceded by a zero.
+ \ ** "m"     The one- or two-digit minute.
+ \ ** "mm"    The two-digit minute. Single-digit values are preceded by a zero.
+ \ ** "M"     The one- or two-digit month number.
+ \ ** "MM"    The two-digit month number. Single-digit values are preceded by a zero.
+ \ ** "MMM"   The three-character month abbreviation.
+ \ ** "MMMM"  The full month name.
+ \ ** "t"     The one-letter AM/PM abbreviation (that is, AM is displayed as "A").
+ \ ** "tt"    The two-letter AM/PM abbreviation (that is, AM is displayed as "AM").
+ \ ** "yy"    The last two digits of the year (that is, 1996 would be displayed as "96").
+ \ ** "yyyy"  The full year (that is, 1996 would be displayed as "1996").
+ \ **
+ \ ** To make the information more readable, you can add body text to the format string by
+ \ ** enclosing it in single quotes. Spaces and punctuation marks do not need to be quoted.
+ \ **
+ \ ** Note   Nonformat characters that are not delimited by single quotes will result in
+ \ ** unpredictable display by the DTP control.
+ \ **
+ \ ** For example, to display the current date with the format
+ \ ** "'Today is: 04:22:31 Tuesday Mar 23, 1996", the format string is
+ \ ** "'Today is: 'hh':'m':'s dddd MMM dd', 'yyyy". To include a single quote in your body text,
+ \ ** use two consecutive single quotes. For example, "'Don''t forget' MMM dd',' yyyy" produces
+ \ ** output that looks like: Don't forget Mar 23, 1996. It is not necessary to use quotes
+ \ ** with the comma, so "'Don''t forget' MMM dd, yyyy" is also valid, and produces the same
+ \ ** output.
+ 
  :M GetTime:     ( -- hrs min secs )
  \ *G get user selected time