From: <mie...@us...> - 2011-04-26 13:47:28
|
Revision: 6940 http://oorexx.svn.sourceforge.net/oorexx/?rev=6940&view=rev Author: miesfeld Date: 2011-04-26 13:47:19 +0000 (Tue, 26 Apr 2011) Log Message: ----------- Continue ooDialog doc revision Modified Paths: -------------- docs/trunk/oodialog/eventNotification.xml docs/trunk/oodialog/monthcalendar.xml docs/trunk/oodialog/userdialog.xml Modified: docs/trunk/oodialog/eventNotification.xml =================================================================== --- docs/trunk/oodialog/eventNotification.xml 2011-04-25 20:02:12 UTC (rev 6939) +++ docs/trunk/oodialog/eventNotification.xml 2011-04-26 13:47:19 UTC (rev 6940) @@ -4554,7 +4554,6 @@ notification message is only sent if the month calendar control has the DAYSTATE style. The <emphasis role="italic">willReply</emphasis> argument is ignored for this event, the event handler must <link linkend="sctCodingEventHandlers">return</link> a reply. - bold. </para> </listitem></varlistentry> <varlistentry><term>RELEASED</term> @@ -4581,8 +4580,8 @@ <varlistentry><term>VIEWCHANGE</term> <listitem> <para> - Sent by a month calendar control when the current view changes. Connecting this event requires Windows Vista - or later. The return value from the event handler is ignored for this event. + <emphasis role="bold">Requires Windows Vista or later</emphasis>. Sent by a month calendar control when the + current view changes. The return value from the event handler is ignored for this event. </para> </listitem></varlistentry> </variablelist> @@ -4667,13 +4666,24 @@ </listitem></varlistentry> </variablelist> + <section id="evtMonthCalendarGETDAYSTATE"><title>GetDayState Event Handler</title> -<indexterm><primary>MonthCalendar Event</primary><secondary>GETDAYSTATE</secondary></indexterm> +<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>GETDAYSTATE</tertiary></indexterm> + +<programlisting> +<![CDATA[ +::method onGetDayState unguarded + use arg startDate, count, id, hwnd + + return dayStateBuffer +]]> +</programlisting> + <para> The event handler for the get day state event is invoked when the month calendar control requests information on how to dispaly days in the calendar. The notification is only sent when the month calendar has the DAYSTATE style. The programmer must reply to this notification and <emphasis role="bold">must</emphasis> use the <link - linkend="clsDayStates">DayStates</link> class to properly construct the reply. + linkend="clsDayStates">DayStates</link> class to properly construct the reply. The interpreter waits for the reply. </para> <para> The reply is a buffer containing a sequential collection of <link linkend="clsDayState">DayState</link> values. Each @@ -4685,53 +4695,62 @@ <para> Essentially, the programmer constructs a number of day state values and then returns a buffer containing those values. </para> -<para> - The event handler recieves 4 arguments and must return a buffer obtained through the - <computeroutput>DayStates</computeroutput> class: -</para> - -<programlisting> -<![CDATA[ -::method onGetDayState unguarded - use arg startDate, count, id, hwnd - - return dayStateBuffer -]]> -</programlisting> <variablelist> - <varlistentry><term>startDate</term> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - A <computeroutput>DateTime</computeroutput> object that specifies the start date the month calendar control needs - day state values for. Each day state value specifies the state for every day in a month, even if the <emphasis - role="italic">dayState</emphasis> arg is a date in the middle of a month. I.e., if the start date is January 11, - 2011, the first day state value should be for the month of January. + The event handling method recieves three arguments: </para> + <variablelist> + <varlistentry><term>startDate</term> + <listitem> + <para> + A <computeroutput>DateTime</computeroutput> object that specifies the start date the month calendar control needs + day state values for. Each day state value specifies the state for every day in a month, even if the <emphasis + role="italic">dayState</emphasis> arg is a date in the middle of a month. I.e., if the start date is January 11, + 2011, the first day state value should be for the month of January. + </para> + </listitem></varlistentry> + <varlistentry><term>count</term> + <listitem> + <para> + The number of day state values required. + </para> + </listitem></varlistentry> + <varlistentry><term>id</term> + <listitem> + <para> + The resource ID for the month calendar control requesting the information. + </para> + </listitem></varlistentry> + <varlistentry><term>hwnd</term> + <listitem> + <para> + The window <link linkend="defHandle">handle</link> for the month calendar control requesting the information. + </para> + </listitem></varlistentry> + </variablelist> </listitem></varlistentry> - <varlistentry><term>count</term> + <varlistentry><term><emphasis role="bold">Return:</emphasis></term> <listitem> <para> - The number of day state values required. + The reply is a buffer containing a sequential collection of <link linkend="clsDayState">DayState</link> values. Each + individual day state value specifies how each day in a single month should be displayed. If a day in the day state + value is turned on, the day is displayed in bold. If a day is not turned on, it is displayed with no emphasis. The + returned buffer must be constructed by using the <link linkend="clsDayStates">DayStates</link> class. </para> - </listitem></varlistentry> - <varlistentry><term>id</term> - <listitem> <para> - The resource ID for the month calendar control requesting the information. + The <computeroutput>DayStates</computeroutput> and <computeroutput>DayState</computeroutput> classes provide methods + to properly construct the day state values and the buffer containing the values. Essentially, the programmer + constructs a number of day state values and then returns a buffer containing those values. </para> </listitem></varlistentry> - <varlistentry><term>hwnd</term> + <varlistentry><term><emphasis role="bold">Example</emphasis></term> <listitem> <para> - The window <link linkend="defHandle">handle</link> for the month calendar control requesting the information. - </para> - </listitem></varlistentry> -</variablelist> -<para> - <emphasis role="bold">Example:</emphasis> The following example is used in a application that displays the 1st and the - 15th of each month in bold. The start date can be ignored in this case because the day state value is the same for any - month. -</para> + The following example is used in a application that displays the 1st and the 15th of each month in bold. The start + date can be ignored in this case because the day state value is the same for any month. + <programlisting> <![CDATA[ @@ -4753,36 +4772,56 @@ ]]> </programlisting> + </para> + </listitem></varlistentry> +</variablelist> </section> <!-- End GetDayState Event Handler --> <section id="evtMonthCalendarRELEASED"><title>Released Event Handler</title> -<indexterm><primary>MonthCalendar Event</primary><secondary>RELEASED</secondary></indexterm> -<para> - The event handler for the released event is invoked when the month calendar releases the moust capture. The method - recieves 2 arguments: -</para> +<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>RELEASED</tertiary></indexterm> <programlisting> <![CDATA[ -::method onRelease unguarded +::method onReleased unguarded use arg id, hwnd return 0 ]]> </programlisting> + +<para> + The event handler for the released event is invoked when the month calendar releases the mouse capture. The + interpreter waits, or does not wait, for the reply as specified by the programmer in the <link + linkend="mthConnectMonthCalendarEvent">connectMonthCalendarEvent</link> method. The operating system ignores the value + of the reply. +</para> <variablelist> - <varlistentry><term>id</term> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - The resource ID of the month calendar sending the notification. + The event handling method recieves two arguments: </para> + <variablelist> + <varlistentry><term>id</term> + <listitem> + <para> + The resource ID of the month calendar sending the notification. + </para> + </listitem></varlistentry> + <varlistentry><term>hwnd</term> + <listitem> + <para> + The window <link linkend="defHandle">handle</link> for the month calendar control sending the notification + </para> + </listitem></varlistentry> + </variablelist> </listitem></varlistentry> - <varlistentry><term>hwnd</term> + <varlistentry><term><emphasis role="bold">Return:</emphasis></term> <listitem> <para> - The window <link linkend="defHandle">handle</link> for the month calendar control sending the notification + Since the return value is ignored by the operating system, any value can be used. Typically, 0 is returned. </para> </listitem></varlistentry> </variablelist> @@ -4791,20 +4830,8 @@ <section id="evtMonthCalendarSELCHANGED"><title>SelChanged Event Handler</title> -<indexterm><primary>MonthCalendar Event</primary><secondary>SELCHANGED</secondary></indexterm> -<para> - The event handler for the selection changed event is invoked when the currently selected date or range of dates - changes. This notification is sent when the user explicitly changes the selection within the current month or when - the selection is implicitly changed by the user navigating to another month. The operating system also send this - notification at regular intervals so that the month calendar control can respond to date changes. +<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>SELCHANGED</tertiary></indexterm> -</para> -<para> - The notification is similar to the SELECT notification, except that the SELECT notification is only sent when the user - explicitly changes the date. This notification is sent when the selecte date is changed for any reason. The method - recieves 4 arguments and the return value from the event handler is ignored. -</para> - <programlisting> <![CDATA[ ::method onSelChanged unguarded @@ -4813,45 +4840,72 @@ return 0 ]]> </programlisting> + +<para> + The event handler for the selection changed event is invoked when the currently selected date or range of dates + changes. This notification is sent when the user explicitly changes the selection within the current month or when the + selection is implicitly changed by the user navigating to another month. The operating system also sends this + notification at regular intervals so that the month calendar control can respond to date changes. +</para> +<para> + The notification is similar to the <link linkend="evtMonthCalendarSELECT">SELECT</link> notification, except that the SELECT + notification is only sent when the user explicitly changes the date. This notification is sent when the selected date + is changed for any reason. +</para> +<para> + The interpreter waits, or does not wait, for the reply as specified by the programmer in the <link + linkend="mthConnectMonthCalendarEvent">connectMonthCalendarEvent</link> method. The operating system ignores the value + of the reply. +</para> <variablelist> - <varlistentry><term>selStart</term> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - A <computeroutput>DateTime</computeroutput> object that is the new selected date, or the first selected date in a - range of selected dates. + The event handling method recieves three arguments: </para> + <variablelist> + <varlistentry><term>selStart</term> + <listitem> + <para> + A <computeroutput>DateTime</computeroutput> object that is the new selected date, or the first selected date in a + range of selected dates. + </para> + </listitem></varlistentry> + <varlistentry><term>selEnd</term> + <listitem> + <para> + A <computeroutput>DateTime</computeroutput> object that is the last selected date in a range of selected dates. If + only a single date is selected, then <emphasis role="italic">selEnd</emphasis> will be the same date as <emphasis + role="italic">selStart</emphasis>. + </para> + </listitem></varlistentry> + <varlistentry><term>id</term> + <listitem> + <para> + The resource ID of the month calendar sending the notification. + </para> + </listitem></varlistentry> + <varlistentry><term>hwnd</term> + <listitem> + <para> + The window <link linkend="defHandle">handle</link> for the month calendar control sending the notification. + </para> + </listitem></varlistentry> + </variablelist> </listitem></varlistentry> - <varlistentry><term>selEnd</term> + <varlistentry><term><emphasis role="bold">Return:</emphasis></term> <listitem> <para> - A <computeroutput>DateTime</computeroutput> object that is the last selected date in a range of selected dates. If - only a single date is selected, then <emphasis role="italic">selEnd</emphasis> will be the same date as <emphasis - role="italic">selStart</emphasis>. + The return value is ignored by the operating system and the programmer can return any value. Typically 0 is + returned. </para> </listitem></varlistentry> - <varlistentry><term>id</term> - <listitem> - <para> - The resource ID of the month calendar sending the notification. - </para> - </listitem></varlistentry> - <varlistentry><term>hwnd</term> - <listitem> - <para> - The window <link linkend="defHandle">handle</link> for the month calendar control sending the notification - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End SelChanged Event Handler --> <section id="evtMonthCalendarSELECT"><title>Select Event Handler</title> -<indexterm><primary>MonthCalendar Event</primary><secondary>SELECT</secondary></indexterm> -<para> - The SELECT event handler is invoked when the user explicity selects a new date. Contrast this with the SELCHANGE - event handler which is invoked when the selected date is changed for any reason. The method recieves 4 arguments and - the return from the event handler is ignored. -</para> +<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>SELECT</tertiary></indexterm> <programlisting> <![CDATA[ @@ -4861,48 +4915,66 @@ return 0 ]]> </programlisting> + +<para> + The SELECT event handler is invoked when the user explicity selects a new date. Contrast this with the <link + linkend="evtMonthCalendarSELCHANGED">SELCHANGE</link> event handler which is invoked when the selected date is changed for any + reason. +</para> +<para> + The interpreter waits, or does not wait, for the reply as specified by the programmer in the <link + linkend="mthConnectMonthCalendarEvent">connectMonthCalendarEvent</link> method. The operating system ignores the value + of the reply. +</para> <variablelist> - <varlistentry><term>selStart</term> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - A <computeroutput>DateTime</computeroutput> object that is the new selected date, or the first selected date in a - range of selected dates. + The event handling method recieves four arguments: </para> + <variablelist> + <varlistentry><term>selStart</term> + <listitem> + <para> + A <computeroutput>DateTime</computeroutput> object that is the new selected date, or the first selected date in a + range of selected dates. + </para> + </listitem></varlistentry> + <varlistentry><term>selEnd</term> + <listitem> + <para> + A <computeroutput>DateTime</computeroutput> object that is the last selected date in a range of selected dates. If + only a single date is selected, then <emphasis role="italic">selEnd</emphasis> will be the same date as <emphasis + role="italic">selStart</emphasis>. + </para> + </listitem></varlistentry> + <varlistentry><term>id</term> + <listitem> + <para> + The resource ID of the month calendar sending the notification. + </para> + </listitem></varlistentry> + <varlistentry><term>hwnd</term> + <listitem> + <para> + The window <link linkend="defHandle">handle</link> for the month calendar control sending the notification. + </para> + </listitem></varlistentry> + </variablelist> </listitem></varlistentry> - <varlistentry><term>selEnd</term> + <varlistentry><term><emphasis role="bold">Return:</emphasis></term> <listitem> <para> - A <computeroutput>DateTime</computeroutput> object that is the last selected date in a range of selected dates. If - only a single date is selected, then <emphasis role="italic">selEnd</emphasis> will be the same date as <emphasis - role="italic">selStart</emphasis>. + The programmer can return any value because the operating system ingores the returned value. Typically 0 is + returned. </para> </listitem></varlistentry> - <varlistentry><term>id</term> - <listitem> - <para> - The resource ID of the month calendar sending the notification. - </para> - </listitem></varlistentry> - <varlistentry><term>hwnd</term> - <listitem> - <para> - The window <link linkend="defHandle">handle</link> for the month calendar control sending the notification - </para> - </listitem></varlistentry> </variablelist> + </section> <!-- End Select Event Handler --> - <section id="evtMonthCalendarVIEWCHANGE"><title>ViewChange Event Handler</title> -<indexterm><primary>MonthCalendar Event</primary><secondary>VIEWCHANGE</secondary></indexterm> -<para> - The view change notification is sent when the current view changes. The notification is only sent on Windows Vista or - later. A syntax exception is raised if the VIEWCHANGE event is connected when the program is not running on Vista or - later. -</para> -<para> - The event handler recieves 4 arguments and the return value from the event handler is ignored. -</para> +<indexterm><primary>MonthCalendar class</primary><secondary>events</secondary><tertiary>VIEWCHANGE</tertiary></indexterm> <programlisting> <![CDATA[ @@ -4912,34 +4984,54 @@ return 0 ]]> </programlisting> + +<para> + The view change notification is sent when the current view changes. The notification is only sent on Windows Vista or + later. A syntax exception is raised if the VIEWCHANGE event is connected when the program is not running on Vista or + later. +</para> +<para> + The interpreter waits, or does not wait, for the reply as specified by the programmer in the <link + linkend="mthConnectMonthCalendarEvent">connectMonthCalendarEvent</link> method. The operating system ignores the value + of the reply. +</para> <variablelist> - <varlistentry><term>oldView</term> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - The <emphasis role="italic">oldView</emphasis> argument is a keyword denoting what the previous view was. It will be - one of: month, year, decade, or centuary. + The event handling method recieves four arguments: </para> + <variablelist> + <varlistentry><term>oldView</term> + <listitem> + <para> + The <emphasis role="italic">oldView</emphasis> argument is a keyword denoting what the previous view was. It will be + one of: month, year, decade, or centuary. + </para> + </listitem></varlistentry> + <varlistentry><term>newView</term> + <listitem> + <para> + The <emphasis role="italic">newView</emphasis> argument is a keyword denoting what the view was changed to. It also + will be one of: month, year, decade, or centuary. + </para> + </listitem></varlistentry> + <varlistentry><term>id</term> + <listitem> + <para> + The resource ID of the month calendar sending the notification. + </para> + </listitem></varlistentry> + <varlistentry><term>hwnd</term> + <listitem> + <para> + The window <link linkend="defHandle">handle</link> for the month calendar control sending the notification + </para> + </listitem></varlistentry> + </variablelist> </listitem></varlistentry> - <varlistentry><term>newView</term> - <listitem> - <para> - The <emphasis role="italic">newView</emphasis> argument is a keyword denoting what the view was changed to. It also - will be one of: month, year, decade, or centuary. - </para> - </listitem></varlistentry> - <varlistentry><term>id</term> - <listitem> - <para> - The resource ID of the month calendar sending the notification. - </para> - </listitem></varlistentry> - <varlistentry><term>hwnd</term> - <listitem> - <para> - The window <link linkend="defHandle">handle</link> for the month calendar control sending the notification - </para> - </listitem></varlistentry> </variablelist> + </section> <!-- End ViewChange Event Handler --> </section> <!-- End EventNotification::connectionMonthCalendarEvent() --> @@ -5043,7 +5135,17 @@ <section id="evtUpDownDELTAPOS"><title>DeltaPos Event Handler</title> -<indexterm><primary>UpDown Event</primary><secondary>DELTAPOS</secondary></indexterm> +<indexterm><primary>UpDown class</primary><secondary>events</secondary><tertiary>DELTAPOS</tertiary></indexterm> + +<programlisting> +<![CDATA[ +::method onDeltaPos unguarded + use arg pos, delta, id, hwnd + + return buffer +]]> +</programlisting> + <para> The event handler for the up-down DELTAPOS event is invoked when when the position of the control is about to change. The arguments the event handler recieves allow the programmer to examine the proposed change in position, to modify @@ -5054,22 +5156,12 @@ linkend="mthDeltaPosReply">deltaPosReply</link> class method of the <link linkend="clsUpDown">UpDown</link> class is used to properly construct the return value from the event handler. </para> - <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> The event handling method recieves four arguments: </para> - - <programlisting> - <![CDATA[ - ::method onDeltaPos unguarded - use arg pos, delta, id, hwnd - - return 0 - ]]> - </programlisting> <variablelist> <varlistentry><term>pos</term> <listitem> @@ -5102,17 +5194,12 @@ <varlistentry><term><emphasis role="bold">Return:</emphasis></term> <listitem> <para> - If the proposed change in position is not going to be canceled or modified, the programmer can simply return - <computeroutput>.false</computeroutput>. However, to cancel or modify the change, a delta position buffer must be - returned. This buffer can only be constructed properly by using the <link linkend="clsUpDown">UpDown</link> - class's <link linkend="mthDeltaPosReply">deltaPosReply</link> method. + A delta position buffer must be returned by the event handler. This buffer can only be constructed properly by + using the <link linkend="clsUpDown">UpDown</link> class's <link linkend="mthDeltaPosReply">deltaPosReply</link> + method. The arguments to <emphasis role="italic">deltaPosReply</emphasis> allow the programmer to return a value + that makes no change to the new position, cancels altogether the change in position, or modifies the resulting new + position. </para> - <para> - Since the <emphasis role="italic">deltaPosReply</emphasis> method can also be used to reply when the proposed change - is allowed, it may be simplest to always use the method to produce the proper return from the event handler. The - arguments to <emphasis role="italic">deltaPosReply</emphasis> allow the programmer to return a value that makes no - change to the new position, cancels the change in position, or modifies the resulting new position. - </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example</emphasis></term> <listitem> Modified: docs/trunk/oodialog/monthcalendar.xml =================================================================== --- docs/trunk/oodialog/monthcalendar.xml 2011-04-25 20:02:12 UTC (rev 6939) +++ docs/trunk/oodialog/monthcalendar.xml 2011-04-26 13:47:19 UTC (rev 6940) @@ -49,15 +49,15 @@ between different versions of Windows. </para> <para> - Windows does not support dates prior to 1601, so the <computeroutput>MonthCalendar</computeroutput> object can to be - used for dates prior to 1601 either. The month calendar control is based on the Gregorian calendar, which was - introduced in 1753. It will not calculate dates that are consistent with the Julian calendar that was in use prior to - 1753. + The <computeroutput>MonthCalendar</computeroutput> object can not be used for dates prior to 1601 because Windows does + not support dates prior to 1601. The month calendar control is based on the Gregorian calendar, which was introduced + in 1753. It will not calculate dates that are consistent with the Julian calendar that was in use prior to 1753. </para> <para> The <computeroutput>MonthCalendar</computeroutput> class provides methods that allow access to all the capabilities of - the underlying Windows month calendar control, including the features available only on Windows Vista and Windows 7 - when Rexx programs are running on those operationg systems. + the underlying Windows month calendar control, including the features available only on Windows Vista and Windows 7. + To use the Windows Vista features, the Rexx program must be running on Vista or later. Likewise, to use Windows 7 + features, the Rexx program must be running a Windows 7, or later, system. </para> <para> In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are @@ -73,8 +73,8 @@ <varlistentry><term><emphasis role="bold">Dynamic Definition:</emphasis></term> <listitem> <para> - To dynamically create a month calendar control in the temaplte of a <link linkend="clsUserDialog">UserDialog</link> - dialog use the <link linkend="mthCreateMonthCalendar">createMonthCalendar</link> + To dynamically create a month calendar control in the template of a user <link + linkend="clsUserDialog">dialog</link>, use the <link linkend="mthCreateMonthCalendar">createMonthCalendar</link> method. </para> </listitem></varlistentry> @@ -304,9 +304,12 @@ <section id="tmthCreateMonthCalendar"><title>createMonthCalendar (UserDialog method)</title> <para> - A month calendar object can be added to the template of a <link linkend="clsUserDialog">UserDialog</link> dialog - through the <link linkend="mthCreateMonthCalendar">createMonthCalendar</link> method. The basic syntax is: -<programlisting> <![CDATA[ + A <computeroutput>MonthCalendar</computeroutput> object can be added to the dialog template in a <link + linkend="clsUserDialog">UserDialog</link> through the <link + linkend="mthCreateMonthCalendar">createMonthCalendar</link> method. The basic syntax is: + +<programlisting> +<![CDATA[ >>-createMonthCalendar(-id-,--x-,--y-,--cx-,--cy-+----------+-+-------------+-->< +-,--style-+ +-,--attrName-+ @@ -318,7 +321,7 @@ <section id="tmthConnectMonthCalendarEvent"><title>connectMonthCalendarEvent (dialog object method)</title> <para> - To connect event notifications from a month calendar object use the <link + To connect event notifications from a month calendar control use the <link linkend="mthConnectMonthCalendarEvent">connectMonthCalendarEvent</link>() method of the <link linkend="chpDialogObject">dialog</link> object. The basic syntax is: @@ -344,41 +347,58 @@ </programlisting> <para> - xx + The <emphasis role="italic">date</emphasis> attribute reflects the currently selected date in the month calendar + control. </para> <variablelist> <varlistentry><term><emphasis role="bold">date get:</emphasis></term> <listitem> <para> - details about get + The value of the <emphasis role="italic">date</emphasis> attribute is a <computeroutput>DateTime</computeroutput> + object that reflects the currently selected date in the control. The time portion of the + <computeroutput>DateTime</computeroutput> object has no meaning. For multi-selection month calendar controls, the + date is the first selected date in the range of selected dates. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">date set:</emphasis></term> <listitem> <para> - details about set + A <computeroutput>DateTime</computeroutput> object must be used to set the <emphasis role="italic">date</emphasis> + attribute. The time portion of the <computeroutput>DateTime</computeroutput> object is ignored. When the <emphasis + role="italic">date</emphasis> attribute is assigned a new value, the currently selected date in the underlying + control is updated to reflect the value of the attribute. With multi-selection month calendar controls, when the + <emphasis role="italic">date</emphasis> attribute is assigned a new value, both the start and end of the selected + range are updated to reflect the new value. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The <emphasis role="italic">date</emphasis> attribute is most useful when used with single-selection month calendar + controls. For multi-selection controls, use the <link linkend="mthGetSelectionRange">getSelectionRange</link> and + <link linkend="mthSetSelectionRange">setSelectionRange</link> methods to work with the full range of selected dates. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> <listitem> <para> - xx + Raises syntax errors if incorrect usage is detected. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example ... + This example initializes a month calendar control with a currently selected date 10 years prior to the current + day. + <programlisting> <![CDATA[ +::method initDialog + mc = self~newMonthCalendar(IDC_MC) + mc~date = .DateTime~new~addYears(-10) + ]]> </programlisting> </para> @@ -391,25 +411,98 @@ <indexterm><primary>MonthCalendar class</primary><secondary>addStyle</secondary></indexterm> <programlisting> <![CDATA[ ->>--addStyle(--+--------+--)--------------------------------------------->< - +--type--+ +>>--addStyle(--styles--)------------------------->< + ]]> </programlisting> <para> - xx + Adds the specified month calendar style(s) to the control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx + The single argument is: <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>style [required]</term> <listitem> <para> - xx + A list of 1 or more of the following month calendar style keywords, separated by spaces, case is not significant: </para> + <para> + <simplelist type='vert' columns='3'> + <member>DAYSTATE </member> + <member>MULTI </member> + <member>NOTODAY </member> + <member>NOCIRCLE </member> + <member>WEEKNUMBERS</member> + <member>NOTRAILING </member> + <member>SHORTDAYS </member> + <member>NOSELCHANGE</member> + </simplelist> + <variablelist> + <varlistentry><term>DAYSTATE</term> + <listitem> + <para> + The month calendar will send the GETDAYSTATE <link linkend="ovvEvents">event</link> notification to request + information about which days should be displayed in bold. Use the <link + linkend="mthConnectMonthCalendarEvent">connectMonthCalendarEvent</link> method to connect this notification + with a method in the Rexx dialog object. + </para> + </listitem></varlistentry> + <varlistentry><term>MULTI</term> + <listitem> + <para> + This style allows the user to select a range of dates within the control. By default, the maximum range is one + week. The programmer changes the maximum range that can be selected by using the <link + linkend="mthSetRangeClsDTP">setMaxSelection</link> method. + </para> + </listitem></varlistentry> + <varlistentry><term>NOTODAY</term> + <listitem> + <para> + The month calendar control will not display the <emphasis role="italic">today</emphasis> date at the bottom of the control. + </para> + </listitem></varlistentry> + <varlistentry><term>NOCIRCLE</term> + <listitem> + <para> + The month calendar control will not circle the <emphasis role="italic">today</emphasis> date at the bottom of + the control. + </para> + </listitem></varlistentry> + <varlistentry><term>WEEKNUMBERS</term> + <listitem> + <para> + The month calendar displays week numbers (1-52) to the left of each row of days. Week 1 is defined by + Microsoft as the first week that contains at least four days. + </para> + </listitem></varlistentry> + <varlistentry><term>NOTRAILING</term> + <listitem> + <para> + <emphasis role="bold">Requires Windows Vista or later</emphasis>. This style disables displaying the dates + from the previous / next month in the current calendar. + </para> + </listitem></varlistentry> + <varlistentry><term>SHORTDAYS</term> + <listitem> + <para> + <emphasis role="bold">Requires Windows Vista or later</emphasis>. With this style, the month calendar uses the + shortest day name for the label of the day of the week column header. + </para> + </listitem></varlistentry> + <varlistentry><term>NOSELCHANGE</term> + <listitem> + <para> + <emphasis role="bold">Requires Windows Vista or later</emphasis>. With this style the selection does not + change when the user navigates to he next or previous month in the calendar. This style is needed for the + user to be able to select a range greater than what is currently displayed. + </para> + </listitem></varlistentry> + </variablelist> + </para> </listitem></varlistentry> </variablelist> </para> @@ -417,31 +510,31 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + A non-negative whole number that is the numeric value of the previous style of the month calendar control. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> <listitem> <para> - Additional comments. - </para> - </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Details</emphasis></term> - <listitem> - <para> - Raises syntax errors when incorrect arguments are detected. - </para> - <para> Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example ... + This example adds the NOSELCHANGE style to the calendar, provide the Rexx program is running on Vista or later. <programlisting> <![CDATA[ +::method initDialog + + ... + + if .OS~isAtLeastVista then do + mc = self~newMonthCalendar(IDC_MC) + mc~addStyle("NOSELCHANGE") + end + ]]> </programlisting> </para> @@ -454,25 +547,98 @@ <indexterm><primary>MonthCalendar class</primary><secondary>removeStyle</secondary></indexterm> <programlisting> <![CDATA[ ->>--removeStyle(--+--------+--)--------------------------------------------->< - +--type--+ +>>--removeStyle(--styles-)----------------------->< + ]]> </programlisting> <para> - xx + Removes the specified month calendar style(s) from the control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx + The single argument is: <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>style [required]</term> <listitem> <para> - xx + A list of 1 or more of the following month calendar style keywords, separated by spaces, case is not significant: </para> + <para> + <simplelist type='vert' columns='3'> + <member>DAYSTATE </member> + <member>MULTI </member> + <member>NOTODAY </member> + <member>NOCIRCLE </member> + <member>WEEKNUMBERS</member> + <member>NOTRAILING </member> + <member>SHORTDAYS </member> + <member>NOSELCHANGE</member> + </simplelist> + <variablelist> + <varlistentry><term>DAYSTATE</term> + <listitem> + <para> + The month calendar will send the GETDAYSTATE <link linkend="ovvEvents">event</link> notification to request + information about which days should be displayed in bold. Use the <link + linkend="mthConnectMonthCalendarEvent">connectMonthCalendarEvent</link> method to connect this notification + with a method in the Rexx dialog object. + </para> + </listitem></varlistentry> + <varlistentry><term>MULTI</term> + <listitem> + <para> + This style allows the user to select a range of dates within the control. By default, the maximum range is one + week. The programmer changes the maximum range that can be selected by using the <link + linkend="mthSetRangeClsDTP">setMaxSelection</link> method. + </para> + </listitem></varlistentry> + <varlistentry><term>NOTODAY</term> + <listitem> + <para> + The month calendar control will not display the <emphasis role="italic">today</emphasis> date at the bottom of the control. + </para> + </listitem></varlistentry> + <varlistentry><term>NOCIRCLE</term> + <listitem> + <para> + The month calendar control will not circle the <emphasis role="italic">today</emphasis> date at the bottom of + the control. + </para> + </listitem></varlistentry> + <varlistentry><term>WEEKNUMBERS</term> + <listitem> + <para> + The month calendar displays week numbers (1-52) to the left of each row of days. Week 1 is defined by + Microsoft as the first week that contains at least four days. + </para> + </listitem></varlistentry> + <varlistentry><term>NOTRAILING</term> + <listitem> + <para> + <emphasis role="bold">Requires Windows Vista or later</emphasis>. This style disables displaying the dates + from the previous / next month in the current calendar. + </para> + </listitem></varlistentry> + <varlistentry><term>SHORTDAYS</term> + <listitem> + <para> + <emphasis role="bold">Requires Windows Vista or later</emphasis>. With this style, the month calendar uses the + shortest day name for the label of the day of the week column header. + </para> + </listitem></varlistentry> + <varlistentry><term>NOSELCHANGE</term> + <listitem> + <para> + <emphasis role="bold">Requires Windows Vista or later</emphasis>. With this style the selection does not + change when the user navigates to he next or previous month in the calendar. This style is needed for the + user to be able to select a range greater than what is currently displayed. + </para> + </listitem></varlistentry> + </variablelist> + </para> </listitem></varlistentry> </variablelist> </para> @@ -480,35 +646,16 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + A non-negative whole number that is the numeric value of the combined styles of the month calendar control before + the specified style(s) were removed. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> <listitem> <para> - Additional comments. - </para> - </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Details</emphasis></term> - <listitem> - <para> - Raises syntax errors when incorrect arguments are detected. - </para> - <para> Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End MonthCalendar::removeStyle() --> @@ -517,57 +664,150 @@ <indexterm><primary>MonthCalendar class</primary><secondary>replaceStyle</secondary></indexterm> <programlisting> <![CDATA[ ->>--replaceStyle(--+--------+--)--------------------------------------------->< - +--type--+ +>>--replaceStyle(--oldStyles--,--newStyles--)---->< + ]]> </programlisting> <para> - xx + The <emphasis role="italic">replaceStyle</emphasis> method removes some existing month calendar styles and adds some + new styles. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx + The arguments are: <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>oldStyles [required]</term> <listitem> <para> - xx + A list of 1 or more of the following month calendar style keywords, separated by spaces, case is not significant. + The styles specified will be removed from the month calendar. </para> + <para> + <simplelist type='vert' columns='3'> + <member>DAYSTATE </member> + <member>MULTI </member> + <member>NOTODAY </member> + <member>NOCIRCLE </member> + <member>WEEKNUMBERS</member> + <member>NOTRAILING </member> + <member>SHORTDAYS </member> + <member>NOSELCHANGE</member> + </simplelist> + <variablelist> + <varlistentry><term>DAYSTATE</term> + <listitem> + <para> + The month calendar will send the GETDAYSTATE <link linkend="ovvEvents">event</link> notification to request + information about which days should be displayed in bold. Use the <link + linkend="mthConnectMonthCalendarEvent">connectMonthCalendarEvent</link> method to connect this notification + with a method in the Rexx dialog object. + </para> + </listitem></varlistentry> + <varlistentry><term>MULTI</term> + <listitem> + <para> + This style allows the user to select a range of dates within the control. By default, the maximum range is one + week. The programmer changes the maximum range that can be selected by using the <link + linkend="mthSetRangeClsDTP">setMaxSelection</link> method. + </para> + </listitem></varlistentry> + <varlistentry><term>NOTODAY</term> + <listitem> + <para> + The month calendar control will not display the <emphasis role="italic">today</emphasis> date at the bottom of the control. + </para> + </listitem></varlistentry> + <varlistentry><term>NOCIRCLE</term> + <listitem> + <para> + The month calendar control will not circle the <emphasis role="italic">today</emphasis> date at the bottom of + the control. + </para> + </listitem></varlistentry> + <varlistentry><term>WEEKNUMBERS</term> + <listitem> + <para> + The month calendar displays week numbers (1-52) to the left of each row of days. Week 1 is defined by + Microsoft as the first week that contains at least four days. + </para> + </listitem></varlistentry> + <varlistentry><term>NOTRAILING</term> + <listitem> + <para> + <emphasis role="bold">Requires Windows Vista or later</emphasis>. This style disables displaying the dates + from the previous / next month in the current calendar. + </para> + </listitem></varlistentry> + <varlistentry><term>SHORTDAYS</term> + <listitem> + <para> + <emphasis role="bold">Requires Windows Vista or later</emphasis>. With this style, the month calendar uses the + shortest day name for the label of the day of the week column header. + </para> + </listitem></varlistentry> + <varlistentry><term>NOSELCHANGE</term> + <listitem> + <para> + <emphasis role="bold">Requires Windows Vista or later</emphasis>. With this style the selection does not + change when the user navigates to he next or previous month in the calendar. This style is needed for the + user to be able to select a range greater than what is currently displayed. + </para> + </listitem></varlistentry> + </variablelist> + </para> </listitem></varlistentry> + <varlistentry><term>newStyles [required]</term> + <listitem> + <para> + A list of 1 or more month calendar style keywords, separated by spaces, case is not significant. The styles + specified will be added to the month calendar. The acceptable keywords are the same as those for the <emphasis + role="italic">oldStyles</emphasis> argument above. + </para> + </listitem></varlistentry> </variablelist> </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + A non-negative whole number that is the numeric value of the combined styles of the month calendar control before + the <emphasis role="italic">replaceStyle</emphasis> method was invoked. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The <emphasis role="italic">replaceStyle</emphasis> method is essentially a combination of the <link + linkend="mthRemoveStyleClsMC">removeStyle</link> and <link linkend="mthAddStyleClsMC">addStyle</link> methods into + one convenience method. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> <listitem> <para> - Raises syntax errors when incorrect arguments are detected. - </para> - <para> Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example ... + This example checks if the Rexx program is running on a Vista or later system. If it is, it removes the NOTODAY and + NOCIRCLE styles and adds the Vista specific, NOSELCHANGE, SHORTDAYS, and NOTRAILING styles. <programlisting> <![CDATA[ +::method initDialog + + ... + + if .OS~isAtLeastVista then do + mc = self~newMonthCalendar(IDC_MC) + mc~replaceStyle("NOTODAY NOCIRCLE", "NOSELCHANGE SHORTDAYS NOTRAILING") + end + ]]> </programlisting> </para> @@ -580,61 +820,36 @@ <indexterm><primary>MonthCalendar class</primary><secondary>getCalendarBorder</secondary></indexterm> <programlisting> <![CDATA[ ->>--getCalendarBorder(--+--------+--)--------------------------------------------->< - +--type--+ +>>--getCalendarBorder---------------------------->< + ]]> </programlisting> <para> - xx + Retrieves the month calendar's border, in pixels. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx - <variablelist> - <varlistentry><term>TERM</term> - <listitem> - <para> - xx - </para> - </listitem></varlistentry> - </variablelist> + There are no arguments to this method. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + The return is the width of the month calendar border in pixels. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> <listitem> <para> - Additional comments. + <emphasis role="bold">Requires Windows Vista or later</emphasis>. </para> - </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Details</emphasis></term> - <listitem> <para> - Raises syntax errors when incorrect arguments are detected. + Raises syntax errors if incorrect usage is detected. </para> - <para> - Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. - </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End MonthCalendar::getCalendarBorder() --> @@ -644,61 +859,36 @@ <indexterm><primary>MonthCalendar class</primary><secondary>getCalendarCount</secondary></indexterm> <programlisting> <![CDATA[ ->>--getCalendarCount(--+--------+--)--------------------------------------------->< - +--type--+ +>>--getCalendarCount----------------------------->< + ]]> </programlisting> <para> - xx + Gets the number of calendars currently displayed in the month calendar control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx - <variablelist> - <varlistentry><term>TERM</term> - <listitem> - <para> - xx - </para> - </listitem></varlistentry> - </variablelist> + This method does not use any arguments. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + Returns the number of calendars displayed. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> <listitem> <para> - Additional comments. + <emphasis role="bold">Requires Windows Vista or later</emphasis>. </para> - </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Details</emphasis></term> - <listitem> <para> - Raises syntax errors when incorrect arguments are detected. + Raises syntax errors if incorrect usage is detected. </para> - <para> - Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. - </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End MonthCalendar::getCalendarCount() --> @@ -707,61 +897,108 @@ <indexterm><primary>MonthCalendar class</primary><secondary>getCalID</secondary></indexterm> <programlisting> <![CDATA[ ->>--getCalID(--+--------+--)--------------------------------------------->< - +--type--+ +>>--getCalID------------------------------------->< + ]]> </programlisting> <para> - xx + Returns a keyword specifying the current calendar ID for the month calendar control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx - <variablelist> - <varlistentry><term>TERM</term> - <listitem> - <para> - xx - </para> - </listitem></varlistentry> - </variablelist> + There are no arguments to this method. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + A calendar ID keyword. The possible keywords and Microsoft's explanations for the keywords are listed in the Remarks + section. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + This table lists the keywords that might be returned from this method: </para> + <table id="tblCalendarIDs" frame="all"> + <title>Calendar IDs</title> + <tgroup cols="2"> + <colspec colwidth="1.75in"> + <thead> + <row> + <entry>ID Keyword</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>GREGORIAN</entry> + <entry>Gregorian (localized)</entry> + </row> + <row> + <entry>GREGORIAN_US</entry> + <entry>Gregorian (English strings always</entry> + </row> + <row> + <entry>JAPAN</entry> + <entry>Japanese Emperor Era</entry> + </row> + <row> + <entry>TAIWAN</entry> + <entry>Taiwan calendar</entry> + </row> + <row> + <entry>KOREA</entry> + <entry>Korean Tangun Era</entry> + </row> + <row> + <entry>HIJRI</entry> + <entry>Hijri (Arabic Lunar)</entry> + </row> + <row> + <entry>THAI</entry> + <entry>Thai</entry> + </row> + <row> + <entry>HEBREW</entry> + <entry>Hebrew (Lunar)</entry> + </row> + <row> + <entry>GREGORIAN_ME_FRENCH</entry> + <entry>Gregorian Middle East French</entry> + </row> + <row> + <entry>GREGORIAN_ARABIC</entry> + <entry>Gregorian Arabic</entry> + </row> + <row> + <entry>CAL_GREGORIAN_XLIT_ENGLISH</entry> + <entry>Gregorian transliterated English</entry> + </row> + <row> + <entry>CAL_GREGORIAN_XLIT_FRENCH</entry> + <entry>Gregorian transliterated French</entry> + </row> + <row> + <entry>UMALQURA</entry> + <entry>Um Al Qura (Arabic lunar) calendar </entry> + </row> + </tbody></tgroup> + </table> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> <listitem> <para> - Raises syntax errors when incorrect arguments are detected. + <emphasis role="bold">Requires Windows Vista or later</emphasis>. </para> <para> - Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + Raises syntax errors if incorrect usage is detected. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End MonthCalendar::getCalID() --> @@ -771,25 +1008,76 @@ <indexterm><primary>MonthCalendar class</primary><secondary>getColor</secondary></indexterm> <programlisting> <![CDATA[ ->>--getColor(--+--------+--)--------------------------------------------->< - +--type--+ +>>--getColor(--calendarPart--)------------------------------------------->< + ]]> </programlisting> <para> - xx + Retrieves the color for a given portion of a month calendar control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx + The single argument is: <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>calendarPart [required]</term> <listitem> <para> - xx + A single keyword specifying which part of the calendar to get the color for, case is not significant. The valid + keywords are: </para> + <para> + <simplelist type='vert' columns='3'> + <member>BACKGROUND </member> + <member>MONTHBK </member> + <member>TEXT </member> + <member>TITLEBK </member> + <member>TITLETEXT </member> + <member>TRAILINGTEXT</member> + <member></member> + </simplelist> + <variablelist> + <varlistentry><term>BACKGROUND</term> + <listitem> + <para> + Retrieves the background color displayed between months. + </para> + </listitem></varlistentry> + <varlistentry><term>MONTHBK</term> + <listitem> + <para> + Retrieves the background color displayed within the month. + </para> + </listitem></varlistentry> + <varlistentry><term>TEXT</term> + <listitem> + <para> + Retrieves the color used to display text within a month. + </para> + </listitem></varlistentry> + <varlistentry><term>TITLEBK</term> + <listitem> + <para> + Retrieves the background color displayed in the calendar's title. + </para> + </listitem></varlistentry> + <varlistentry><term>TITLETEXT</term> + <listitem> + <para> + Retrieves the color used to display text within the calendar's title. + </para> + </listitem></varlistentry> + <varlistentry><term>TRAILINGTEXT</term> + <listitem> + <para> + Retrieves the color used to display header day and trailing day text. Header and trailing days are the days + from the previous and following months that appear on the current month calendar. + </para> + </listitem></varlistentry> + </variablelist> + </para> </listitem></varlistentry> </variablelist> </para> @@ -797,31 +1085,36 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + On success, returns a COLORREF representing the color setting for the part of the month calendar control specified. + returns CLR_INVALID on error. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The <link linkend="clsImage">Image</link> class has a number of convenience methods for working with COLORREFs, + including the <link linkend="mthColorRef">ColorRef</link> method that explains what COLORREF is. </para> - </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Details</emphasis></term> - <listitem> <para> - Raises syntax errors when incorrect arguments are detected. + The <emphasis role="italic">colorRef</emphasis> method can be used to test the return for error. I.e.: + <computeroutput>.Image~colorRef(CLR_INVALID)</computeroutput>. (An error is not very likely.) </para> - <para> - Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. - </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example ... + This example gets the color for the head and traing day text, and checks for an error. <programlisting> <![CDATA[ + monthCalendar = self~newMonthCalendar(IDC_MC) + invalid = .Image~colorRef(CLR_INVALID) + + color = monthCalendar~getColor("TRAILINGTEXT") + if color == invalid then do + -- Fill in with some error routine. + end + ]]> </programlisting> </para> @@ -835,61 +1128,38 @@ <indexterm><primary... [truncated message content] |