From: <mie...@us...> - 2012-08-31 03:00:08
|
Revision: 8328 http://sourceforge.net/p/oorexx/code-0/8328 Author: miesfeld Date: 2012-08-31 03:00:03 +0000 (Fri, 31 Aug 2012) Log Message: ----------- Work on Publican ooDialog Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/button.xml docs/trunk/publican/oodialog/en-US/dataAttributes.xml docs/trunk/publican/oodialog/en-US/datetimepicker.xml docs/trunk/publican/oodialog/en-US/deprecated.xml docs/trunk/publican/oodialog/en-US/dialogControlObject.xml docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/dialogObject.xml docs/trunk/publican/oodialog/en-US/edit.xml docs/trunk/publican/oodialog/en-US/eventNotification.xml docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/menus.xml docs/trunk/publican/oodialog/en-US/monthcalendar.xml docs/trunk/publican/oodialog/en-US/mouse.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/progressbar.xml docs/trunk/publican/oodialog/en-US/propertySheetDialogs.xml docs/trunk/publican/oodialog/en-US/resdialog.xml docs/trunk/publican/oodialog/en-US/resources.xml docs/trunk/publican/oodialog/en-US/tab.xml docs/trunk/publican/oodialog/en-US/treeview.xml docs/trunk/publican/oodialog/en-US/updown.xml docs/trunk/publican/oodialog/en-US/userInput.xml docs/trunk/publican/oodialog/en-US/userdialog.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml docs/trunk/publican/oodialog/en-US/windowBase.xml docs/trunk/publican/oodialog/en-US/windowBaseDCO.xml docs/trunk/publican/oodialog/en-US/windowBaseDO.xml docs/trunk/publican/oodialog/en-US/windowExtensions.xml docs/trunk/publican/oodialog/en-US/windowExtensionsDCO.xml docs/trunk/publican/oodialog/en-US/windowExtensionsDO.xml Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-08-30 23:12:25 UTC (rev 8327) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-08-31 03:00:03 UTC (rev 8328) @@ -48,7 +48,7 @@ <indexterm><primary>Base Mixin classes</primary></indexterm> <para> ooDialog programs primarily deal with dialog and dialog control objects. The top-level objects in the programs, say - a user dialog (<xref linkend="clsUserDialog" />) or a button control (<xref linkend="clsButton" />) are + a user <xref linkend="clsUserDialog"/> or a button <xref linkend="clsButton"/> are actually composed of a number of base objects and / or mixin classes. All dialog and dialog control objects contain the methods of their component base classes. </para> @@ -89,7 +89,7 @@ PlainBaseDialog is the base class of all dialog classes in the ooDialog framework. It implements methods that are common to every dialog. PlainBaseDialog is an abstract class. A programmer can not instantiate a new PlainBaseDialog object and display a dialog on the screen. Rather, the ooDialog programmer subclasses one of the concrete classes - provided by the ooDialog framework, such as the ResDialog (<xref linkend="clsResDialog" />), the RcDialog (<xref + provided by the ooDialog framework, such as the <xref linkend="clsResDialog"/>, the RcDialog (<xref linkend="clsRcDialog" />), or the <xref linkend="clsUserDialog"/>, to create and execute a real dialog. </para> @@ -2163,11 +2163,11 @@ <section id="clsDialogControl"><title>DialogControl</title> <indexterm><primary>DialogControl Class</primary></indexterm> <para> - In a similar relationship as the PlainBaseDialog (<xref linkend="clsPlainBaseDialog" />) and dialog objects, the + In a similar relationship as the <xref linkend="clsPlainBaseDialog"/> and dialog objects, the <emphasis role="italic">DialogControl</emphasis> is the base class of all dialog control classes in the ooDialog framework. It implements methods that are common to every dialog control. DialogControl is also an abstract class. A programmer can not instantiate a new DialogControl object. Rather, one of the concrete dialog control classes such as, - the DateTimePicker (<xref linkend="clsDateTimePicker" />) or the ListView (<xref linkend="clsListView" />(, are + the <xref linkend="clsDateTimePicker"/> or the ListView (<xref linkend="clsListView" />(, are used. </para> <para> @@ -2549,7 +2549,7 @@ <indexterm><primary>ResourceUtils Class</primary></indexterm> <para> The <computeroutput>ResourceUtils</computeroutput> class provides utility methods for dealing with resource IDs (<xref - linkend="defResourceId" />) and parsing resource script (<xref linkend="defResourceScript" />) files. The + linkend="defResourceId" />) and parsing resource <xref linkend="defResourceScript"/> files. The class is inherited by the dialog (<xref linkend="chpDialogObject" />) object and the ApplicationManager (<xref linkend="clsApplicationManager" />) class. Most of the methods of the <computeroutput>ResourceUtils</computeroutput> class are used internally (<xref linkend="ovvUndocumented" />) and Modified: docs/trunk/publican/oodialog/en-US/button.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/button.xml 2012-08-30 23:12:25 UTC (rev 8327) +++ docs/trunk/publican/oodialog/en-US/button.xml 2012-08-31 03:00:03 UTC (rev 8328) @@ -80,15 +80,15 @@ <tbody> <row> <entry>Push Button</entry> -<entry>Button Class (<xref linkend="clsButton" />)</entry> +<entry>Button <xref linkend="clsButton"/></entry> </row> <row> <entry>Check Box Button</entry> -<entry>CheckBox Calss (<xref linkend="clsCheckBox" />)</entry> +<entry>CheckBox <xref linkend="clsCheckBox"/></entry> </row> <row> <entry>Radio Button</entry> -<entry>RadioButton Class (<xref linkend="clsRadioButton" />)</entry> +<entry>RadioButton <xref linkend="clsRadioButton"/></entry> </row> <row> <entry>Group Box</entry> @@ -96,7 +96,7 @@ </row> <row> <entry>Owner Drawn Button</entry> -<entry>AnimatedButton (<xref linkend="anibut" />), Button Class (<xref linkend="clsButton" />)</entry> +<entry>AnimatedButton (<xref linkend="anibut" />), Button <xref linkend="clsButton"/></entry> </row> </tbody></tgroup> </table> @@ -352,7 +352,7 @@ The <computeroutput>CheckBox</computeroutput> class provides methods to query and modify check box controls. </para> <para> - The <computeroutput>CheckBox</computeroutput> class is a subclass of the Button (<xref linkend="clsButton" />) class + The <computeroutput>CheckBox</computeroutput> class is a subclass of the <xref linkend="clsButton"/> class and therefore has all the instance methods of that class. In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are needed, or are useful, when working with check box controls: @@ -802,7 +802,7 @@ provides methods to query and modify radio button controls. </para> <para> - The <computeroutput>RadioButton</computeroutput> class is a subclass of the Button (<xref linkend="clsButton" />) + The <computeroutput>RadioButton</computeroutput> class is a subclass of the <xref linkend="clsButton"/> class and therefore has all the instance methods of that class. In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are needed, or are useful, when working with radio button controls: @@ -1207,8 +1207,8 @@ </para> <para> The <computeroutput>Button</computeroutput> class provides methods to query and modify all types of button - controls, including push buttons. It is the superclass of both the RadioButton (<xref linkend="clsRadioButton" />) - and CheckBox (<xref linkend="clsCheckBox" />) classes. The class also has methods that allow the Rexx programmer to + controls, including push buttons. It is the superclass of both the <xref linkend="clsRadioButton"/> + and <xref linkend="clsCheckBox"/> classes. The class also has methods that allow the Rexx programmer to partially implement owner drawn buttons using bitmaps. </para> <para> @@ -1852,7 +1852,7 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example gets an image from the resource file for a ResDialog (<xref linkend="clsResDialog" />) and associates + This example gets an image from the resource file for a <xref linkend="clsResDialog"/> and associates it with the Push Me button. <programlisting> @@ -1978,7 +1978,7 @@ StylusHot is only used on tablet computers. If more than 1 image is supplied, but some indexes do not have an image, then the system does not draw an image for that state. The programmer retains ownership of the image list. What this means in essence is the programmer decide when, or if, the image list should be released. See the discussion in the - ImageList (<xref linkend="clsImageList" />) class about releasing image lists if needed. If you release the image + <xref linkend="clsImageList"/> class about releasing image lists if needed. If you release the image list while the dialog is still active, the images on the button disappear. </para> <para> Modified: docs/trunk/publican/oodialog/en-US/dataAttributes.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dataAttributes.xml 2012-08-30 23:12:25 UTC (rev 8327) +++ docs/trunk/publican/oodialog/en-US/dataAttributes.xml 2012-08-31 03:00:03 UTC (rev 8328) @@ -58,7 +58,7 @@ <emphasis role="bold">getting</emphasis> and <emphasis role="bold">setting</emphasis> the <emphasis role="bold">data</emphasis>, and methods to deal with <emphasis role="bold">automatic data detection</emphasis>. These data attributes are used to reflect the <emphasis role="bold">values</emphasis> associated with the underlying dialog - controls. For instance, the value of an edit (<xref linkend="clsEdit" />) control could be thought of as the text of + controls. For instance, the value of an <xref linkend="clsEdit"/> control could be thought of as the text of the control. </para> <para> @@ -98,7 +98,7 @@ </para> <para> Automatic data detection is implemented in all three main classes of dialogs, the UserDialog (<xref - linkend="clsUserDialog" />, ResDialog (<xref linkend="clsResDialog" />), and RxDialog (<xref + linkend="clsUserDialog" />, <xref linkend="clsResDialog"/>, and RxDialog (<xref linkend="clsRcDialog" />), and of course their subclasses. Automatic data detection can be turned on or off. By default it is <emphasis role="bold">on</emphasis>. The best way to turn automatic data field detection off for a single dialog is to over-ride the initAutoDetection() (<xref linkend="mthInitAutoDetection" />) method in your @@ -110,7 +110,7 @@ Some dialog controls are not considered to be <emphasis role="italic">data</emphasis> and therefore data attributes are not created for those controls. (This is a quirk going back to the original implementation of of ooDialog.) The non-data controls are those, in general, that the user would not change or update in a dialog. Push buttons (<xref - linkend="clsButton" />), group boxes (<xref linkend="clsGroupBox" />), and static (<xref + linkend="clsButton" />), group <xref linkend="clsGroupBox"/>, and static (<xref linkend="clsStatic" />) controls are all considered non-data controls. There are no data attribute methods for these controls. </para> @@ -142,7 +142,7 @@ <varlistentry><term><emphasis role="bold">RcDialog</emphasis></term> <listitem> <para> - A RcDialog (<xref linkend="clsRcDialog" />) is actually a subclass of the + A <xref linkend="clsRcDialog"/> is actually a subclass of the <computeroutput>UserDialog</computeroutput>. Therefore, when automatic data detection is on, the connect... attribute methods are invoked automatically during the creation of each dialog control. The difference is that there is no option to specify the attribute name, the name is <emphasis role="bold">always</emphasis> generated @@ -152,7 +152,7 @@ <varlistentry><term><emphasis role="bold">ResDialog</emphasis></term> <listitem> <para> - With a ResDialog (<xref linkend="clsResDialog" />) the data connections are made after the underlying dialog is + With a <xref linkend="clsResDialog"/> the data connections are made after the underlying dialog is created. Internally, the numeric resource ID and text of each control in the dialog is determined. Then, a data attribute for each control is created and connected. Again, there is no way for the programmer to specify the data attribute name, it is always automatically constructed. @@ -315,7 +315,7 @@ </para> <para> <emphasis role="bold">Note</emphasis> this important detail: every dialog control can have text associated with it - when compiled from a resource script (<xref linkend="defResourceScript" />). Although for many controls, text is + when compiled from a resource <xref linkend="defResourceScript"/>. Although for many controls, text is not usually associated with them, it is always possible that they do have text. </para> <para> @@ -588,7 +588,7 @@ linkend="mthGetDataAttribute" />) methods could also be used. </para> <para> - The <emphasis role="italic">data</emphasis> of a check box (<xref linkend="clsCheckBox" />) is defined to be its + The <emphasis role="italic">data</emphasis> of a check <xref linkend="clsCheckBox"/> is defined to be its check state. For normal check boxes this is 0 for not checked and 1 for checked. Three-state check boxes have the additional indeterminate state. The value for the indeterminate state is 2. </para> @@ -681,7 +681,7 @@ linkend="mthGetDataAttribute" />) methods can also be used. </para> <para> - The <emphasis role="italic">data</emphasis> of a combo box (<xref linkend="clsComboBox" />) is defined to be the + The <emphasis role="italic">data</emphasis> of a combo <xref linkend="clsComboBox"/> is defined to be the text in the selection field or the selected combo box item. </para> <para> @@ -773,7 +773,7 @@ linkend="mthGetDataAttribute" />) methods. </para> <para> - The <emphasis role="italic">data</emphasis> of a date time picker (<xref linkend="clsDateTimePicker" />) is + The <emphasis role="italic">data</emphasis> of a date time <xref linkend="clsDateTimePicker"/> is defined to be a <computeroutput>DateTime</computeroutput> object that represents it currently selected date and time. </para> @@ -1395,7 +1395,7 @@ linkend="mthGetDataAttribute" />) methods. </para> <para> - The <emphasis role="italic">data</emphasis> of a list view (<xref linkend="clsListView" />) is defined to be a + The <emphasis role="italic">data</emphasis> of a list <xref linkend="clsListView"/> is defined to be a string containing the blank seperated index(es) of its selected item(s). </para> <para> @@ -1487,7 +1487,7 @@ linkend="mthGetDataAttribute" />) methods. </para> <para> - The <emphasis role="italic">data</emphasis> of a month calendar (<xref linkend="clsMonthCalendar" />) is defined + The <emphasis role="italic">data</emphasis> of a month <xref linkend="clsMonthCalendar"/> is defined to be a <computeroutput>DateTime</computeroutput> object that specifies the selected date in the month calendar control. </para> @@ -1676,7 +1676,7 @@ linkend="mthGetDataAttribute" />) methods. </para> <para> - The <emphasis role="italic">data</emphasis> of a tab (<xref linkend="clsTab" />) control is defined to the text + The <emphasis role="italic">data</emphasis> of a <xref linkend="clsTab"/> control is defined to the text of its currently selected tab. </para> <para> @@ -1769,7 +1769,7 @@ linkend="mthGetDataAttribute" />) methods. </para> <para> - The <emphasis role="italic">data</emphasis> of a trackbar (<xref linkend="clsTab" />) control is defined to be + The <emphasis role="italic">data</emphasis> of a <xref linkend="clsTab"/> control is defined to be the current logical position of the slider in the trackbar. </para> <para> @@ -1858,7 +1858,7 @@ linkend="mthGetDataAttribute" />) methods. </para> <para> - The <emphasis role="italic">data</emphasis> of a tree view (<xref linkend="clsTreeView" />) is defined to be the + The <emphasis role="italic">data</emphasis> of a tree <xref linkend="clsTreeView"/> is defined to be the text of the selected tree view item. </para> <para> @@ -1950,7 +1950,7 @@ linkend="mthGetDataAttribute" />) methods. </para> <para> - The <emphasis role="italic">data</emphasis> of a up down (<xref linkend="clsUpDown" />) control is defined to be + The <emphasis role="italic">data</emphasis> of a up <xref linkend="clsUpDown"/> control is defined to be the value of its current position. </para> <para> @@ -2058,7 +2058,7 @@ <listitem> <para> The <emphasis role="italic">data</emphasis> of a combo box is considered to be the text of the selection field in - the combo box (<xref linkend="clsComboBox" />). The current text in the selection field is returned, which may be + the combo <xref linkend="clsComboBox"/>. The current text in the selection field is returned, which may be the empty string if there is no text in the selection field. </para> </listitem></varlistentry> @@ -2657,7 +2657,7 @@ <listitem> <para> The <emphasis role="italic">data</emphasis> to be assigned to the underlying check box. The <emphasis - role="italic">data</emphasis> of a check box (<xref linkend="clsCheckBox" />) is defined to be its check state. + role="italic">data</emphasis> of a check <xref linkend="clsCheckBox"/> is defined to be its check state. For normal check boxes this is 0 for not checked and 1 for checked. Three-state check boxes have the additional indeterminate state. The value for the indeterminate state is 2. </para> @@ -2741,7 +2741,7 @@ <listitem> <para> The <emphasis role="italic">data</emphasis> to be assigned to the underlying combo box control. The <emphasis - role="italic">data</emphasis> of a combo box (<xref linkend="clsComboBox" />) is defined to be the text in the + role="italic">data</emphasis> of a combo <xref linkend="clsComboBox"/> is defined to be the text in the selection field or the selected combo box item. </para> </listitem></varlistentry> @@ -3291,7 +3291,7 @@ <listitem> <para> The data that is assigned to the list box. The <emphasis role="italic">data</emphasis> of a <emphasis - role="bold">single-selection</emphasis> list box (<xref linkend="clsListBox" />) is defined to be text of the + role="bold">single-selection</emphasis> list <xref linkend="clsListBox"/> is defined to be text of the selected item in the list box. </para> <para> @@ -3406,7 +3406,7 @@ <listitem> <para> The <emphasis role="italic">data</emphasis> to be assigned to the underlying radio button. The <emphasis - role="italic">data</emphasis> of a radio button (<xref linkend="clsRadioButton" />) is defined to be the its + role="italic">data</emphasis> of a radio <xref linkend="clsRadioButton"/> is defined to be the its check state. This is 0 for not checked and 1 for checked. </para> </listitem></varlistentry> Modified: docs/trunk/publican/oodialog/en-US/datetimepicker.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/datetimepicker.xml 2012-08-30 23:12:25 UTC (rev 8327) +++ docs/trunk/publican/oodialog/en-US/datetimepicker.xml 2012-08-31 03:00:03 UTC (rev 8328) @@ -363,7 +363,7 @@ </row> <row> <entry><xref linkend="mthGetMonthCal"/></entry> -<entry>Returns the MonthCalendar (<xref linkend="clsMonthCalendar" />) object for a date and time picker's (DTP) child month calendar control.</entry> +<entry>Returns the <xref linkend="clsMonthCalendar"/> object for a date and time picker's (DTP) child month calendar control.</entry> </row> <row> <entry><xref linkend="mthGetMonthCalColor"/></entry> @@ -578,7 +578,7 @@ <varlistentry><term>size [required] [in / out]</term> <listitem> <para> - A Size (<xref linkend="clsSize" />) object in which the ideal size is returned. + A <xref linkend="clsSize"/> object in which the ideal size is returned. </para> </listitem></varlistentry> </variablelist> @@ -660,7 +660,7 @@ <varlistentry><term>CHECKRECT</term> <listitem> <para> - This index is a Rect (<xref linkend="clsRect" />) object that contains the location of the check box allowing + This index is a <xref linkend="clsRect"/> object that contains the location of the check box allowing the user to have no date selected. This check box is only present when the DTP control has the SHOWNONE style. When the check box is not present, the coordinates of the rectangle will be all zeros. </para> @@ -683,7 +683,7 @@ <varlistentry><term>BUTTONRECT</term> <listitem> <para> - A Rect (<xref linkend="clsRect" />) object that contains the location of the button that shows the drop down + A <xref linkend="clsRect"/> object that contains the location of the button that shows the drop down calendar when the user clicks on it. (Or closes the month calendar if the user clicks on it when the month calendar is already open.) This button is not present if the DTP control has the UPDOWN style, in which case the coordinates of the rectangle will be all zeros. @@ -704,7 +704,7 @@ <varlistentry><term>EDIT</term> <listitem> <para> - This index will either be an Edit (<xref linkend="clsEdit" />) object, or <computeroutput>.nil</computeroutput>, + This index will either be an <xref linkend="clsEdit"/> object, or <computeroutput>.nil</computeroutput>, depending on whether the DTP control currently has a child edit control or not. The DTP control will only have an edit control when the DTP control has the CANPARSE style. The CANPARSE style allows the user to edit within the client area of the control when they press the F2 key, or single click on the client area of the DTP control when the @@ -714,7 +714,7 @@ <varlistentry><term>DROPDOWN</term> <listitem> <para> - This index will either be a MonthCalendar (<xref linkend="clsMonthCalendar" />) object, or + This index will either be a <xref linkend="clsMonthCalendar"/> object, or <computeroutput>.nil</computeroutput>, depending on whether the DTP control currently has a child month calendar control or not. </para> @@ -722,7 +722,7 @@ <varlistentry><term>UPDOWN</term> <listitem> <para> - This index will either be an UpDown (<xref linkend="clsUpDown" />) object, or + This index will either be an <xref linkend="clsUpDown"/> object, or <computeroutput>.nil</computeroutput>, depending on whether the DTP control currently has a child updown control or not. The up down control will only exist when the DTP control has the UPDOWN style. With the UPDOWN style, the normal drop down month calendar is replaced by an up down control. @@ -817,7 +817,7 @@ </programlisting> <para> - Returns the MonthCalendar (<xref linkend="clsMonthCalendar" />) object for a date and time picker's (DTP) child + Returns the <xref linkend="clsMonthCalendar"/> object for a date and time picker's (DTP) child month calendar control. </para> <variablelist> @@ -981,7 +981,7 @@ child month calendar. </para> <para> - The Image (<xref linkend="clsImage" />) class has a number of convenience methods for working with COLORREFs, + The <xref linkend="clsImage"/> class has a number of convenience methods for working with COLORREFs, including the <xref linkend="mthColorRef"/> method that explains what a COLORREF is. </para> <para> @@ -1064,7 +1064,7 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - A list of MonthCalendar (<xref linkend="clsMonthCalendar" />) style keywords separated by spaces. The list may be + A list of <xref linkend="clsMonthCalendar"/> style keywords separated by spaces. The list may be empty, otherwise it will contain one or more of the following keywords. </para> <para> @@ -1561,7 +1561,7 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - The Image (<xref linkend="clsImage" />) class has a number of convenience methods for working with COLORREFs, + The <xref linkend="clsImage"/> class has a number of convenience methods for working with COLORREFs, including the <xref linkend="mthColorRef"/> method that explains what a COLORREF is. </para> <para> @@ -1657,7 +1657,7 @@ <varlistentry><term>style [required]</term> <listitem> <para> - A list of MonthCalendar (<xref linkend="clsMonthCalendar" />) style keywords separated by spaces. The list may + A list of <xref linkend="clsMonthCalendar"/> style keywords separated by spaces. The list may be empty. This will revert the month calendar to its default style. Otherwise, it can contain one or more of the following keywords. </para> Modified: docs/trunk/publican/oodialog/en-US/deprecated.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-08-30 23:12:25 UTC (rev 8327) +++ docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-08-31 03:00:03 UTC (rev 8328) @@ -133,7 +133,7 @@ role="italic">unnecessary</emphasis> to begin with. </para> <para> - Use the PropertySheetDialog (<xref linkend="clsPropertySheetDialog" />), or a tab (<xref linkend="clsTab" />) + Use the <xref linkend="clsPropertySheetDialog"/>, or a <xref linkend="clsTab"/> control with one of the Control (<xref linkend="sctControlDialogs" />) dialog classes, to replace the <computeroutput>CategoryDialog</computeroutput> class. </para> @@ -149,7 +149,7 @@ role="italic">unnecessary</emphasis> to begin with. </para> <para> - Use the PropertySheeyDialog (<xref linkend="clsPropertySheetDialog" />), or a tab (<xref linkend="clsTab" />) + Use the <xref linkend="clsPropertySheetDialog"/>, or a <xref linkend="clsTab"/> control with one of the Control (<xref linkend="sctControlDialogs" />) dialog classes, to replace the <computeroutput>PropertySheet</computeroutput> class. </para> @@ -167,7 +167,7 @@ <section><title>captureMouse</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -423,7 +423,7 @@ <section><title>getMouseCapture</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -547,7 +547,7 @@ <section><title>isMouseButtonDown</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -582,7 +582,7 @@ <section><title>releaseMouseCapture</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -866,7 +866,7 @@ <section><title>indeterminate</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - setIndeterminate() (<xref linkend="mthSetIndeterminate" />) method of the CheckBox (<xref linkend="clsCheckBox" />) + setIndeterminate() (<xref linkend="mthSetIndeterminate" />) method of the <xref linkend="clsCheckBox"/> class. Radio buttons can not be set to indeterminate. Using this method with a radio button sets it to the checked state, not the indeterminate state. In addition, this method was poorly named. One can check a button, but one does not indeterminate a check box. @@ -942,7 +942,7 @@ <section><title>captureMouse</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -956,7 +956,7 @@ <section><title>getMouseCapture</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -976,7 +976,7 @@ <section><title>isMouseButtonDown</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -990,7 +990,7 @@ <section><title>releaseMouseCapture</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -1157,7 +1157,7 @@ <section><title>connectMouseCapture</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) object + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -1698,7 +1698,7 @@ <section id="deprecatedWindowBase"><title>Deprecated WindowBase Methods</title> <indexterm><primary>Deprecated</primary><secondary>WindowBase methods</secondary></indexterm> <para> - The WindowBase (<xref linkend="clsWindowBase" />) class is inherited by both the dialog + The <xref linkend="clsWindowBase"/> class is inherited by both the dialog object (<xref linkend="chpDialogObject" />) and the dialog control object (<xref linkend="chpDialogControlObject" />). Therefore, depending on the point of view of the reader, these deprecated methods may be thought of as either deprecated dialog methods or deprecated dialog control methods. @@ -1716,7 +1716,7 @@ <emphasis role="italic">WindowsManager</emphasis> class. The <emphasis role="italic">WindowsManager</emphasis>is part of the <emphasis role="italic">WinSystm.cls</emphasis> package. In certain cases it may be desirable to invoke a method common to all windows when only the window handle (<xref linkend="defHandle" />) is known. For these cases - use a Window (<xref linkend="clsWindow" />) object. + use a <xref linkend="clsWindow"/> object. </para> </section> @@ -1734,7 +1734,7 @@ <section id="deprecatedWindowExtensions"><title>Deprecated WindowExtensions Methods</title> <indexterm><primary>Deprecated</primary><secondary>WindowExtensions methods</secondary></indexterm> <para> - The WindowExtensions (<xref linkend="clsWindowExtensions" />) class is inherited by both the dialog + The <xref linkend="clsWindowExtensions"/> class is inherited by both the dialog object (<xref linkend="chpDialogObject" />) and the dialog control object (<xref linkend="chpDialogControlObject" />). Therefore, depending on the point of view of the reader, these deprecated methods may be thought of as either deprecated dialog methods or deprecated dialog control methods. @@ -1747,49 +1747,49 @@ <section><title>absRect2LogRect</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />) because it is incorrectly implemented and - inaccurate (<xref linkend="ovvInaccurate" />). Replace this method with the pixel2dlgUnit() (<xref + <xref linkend="ovvInaccurate"/>. Replace this method with the pixel2dlgUnit() (<xref linkend="mthPixel2dlgUnit" />) method. </para> </section> <section><title>cursor_appStarting</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> <section><title>cursor_arrow</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> <section><title>cursor_cross</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> <section><title>cursor_no</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> <section><title>cursor_wait</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> <section><title>cursorPos</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> @@ -1797,21 +1797,21 @@ <section><title>logRect2AbsRect</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />) because it is incorrectly implemented and - inaccurate (<xref linkend="ovvInaccurate" />). Replace this method with the dlgUnit2pixel() (<xref + <xref linkend="ovvInaccurate"/>. Replace this method with the dlgUnit2pixel() (<xref linkend="mthDlgUnit2pixel" />) method. </para> </section> <section><title>restoreCursorShape</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> <section><title>setCursorPos</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use the mouse (<xref linkend="clsMouse" />) + This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="clsMouse"/> object methods directly. </para> </section> Modified: docs/trunk/publican/oodialog/en-US/dialogControlObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-08-30 23:12:25 UTC (rev 8327) +++ docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-08-31 03:00:03 UTC (rev 8328) @@ -56,7 +56,7 @@ <para id="paraDialogControlStyles"> In the Windows GUI all windows are created with a set of <emphasis role="italic">window styles</emphasis>. Dialog control windows are created using styles that are common to all windows, (for example the visible style,) and styles - specific to the dialog control itself, (for example the multi-line style of the Edit (<xref linkend="clsEdit" />) + specific to the dialog control itself, (for example the multi-line style of the <xref linkend="clsEdit"/> control class.) In general the styles of a control fall into three categories: Styles that can only be set when the control is created and then can not be changed afterwards. Styles that can be changed after control creation by sending messages to the control. And, styles that can be changed after the control is created by accessing the control @@ -856,8 +856,8 @@ <listitem> <para> The coordinates of the rectangle to be cleared. The coordinates specify the upper left and lower right corners - of the rectangle. The corners can be specified using either a rect (<xref linkend="clsRect" />) object, two - point (<xref linkend="clsPoint" />) objects, or the individual x and y coordinates of each corner. + of the rectangle. The corners can be specified using either a <xref linkend="clsRect"/> object, two + <xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner. </para> <para> The coordinates are specified as client-area (<xref linkend="defClientArea" />) coordinates, in pixels. @@ -930,7 +930,7 @@ <varlistentry id="rmkConnectCharEvent"><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - The operating system translates the numeric virtual (<xref linkend="clsVK" />) key code produced by a key down / + The operating system translates the numeric <xref linkend="clsVK"/> key code produced by a key down / key up combination into a numeric <emphasis role="italic">character</emphasis> code. The character code is sent to the window with the keyboard focus in a character event notification. For enhanced 101-key and 102-key keyboards, the character (<xref linkend="evtDialogControlCHAR" />) event handler will also receive extended key @@ -975,7 +975,7 @@ <entry>Numeric characters</entry><entry>use <computeroutput>d2c</computeroutput></entry> </row> <row> - <entry>Extended keys use the VK (<xref linkend="clsVK" />) class</entry> + <entry>Extended keys use the <xref linkend="clsVK"/> class</entry> </row> </tbody></tgroup> </table> @@ -1436,7 +1436,7 @@ <para> The keys are specified by the numeric value defined by Microsoft for its virtual key set. These numeric values are 0 through 255. There are some integer values between 0 and 255 that do not have a vitural key assigned to - them. For example, 0, 7, 10, 11, and 255 are not used. The VK (<xref linkend="clsVK" />) class contains + them. For example, 0, 7, 10, 11, and 255 are not used. The <xref linkend="clsVK"/> class contains constants for all of the defined virtual keys. </para> <para> @@ -2176,7 +2176,7 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - The size needed for the string is returned in a Size (<xref linkend="clsSize" />) object. The size is specified + The size needed for the string is returned in a <xref linkend="clsSize"/> object. The size is specified in dialog units. </para> </listitem></varlistentry> @@ -2396,8 +2396,8 @@ <listitem> <para> The coordinates of the rectangle to be redrawn. The coordinates specify the upper left and lower right corners - of the rectangle. The corners can be specified using either a rect (<xref linkend="clsRect" />) object, two - point (<xref linkend="clsPoint" />) objects, or the individual x and y coordinates of each corner. + of the rectangle. The corners can be specified using either a <xref linkend="clsRect"/> object, two + <xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner. </para> <para> The coordinates are specified as client-area (<xref linkend="defClientArea" />) coordinates, in pixels. Modified: docs/trunk/publican/oodialog/en-US/dialogExtensions.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-08-30 23:12:25 UTC (rev 8327) +++ docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-08-31 03:00:03 UTC (rev 8328) @@ -47,7 +47,7 @@ <indexterm><primary>DialogExtensions Class</primary></indexterm> <para> The <computeroutput>DialogExtensions</computeroutput> class is a <emphasis role="italic">mixin</emphasis> class - inherited by PlainBaseDialog (<xref linkend="clsPlainBaseDialog" />) class. Therefore the methods of this class are + inherited by <xref linkend="clsPlainBaseDialog"/> class. Therefore the methods of this class are methods of every dialog. The methods of the <computeroutput>DialogExtensions</computeroutput> class are probably methods added after the original release of the ooDialog framework, thus the <emphasis role="italic">extensions</emphasis> part of the class name. @@ -488,7 +488,7 @@ <listitem> <para> The arguments specifying the bitmaps can be a bitmap file name, a bitmap handle (<xref linkend="defHandle" />), or - the resource number of a bitmap compiled into the resource DLL of a ResDialog (<xref linkend="clsResDialog" />). + the resource number of a bitmap compiled into the resource DLL of a <xref linkend="clsResDialog"/>. The bitmap arguments must all be the same type. I.e. all file names, all resource IDs, or all handles. Symbolic resource IDs can be used for the bitmap arguments. If the bitmap arguments are handles the style argument must contain the INMEMORY keyword. @@ -641,8 +641,8 @@ <listitem> <para> The coordinates of the rectangle to be cleared. The coordinates specify the upper left and lower right corners - of the rectangle. The corners can be specified using either a rect (<xref linkend="clsRect" />) object, two - point (<xref linkend="clsPoint" />) objects, or the individual x and y coordinates of each corner. + of the rectangle. The corners can be specified using either a <xref linkend="clsRect"/> object, two + <xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner. </para> <para> The coordinates are specified as client-area (<xref linkend="defClientArea" />) coordinates, in pixels. @@ -828,7 +828,7 @@ <para> If this argument is omitted a solid brush using the color specified is created. Otherwise, this argument can be the name of a bitmap file, the resource ID of a bitmap compiled in the resource only DLL of a - ResDialog (<xref linkend="clsResDialog" />), or one of the following keywords. The keywords create a hatched brush. A + <xref linkend="clsResDialog"/>, or one of the following keywords. The keywords create a hatched brush. A bitmap file name will cause the bitmap to be loaded into memory and then used for the brush. Case is not significant in the keywords. </para> @@ -904,8 +904,8 @@ <para> The <emphasis role="italic">createBrush</emphasis> method here is almost identical to the <xref linkend="mthCreateBrush"/> method of the - WindowExtensions (<xref linkend="clsWindowExtensions" />) class. The method documented here is a method of the - DialogExtensions (<xref linkend="clsDialogExtensions" />) class and is therefore inherited only by the + <xref linkend="clsWindowExtensions"/> class. The method documented here is a method of the + <xref linkend="clsDialogExtensions"/> class and is therefore inherited only by the dialog (<xref linkend="chpDialogObject" />) object. </para> <para> @@ -1606,7 +1606,7 @@ <varlistentry><term>pos</term> <listitem> <para> - A point (<xref linkend="clsPoint" />) object. On a successful return the point object is updated with the + A <xref linkend="clsPoint"/> object. On a successful return the point object is updated with the position of the bitmap. On an error return, the point object is left unchanged. </para> </listitem></varlistentry> @@ -1657,7 +1657,7 @@ </programlisting> <para> - Retrieves the size of the bitmap for a bitmap button as a size (<xref linkend="clsSize" />) object. + Retrieves the size of the bitmap for a bitmap button as a <xref linkend="clsSize"/> object. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1972,7 +1972,7 @@ dialog units. </para> <para> - The value is usually incorrect (<xref linkend="ovvInaccurate" />) because it is calculated using + The value is usually <xref linkend="ovvInaccurate"/> because it is calculated using factorX (<xref linkend="atrFactorX" />). The programmer is advised to use the <xref linkend="mthGetListItemHeightPx"/> method instead, which will return the correct height of a list item. @@ -2004,7 +2004,7 @@ </programlisting> <para> - Gets the height, in pixels, of an individual item in a ListBox (<xref linkend="clsListBox" />) control. + Gets the height, in pixels, of an individual item in a <xref linkend="clsListBox"/> control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2044,7 +2044,7 @@ The getListWidth method returns the scrollable width of a list box, in dialog units. </para> <para> - The value is usually incorrect (<xref linkend="ovvInaccurate" />) because it is calculated using + The value is usually <xref linkend="ovvInaccurate"/> because it is calculated using factorX (<xref linkend="atrFactorX" />). The programmer is advised to use the <xref linkend="mthGetListWidthPx"/> method instead, which will return the correct width in pixels. </para> @@ -2434,7 +2434,7 @@ There are 3 ways to specify the bitmap source for the <emphasis role="italic">bN</emphasis>, <emphasis role="italic">bf</emphasis>, <emphasis role="italic">bS</emphasis>, and <emphasis role="italic">bD</emphasis> arguments. The arguments can be a bitmap file name, in which case the bitmap is loaded from the file, the arguments - can be the resource ID of bitmap compiled into the resource DLL for a ResDialog (<xref linkend="clsResDialog" />), + can be the resource ID of bitmap compiled into the resource DLL for a <xref linkend="clsResDialog"/>, or the arguments can be a bitmap <emphasis role="italic">handle</emphasis> returned from the <xref linkend="mthLoadBitmap"/> method. </para> @@ -2979,8 +2979,8 @@ <listitem> <para> The coordinates of the rectangle to be redrawn. The coordinates specify the upper left and lower right corners - of the rectangle. The corners can be specified using either a rect (<xref linkend="clsRect" />) object, two - point (<xref linkend="clsPoint" />) objects, or the individual x and y coordinates of each corner. + of the rectangle. The corners can be specified using either a <xref linkend="clsRect"/> object, two + <xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner. </para> <para> The coordinates are specified as client-area (<xref linkend="defClientArea" />) coordinates, in pixels. @@ -3847,7 +3847,7 @@ <listitem> <para> The <emphasis role="italic">newPosition</emphasis> argument(s) specify the (x, y) coordinates of the bitmap. - These coordinates can be specified either as a object (<xref linkend="clsPoint" />) or as 2 separate whole + These coordinates can be specified either as a <xref linkend="clsPoint"/> or as 2 separate whole number arguments, as in Form 2. </para> <para> @@ -4232,7 +4232,7 @@ dialog units. </para> <para> - The method usually produces incorrect (<xref linkend="ovvInaccurate" />) results because it converts the dialog + The method usually produces <xref linkend="ovvInaccurate"/> results because it converts the dialog units to pixels using factorX (<xref linkend="atrFactorX" />). The programmer is advised to use the <xref linkend="mthSetListColumnWidthPx"/> method instead, which will produce the correct results. </para> @@ -4325,7 +4325,7 @@ units. </para> <para> - The method usually produces incorrect (<xref linkend="ovvInaccurate" />) results because it converts the dialog + The method usually produces <xref linkend="ovvInaccurate"/> results because it converts the dialog units to pixels using factorX (<xref linkend="atrFactorX" />). The programmer is advised to use the <xref linkend="mthSetListItemHeightPx"/> method instead, which will produce the correct results. </para> @@ -4423,7 +4423,7 @@ The <emphasis role="italic">setListWidth</emphasis> method sets the scrollable width of a list box, in dialog units. </para> <para> - The method usually produces incorrect (<xref linkend="ovvInaccurate" />) results because it converts the dialog + The method usually produces <xref linkend="ovvInaccurate"/> results because it converts the dialog units to pixels using factorX (<xref linkend="atrFactorX" />). The programmer is advised to use the <xref linkend="mthSetListWidthPx"/> method instead, which will produce the correct results. </para> @@ -4549,7 +4549,7 @@ <para> The <emphasis role="italic">setSBPos</emphasis> method sets the current position of a - scroll (<xref linkend="clsScrollBar" />) bar control. + <xref linkend="clsScrollBar"/> bar control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -4682,8 +4682,8 @@ The coordinates for the new size and position of the window as a point/size (<xref linkend="ovvRectangleCoordinates" />) rectangle. The coordinates specify the upper left point of the the new position, the width of the window and the height of the window. These coordinates can be specified - using either a rect (<xref linkend="clsRect" />) object, a point (<xref linkend="clsPoint" />) object and a - size (<xref linkend="clsSize" />) objects, or the individual x and y coordinates, width, and height values. + using either a <xref linkend="clsRect"/> object, a <xref linkend="clsPoint"/> object and a + <xref linkend="clsSize"/> objects, or the individual x and y coordinates, width, and height values. </para> <para> The coordinates are specified as client-area (<xref linkend="defClientArea" />) coordinates, in pixels. All 4 Modified: docs/trunk/publican/oodialog/en-US/dialogObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-08-30 23:12:25 UTC (rev 8327) +++ docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-08-31 03:00:03 UTC (rev 8328) @@ -53,8 +53,8 @@ <para> The dialog object here is an abstract concept, used to make it simpler to understand the basic concepts. To instantiate a dialog object you create a subclass of one of the concrete dialog classes provided by the ooDialog - framework, such as the UserDialog Class (<xref linkend="clsUserDialog" />), - ResDialog Class (<xref linkend="clsResDialog" />), or RcDialog Class (<xref linkend="clsRcDialog" />). This chapter provides the reference for the + framework, such as the UserDialog <xref linkend="clsUserDialog"/>, + ResDialog <xref linkend="clsResDialog"/>, or RcDialog <xref linkend="clsRcDialog"/>. This chapter provides the reference for the constants, attributes, and methods that are common to all dialog objects. See the specific dialog subclass for methods that are unique to the subclass. </para> @@ -1405,7 +1405,7 @@ <para> Recall that the constant methods defined by the <computeroutput>::constant</computeroutput> directive are both class and instance methods of the class they are defined in. The constants listed here are defined in the - PlainBaseDialog (<xref linkend="clsPlainBaseDialog" />) class. Therefore to access the constant value, the programmer uses + <xref linkend="clsPlainBaseDialog"/> class. Therefore to access the constant value, the programmer uses either the <computeroutput>PlainBaseDialog</computeroutput> class object, or an instantiated dialog object. An example using the class object and the IDOK constant: @@ -1726,7 +1726,7 @@ <para> The dialog object is abstract, the programmer can not directly instantiate a workable dialog object. Rather, the programmer instantiates one of the concrete subclasses. Such as a subclass of a - RcDialog (<xref linkend="clsRcDialog" />) or a ResDialog (<xref linkend="clsResDialog" />). + <xref linkend="clsRcDialog"/> or a <xref linkend="clsResDialog"/>. </para> </listitem></varlistentry> <varlistentry id="exampleDialogObjectnew"><term><emphasis role="bold">Example:</emphasis></term> @@ -1997,7 +1997,7 @@ <listitem> <para> Dialog objects also have the hwnd (<xref linkend="atrHwnd" />) attribute which is inherited from the - WindoBase (<xref linkend="clsWindowBase" />) class. The two attributes are essentially the same and can be used by the + <xref linkend="clsWindowBase"/> class. The two attributes are essentially the same and can be used by the programmer interchangeably. </para> </listitem></varlistentry> @@ -2064,7 +2064,7 @@ Prior to the creation of the underlying Windows dialog, the font name attribute specifies the name of the font that will be used to create the dialog. This font is used in a <xref linkend="clsUserDialog"/> when the font is not specified in the <xref linkend="mthCreate"/>() or the - <xref linkend="mthCreateCenter"/>() methods, or in a RcDialog (<xref linkend="clsRcDialog" />) where the + <xref linkend="mthCreateCenter"/>() methods, or in a <xref linkend="clsRcDialog"/> where the font is not specified in the resource script file. With a binary compiled dialog resource (ResDialog (<xref linkend="clsResDialog" />)) the font has already been specified when the dialog template was compiled and can not be changed. Therefore the font name attribute has no effect on a ResDialog prior to the @@ -2108,7 +2108,7 @@ <listitem> <para> The <emphasis role="italic">fontName</emphasis> attribute is a member of the - PlainBaseDialog (<xref linkend="clsPlainBaseDialog" />) class. + <xref linkend="clsPlainBaseDialog"/> class. </para> <para> Syntax errors are raised when incorrect usage is detected. @@ -2212,7 +2212,7 @@ <listitem> <para> The <emphasis role="italic">fontSize</emphasis> attribute is a member of the - PlainBaseDialog (<xref linkend="clsPlainBaseDialog" />) class. + <xref linkend="clsPlainBaseDialog"/> class. </para> <para> Syntax errors are raised when incorrect usage is detected. @@ -2274,7 +2274,7 @@ <para> In the ooDialog framework, <emphasis role="italic">all</emphasis> control (<xref linkend="sctControlDialogs" />) dialogs <emphasis role="italic">must</emphasis> have an owner dialog. Dialogs like the - PropertySheetDialog (<xref linkend="clsPropertySheetDialog" />) can <emphasis role="italic">not</emphasis> have an owner + <xref linkend="clsPropertySheetDialog"/> can <emphasis role="italic">not</emphasis> have an owner dialog. For the most part other dialogs would not have an owner dialog. </para> <variablelist> @@ -2289,9 +2289,9 @@ <listitem> <para> Sets the Rexx owner dialog for this dialog. There are a number of constraints imposed on setting the owner dialog. - The owner dialog can not be a ControlDialog (<xref linkend="clsControlDialog" />), a - PropertySheetDialog (<xref linkend="clsPropertySheetDialog" />), or a - PropertySheetPage (<xref linkend="clsPropertySheetPage" />) dialog. + The owner dialog can not be a <xref linkend="clsControlDialog"/>, a + <xref linkend="clsPropertySheetDialog"/>, or a + <xref linkend="clsPropertySheetPage"/> dialog. </para> <para> Once set, the owner dialog can not be changed or removed. The owner dialog can not be set once the @@ -2865,7 +2865,7 @@ <listitem> <para> This example show how the <emphasis role="italic">initDialog</emphasis> method is used to initialize a - list box (<xref linkend="clsListBox" />) by adding items to it. + list <xref linkend="clsListBox"/> by adding items to it. <programlisting> <![CDATA[ @@ -3014,8 +3014,8 @@ <xref linkend="clsUserDialog"/> or a subclasses of a <emphasis role="italic">UserDialog</emphasis>. </para> <para> - In a ResDialog (<xref linkend="clsResDialog" />), the font of the compiled binary resource will always be used, and - the font set by this method has no effect. In a RcDialog (<xref linkend="clsRcDialog" />), if the resource script + In a <xref linkend="clsResDialog"/>, the font of the compiled binary resource will always be used, and + the font set by this method has no effect. In a <xref linkend="clsRcDialog"/>, if the resource script file specifies the font, that font will be used. Likewise, in a <xref linkend="clsUserDialog"/>, if the programmer specifies a font in the <emphasis role="italic">create</emphasis>() method call, (or the <emphasis role="italic">createCenter</emphasis>() method call,) the specified font over-rides what is set by this method. @@ -3030,9 +3030,9 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example sets the dialog font for a user (<xref linkend="clsUserDialog" />) dialog before the dialog + This example sets the dialog font for a <xref linkend="clsUserDialog"/> dialog before the dialog template (<xref linkend="ovvDialogTemplate" />) is started. This allows the code to - correctly (<xref linkend="ovvInaccurate" />) calculate the size of the bitmap in dialog + <xref linkend="ovvInaccurate"/> calculate the size of the bitmap in dialog units (<xref linkend="defDialogUnit" />). The size of the bitmap is then used to size the dialog and to place the other controls in the dialog. @@ -3104,7 +3104,7 @@ <para> The <emphasis role="italic">newCheckBox</emphasis> method returns an object of the - CheckBox (<xref linkend="clsCheckBox" />) control class. This object represents the check box control in the underlying dialog + <xref linkend="clsCheckBox"/> control class. This object represents the check box control in the underlying dialog with the specified resource ID. </para> <variablelist> @@ -3166,7 +3166,7 @@ <para> The <emphasis role="italic">newComboBox</emphasis> method returns an object of the - ComboBox (<xref linkend="clsComboBox" />) control class. This object represents the combo box control in the underlying dialog + <xref linkend="clsComboBox"/> control class. This object represents the combo box control in the underlying dialog with the specified resource ID. </para> <variablelist> @@ -3243,7 +3243,7 @@ <para> The <emphasis role="italic">newDateTimePicker</emphasis> method returns a date and time picker object that represents the date and time picker control with the specified resource ID in the underlying dialog. See the - DateTimePicker (<xref linkend="clsDateTimePicker" />) class for details about date and time picker controls. + <xref linkend="clsDateTimePicker"/> class for details about date and time picker controls. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -3305,7 +3305,7 @@ <para> The <emphasis role="italic">newEdit</emphasis> method returns an object of the - Edit (<xref linkend="clsEdit" />) control class. This object represents the edit control in the underlying dialog + <xref linkend="clsEdit"/> control class. This object represents the edit control in the underlying dialog with the specified resource ID. </para> <variablelist> @@ -3363,7 +3363,7 @@ <para> The <em... [truncated message content] |
From: <mie...@us...> - 2012-09-01 15:12:28
|
Revision: 8331 http://sourceforge.net/p/oorexx/code-0/8331 Author: miesfeld Date: 2012-09-01 15:12:23 +0000 (Sat, 01 Sep 2012) Log Message: ----------- Publican ooDialog - work on links Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/button.xml docs/trunk/publican/oodialog/en-US/combobox.xml docs/trunk/publican/oodialog/en-US/dataAttributes.xml docs/trunk/publican/oodialog/en-US/datetimepicker.xml docs/trunk/publican/oodialog/en-US/deprecated.xml docs/trunk/publican/oodialog/en-US/dialogControlObject.xml docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/dialogObject.xml docs/trunk/publican/oodialog/en-US/edit.xml docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/menus.xml docs/trunk/publican/oodialog/en-US/mouse.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/resources.xml docs/trunk/publican/oodialog/en-US/static.xml docs/trunk/publican/oodialog/en-US/updown.xml docs/trunk/publican/oodialog/en-US/userdialog.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml docs/trunk/publican/oodialog/en-US/windowBase.xml docs/trunk/publican/oodialog/en-US/windowBaseDCO.xml docs/trunk/publican/oodialog/en-US/windowExtensions.xml Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-01 01:23:43 UTC (rev 8330) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-01 15:12:23 UTC (rev 8331) @@ -56,14 +56,14 @@ To make it easier to understand the methods and attributes that all dialogs have in common, this documentation treats the <xref linkend="chpDialogObject"/> object as a whole. The dialog object chapter shows all the methods and attributes that every dialog has, without making much distinction as to what specific mixin or base class the - method belongs to. The dialog control object (<xref linkend="chpDialogControlObject" />), is treated in a similar + method belongs to. The dialog <xref linkend="chpDialogControlObject" /> object, is treated in a similar fashion in its chapter. </para> <para> This chapter describes the base and mixin classes that make up the dialog object and the dialog control object and shows how they fit together. In addition, it contains the detailed information for the mixin classes inherited by both the dialog and dialog control object. The <xref linkend="chpDialogObject"/> object and the - dialog control (<xref linkend="chpDialogControlObject" />) object chapters link back to this chapter for the detailed + dialog <xref linkend="chpDialogControlObject" /> object chapters link back to this chapter for the detailed information where needed. </para> @@ -89,9 +89,8 @@ PlainBaseDialog is the base class of all dialog classes in the ooDialog framework. It implements methods that are common to every dialog. PlainBaseDialog is an abstract class. A programmer can not instantiate a new PlainBaseDialog object and display a dialog on the screen. Rather, the ooDialog programmer subclasses one of the concrete classes - provided by the ooDialog framework, such as the <xref linkend="clsResDialog"/>, the RcDialog (<xref - linkend="clsRcDialog" />), or the <xref linkend="clsUserDialog"/>, to create and - execute a real dialog. + provided by the ooDialog framework, such as the <xref linkend="clsResDialog"/>, the (<xref linkend="clsRcDialog" />), + or the <xref linkend="clsUserDialog"/>, to create and execute a real dialog. </para> <para> Many of the methods of the PlainBaseDialog are actually implemented in one of the mixin classes inherited by the @@ -241,7 +240,7 @@ <entry>Creates a data attribute in the Rexx dialog object and connects it to a combo box control in the underlying dialog.</entry> </row> <row> -<entry>connectDateTimePicker (<xref linkend="pbdConnectDateTimePicker" /></entry> +<entry><xref linkend="pbdConnectDateTimePicker"/><entry> <entry>Creates a data attribute in the Rexx dialog object and connects it to a date time picker control in the underlying dialog.</entry> </row> <row> @@ -249,7 +248,7 @@ <entry>Creates a data attribute in the Rexx dialog object and connects it to a edit control in the underlying dialog.</entry> </row> <row> -<entry>connectListBox (<xref linkend="pbdConnectListBox" /></entry> +<entry><xref linkend="pbdConnectListBox"/><entry> <entry>Creates a data attribute in the Rexx dialog object and connects it to a list box control in the underlying dialog.</entry> </row> <row> @@ -269,7 +268,7 @@ <entry>Creates a data attribute in the Rexx dialog object and connects it to a tab control in the underlying dialog.</entry> </row> <row> -<entry>connectTrackBar (<xref linkend="pbdConnectTrackBar" /></entry> +<entry><xref linkend="pbdConnectTrackBar"/><entry> <entry>Creates a data attribute in the Rexx dialog object and connects it to a track bar control in the underlying dialog.</entry> </row> <row> @@ -297,7 +296,7 @@ <entry>Takes a dimension expressed in dialog units of this dialog and transforms it to a dimension expressed in pixels.</entry> </row> <row> -<entry>enable Control (<xref linkend="pbdEnableControl" />)</entry> +<entry><xref linkend="pbdEnableControl"/></entry> <entry>Enables the control with the specified resource id.</entry> </row> <row> @@ -333,7 +332,7 @@ <entry>Sets the value of the connected data attribute in the Rexx dialog object to match the state of the specified combo box in the underlying dialog.</entry> </row> <row> -<entry>getComboEntry (<xref linkend="pbdGetComboEntry" /></entry> +<entry><xref linkend="pbdGetComboEntry"/><entry> <entry>Returns the string at the specified index of the combo box.</entry> </row> <row> @@ -453,7 +452,7 @@ <entry>Inserts a string into the list of a combo box.</entry> </row> <row> -<entry>insertListEntry (<xref linkend="pbdInsertListEntry" /></entry> +<entry><xref linkend="pbdInsertListEntry"/><entry> <entry>Inserts a string into the specified list box.</entry> </row> <row> @@ -537,7 +536,7 @@ <entry>Returns an object of the <computeroutput>ScrollBar</computeroutput> class for the scroll bar control with the specified resource ID.</entry> </row> <row> -<entry>newTrackBar (<xref linkend="pbdNewTrackBar" /></entry> +<entry><xref linkend="pbdNewTrackBar"/><entry> <entry>Returns an object of the <computeroutput>TrackBar</computeroutput> class for the track bar control with the specified resource ID.</entry> </row> <row> @@ -557,7 +556,7 @@ <entry>Returns an object of the <computeroutput>UpDown</computeroutput> class for the up-down control with the specified resource ID.</entry> </row> <row> -<entry>noAutoDetection (<xref linkend="pbdNoAutoDetection" /></entry> +<entry><xref linkend="pbdNoAutoDetection"/><entry> <entry>Turns automatic data field detection off</entry> </row> <row> @@ -1116,7 +1115,7 @@ <section id="pbdEnableControl" xreflabel="enableControl"><title>enableControl</title> <programlisting> -PlainBaseDialog::enableControl (<xref linkend="mthEnableControl" /> +PlainBaseDialog::<xref linkend="mthEnableControl"/> <![CDATA[ >>--enableControl(--id--)------------------------>< @@ -1136,7 +1135,7 @@ <section id="pbdExecute" xreflabel="execute"><title>execute</title> <programlisting> -PlainBaseDialog::execute (<xref linkend="mthExecute" /> +PlainBaseDialog::<xref linkend="mthExecute"/> <![CDATA[ >>--execute(--+-------------+--+---------+--)---->< @@ -1147,7 +1146,7 @@ <section id="pbdFindComboEntry" xreflabel="findComboEntry"><title>findComboEntry</title> <programlisting> -PlainBaseDialog::findComboEntry (<xref linkend="mthFindComboEntry" /> +PlainBaseDialog::<xref linkend="mthFindComboEntry"/> r<![CDATA[ >>--findComboEntry(--id--,--aString--)----------->< @@ -1611,7 +1610,7 @@ <section id="pbdNewCheckBox" xreflabel="newCheckBox"><title>newCheckBox</title> <programlisting> -PlainBaseDialog::newCheckBox (<xref linkend="mthNewCheckBox" /> +PlainBaseDialog::<xref linkend="mthNewCheckBox"/> <![CDATA[ >>--newCheckBox(--id--)-------------------------->< @@ -1661,7 +1660,7 @@ <section id="pbdNewListBox" xreflabel="newListBox"><title>newListBox</title> <programlisting> -PlainBaseDialog::newListBox (<xref linkend="mthNewListBox" /> +PlainBaseDialog::<xref linkend="mthNewListBox"/> <![CDATA[ >>--newListBox(--id--)--------------------------->< @@ -2172,7 +2171,7 @@ </para> <para> See <xref linkend="figComponentClassesDiagram" /> to visualize the mixin classes that the - DialogControl inherits. In essence the DialogControl is the dialog control (<xref linkend="chpDialogControlObject" />) + DialogControl inherits. In essence the DialogControl is the dialog <xref linkend="chpDialogControlObject"/> object. All the methods and attributes of the DialogControl are listed and documented in the dialog control object chapter. This includes the methods and attributes of its inherited mixin classes. </para> @@ -2436,7 +2435,7 @@ <section id="dcoRedrawRect"><title>redrawRect</title> <programlisting> -DialogControl::redrawRect (<xref linkend="mthRedrawRectClsDialogControl" /> +DialogControl::<xref linkend="mthRedrawRectClsDialogControl"/> <![CDATA[ Form 1: @@ -2804,7 +2803,7 @@ <listitem> <para> The ooDialog framework provides a <xref linkend="ovvSymbolicIDMechanism" /> allowing programmers to - use symbolic (<xref linkend="defSymbolicId" /> IDs in their program. This method is intended to look up a + use <xref linkend="defSymbolicId"/> IDs in their program. This method is intended to look up a numeric resource ID and return its symbolic ID. The lookup is done in the <computeroutput>.Directory</computeroutput> object assigned to the .constDir (<xref linkend="atrConstDir" />) attribute of this resource utils object. If an item in the <computeroutput>constDir</computeroutput> matches the @@ -2870,7 +2869,7 @@ <listitem> <para> The ooDialog framework provides a <xref linkend="ovvSymbolicIDMechanism" /> allowing programmers to - use symbolic (<xref linkend="defSymbolicId" /> IDs in their program. The <emphasis + use <xref linkend="defSymbolicId"/> IDs in their program. The <emphasis role="italic">resolveSymbolicID</emphasis> is the foundation of this mechanism. The framework relies on it heavily, however it is not expected that the programmer would have much need for the method. </para> @@ -2977,7 +2976,7 @@ <entry>Creates a combobox with a static text control (for the label) in the dialog template. </entry> </row> <row> -<entry>createDateTimePicker (<xref linkend="mthCreateDateTimePicker" /></entry> +<entry><xref linkend="mthCreateDateTimePicker"/><entry> <entry>Creates a date time picker control in the dialog template.</entry> </row> <row> @@ -3354,7 +3353,7 @@ <section id="ddCreateEtchedFrame"><title>createEtchedFrame</title> <programlisting> -DynamicDialog::createEtchedFrame (<xref linkend="mthCreateEtchedFrame" /> +DynamicDialog::<xref linkend="mthCreateEtchedFrame"/> <![CDATA[ >>--createEtchedFrame(--+-------+--x-,-y-,-cx-,-cy--+-----------+-)------------>< Modified: docs/trunk/publican/oodialog/en-US/button.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/button.xml 2012-09-01 01:23:43 UTC (rev 8330) +++ docs/trunk/publican/oodialog/en-US/button.xml 2012-09-01 15:12:23 UTC (rev 8331) @@ -360,7 +360,7 @@ <varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term> <listitem> <para> - Use the newChectBox() (<xref linkend="tmthNewCheckBox" />) method to retrieve an object of + Use the <xref linkend="tmthNewCheckBox"/> method to retrieve an object of the check box class. </para> </listitem></varlistentry> @@ -377,7 +377,7 @@ <listitem> <para> A check box, is a button, and the programmer uses the same method to receive notifications of events as with the - button control, the connectButtonEvent() (<xref linkend="mthConnectButtonEvent" />) method. + button control, the<xref linkend="mthConnectButtonEvent" /> method. </para> </listitem></varlistentry> </variablelist> @@ -407,7 +407,7 @@ <entry align="center"><emphasis role="bold">External Methods</emphasis></entry> </row> <row> -<entry>newCheckBox (<xref linkend="tmthNewCheckBox" /></entry> +<entry><xref linkend="tmthNewCheckBox"/><entry> <entry>Returns a <computeroutput>CheckBox</computeroutput> object for the control with the specified ID.</entry> </row> <row> @@ -442,7 +442,7 @@ <section id="tmthNewCheckBox"><title>newCheckBox (dialog object method)</title> <para> Check box objects can not be instantiated by the programmer from Rexx code. Rather a check box object is - obtained by using the newCheckBox() (<xref linkend="mthNewCheckBox" />) method of the dialog object (<xref + obtained by using the<xref linkend="mthNewCheckBox" /> method of the dialog object (<xref linkend="chpDialogObject" />). The syntax is: <programlisting> <![CDATA[ @@ -457,7 +457,7 @@ <section id="tmthCreateCheckBox"><title>createCheckBox (UserDialog method)</title> <para> A check box object can be created in the dialog template for a <xref linkend="clsUserDialog"/> dialog - through the createCheckBox() (<xref linkend="mthCreateCheckBox" />) method. The basic syntax is: + through the<xref linkend="mthCreateCheckBox" /> method. The basic syntax is: <programlisting> <![CDATA[ >>--createCheckBox(-id-,--x-,--y--+------+--+------+--+---------+--+---------+-> @@ -696,7 +696,7 @@ <section id="tmthNewGroupBox"><title>newGroupBox (dialog object method)</title> <para> Group box objects can not be instantiated by the programmer from Rexx code. Rather a group box object is - obtained by using the newGroupBox() (<xref linkend="mthNewGroupBox" />) method of the dialog object (<xref + obtained by using the<xref linkend="mthNewGroupBox" /> method of the dialog object (<xref linkend="chpDialogObject" />). The syntax is: <programlisting> <![CDATA[ @@ -711,7 +711,7 @@ <section id="tmthCreateGroupBox"><title>createGroupBox (UserDialog method)</title> <para> A group box object can be create in the dialog template for a <xref linkend="clsUserDialog"/> - dialog through the createGroupBox() (<xref linkend="mthCreateGroupBox" />) method. The basic syntax is: + dialog through the<xref linkend="mthCreateGroupBox" /> method. The basic syntax is: <programlisting> <![CDATA[ >>--createGroupbox(-+------+-,-x-,-y-,-cx-,-cy--+---------+-+--------+-)------->< @@ -810,7 +810,7 @@ <varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term> <listitem> <para> - Use the newRadioButton() (<xref linkend="tmthNewRadioButton" />) method of the dialog (<xref + Use the <xref linkend="tmthNewRadioButton"/> method of the dialog (<xref linkend="chpDialogObject" />) object to retrieve a new <computeroutput>RadioButton</computeroutput> object. </para> @@ -829,7 +829,7 @@ <listitem> <para> To connect the <xref linkend="ovvEvents"/> notifications sent by the underlying radio button control to a - method in the Rexx dialog object use the connectButtonEvent() (<xref linkend="mthConnectButtonEvent" />) method. + method in the Rexx dialog object use the<xref linkend="mthConnectButtonEvent" /> method. </para> </listitem></varlistentry> </variablelist> @@ -905,7 +905,7 @@ <section id="tmthNewRadioButton"><title>newRadioButton (dialog object method)</title> <para> Radio button objects can not be instantiated by the programmer from Rexx code. Rather a radio button object is - obtained by using the newRadioButton() (<xref linkend="mthNewRadioButton" />) method of the dialog object (<xref + obtained by using the<xref linkend="mthNewRadioButton" /> method of the dialog object (<xref linkend="chpDialogObject" />). The syntax is: <programlisting> <![CDATA[ @@ -920,7 +920,7 @@ <section id="tmthCreateRadioButton"><title>createRadioButton (UserDialog method)</title> <para> A radio button object can be created in the dialog template for a <xref linkend="clsUserDialog"/> - dialog through the createRadioButton() (<xref linkend="mthCreateRadioButton" />) method. The basic syntax is: + dialog through the<xref linkend="mthCreateRadioButton" /> method. The basic syntax is: <programlisting> <![CDATA[ >>--createRadioButton(-id-,-x-,-y-+------+--+------+--+---------+--------------> @@ -1219,7 +1219,7 @@ <varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term> <listitem> <para> - Use the newPushButton() (<xref linkend="tmthNewPushButton" />) method of the dialog <xref + Use the <xref linkend="tmthNewPushButton"/> method of the dialog <xref linkend="chpDialogObject" />) object to retrieve a new <computeroutput>Button</computeroutput> object. </para> </listitem></varlistentry> @@ -1236,7 +1236,7 @@ <listitem> <para> To connect the <xref linkend="ovvEvents"/> notifications sent by the underlying push button to a method - in the Rexx dialog object use the connectButtonEvent() (<xref linkend="mthConnectButtonEvent" />) method. + in the Rexx dialog object use the<xref linkend="mthConnectButtonEvent" /> method. </para> </listitem></varlistentry> </variablelist> @@ -1353,7 +1353,7 @@ <section id="tmthCreatePushButton"><title>createPushButton (UserDialog method)</title> <para> A push button object can be created in the dialog template for a <xref linkend="clsUserDialog"/> - dialog through the createPushButton() (<xref linkend="mthCreatePushButton" />) method. The basic syntax is: + dialog through the<xref linkend="mthCreatePushButton" /> method. The basic syntax is: <programlisting> <![CDATA[ >>--createPushButton(-id-,-x-,-y-,-cx-,-cy-,-+---------+-+-------+-+-------+-)->< @@ -1449,7 +1449,7 @@ <para> The possible return values are: <variablelist> - <varlistentry><term>A .Size (<xref linkend="clsSize" />) object</term> + <varlistentry><term>A<xref linkend="clsSize" /> object</term> <listitem> <para> The ideal size for the button. @@ -1468,7 +1468,7 @@ <listitem> <para> This method requires Common Control <xref linkend="ovvComctl32" /> version 6.0 or later.If necessary use - the comCtl32Version() (<xref linkend="mthComCtl32Version" />) method to determine the current version of the + the<xref linkend="mthComCtl32Version" /> method to determine the current version of the library. </para> <para> @@ -1518,7 +1518,7 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - This method returns the .Image (<xref linkend="clsImage" />) object for the button, or .nil if the button does not + This method returns the<xref linkend="clsImage" /> object for the button, or .nil if the button does not have an image. </para> </listitem></varlistentry> @@ -1584,13 +1584,13 @@ <varlistentry><term>imageList</term> <listitem> <para> - The .ImageList (<xref linkend="clsImageList" />) object containing the images for the button. + The<xref linkend="clsImageList" /> object containing the images for the button. </para> </listitem></varlistentry> <varlistentry><term>rect</term> <listitem> <para> - A .Rect (<xref linkend="clsRect" />) object that specifies the margin around the image. + A<xref linkend="clsRect" /> object that specifies the margin around the image. </para> </listitem></varlistentry> <varlistentry><term>alignment</term> @@ -1616,7 +1616,7 @@ <listitem> <para> This method requires Bommon Control Librayr (<xref linkend="ovvComctl32" />) version 6.0 or later. - If necessary use the comCtl32Version() (<xref linkend="mthComCtl32Version" />) method to + If necessary use the<xref linkend="mthComCtl32Version" /> method to determine the current version of the library. </para> <para> @@ -1696,7 +1696,7 @@ <para> The possible return values are: <variablelist> - <varlistentry><term>A .Rect (<xref linkend="clsRect" />) object</term> + <varlistentry><term>A<xref linkend="clsRect" /> object</term> <listitem> <para> The margin for drawing text in the button. @@ -1715,7 +1715,7 @@ <listitem> <para> This method requires CommonControl <xref linkend="ovvComctl32" /> version 6.0 or later. - If necessary use the comCtl32Version() (<xref linkend="mthComCtl32Version" />) method to + If necessary use the<xref linkend="mthComCtl32Version" /> method to determine the current version of the library. </para> <para> @@ -1829,7 +1829,7 @@ <varlistentry><term>newImage [required]</term> <listitem> <para> - The new .Image (<xref linkend="clsImage" />) object to be associated with the button or + The new<xref linkend="clsImage" /> object to be associated with the button or <computeroutput>.nil</computeroutput>. The use of <computeroutput>.nil</computeroutput> for the argument removes any existing image. </para> @@ -1894,14 +1894,14 @@ <varlistentry><term>imageList [required]</term> <listitem> <para> - A .ImageList (<xref linkend="clsImageList" />) object containing the images for the button. If this argument + A<xref linkend="clsImageList" /> object containing the images for the button. If this argument is the <computeroutput>.Nil</computeroutput> object, then any existing image list is removed. </para> </listitem></varlistentry> <varlistentry><term>margin [optional]</term> <listitem> <para> - A .Rect (<xref linkend="clsRect" />) object containing the margins around the image. The default is a 0 + A<xref linkend="clsRect" /> object containing the margins around the image. The default is a 0 margin. </para> </listitem></varlistentry> @@ -1960,7 +1960,7 @@ give the button the same look and feel as other buttons on the system. </para> <para> - A .ImageList (<xref linkend="clsImageList" />) object is used to supply the images for the button. If the image list + A<xref linkend="clsImageList" /> object is used to supply the images for the button. If the image list only contains 1 image at the first index, then that image is used for all button states. If more than 1 image is supplied, the the image at each index is used for the button state with this mapping: </para> @@ -1991,7 +1991,7 @@ <listitem> <para> This method requires Common Control <xref linkend="ovvComctl32" /> version 6.0 or later. - If necessary use the comCtl32Version() (<xref linkend="mthComCtl32Version" />) method to + If necessary use the<xref linkend="mthComCtl32Version" /> method to determine the current version of the library. </para> <para> @@ -2085,7 +2085,7 @@ <varlistentry><term>margins</term> <listitem> <para> - A .Rect (<xref linkend="clsRect" />) object describing the new margins. + A<xref linkend="clsRect" /> object describing the new margins. </para> </listitem></varlistentry> </variablelist> @@ -2114,7 +2114,7 @@ <listitem> <para> This method requires Common Control <xref linkend="ovvComctl32" /> version 6.0 or later. - If necessary use the comCtl32Version() (<xref linkend="mthComCtl32Version" />) method to + If necessary use the<xref linkend="mthComCtl32Version" /> method to determine the current version of the library. </para> <para> Modified: docs/trunk/publican/oodialog/en-US/combobox.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/combobox.xml 2012-09-01 01:23:43 UTC (rev 8330) +++ docs/trunk/publican/oodialog/en-US/combobox.xml 2012-09-01 15:12:23 UTC (rev 8331) @@ -73,7 +73,7 @@ <varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term> <listitem> <para> - Use the newComboBox() (<xref linkend="mthNewComboBox" />) method of the dialog (<xref + Use the<xref linkend="mthNewComboBox" /> method of the dialog (<xref linkend="chpDialogObject" />) object to retrieve a combo box object. </para> </listitem></varlistentry> @@ -87,9 +87,8 @@ <varlistentry><term><emphasis role="bold">Event Notification</emphasis></term> <listitem> <para> - To connect the rvent (<xref linkend="ovvEvents"/>) notifications sent by the underlying combo box control to a - method in the Rexx dialog object use the <xref linkend="mthConnectComboBoxEvent"/> - method. + To connect the <xref linkend="ovvEvents"/> notifications sent by the underlying combo box control to a method in + the Rexx dialog object use the <xref linkend="mthConnectComboBoxEvent"/> method. </para> </listitem></varlistentry> </variablelist> Modified: docs/trunk/publican/oodialog/en-US/dataAttributes.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dataAttributes.xml 2012-09-01 01:23:43 UTC (rev 8330) +++ docs/trunk/publican/oodialog/en-US/dataAttributes.xml 2012-09-01 15:12:23 UTC (rev 8331) @@ -101,7 +101,7 @@ linkend="clsUserDialog" />, <xref linkend="clsResDialog"/>, and RxDialog (<xref linkend="clsRcDialog" />), and of course their subclasses. Automatic data detection can be turned on or off. By default it is <emphasis role="bold">on</emphasis>. The best way to turn automatic data field detection off for - a single dialog is to over-ride the initAutoDetection() (<xref linkend="mthInitAutoDetection" />) method in your + a single dialog is to over-ride the<xref linkend="mthInitAutoDetection" /> method in your subclass. The <xref linkend="dotApplication" />, an instance of the ApplicationManager (<xref linkend="clsApplicationManager" />) class, can be used to change the default to <emphasis role="bold">off</emphasis> for the entire program. @@ -120,7 +120,7 @@ for any control. However, with automatic detection off, the ooDialog framework will not set the state of the dialog controls to match the values of the connected attributes when the underlying dialog is created. Likewise, when the dialog ends the connected attributes of the Rexx dialog object are not updated to the state of the dialog controls. - But, the programmer can use the setData() (<xref linkend="mthSetData" />) and getData() (<xref + But, the programmer can use the<xref linkend="mthSetData" /> and getData() (<xref linkend="mthGetData" />) methods to do this herself. </para> <para> @@ -131,7 +131,7 @@ <varlistentry><term><emphasis role="bold">UserDialog:</emphasis></term> <listitem> <para> - In a UserDialog (<xref linkend="clsUserDialog" /> the connect... (<xref linkend="sctConnectDataMethods" />) + In a <xref linkend="clsUserDialog" /> the connect... (<xref linkend="sctConnectDataMethods" />) attribute methods are called automatically from the create... (<xref linkend="sctCreateMethods" />) methods of the <computeroutput>UserDialog</computeroutput>. Each of the create... methods takes an optional argument that allows the programmer to specify the data attribute name. If that argument is omitted, the attribute name is automatically (<xref @@ -464,7 +464,7 @@ </para> <para> With auto detection on, the states of the dialog controls are set to the data (values) of the corresponding data - attributes. This is done <emphasis role="bold">after</emphasis> initDialog() (<xref linkend="mthInitDialog" />) is + attributes. This is done <emphasis role="bold">after</emphasis><xref linkend="mthInitDialog" /> is invoked. The consequence of this is that, if the programmer explicitly sets the state of the dialog controls in the <emphasis role="italic">initDialog</emphasis>() method, the ooDialog framwork will then <emphasis role="bold">reset</emphasis> the state of all the dialog controls afterwards. This can be disconcerting to the Modified: docs/trunk/publican/oodialog/en-US/datetimepicker.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/datetimepicker.xml 2012-09-01 01:23:43 UTC (rev 8330) +++ docs/trunk/publican/oodialog/en-US/datetimepicker.xml 2012-09-01 15:12:23 UTC (rev 8331) @@ -61,15 +61,15 @@ <para> The client area of a date and time picker (DTP) control displays date or time information, or both, and acts as the interface through which users modify the information. The date can be selected from a calendar, or by using an up-down - control. The time can be changed by typing in fields that are defined by the control's Format Strings (<xref - linkend="sctDTPFormatStrings" />). The control can optionally display a check box. When it is - checked, the value in the control is considered valid and can be retrieved. When not checked, the control's date and - time is not valid. + control. The time can be changed by typing in fields that are defined by the control's Format <link + linkend="sctDTPFormatStrings">Strings</link>. The control can optionally display a check box. When it + is checked, the value in the control is considered valid and can be retrieved. When not checked, the control's date + and time is not valid. </para> <para> The <computeroutput>DateTimePicker</computeroutput> class provides methods to get and set the date and time in the - underlying DTP control, along with methods to manipulate the control. It is a concrete subclass of the dialog control object (<xref - linkend="chpDialogControlObject" />) and therefore has all methods of the of the dialog control object. + underlying DTP control, along with methods to manipulate the control. It is a concrete subclass of the dialog <xref + linkend="chpDialogControlObject" /> object and therefore has all methods of the of the dialog control object. </para> <para> In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are Modified: docs/trunk/publican/oodialog/en-US/deprecated.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-09-01 01:23:43 UTC (rev 8330) +++ docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-09-01 15:12:23 UTC (rev 8331) @@ -203,7 +203,7 @@ <section><title>connectAnimatedButton</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - installAnimateButton() (<xref linkend="mthInstallAnimatedButton" />) method. +<xref linkend="mthInstallAnimatedButton" /> method. </para> </section> @@ -217,42 +217,42 @@ <section><title>connectEntryLine</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectEdit() (<xref linkend="mthConnectEdit" />) method. +<xref linkend="mthConnectEdit" /> method. </para> </section> <section><title>connectListControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectListView() (<xref linkend="mthConnectListView" />) method. +<xref linkend="mthConnectListView" /> method. </para> </section> <section><title>connectMultiListBox</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectListBox() (<xref linkend="mthConnectListBox" />) method. +<xref linkend="mthConnectListBox" /> method. </para> </section> <section><title>connectSliderControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectTrackBar() (<xref linkend="mthConnectTrackBar" />) method. +<xref linkend="mthConnectTrackBar" /> method. </para> </section> <section><title>connectTabControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectTab() (<xref linkend="mthConnectTab" />) method. +<xref linkend="mthConnectTab" /> method. </para> </section> <section><title>connectTreeControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectTreeView() (<xref linkend="mthConnectTreeView" />) method. +<xref linkend="mthConnectTreeView" /> method. </para> </section> @@ -268,7 +268,7 @@ <section><title>disableItem</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - disableControl() (<xref linkend="mthDisableControl" />) method. +<xref linkend="mthDisableControl" /> method. </para> </section> @@ -291,7 +291,7 @@ <section><title>enableItem</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - enableControl() (<xref linkend="mthEnableControl" />) method. +<xref linkend="mthEnableControl" /> method. </para> </section> @@ -305,7 +305,7 @@ <section><title>freeButtonDC</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - freeControlDC() (<xref linkend="mthFreeControlDC" />) method. +<xref linkend="mthFreeControlDC" /> method. </para> </section> @@ -319,28 +319,28 @@ <section><title>getButtonControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newPushButton() (<xref linkend="mthNewPushButton" />) method. +<xref linkend="mthNewPushButton" /> method. </para> </section> <section><title>getButtonDC</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getControlDC() (<xref linkend="mthGetControlDC" />) method. +<xref linkend="mthGetControlDC" /> method. </para> </section> <section><title>getButtonRect</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Use the - getControlRect() (<xref linkend="mthGetControlRect" />) method instead. +<xref linkend="mthGetControlRect" /> method instead. </para> </section> <section><title>getCheckBox</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getCheckBoxData() (<xref linkend="mthGetCheckBoxData" />) method. +<xref linkend="mthGetCheckBoxData" /> method. </para> </section> @@ -361,56 +361,56 @@ <section><title>getComboLine</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getComboBoxData() (<xref linkend="mthGetComboBoxData" />) method. +<xref linkend="mthGetComboBoxData" /> method. </para> </section> <section><title>getEditControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newEdit() (<xref linkend="mthNewEdit" />) method. +<xref linkend="mthNewEdit" /> method. </para> </section> <section><title>getEntryLine</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getEditData() (<xref linkend="mthGetEditData" />) method. +<xref linkend="mthGetEditData" /> method. </para> </section> <section><title>getGroupBox</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newGroupBox() (<xref linkend="mthNewGroupBox" />) method. +<xref linkend="mthNewGroupBox" /> method. </para> </section> <section><title>getItem</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getControlHandle() (<xref linkend="mthGetControlHandle" />) method. +<xref linkend="mthGetControlHandle" /> method. </para> </section> <section><title>getListBox</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newListBox() (<xref linkend="mthNewListBox" />) method. +<xref linkend="mthNewListBox" /> method. </para> </section> <section><title>getListControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newListView() (<xref linkend="mthNewListView" />) method. +<xref linkend="mthNewListView" /> method. </para> </section> <section><title>getListLine</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getListBoxData() (<xref linkend="mthGetListBoxData" />) method. +<xref linkend="mthGetListBoxData" /> method. </para> </section> @@ -431,21 +431,21 @@ <section><title>getMultiList</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getListBoxData() (<xref linkend="mthGetListBoxData" />) method. +<xref linkend="mthGetListBoxData" /> method. </para> </section> <section><title>getProgressBar</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newProgressBar() (<xref linkend="mthNewProgressBar" />) method. +<xref linkend="mthNewProgressBar" /> method. </para> </section> <section><title>getRadioButton</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getRadioButtonData() (<xref linkend="mthGetRadioButtonData" />) method. +<xref linkend="mthGetRadioButtonData" /> method. </para> </section> @@ -459,35 +459,35 @@ <section><title>getScrollBar</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newScrollBar() (<xref linkend="mthNewScrollBar" />) method. +<xref linkend="mthNewScrollBar" /> method. </para> </section> <section><title>getSliderControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newTrackBar() (<xref linkend="mthNewTrackBar" />) method. +<xref linkend="mthNewTrackBar" /> method. </para> </section> <section><title>getStaticControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newStatic() (<xref linkend="mthNewStatic" />) method. +<xref linkend="mthNewStatic" /> method. </para> </section> <section><title>getTabControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newTab() (<xref linkend="mthNewTab" />) method. +<xref linkend="mthNewTab" /> method. </para> </section> <section><title>getTextSize</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with, preferably, the - getTextSizeData() (<xref linkend="mthGetTextSizeDu" />) method, or the getTextSizeDialog() (<xref +<xref linkend="mthGetTextSizeDu" /> method, or the getTextSizeDialog() (<xref linkend="mthGetTextSizeDlgClsPlainBaseDialog" />) method if absolutely necessary. </para> <para> @@ -500,14 +500,14 @@ <section><title>getTreeControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - newTreeView() (<xref linkend="mthNewTreeView" />) method. +<xref linkend="mthNewTreeView" /> method. </para> </section> <section><title>getValue</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getControlData() (<xref linkend="mthGetControlData" />) method. +<xref linkend="mthGetControlData" /> method. </para> </section> @@ -534,14 +534,14 @@ <section><title>hideItem</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - hideControl() (<xref linkend="mthHideControl" />) method. +<xref linkend="mthHideControl" /> method. </para> </section> <section><title>hideItemFast</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - hideControlFast() (<xref linkend="mthHideControlFast" />) method. +<xref linkend="mthHideControlFast" /> method. </para> </section> @@ -555,7 +555,7 @@ <section><title>itemText</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - setControlText() (<xref linkend="mthSetControlText" />) method. <emphasis role="bold">Note</emphasis> that this method has +<xref linkend="mthSetControlText" /> method. <emphasis role="bold">Note</emphasis> that this method has always been present in ooDialog, but was never previously documented. </para> </section> @@ -576,7 +576,7 @@ <section><title>redrawItem</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - redrawControl() (<xref linkend="mthRedrawControl" />) method. +<xref linkend="mthRedrawControl" /> method. </para> </section> @@ -614,7 +614,7 @@ <section><title>scrollInButton</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - scrollInScroll() (<xref linkend="mthScrollInControl" />) method. +<xref linkend="mthScrollInControl" /> method. </para> </section> @@ -635,7 +635,7 @@ <section><title>setItemSysColor</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - setControlSysColor() (<xref linkend="mthSetControlSysColor" />) method. +<xref linkend="mthSetControlSysColor" /> method. </para> </section> @@ -649,7 +649,7 @@ <section><title>setStaticText</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - setControlText() (<xref linkend="mthSetControlText" />) method. +<xref linkend="mthSetControlText" /> method. </para> </section> @@ -663,7 +663,7 @@ <section><title>writeToButton</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - writeToControl() (<xref linkend="mthWriteToControl" />) method. +<xref linkend="mthWriteToControl" /> method. </para> </section> @@ -685,7 +685,7 @@ <section><title>changeBitmap</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - changeBitmapButton() (<xref linkend="mthChangeBitmapButton" />) method of the the +<xref linkend="mthChangeBitmapButton" /> method of the the <xref linkend="chpDialogObject" /> object. </para> </section> @@ -693,7 +693,7 @@ <section><title>dimBitmap</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - dimBitmap() (<xref linkend="mthDimBitmap" />) method of the the dialog (<xref +<xref linkend="mthDimBitmap" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -701,7 +701,7 @@ <section><title>displaceBitmap</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - displaceBitmap() (<xref linkend="mthDisplaceBitmap" />) method of the the dialog (<xref +<xref linkend="mthDisplaceBitmap" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -709,7 +709,7 @@ <section><title>drawBitmap</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - drawBitmap() (<xref linkend="mthDrawBitmap" />) method of the the dialog (<xref +<xref linkend="mthDrawBitmap" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -717,7 +717,7 @@ <section><title>getBitmapPosition</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getBitmapPosition() (<xref linkend="mthGetBitmapPosition" />) method of the the dialog (<xref +<xref linkend="mthGetBitmapPosition" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -725,7 +725,7 @@ <section><title>getBitmapSizeX</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getBitmapSizeX() (<xref linkend="mthGetBitmapSizeX" />) method of the the dialog (<xref +<xref linkend="mthGetBitmapSizeX" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -733,7 +733,7 @@ <section><title>getBitmapSizeY</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getBitmapSizeY() (<xref linkend="mthGetBitmapSizeY" />) method of the the dialog (<xref +<xref linkend="mthGetBitmapSizeY" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -741,7 +741,7 @@ <section><title>scroll</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - scrollButton() (<xref linkend="mthScrollButton" />) method of the the dialog (<xref +<xref linkend="mthScrollButton" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -749,7 +749,7 @@ <section><title>scrollBitmapFromTo</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - scrollBitmaoFromTo() (<xref linkend="mthScrollBitmapFromTo" />) method of the the dialog (<xref +<xref linkend="mthScrollBitmapFromTo" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -757,7 +757,7 @@ <section><title>scrollText</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - scrollText() (<xref linkend="mthScrollText" />) method of the the dialog (<xref +<xref linkend="mthScrollText" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -765,7 +765,7 @@ <section><title>setBitmapPosition</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - setBitmapPosition() (<xref linkend="mthSetBitmapPosition" />) method of the the dialog (<xref +<xref linkend="mthSetBitmapPosition" /> method of the the dialog (<xref linkend="chpDialogObject" />) object. </para> </section> @@ -838,13 +838,13 @@ <section><title>getRange</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use getFullRange() (<xref linkend="mthGetFullRangePBC" />). + This method is deprecated (<xref linkend="apxDeprecated" />). Use<xref linkend="mthGetFullRangePBC" />. </para> </section> <section id="mthSetRangePBC" xreflabel="setRange"><title>setRange</title> <para> - This method is deprecated (<xref linkend="apxDeprecated" />). Use setFullRange() (<xref linkend="mthSetFullRangePBC" />). + This method is deprecated (<xref linkend="apxDeprecated" />). Use<xref linkend="mthSetFullRangePBC" />. </para> </section> @@ -857,8 +857,8 @@ <section><title>isChecked</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getChectState() (<xref linkend="mthGetCheckStateClsRadioButton" />) method for radio buttons, and the over-ridden - getChectState() (<xref linkend="mthGetCheckStateClsCheckBox" />) method for check boxes. This method was poorly named and +<xref linkend="mthGetCheckStateClsRadioButton" /> method for radio buttons, and the over-ridden +<xref linkend="mthGetCheckStateClsCheckBox" /> method for check boxes. This method was poorly named and in some circumstances produced inconsistent results. </para> </section> @@ -866,7 +866,7 @@ <section><title>indeterminate</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - setIndeterminate() (<xref linkend="mthSetIndeterminate" />) method of the <xref linkend="clsCheckBox"/> +<xref linkend="mthSetIndeterminate" /> method of the <xref linkend="clsCheckBox"/> class. Radio buttons can not be set to indeterminate. Using this method with a radio button sets it to the checked state, not the indeterminate state. In addition, this method was poorly named. One can check a button, but one does not indeterminate a check box. @@ -950,7 +950,7 @@ <section><title>getFocus</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="chpDialogObject" /> - object's getFocus() (<xref linkend="mthGetFocus" />) method instead. + object's<xref linkend="mthGetFocus" /> method instead. </para> </section> @@ -964,7 +964,7 @@ <section><title>getTextSize</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - getTextSizeDu() (<xref linkend="mthGetTextSizeDu" />) method. The getTextSizeDlg() (<xref +<xref linkend="mthGetTextSizeDu" /> method. The getTextSizeDlg() (<xref linkend="mthGetTextSizeDlgClsDialogControl" />) method could also be used, if absolutely necessary. However, that is not recommended. </para> @@ -998,21 +998,21 @@ <section><title>setFocus</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="chpDialogObject" /> - object's setFocus() (<xref linkend="mthSetFocus" />) method instead. + object's<xref linkend="mthSetFocus" /> method instead. </para> </section> <section><title>tabToNext</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="chpDialogObject" /> - object's tabToNext() (<xref linkend="mthTabToNext" />) method instead. + object's<xref linkend="mthTabToNext" /> method instead. </para> </section> <section><title>tabToPrevious</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Use the <xref linkend="chpDialogObject" /> - object's tabToPrevious() (<xref linkend="mthTabToPrevious" />) method instead. + object's<xref linkend="mthTabToPrevious" /> method instead. </para> </section> @@ -1047,7 +1047,7 @@ <section><title>connectButton</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method using the - connectButtonEvent() (<xref linkend="mthConnectButtonEvent" />) method in this manner: +<xref linkend="mthConnectButtonEvent" /> method in this manner: <programlisting> <![CDATA[ -- Change the following code: @@ -1063,42 +1063,42 @@ <section><title>connectButtonNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectButtonEvent() (<xref linkend="mthConnectButtonEvent" />) method. +<xref linkend="mthConnectButtonEvent" /> method. </para> </section> <section><title>connectComboBoxNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectComboBoxEvent() (<xref linkend="mthConnectComboBoxEvent" />) method. +<xref linkend="mthConnectComboBoxEvent" /> method. </para> </section> <section><title>connectCommonNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectNotifyEvent() (<xref linkend="mthConnectNotifyEvent" />) method. +<xref linkend="mthConnectNotifyEvent" /> method. </para> </section> <section><title>connectControl</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectCommandEvents() (<xref linkend="mthConnectCommandEvents" />) method. +<xref linkend="mthConnectCommandEvents" /> method. </para> </section> <section><title>connectEditNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectEditEvent() (<xref linkend="mthConnectEditEvent" />) method. +<xref linkend="mthConnectEditEvent" /> method. </para> </section> <section><title>connectList</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method by using the - connectListBoxEvent() (<xref linkend="mthConnectListViewEvent" />) method in this manner: +<xref linkend="mthConnectListViewEvent" /> method in this manner: <programlisting> <![CDATA[ -- Change the following code: @@ -1114,14 +1114,14 @@ <section><title>connectListBoxNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectListBoxEvent() (<xref linkend="mthConnectListBoxEvent" />) method. +<xref linkend="mthConnectListBoxEvent" /> method. </para> </section> <section><title>connectListLeftDoubleClick</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method by using the - connectListBoxEvent() (<xref linkend="mthConnectListViewEvent" />) method in this manner: +<xref linkend="mthConnectListViewEvent" /> method in this manner: <programlisting> <![CDATA[ -- Change the following code: @@ -1137,14 +1137,14 @@ <section><title>connectListNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectListViewEvent() (<xref linkend="mthConnectListViewEvent" />) method. +<xref linkend="mthConnectListViewEvent" /> method. </para> </section> <section><title>connectListViewNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectListViewEvent() (<xref linkend="mthConnectListViewEvent" />) method. +<xref linkend="mthConnectListViewEvent" /> method. </para> </section> @@ -1165,42 +1165,42 @@ <section><title>connectScrollBar</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectEachSBEvent() (<xref linkend="mthConnectEachSBEvent" />) method. +<xref linkend="mthConnectEachSBEvent" /> method. </para> </section> <section><title>connectScrollBarNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectScrollBarEvent() (<xref linkend="mthConnectScrollBarEvent" />) method. +<xref linkend="mthConnectScrollBarEvent" /> method. </para> </section> <section><title>connectSliderNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectTrackBarEvent() (<xref linkend="mthConnectTrackBarEvent" />) method. +<xref linkend="mthConnectTrackBarEvent" /> method. </para> </section> <section><title>connectStaticNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectStatisEvent() (<xref linkend="mthConnectStaticEvent" />) method. +<xref linkend="mthConnectStaticEvent" /> method. </para> </section> <section><title>connectTabNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectTabEvent() (<xref linkend="mthConnectTabEvent" />) method. +<xref linkend="mthConnectTabEvent" /> method. </para> </section> <section><title>connectTreeNotify</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - connectTreeViewEvent() (<xref linkend="mthConnectTreeViewEvent" />) method. +<xref linkend="mthConnectTreeViewEvent" /> method. </para> </section> @@ -1366,147 +1366,147 @@ <section><title>addBitmapButton</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createBitmapButton() (<xref linkend="mthCreateBitmapButton" />) method. +<xref linkend="mthCreateBitmapButton" /> method. </para> </section> <section><title>addBlackFrame</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createBlackFrame() (<xref linkend="mthCreateBlackFrame" />) method. +<xref linkend="mthCreateBlackFrame" /> method. </para> </section> <section><title>addBlackRect</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createBlackRect() (<xref linkend="mthCreateBlackRect" />) method. +<xref linkend="mthCreateBlackRect" /> method. </para> </section> <section><title>addButton</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createPuskButton() (<xref linkend="mthCreatePushButton" />) method. +<xref linkend="mthCreatePushButton" /> method. </para> </section> <section><title>addButtonGroup</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createPushButtonGroup() (<xref linkend="mthCreatePushButtonGroup" />) method. +<xref linkend="mthCreatePushButtonGroup" /> method. </para> </section> <section><title>addCheckBox</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createCheckBox() (<xref linkend="mthCreateCheckBox" />) method. +<xref linkend="mthCreateCheckBox" /> method. </para> </section> <section><title>addCheckBoxStem</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createCheckBoxStem() (<xref linkend="mthCreateCheckBoxStem" />) method. +<xref linkend="mthCreateCheckBoxStem" /> method. </para> </section> <section><title>addCheckGroup</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createCheckBoxGroup() (<xref linkend="mthCreateCheckBoxGroup" />) method. +<xref linkend="mthCreateCheckBoxGroup" /> method. </para> </section> <section><title>addComboBox</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createComboBox() (<xref linkend="mthCreateComboBox" />) method. +<xref linkend="mthCreateComboBox" /> method. </para> </section> <section><title>addComboInput</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createComboBoxInput() (<xref linkend="mthCreateComboBoxInput" />) method. +<xref linkend="mthCreateComboBoxInput" /> method. </para> </section> <section><title>addEntryLine</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createEdit() (<xref linkend="mthCreateEdit" />) method. +<xref linkend="mthCreateEdit" /> method. </para> </section> <section><title>addEtchedFrame</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createEtchedFrame() (<xref linkend="mthCreateEtchedFrame" />) method. +<xref linkend="mthCreateEtchedFrame" /> method. </para> </section> <section><title>addEtchedHorizontal</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createEtchedHorizontal() (<xref linkend="mthCreateEtchedHorizontal" />) method. +<xref linkend="mthCreateEtchedHorizontal" /> method. </para> </section> <section><title>addEtchedVertical</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createEtchedVertical() (<xref linkend="mthCreateEtchedVertical" />) method. +<xref linkend="mthCreateEtchedVertical" /> method. </para> </section> <section><title>addGrayFrame</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createGrayFrame() (<xref linkend="mthCreateGrayFrame" />) method. +<xref linkend="mthCreateGrayFrame" /> method. </para> </section> <section><title>addGrayRect</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createGrayRect() (<xref linkend="mthCreateGrayRect" />) method. +<xref linkend="mthCreateGrayRect" /> method. </para> </section> <section><title>addGroupBox</title> <para> This method is deprecated (<xref linkend="apxDeprecated" />). Replace this method with the - createGroupBox() (<xref linkend="mthCreateGroupBox" />) method. +<xref linkend="mthCreateGroupBox" /> method. </para> </section> <section><title>addIcon</titl... [truncated message content] |
From: <mie...@us...> - 2012-09-01 15:19:15
|
Revision: 8332 http://sourceforge.net/p/oorexx/code-0/8332 Author: miesfeld Date: 2012-09-01 15:19:12 +0000 (Sat, 01 Sep 2012) Log Message: ----------- Publican ooDialog - fix tags Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/button.xml Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-01 15:12:23 UTC (rev 8331) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-01 15:19:12 UTC (rev 8332) @@ -240,7 +240,7 @@ <entry>Creates a data attribute in the Rexx dialog object and connects it to a combo box control in the underlying dialog.</entry> </row> <row> -<entry><xref linkend="pbdConnectDateTimePicker"/><entry> +<entry><xref linkend="pbdConnectDateTimePicker"/></entry> <entry>Creates a data attribute in the Rexx dialog object and connects it to a date time picker control in the underlying dialog.</entry> </row> <row> @@ -248,7 +248,7 @@ <entry>Creates a data attribute in the Rexx dialog object and connects it to a edit control in the underlying dialog.</entry> </row> <row> -<entry><xref linkend="pbdConnectListBox"/><entry> +<entry><xref linkend="pbdConnectListBox"/></entry> <entry>Creates a data attribute in the Rexx dialog object and connects it to a list box control in the underlying dialog.</entry> </row> <row> @@ -268,7 +268,7 @@ <entry>Creates a data attribute in the Rexx dialog object and connects it to a tab control in the underlying dialog.</entry> </row> <row> -<entry><xref linkend="pbdConnectTrackBar"/><entry> +<entry><xref linkend="pbdConnectTrackBar"/></entry> <entry>Creates a data attribute in the Rexx dialog object and connects it to a track bar control in the underlying dialog.</entry> </row> <row> @@ -332,7 +332,7 @@ <entry>Sets the value of the connected data attribute in the Rexx dialog object to match the state of the specified combo box in the underlying dialog.</entry> </row> <row> -<entry><xref linkend="pbdGetComboEntry"/><entry> +<entry><xref linkend="pbdGetComboEntry"/></entry> <entry>Returns the string at the specified index of the combo box.</entry> </row> <row> @@ -452,7 +452,7 @@ <entry>Inserts a string into the list of a combo box.</entry> </row> <row> -<entry><xref linkend="pbdInsertListEntry"/><entry> +<entry><xref linkend="pbdInsertListEntry"/></entry> <entry>Inserts a string into the specified list box.</entry> </row> <row> @@ -536,7 +536,7 @@ <entry>Returns an object of the <computeroutput>ScrollBar</computeroutput> class for the scroll bar control with the specified resource ID.</entry> </row> <row> -<entry><xref linkend="pbdNewTrackBar"/><entry> +<entry><xref linkend="pbdNewTrackBar"/></entry> <entry>Returns an object of the <computeroutput>TrackBar</computeroutput> class for the track bar control with the specified resource ID.</entry> </row> <row> @@ -556,7 +556,7 @@ <entry>Returns an object of the <computeroutput>UpDown</computeroutput> class for the up-down control with the specified resource ID.</entry> </row> <row> -<entry><xref linkend="pbdNoAutoDetection"/><entry> +<entry><xref linkend="pbdNoAutoDetection"/></entry> <entry>Turns automatic data field detection off</entry> </row> <row> @@ -2976,7 +2976,7 @@ <entry>Creates a combobox with a static text control (for the label) in the dialog template. </entry> </row> <row> -<entry><xref linkend="mthCreateDateTimePicker"/><entry> +<entry><xref linkend="mthCreateDateTimePicker"/></entry> <entry>Creates a date time picker control in the dialog template.</entry> </row> <row> Modified: docs/trunk/publican/oodialog/en-US/button.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/button.xml 2012-09-01 15:12:23 UTC (rev 8331) +++ docs/trunk/publican/oodialog/en-US/button.xml 2012-09-01 15:19:12 UTC (rev 8332) @@ -407,7 +407,7 @@ <entry align="center"><emphasis role="bold">External Methods</emphasis></entry> </row> <row> -<entry><xref linkend="tmthNewCheckBox"/><entry> +<entry><xref linkend="tmthNewCheckBox"/></entry> <entry>Returns a <computeroutput>CheckBox</computeroutput> object for the control with the specified ID.</entry> </row> <row> |
From: <mie...@us...> - 2012-09-01 18:08:53
|
Revision: 8333 http://sourceforge.net/p/oorexx/code-0/8333 Author: miesfeld Date: 2012-09-01 18:08:44 +0000 (Sat, 01 Sep 2012) Log Message: ----------- Publican ooDialog work Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/Author_Group.xml docs/trunk/publican/oodialog/en-US/Book_Info.xml docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/button.xml docs/trunk/publican/oodialog/en-US/combobox.xml docs/trunk/publican/oodialog/en-US/dataAttributes.xml docs/trunk/publican/oodialog/en-US/datetimepicker.xml docs/trunk/publican/oodialog/en-US/deprecated.xml docs/trunk/publican/oodialog/en-US/dialogControlObject.xml docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/dialogObject.xml docs/trunk/publican/oodialog/en-US/edit.xml docs/trunk/publican/oodialog/en-US/eventNotification.xml docs/trunk/publican/oodialog/en-US/listbox.xml docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/menus.xml docs/trunk/publican/oodialog/en-US/monthcalendar.xml docs/trunk/publican/oodialog/en-US/mouse.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/progressbar.xml docs/trunk/publican/oodialog/en-US/propertySheetDialogs.xml docs/trunk/publican/oodialog/en-US/resdialog.xml docs/trunk/publican/oodialog/en-US/resources.xml docs/trunk/publican/oodialog/en-US/scrollbar.xml docs/trunk/publican/oodialog/en-US/static.xml docs/trunk/publican/oodialog/en-US/tab.xml docs/trunk/publican/oodialog/en-US/trackbar.xml docs/trunk/publican/oodialog/en-US/treeview.xml docs/trunk/publican/oodialog/en-US/updown.xml docs/trunk/publican/oodialog/en-US/userInput.xml docs/trunk/publican/oodialog/en-US/userdialog.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml docs/trunk/publican/oodialog/en-US/windowBase.xml docs/trunk/publican/oodialog/en-US/windowBaseDCO.xml docs/trunk/publican/oodialog/en-US/windowBaseDO.xml docs/trunk/publican/oodialog/en-US/windowExtensions.xml docs/trunk/publican/oodialog/en-US/windowExtensionsDCO.xml docs/trunk/publican/oodialog/en-US/windowExtensionsDO.xml Modified: docs/trunk/publican/oodialog/en-US/Author_Group.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/Author_Group.xml 2012-09-01 15:19:12 UTC (rev 8332) +++ docs/trunk/publican/oodialog/en-US/Author_Group.xml 2012-09-01 18:08:44 UTC (rev 8333) @@ -45,12 +45,8 @@ --> <authorgroup> <author> - <firstname> - <xi:include parse="text" href="../../../datepub.tmp" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </firstname> - <surname> - svn revision <xi:include parse="text" href="../../../svnrev.tmp" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </surname> + <firstname>Open Object</firstname> + <surname>Rexx™</surname> </author> <author> <firstname>W. David</firstname> Modified: docs/trunk/publican/oodialog/en-US/Book_Info.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/Book_Info.xml 2012-09-01 15:19:12 UTC (rev 8332) +++ docs/trunk/publican/oodialog/en-US/Book_Info.xml 2012-09-01 18:08:44 UTC (rev 8333) @@ -45,7 +45,10 @@ --> <bookinfo id="book-oodialog-oodialog"> <title>ooDialog Reference &VERSION;</title> - <subtitle>Open Object Rexx™</subtitle> + <subtitle> + <xi:include parse="text" href="../../../datepub.tmp" xmlns:xi="http://www.w3.org/2001/XInclude" /> svn revision + <xi:include parse="text" href="../../../svnrev.tmp" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </subtitle> <productname>ooRexx Documentation</productname> <productnumber></productnumber> <edition>&EDITION;</edition> Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-01 15:19:12 UTC (rev 8332) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-01 18:08:44 UTC (rev 8333) @@ -56,14 +56,14 @@ To make it easier to understand the methods and attributes that all dialogs have in common, this documentation treats the <xref linkend="chpDialogObject"/> object as a whole. The dialog object chapter shows all the methods and attributes that every dialog has, without making much distinction as to what specific mixin or base class the - method belongs to. The dialog <xref linkend="chpDialogControlObject" /> object, is treated in a similar + method belongs to. The dialog <xref linkend="chpDialogControlObject"/> object, is treated in a similar fashion in its chapter. </para> <para> This chapter describes the base and mixin classes that make up the dialog object and the dialog control object and shows how they fit together. In addition, it contains the detailed information for the mixin classes inherited by both the dialog and dialog control object. The <xref linkend="chpDialogObject"/> object and the - dialog <xref linkend="chpDialogControlObject" /> object chapters link back to this chapter for the detailed + dialog <xref linkend="chpDialogControlObject"/> object chapters link back to this chapter for the detailed information where needed. </para> @@ -89,12 +89,12 @@ PlainBaseDialog is the base class of all dialog classes in the ooDialog framework. It implements methods that are common to every dialog. PlainBaseDialog is an abstract class. A programmer can not instantiate a new PlainBaseDialog object and display a dialog on the screen. Rather, the ooDialog programmer subclasses one of the concrete classes - provided by the ooDialog framework, such as the <xref linkend="clsResDialog"/>, the (<xref linkend="clsRcDialog" />), - or the <xref linkend="clsUserDialog"/>, to create and execute a real dialog. + provided by the ooDialog framework, such as the <xref linkend="clsResDialog"/>, the <xref linkend="clsRcDialog"/>, or + the <xref linkend="clsUserDialog"/>, to create and execute a real dialog. </para> <para> Many of the methods of the PlainBaseDialog are actually implemented in one of the mixin classes inherited by the - PlainBaseDialog. See this <xref linkend="figComponentClassesDiagram" /> to visualize the inheritance. In + PlainBaseDialog. See this <xref linkend="figComponentClassesDiagram"/> to visualize the inheritance. In essence the PlainBaseDialog is the <xref linkend="chpDialogObject"/> object. All the methods and attributes of the PlainBaseDialog are listed in the dialog object chapter. This includes the methods and attributes of its inherited mixin classes. @@ -641,7 +641,7 @@ </row> <row> <entry><xref linkend="pbdSetGroup"/></entry> -<entry>Adds or removes the group style (<xref linkend="wsgroup" />) for the control specified.</entry> +<entry>Adds or removes the <xref linkend="wsgroup"/> style for the control specified.</entry> </row> <row> <entry><xref linkend="pbdSetListBoxData"/></entry> @@ -709,7 +709,7 @@ <section id="pbdGetFontName"><title>getFontName (Class method)</title> <programlisting> -PlainBaseDialog::<xref linkend="mthClsGetFontName" /> +PlainBaseDialog::<xref linkend="mthClsGetFontName"/> <![CDATA[ >>--getFontName---------------------------------->< @@ -719,7 +719,7 @@ <section id="pbdGetFontSize"><title>getFontSize (Class method)</title> <programlisting> -PlainBaseDialog::<xref linkend="mthClsGetFontSize" /> +PlainBaseDialog::<xref linkend="mthClsGetFontSize"/> <![CDATA[ >>--getFontSize---------------------------------->< @@ -729,7 +729,7 @@ <section id="pbdNew"><title>new (Class method)</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewDialogObject" /> +PlainBaseDialog::<xref linkend="mthNewDialogObject"/> <![CDATA[ >>--new(--library--,--id--+-------------+--+----------+--)--------------------->< @@ -740,7 +740,7 @@ <section id="pbdSetDefaultFont"><title>setDefaultFont (Class method)</title> <programlisting> -PlainBaseDialog::<xref linkend="mthClsSetDefaultFont" /> +PlainBaseDialog::<xref linkend="mthClsSetDefaultFont"/> <![CDATA[ >>--setDefaultFont(--fontName--,--fontSize--)---->< @@ -750,7 +750,7 @@ <section id="pbdAutoDetect"><title>autoDetect (Attribute)</title> <programlisting> -PlainBaseDialog::<xref linkend="atrAutoDetect" /> +PlainBaseDialog::<xref linkend="atrAutoDetect"/> <![CDATA[ >>--autoDetect----------------------------------->< @@ -762,7 +762,7 @@ <section id="pbdDlgHandle"><title>dlgHandle (Attribute)</title> <programlisting> -PlainBaseDialog::<xref linkend="atrDlgHandle" /> +PlainBaseDialog::<xref linkend="atrDlgHandle"/> <![CDATA[ ]]> @@ -771,7 +771,7 @@ <section id="pbdFontName"><title>fontName (Attribute)</title> <programlisting> -PlainBaseDialog::<xref linkend="atrFontName" /> +PlainBaseDialog::<xref linkend="atrFontName"/> <![CDATA[ >>--fontName------------------------------------->< @@ -783,7 +783,7 @@ <section id="pbdFontSize"><title>fontSize (Attribute)</title> <programlisting> -PlainBaseDialog::<xref linkend="atrFontSize" /> +PlainBaseDialog::<xref linkend="atrFontSize"/> <![CDATA[ >>--fontSize------------------------------------->< @@ -795,7 +795,7 @@ <section id="pbdOwnerDialog"><title>ownerDialog (Attribute)</title> <programlisting> -PlainBaseDialog::<xref linkend="atrOwnerDialog" /> +PlainBaseDialog::<xref linkend="atrOwnerDialog"/> <![CDATA[ >>--ownerDialog---------------------------------->< @@ -807,7 +807,7 @@ <section id="pbdAddComboEntry" xreflabel="addComboEntry"><title>addComboEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthAddComboEntry" /> +PlainBaseDialog::<xref linkend="mthAddComboEntry"/> <![CDATA[ >>--addComboEntry(--id--,--aString--)------------>< @@ -817,7 +817,7 @@ <section id="pbdAddListEntry" xreflabel="addListEntry"><title>addListEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthAddListEntry" /> +PlainBaseDialog::<xref linkend="mthAddListEntry"/> <![CDATA[ >>--addListEntry(--id--,--aString--)------------->< @@ -827,7 +827,7 @@ <section id="pbdAddNewAttribute" xreflabel="addNewAttribute"><title>addNewAttribute</title> <programlisting> -PlainBaseDialog::<xref linkend="mthAddNewAttribute" /> +PlainBaseDialog::<xref linkend="mthAddNewAttribute"/> <![CDATA[ >>--addNewAttribute(--atrName--+------------+--+--------------+--+------------+--)-->< @@ -838,7 +838,7 @@ <section id="pbdAddNewMethod" xreflabel="addNewMethod"><title>addNewMethod</title> <programlisting> -PlainBaseDialog::<xref linkend="mthAddNewMethod" /> +PlainBaseDialog::<xref linkend="mthAddNewMethod"/> <![CDATA[ >>--addNewMethod(--mthName--+--------------+--+------------+--)---------------->< @@ -849,7 +849,7 @@ <section id="pbdBackgroundBitmap" xreflabel="backgroundBitmap"><title>backgroundBitmap</title> <programlisting> -PlainBaseDialog::<xref linkend="mthBackgroundBitmap" /> +PlainBaseDialog::<xref linkend="mthBackgroundBitmap"/> <![CDATA[ >>--backgroundBitmap(--bmpFilename--+-------------+--)------------------------->< @@ -860,7 +860,7 @@ <section id="pbdAutoDetection" xreflabel="autoDetection"><title>autoDetection</title> <programlisting> -PlainBaseDialog::<xref linkend="mthAutoDetection" /> +PlainBaseDialog::<xref linkend="mthAutoDetection"/> <![CDATA[ >>--autoDetection-------------------------------->< @@ -870,7 +870,7 @@ <section id="pbdBackgroundColor" xreflabel="backgroundColor"><title>backgroundColor</title> <programlisting> -PlainBaseDialog::<xref linkend="mthBackgroundColor" /> +PlainBaseDialog::<xref linkend="mthBackgroundColor"/> <![CDATA[ >>--backgroundColor(--color--)------------------->< @@ -880,7 +880,7 @@ <section id="pbdCancel" xreflabel="cancel"><title>cancel</title> <programlisting> -PlainBaseDialog::<xref linkend="mthCancel" /> +PlainBaseDialog::<xref linkend="mthCancel"/> <![CDATA[ >>--cancel--------------------------------------->< @@ -890,7 +890,7 @@ <section id="pbdCenter" xreflabel="center"><title>center</title> <programlisting> -PlainBaseDialog::<xref linkend="mthCenter" /> +PlainBaseDialog::<xref linkend="mthCenter"/> <![CDATA[ >>--center(--+------------+--)------------------->< @@ -901,7 +901,7 @@ <section id="pbdChangeComboEntry" xreflabel="changeComboEntry"><title>changeComboEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthChangeComboEntry" /> +PlainBaseDialog::<xref linkend="mthChangeComboEntry"/> <![CDATA[ >>--changeComboEntry(--id--,--+-------+--,--aString--)------------------------->< @@ -912,7 +912,7 @@ <section id="pbdChangeListEntry" xreflabel="changeListEntry"><title>changeListEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthChangeListEntry" /> +PlainBaseDialog::<xref linkend="mthChangeListEntry"/> <![CDATA[ >>--changeListEntry(--id--,--+-------+--,--aString--)-------------------------->< @@ -923,7 +923,7 @@ <section id="pbdComboAddDirectory" xreflabel="comboAddDirectory"><title>comboAddDirectory</title> <programlisting> -PlainBaseDialog::<xref linkend="mthComboAddDirectory" /> +PlainBaseDialog::<xref linkend="mthComboAddDirectory"/> <![CDATA[ >>--comboAddDirectory(--id--,--drvpath--,--fileAtrs--)---------->< @@ -933,7 +933,7 @@ <section id="pbdComboDrop" xreflabel="comboDrop"><title>comboDrop</title> <programlisting> -PlainBaseDialog::<xref linkend="mthComboDrop" /> +PlainBaseDialog::<xref linkend="mthComboDrop"/> <![CDATA[ >>--comboDrop(--id--)---------------------------->< @@ -943,7 +943,7 @@ <section id="pbdConnectCheckBox" xreflabel="connectCheckBox"><title>connectCheckBox</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectCheckBox" /> +PlainBaseDialog::<xref linkend="mthConnectCheckBox"/> <![CDATA[ >>--connctChectBox(--id--+-------------------+--)--------------->< @@ -954,7 +954,7 @@ <section id="pbdConnectComboBox" xreflabel="connectComboBox"><title>connectComboBox</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectComboBox" /> +PlainBaseDialog::<xref linkend="mthConnectComboBox"/> <![CDATA[ >>--connectComboBox(--id--+------------------+--)--------------->< @@ -965,7 +965,7 @@ <section id="pbdConnectDateTimePicker" xreflabel="connectDateTimePicker"><title>connectDateTimePicker</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectDateTimePicker" /> +PlainBaseDialog::<xref linkend="mthConnectDateTimePicker"/> <![CDATA[ >>--connectDateTimePicker(--id--+------------------+--)--------->< @@ -976,7 +976,7 @@ <section id="pbdConnectEdit" xreflabel="connectEdit"><title>connectEdit</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectEdit" /> +PlainBaseDialog::<xref linkend="mthConnectEdit"/> <![CDATA[ >>--connectEdit(--id--+------------------+--)---->< @@ -987,7 +987,7 @@ <section id="pbdConnectListBox" xreflabel="connectListBox"><title>connectListBox</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectListBox" /> +PlainBaseDialog::<xref linkend="mthConnectListBox"/> <![CDATA[ >>--connectListBox(--id--+-------------------+--)--------------->< @@ -998,7 +998,7 @@ <section id="pbdConnectListView" xreflabel="connectListView"><title>connectListView</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectListView" /> +PlainBaseDialog::<xref linkend="mthConnectListView"/> <![CDATA[ >>--connectListView(--id--+------------------+--)--------------->< @@ -1009,7 +1009,7 @@ <section id="pbdConnectMonthCalendar" xreflabel="connectMonthCalendar"><title>connectMonthCalendar</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectMonthCalendar" /> +PlainBaseDialog::<xref linkend="mthConnectMonthCalendar"/> <![CDATA[ >>--connectMonthCalendar(--id--+------------------+--)---------->< @@ -1020,7 +1020,7 @@ <section id="pbdConnectRadioButton" xreflabel="connectRadioButton"><title>connectRadioButton</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectRadioButton" /> +PlainBaseDialog::<xref linkend="mthConnectRadioButton"/> <![CDATA[ >>--connectRadioButton(--id--+-------------------+--)----------->< @@ -1031,7 +1031,7 @@ <section id="pbdConnectTab" xreflabel="connectTab"><title>connectTab</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectTab" /> +PlainBaseDialog::<xref linkend="mthConnectTab"/> <![CDATA[ >>--connectTab(--id--+------------------+--)----->< @@ -1042,7 +1042,7 @@ <section id="pbdConnectTrackBar" xreflabel="connectTrackBar"><title>connectTrackBar</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectTrackBar" /> +PlainBaseDialog::<xref linkend="mthConnectTrackBar"/> <![CDATA[ >>--connectTrackBar(--id--+------------------+--)--------------->< @@ -1053,7 +1053,7 @@ <section id="pbdConnectTreeview" xreflabel="connectTreeview"><title>connectTreeview</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectTreeView" /> +PlainBaseDialog::<xref linkend="mthConnectTreeView"/> <![CDATA[ >>--connectTreeView(--id--+------------------+--)--------------->< @@ -1064,7 +1064,7 @@ <section id="pbdConnectUpDown" xreflabel="connectUpDown"><title>connectUpDown</title> <programlisting> -PlainBaseDialog::<xref linkend="mthConnectUpDown" /> +PlainBaseDialog::<xref linkend="mthConnectUpDown"/> <![CDATA[ >>--connectUpDown(--id--+------------------+--)-->< @@ -1075,7 +1075,7 @@ <section id="pbdDeleteComboEntry" xreflabel="deleteComboEntry"><title>deleteComboEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthDeleteComboEntry" /> +PlainBaseDialog::<xref linkend="mthDeleteComboEntry"/> <![CDATA[ >>--deleteComboEntry(--id--,--index--)----------->< @@ -1085,7 +1085,7 @@ <section id="pbdDeleteListEntry" xreflabel="deleteListEntry"><title>deleteListEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthDeleteListEntry" /> +PlainBaseDialog::<xref linkend="mthDeleteListEntry"/> <![CDATA[ >>--deleteListEntry(--id--,--index--)------------>< @@ -1095,7 +1095,7 @@ <section id="pbdDisableControl" xreflabel="disableControl"><title>disableControl</title> <programlisting> -PlainBaseDialog::<xref linkend="mthDisableControl" /> +PlainBaseDialog::<xref linkend="mthDisableControl"/> <![CDATA[ >>--disableControl(--id--)----------------------->< @@ -1105,7 +1105,7 @@ <section id="pbdDlgUnit2pixel" xreflabel="dlgUnit2pixel"><title>dlgUnit2pixel</title> <programlisting> -PlainBaseDialog::<xref linkend="mthDlgUnit2pixel" /> +PlainBaseDialog::<xref linkend="mthDlgUnit2pixel"/> <![CDATA[ >>--dlgUnit2pixel(--du--)------------------------>< @@ -1125,7 +1125,7 @@ <section id="pbdEnsureVisible" xreflabel="ensureVisible"><title>ensureVisible</title> <programlisting> -PlainBaseDialog::<xref linkend="mthEnsureVisible" /> +PlainBaseDialog::<xref linkend="mthEnsureVisible"/> <![CDATA[ >>--ensureVisible-------------------------------->< @@ -1156,7 +1156,7 @@ <section id="pbdFindListEntry" xreflabel="findListEntry"><title>findListEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthFindListEntry" /> +PlainBaseDialog::<xref linkend="mthFindListEntry"/> <![CDATA[ >>--findListEntry(--id--,--aString--)------------>< @@ -1166,7 +1166,7 @@ <section id="pbdFocusControl" xreflabel="focusControl"><title>focusControl</title> <programlisting> -PlainBaseDialog::<xref linkend="mthFocusControl" /> +PlainBaseDialog::<xref linkend="mthFocusControl"/> <![CDATA[ >>--focusControl(--id--)------------------------->< @@ -1176,7 +1176,7 @@ <section id="pbdGet" xreflabel="get"><title>get</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGet" /> +PlainBaseDialog::<xref linkend="mthGet"/> <![CDATA[ >>--get------------------------------------------>< @@ -1186,7 +1186,7 @@ <section id="pbdGetCheckBoxData" xreflabel="getCheckBoxData"><title>getCheckBoxData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetCheckBoxData" /> +PlainBaseDialog::<xref linkend="mthGetCheckBoxData"/> <![CDATA[ >>--getCheckBoxData(--id--)---------------------->< @@ -1196,7 +1196,7 @@ <section id="pbdGetComboBoxData" xreflabel="getComboBoxData"><title>getComboBoxData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetComboBoxData" /> +PlainBaseDialog::<xref linkend="mthGetComboBoxData"/> <![CDATA[ >>--getComboBoxData(--id--)---------------------->< @@ -1206,7 +1206,7 @@ <section id="pbdGetComboEntry" xreflabel="getComboEntry"><title>getComboEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetComboEntry" /> +PlainBaseDialog::<xref linkend="mthGetComboEntry"/> <![CDATA[ >>--getComboEntry(--id--,--index--)-------------->< @@ -1216,7 +1216,7 @@ <section id="pbdGetComboItems" xreflabel="getComboItems"><title>getComboItems</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetComboItems" /> +PlainBaseDialog::<xref linkend="mthGetComboItems"/> <![CDATA[ >>--getComboItems(--id--)------------------------>< @@ -1226,7 +1226,7 @@ <section id="pbdGetControlData" xreflabel="getControlData"><title>getControlData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetControlData" /> +PlainBaseDialog::<xref linkend="mthGetControlData"/> <![CDATA[ >>--getControlData(--id--)----------------------->< @@ -1236,7 +1236,7 @@ <section id="pbdGetControlHandle" xreflabel="getControlHandle"><title>getControlHandle</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetControlHandle" /> +PlainBaseDialog::<xref linkend="mthGetControlHandle"/> <![CDATA[ >>--getControlHandle(--id--+---------+--)-------->< @@ -1247,7 +1247,7 @@ <section id="pbdGetControlID" xreflabel="getControlID"><title>getControlID</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetControlID" /> +PlainBaseDialog::<xref linkend="mthGetControlID"/> <![CDATA[ >>--getControlID(--hwnd--)----------------------->< @@ -1257,7 +1257,7 @@ <section id="pbdGetControlText" xreflabel="getControlText"><title>getControlText</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetControlText" /> +PlainBaseDialog::<xref linkend="mthGetControlText"/> <![CDATA[ >>--getControlText(--id--)----------------------->< @@ -1267,7 +1267,7 @@ <section id="pbdGetCurrentComboIndex" xreflabel="getCurrentComboIndex"><title>getCurrentComboIndex</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetCurrentComboIndex" /> +PlainBaseDialog::<xref linkend="mthGetCurrentComboIndex"/> <![CDATA[ >>--getCurrentComboIndex(--id--)----------------->< @@ -1277,7 +1277,7 @@ <section id="pbdGetCurrentListIndex" xreflabel="getCurrentListIndex"><title>getCurrentListIndex</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetCurrentListIndex" /> +PlainBaseDialog::<xref linkend="mthGetCurrentListIndex"/> <![CDATA[ >>--getCurrentListIndex(--id--)------------------>< @@ -1287,7 +1287,7 @@ <section id="pbdGetData" xreflabel="getData"><title>getData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetData" /> +PlainBaseDialog::<xref linkend="mthGetData"/> <![CDATA[ >>--getData-------------------------------------->< @@ -1297,7 +1297,7 @@ <section id="pbdGetDataAttribute" xreflabel="getDataAttribute"><title>getDataAttribute</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetDataAttribute" /> +PlainBaseDialog::<xref linkend="mthGetDataAttribute"/> <![CDATA[ >>--getDataAttribute(--attributeName--)---------->< @@ -1307,7 +1307,7 @@ <section id="pbdGetDataStem" xreflabel="getDataStem"><title>getDataStem</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetDataStem" /> +PlainBaseDialog::<xref linkend="mthGetDataStem"/> <![CDATA[ >>--getDataStem(--dataStem.--)------------------->< @@ -1317,7 +1317,7 @@ <section id="pbdGetEditData" xreflabel="getEditData"><title>getEditData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetEditData" /> +PlainBaseDialog::<xref linkend="mthGetEditData"/> <![CDATA[ >>-aBaseDialog~getEditData(--id--)---------------------------->< @@ -1327,7 +1327,7 @@ <section id="pbdGetFocus" xreflabel="getFocus"><title>getFocus</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetFocus" /> +PlainBaseDialog::<xref linkend="mthGetFocus"/> <![CDATA[ >>--getFocus------------------------------------->< @@ -1337,7 +1337,7 @@ <section id="pbdGetListBoxData" xreflabel="getListBoxData"><title>getListBoxData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetListBoxData" /> +PlainBaseDialog::<xref linkend="mthGetListBoxData"/> <![CDATA[ >>--getListBoxData(--id--)----------------------->< @@ -1347,7 +1347,7 @@ <section id="pbdGetListEntry" xreflabel="getListEntry"><title>getListEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetListEntry" /> +PlainBaseDialog::<xref linkend="mthGetListEntry"/> <![CDATA[ >>--getListEntry(--id--,--index--)--------------->< @@ -1357,7 +1357,7 @@ <section id="pbdGetListItems" xreflabel="getListItems"><title>getListItems</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetListItems" /> +PlainBaseDialog::<xref linkend="mthGetListItems"/> <![CDATA[ >>--getListItems(--id--)------------------------->< @@ -1367,7 +1367,7 @@ <section id="pbdGetMenuBar" xreflabel="getMenuBar"><title>getMenuBar</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetMenuBar" /> +PlainBaseDialog::<xref linkend="mthGetMenuBar"/> <![CDATA[ >>--getMenuBar----------------------------------->< @@ -1377,7 +1377,7 @@ <section id="pbdGetRadioButtonData" xreflabel="getRadioButtonData"><title>getRadioButtonData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetRadioButtonData" /> +PlainBaseDialog::<xref linkend="mthGetRadioButtonData"/> <![CDATA[ >>--getRadioButtonData(--id--)------------------->< @@ -1387,7 +1387,7 @@ <section id="pbdGetSelf" xreflabel="getSelf"><title>getSelf</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetSelf" /> +PlainBaseDialog::<xref linkend="mthGetSelf"/> <![CDATA[ >>--getSelf-------------------------------------->< @@ -1397,7 +1397,7 @@ <section id="pbdGetTextSizeDlg" xreflabel="getTextSizeDlg"><title>getTextSizeDlg</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetTextSizeDlgClsPlainBaseDialog" /> +PlainBaseDialog::<xref linkend="mthGetTextSizeDlgClsPlainBaseDialog"/> <![CDATA[ >>--getTextSizeDlg(--text--+-------------+--+-------------+--+---------+--)---->< @@ -1408,7 +1408,7 @@ <section id="pbdGetTextSizeDu" xreflabel="getTextSizeDu"><title>getTextSizeDu</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetTextSizeDu" /> +PlainBaseDialog::<xref linkend="mthGetTextSizeDu"/> <![CDATA[ >>--getTextSizeDu(--text--)---------------------->< @@ -1418,7 +1418,7 @@ <section id="pbdGetWindowText" xreflabel="getWindowText"><title>getWindowText</title> <programlisting> -PlainBaseDialog::<xref linkend="mthGetWindowText" /> +PlainBaseDialog::<xref linkend="mthGetWindowText"/> <![CDATA[ >>--getWindowText(--hwnd--)---------------------->< @@ -1428,7 +1428,7 @@ <section id="pbdHasMenuBar" xreflabel="hasMenuBar"><title>hasMenuBar</title> <programlisting> -PlainBaseDialog::<xref linkend="mthHasMenuBar" /> +PlainBaseDialog::<xref linkend="mthHasMenuBar"/> <![CDATA[ >>--hasMenuBar----------------------------------->< @@ -1438,7 +1438,7 @@ <section id="pbdHelp" xreflabel="help"><title>help</title> <programlisting> -PlainBaseDialog::<xref linkend="mthHelp" /> +PlainBaseDialog::<xref linkend="mthHelp"/> <![CDATA[ >>--help----------------------------------------->< @@ -1448,7 +1448,7 @@ <section id="pbdHideControl" xreflabel="HideControl"><title>HideControl</title> <programlisting> -PlainBaseDialog::<xref linkend="mthHideControl" /> +PlainBaseDialog::<xref linkend="mthHideControl"/> <![CDATA[ >>--hideControl(--id--)-------------------------->< @@ -1458,7 +1458,7 @@ <section id="pbdHideControlFast" xreflabel="hideControlFast"><title>hideControlFast</title> <programlisting> -PlainBaseDialog::<xref linkend="mthHideControlFast" /> +PlainBaseDialog::<xref linkend="mthHideControlFast"/> <![CDATA[ >>--hideControlFast(--id--)---------------------->< @@ -1468,7 +1468,7 @@ <section id="pbdHideWindow" xreflabel="hideWindow"><title>hideWindow</title> <programlisting> -PlainBaseDialog::<xref linkend="mthHideWindow" /> +PlainBaseDialog::<xref linkend="mthHideWindow"/> <![CDATA[ >>--hideWindow(--hwnd--)------------------------->< @@ -1478,7 +1478,7 @@ <section id="pbdHideWindowFast" xreflabel="hideWindowFast"><title>hideWindowFast</title> <programlisting> -PlainBaseDialog::<xref linkend="mthHideWindowFast" /> +PlainBaseDialog::<xref linkend="mthHideWindowFast"/> <![CDATA[ >>--hideWindowFast(--hwnd--)--------------------->< @@ -1488,7 +1488,7 @@ <section id="pbdInitAutoDetection" xreflabel="initAutoDetection"><title>initAutoDetection</title> <programlisting> -PlainBaseDialog::<xref linkend="mthInitAutoDetection" /> +PlainBaseDialog::<xref linkend="mthInitAutoDetection"/> <![CDATA[ >>-initAutoDetection--------------------------------->< @@ -1498,7 +1498,7 @@ <section id="pbdInitDialog" xreflabel="initDialog"><title>initDialog</title> <programlisting> -PlainBaseDialog::<xref linkend="mthInitDialog" /> +PlainBaseDialog::<xref linkend="mthInitDialog"/> <![CDATA[ >>--initDialog----------------------------------->< @@ -1508,7 +1508,7 @@ <section id="pbdInsertComboEntry" xreflabel="insertComboEntry"><title>insertComboEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthInsertComboEntry" /> +PlainBaseDialog::<xref linkend="mthInsertComboEntry"/> <![CDATA[ >>--insertComboEntry(--id--,--+-------+--,--string--)----------->< @@ -1519,7 +1519,7 @@ <section id="pbdInsertListEntry" xreflabel="insertListEntry"><title>insertListEntry</title> <programlisting> -PlainBaseDialog::<xref linkend="mthInsertListEntry" /> +PlainBaseDialog::<xref linkend="mthInsertListEntry"/> <![CDATA[ >>--insertListEntry(--id--,--+-------+--,--aString--)-------------------------->< @@ -1530,7 +1530,7 @@ <section id="pbdIsDialogActive" xreflabel="isDialogActive"><title>isDialogActive</title> <programlisting> -PlainBaseDialog::<xref linkend="mthIsDialogActive" /> +PlainBaseDialog::<xref linkend="mthIsDialogActive"/> <![CDATA[ >>--isDialogActive------------------------------->< @@ -1540,7 +1540,7 @@ <section id="pbdIsMaximized" xreflabel="isMaximized"><title>isMaximized</title> <programlisting> -PlainBaseDialog::<xref linkend="mthIsMaximized" /> +PlainBaseDialog::<xref linkend="mthIsMaximized"/> <![CDATA[ >>--isMaximized---------------------------------->< @@ -1550,7 +1550,7 @@ <section id="pbdIsMinimized" xreflabel="isMinimized"><title>isMinimized</title> <programlisting> -PlainBaseDialog::<xref linkend="mthIsMinimized" /> +PlainBaseDialog::<xref linkend="mthIsMinimized"/> <![CDATA[ >>--isMinimized---------------------------------->< @@ -1560,7 +1560,7 @@ <section id="pbdLeaving" xreflabel="leaving"><title>leaving</title> <programlisting> -PlainBaseDialog::<xref linkend="mthLeaving" /> +PlainBaseDialog::<xref linkend="mthLeaving"/> <![CDATA[ >>--leaving-------------------------------------->< @@ -1570,7 +1570,7 @@ <section id="pbdListAddDirectory" xreflabel="listAddDirectory"><title>listAddDirectory</title> <programlisting> -PlainBaseDialog::<xref linkend="mthListAddDirectory" /> +PlainBaseDialog::<xref linkend="mthListAddDirectory"/> <![CDATA[ >>--listAddDirectory(--id--,--drvPath--,--fileAtrs--)----------->< @@ -1580,7 +1580,7 @@ <section id="pbdListDrop" xreflabel="listDrop"><title>listDrop</title> <programlisting> -PlainBaseDialog::<xref linkend="mthListDrop" /> +PlainBaseDialog::<xref linkend="mthListDrop"/> <![CDATA[ >>--listDrop(--id--)----------------------------->< @@ -1590,7 +1590,7 @@ <section id="pbdMaximize" xreflabel="maximize"><title>maximize</title> <programlisting> -PlainBaseDialog::<xref linkend="mthMaximize" /> +PlainBaseDialog::<xref linkend="mthMaximize"/> <![CDATA[ >>--maximize------------------------------------->< @@ -1600,7 +1600,7 @@ <section id="pbdMinimize" xreflabel="minimize"><title>minimize</title> <programlisting> -PlainBaseDialog::<xref linkend="mthMinimize" /> +PlainBaseDialog::<xref linkend="mthMinimize"/> <![CDATA[ >>--minimize------------------------------------->< @@ -1620,7 +1620,7 @@ <section id="pbdNewComboBox" xreflabel="newComboBox"><title>newComboBox</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewComboBox" /> +PlainBaseDialog::<xref linkend="mthNewComboBox"/> <![CDATA[ >>--newComboBox(--id--)-------------------------->< @@ -1630,7 +1630,7 @@ <section id="pbdNewDateTimePicker" xreflabel="newDateTimePicker"><title>newDateTimePicker</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewDateTimePicker" /> +PlainBaseDialog::<xref linkend="mthNewDateTimePicker"/> <![CDATA[ >>--newDateTimePicker(--id--)-------------------->< @@ -1640,7 +1640,7 @@ <section id="pbdNewEdit" xreflabel="newEdit"><title>newEdit</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewEdit" /> +PlainBaseDialog::<xref linkend="mthNewEdit"/> <![CDATA[ >>--newEdit(--id--)------------------------------>< @@ -1650,7 +1650,7 @@ <section id="pbdNewGroupBox" xreflabel="newGroupBox"><title>newGroupBox</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewGroupBox" /> +PlainBaseDialog::<xref linkend="mthNewGroupBox"/> <![CDATA[ >>--newGroupBox(--id--)-------------------------->< @@ -1670,7 +1670,7 @@ <section id="pbdNewListView" xreflabel="newListView"><title>newListView</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewListView" /> +PlainBaseDialog::<xref linkend="mthNewListView"/> <![CDATA[ >>--newListView(--id--)-------------------------->< @@ -1680,7 +1680,7 @@ </section> <section id="pbdNewMonthCalendar" xreflabel="newMonthCalendar"><title>newMonthCalendar</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewMonthCalendar" /> +PlainBaseDialog::<xref linkend="mthNewMonthCalendar"/> <![CDATA[ >>--newMonthCalendar(--id--)--------------------->< @@ -1690,7 +1690,7 @@ <section id="pbdNewProgressBar" xreflabel="newProgressBar"><title>newProgressBar</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewProgressBar" /> +PlainBaseDialog::<xref linkend="mthNewProgressBar"/> <![CDATA[ >>--newProgressBar(--id--)----------------------->< @@ -1700,7 +1700,7 @@ <section id="pbdNewPushButton" xreflabel="newPushButton"><title>newPushButton</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewPushButton" /> +PlainBaseDialog::<xref linkend="mthNewPushButton"/> <![CDATA[ >>--newPushButton(--id--)------------------------>< @@ -1710,7 +1710,7 @@ <section id="pbdNewRadioButton" xreflabel="newRadioButton"><title>newRadioButton</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewRadioButton" /> +PlainBaseDialog::<xref linkend="mthNewRadioButton"/> <![CDATA[ >>--newRadioButton(--id--)----------------------->< @@ -1720,7 +1720,7 @@ <section id="pbdNewScrollBar" xreflabel="newScrollBar"><title>newScrollBar</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewScrollBar" /> +PlainBaseDialog::<xref linkend="mthNewScrollBar"/> <![CDATA[ >>--newScrollBar(--id--)------------------------->< @@ -1730,7 +1730,7 @@ <section id="pbdNewTab" xreflabel="newTab"><title>newTab</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewTab" /> +PlainBaseDialog::<xref linkend="mthNewTab"/> <![CDATA[ >>--newTab(--id--)------------------------------->< @@ -1740,7 +1740,7 @@ <section id="pbdNewStatic" xreflabel="newStatic"><title>newStatic</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewStatic" /> +PlainBaseDialog::<xref linkend="mthNewStatic"/> <![CDATA[ >>--newStatic(--id--)---------------------------->< @@ -1750,7 +1750,7 @@ <section id="pbdNewTrackBar" xreflabel="newTrackBar"><title>newTrackBar</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewTrackBar" /> +PlainBaseDialog::<xref linkend="mthNewTrackBar"/> <![CDATA[ >>--newTrackBar(--id--)-------------------------->< @@ -1760,7 +1760,7 @@ <section id="pbdNewTreeView" xreflabel="newTreeView"><title>newTreeView</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewTreeView" /> +PlainBaseDialog::<xref linkend="mthNewTreeView"/> <![CDATA[ >>--newTreeView(--id--)-------------------------->< @@ -1770,7 +1770,7 @@ <section id="pbdNewUpDown" xreflabel="newUpDown"><title>newUpDown</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewUpDown" /> +PlainBaseDialog::<xref linkend="mthNewUpDown"/> <![CDATA[ >>--newUpDown(--id--)---------------------------->< @@ -1780,7 +1780,7 @@ <section id="pbdNoAutoDetection" xreflabel="noAutoDetection"><title>noAutoDetection</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNoAutoDetection" /> +PlainBaseDialog::<xref linkend="mthNoAutoDetection"/> <![CDATA[ >>--noAutoDetection------------------------------>< @@ -1790,7 +1790,7 @@ <section id="pbdOk" xreflabel="ok"><title>ok</title> <programlisting> -PlainBaseDialog::<xref linkend="mthOk" /> +PlainBaseDialog::<xref linkend="mthOk"/> <![CDATA[ >>--ok------------------------------------------->< @@ -1800,7 +1800,7 @@ <section id="pbdPixel2dlgUnit" xreflabel="pixel2dlgUnit"><title>pixel2dlgUnit</title> <programlisting> -PlainBaseDialog::<xref linkend="mthPixel2dlgUnit" /> +PlainBaseDialog::<xref linkend="mthPixel2dlgUnit"/> <![CDATA[ >>--pixel2dlgUnit(--pixels--)-------------------->< @@ -1810,7 +1810,7 @@ <section id="pbdRestore" xreflabel="restore"><title>restore</title> <programlisting> -PlainBaseDialog::<xref linkend="mthRestore" /> +PlainBaseDialog::<xref linkend="mthRestore"/> <![CDATA[ >>--restore-------------------------------------->< @@ -1820,7 +1820,7 @@ <section id="pbdSendMessageToControl" xreflabel="sendMessageToControl"><title>sendMessageToControl</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSendMessageToControl" /> +PlainBaseDialog::<xref linkend="mthSendMessageToControl"/> <![CDATA[ >>--sendMessageToControl(--id--,--msg--,--wParam--,--lParam--)----------------->< @@ -1830,7 +1830,7 @@ <section id="pbdSendMessageToControlH" xreflabel="sendMessageToControlH"><title>sendMessageToControlH</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSendMessageToControlH" /> +PlainBaseDialog::<xref linkend="mthSendMessageToControlH"/> <![CDATA[ >>--sendMessageToControlH(--id--,--msg--,--wParam--,--lParam--)---------------->< @@ -1840,7 +1840,7 @@ <section id="pbdSendMessageToWindow" xreflabel="sendMessageToWindow"><title>sendMessageToWindow</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSendMessageToWindow" /> +PlainBaseDialog::<xref linkend="mthSendMessageToWindow"/> <![CDATA[ >>--sendMessageToWindow(--hwnd--,--msg--,--wParam--,--lParam--)---------------->< @@ -1850,7 +1850,7 @@ <section id="pbdSendMessageToWindowH" xreflabel="sendMessageToWindowH"><title>sendMessageToWindowH</title> <programlisting> -PlainBaseDialog::sendMessageToWindowH<xref linkend="mthSendMessageToWindowH" />) +PlainBaseDialog::sendMessageToWindowH<xref linkend="mthSendMessageToWindowH"/>) <![CDATA[ >>--sendMessageToWindowH(--hwnd,--msg--,--wParam--,--lParam--)----------------->< @@ -1860,7 +1860,7 @@ <section id="pbdSetCheckBoxData" xreflabel="setCheckBoxData"><title>setCheckBoxData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetCheckBoxData" /> +PlainBaseDialog::<xref linkend="mthSetCheckBoxData"/> <![CDATA[ >>--setCheckBoxData(--id--,--data--)------------->< @@ -1870,7 +1870,7 @@ <section id="pbdSetComboBoxData" xreflabel="setComboBoxData"><title>setComboBoxData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetComboBoxData" /> +PlainBaseDialog::<xref linkend="mthSetComboBoxData"/> <![CDATA[ >>--setComboBoxData(--id--,--data--)------------->< @@ -1880,7 +1880,7 @@ <section id="pbdSetControlData" xreflabel="setControlData"><title>setControlData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetControlData" /> +PlainBaseDialog::<xref linkend="mthSetControlData"/> <![CDATA[ >>--setControlData(--id--,--dataValue--)--------->< @@ -1890,7 +1890,7 @@ <section id="pbdSetControlText" xreflabel="setControlText"><title>setControlText</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetControlText" /> +PlainBaseDialog::<xref linkend="mthSetControlText"/> <![CDATA[ >>--setControlText(--id--,--text--)-------------->< @@ -1900,7 +1900,7 @@ <section id="pbdSetCurrentComboIndex" xreflabel="setCurrentComboIndex"><title>setCurrentComboIndex</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetCurrentComboIndex" /> +PlainBaseDialog::<xref linkend="mthSetCurrentComboIndex"/> <![CDATA[ >>--setCurrentComboIndex(--id--+----------+--)--->< @@ -1911,7 +1911,7 @@ <section id="pbdSetCurrentListIndex" xreflabel="setCurrentListIndex"><title>setCurrentListIndex</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetCurrentListIndex" /> +PlainBaseDialog::<xref linkend="mthSetCurrentListIndex"/> <![CDATA[ >>--setCurrentListIndex(--id--+----------+--)---->< @@ -1922,7 +1922,7 @@ <section id="pbdSetData" xreflabel="setData"><title>setData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetData" /> +PlainBaseDialog::<xref linkend="mthSetData"/> <![CDATA[ >>--setData-------------------------------------->< @@ -1932,7 +1932,7 @@ <section id="pbdSetDataAttribute" xreflabel="setDataAttribute"><title>setDataAttribute</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetDataAttribute" /> +PlainBaseDialog::<xref linkend="mthSetDataAttribute"/> <![CDATA[ >>--setDataAttribute(--attributeName--)---------->< @@ -1942,7 +1942,7 @@ <section id="pbdSetDataStem" xreflabel="setDataStem"><title>setDataStem</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetDataStem" /> +PlainBaseDialog::<xref linkend="mthSetDataStem"/> <![CDATA[ >>--setDataStem(--dataStem.--)------------------->< @@ -1952,7 +1952,7 @@ <section id="pbdSetDlgFont" xreflabel="setDlgFont"><title>setDlgFont</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetDlgFont" /> +PlainBaseDialog::<xref linkend="mthSetDlgFont"/> <![CDATA[ >>--setDlgFont(--fontName--+-----------+--)------>< @@ -1963,7 +1963,7 @@ <section id="pbdSetEditData" xreflabel="setEditData"><title>setEditData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetEditData" /> +PlainBaseDialog::<xref linkend="mthSetEditData"/> <![CDATA[ >>--setEditData(--id--,--data--)----------------->< @@ -1973,7 +1973,7 @@ <section id="pbdSetFocus" xreflabel="setFocus"><title>setFocus</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetFocus" /> +PlainBaseDialog::<xref linkend="mthSetFocus"/> <![CDATA[ >>--setFocus(--hwnd--)--------------------------->< @@ -1983,7 +1983,7 @@ <section id="pbdSetFocusToWindow" xreflabel="setFocusToWindow"><title>setFocusToWindow</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetFocusToWindow" /> +PlainBaseDialog::<xref linkend="mthSetFocusToWindow"/> <![CDATA[ >>--setFocusToWindow(--hwnd--)------------------->< @@ -1993,7 +1993,7 @@ <section id="pbdSetGroup" xreflabel="setGroup"><title>setGroup</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetGroup" /> +PlainBaseDialog::<xref linkend="mthSetGroup"/> <![CDATA[ >>--setGroup(--id--+-----------+--)-------------->< @@ -2004,7 +2004,7 @@ <section id="pbdSetListBoxData" xreflabel="setListBoxData"><title>setListBoxData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetListBoxData" /> +PlainBaseDialog::<xref linkend="mthSetListBoxData"/> <![CDATA[ >>--setListBoxData(--id--,--data--)-------------->< @@ -2014,7 +2014,7 @@ <section id="pbdSetListTabulators" xreflabel="setListTabulators"><title>setListTabulators</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetListTabulators" /> +PlainBaseDialog::<xref linkend="mthSetListTabulators"/> <![CDATA[ +-,---+ @@ -2026,7 +2026,7 @@ <section id="pbdSetRadioButtonData" xreflabel="setRadioButtonData"><title>setRadioButtonData</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetRadioButtonData" /> +PlainBaseDialog::<xref linkend="mthSetRadioButtonData"/> <![CDATA[ >>--setRadioButtonData(--id--,--data--)---------->< @@ -2036,7 +2036,7 @@ <section id="pbdSetTabStop" xreflabel="setTabStop"><title>setTabStop</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetTabStop" /> +PlainBaseDialog::<xref linkend="mthSetTabStop"/> <![CDATA[ >>--setTabStop(--id--,--+-----------+--)--------->< @@ -2047,7 +2047,7 @@ <section id="pbdSetWindowText" xreflabel="setWindowText"><title>setWindowText</title> <programlisting> -PlainBaseDialog::<xref linkend="mthSetWindowText" /> +PlainBaseDialog::<xref linkend="mthSetWindowText"/> <![CDATA[ >>--setWindowText(--hwnd--,--text--)------------->< @@ -2057,7 +2057,7 @@ <section id="pbdShow" xreflabel="show"><title>show</title> <programlisting> -PlainBaseDialog::<xref linkend="mthShowClsPlainBaseDialog" /> +PlainBaseDialog::<xref linkend="mthShowClsPlainBaseDialog"/> <![CDATA[ >>--show(--+--------+--)------------------------->< @@ -2068,7 +2068,7 @@ <section id="pbdShowControl" xreflabel="showControl"><title>showControl</title> <programlisting> -PlainBaseDialog::<xref linkend="mthShowControl" /> +PlainBaseDialog::<xref linkend="mthShowControl"/> <![CDATA[ >>--showControl(--id--)-------------------------->< @@ -2078,7 +2078,7 @@ <section id="pbdShowControlFast" xreflabel="showControlFast"><title>showControlFast</title> <programlisting> -PlainBaseDialog::<xref linkend="mthShowControlFast" /> +PlainBaseDialog::<xref linkend="mthShowControlFast"/> <![CDATA[ >>--showItemFast(--id--)------------------------->< @@ -2088,7 +2088,7 @@ <section id="pbdShowWindow" xreflabel="showWindow"><title>showWindow</title> <programlisting> -PlainBaseDialog::<xref linkend="mthShowWindow" /> +PlainBaseDialog::<xref linkend="mthShowWindow"/> <![CDATA[ >>--showWindow(--hwnd--)------------------------->< @@ -2098,7 +2098,7 @@ <section id="pbdShowWindowFast" xreflabel="showWindowFast"><title>showWindowFast</title> <programlisting> -PlainBaseDialog::<xref linkend="mthShowWindowFast" /> +PlainBaseDialog::<xref linkend="mthShowWindowFast"/> <![CDATA[ >>-showWindowFast(--hwnd--)---------------------->< @@ -2108,7 +2108,7 @@ <section id="pbdTabToNext" xreflabel="tabToNext"><title>tabToNext</title> <programlisting> -PlainBaseDialog::<xref linkend="mthTabToNext" /> +PlainBaseDialog::<xref linkend="mthTabToNext"/> <![CDATA[ >>--tabToNext------------------------------------>< @@ -2118,7 +2118,7 @@ <section id="pbdTabToPrevious" xreflabel="tabToPrevious"><title>tabToPrevious</title> <programlisting> -PlainBaseDialog::<xref linkend="mthTabToPrevious" /> +PlainBaseDialog::<xref linkend="mthTabToPrevious"/> <![CDATA[ >>--tabToPrevious-------------------------------->< @@ -2128,7 +2128,7 @@ <section id="pbdTiledBackgroundBitmap" xreflabel="tiledBackgroundBitmap"><title>tiledBackgroundBitmap</title> <programlisting> -PlainBaseDialog::<xref linkend="mthTiledBackgroundBitmap" /> +PlainBaseDialog::<xref linkend="mthTiledBackgroundBitmap"/> <![CDATA[ >>--tiledBackgroundBitmap(--bmpFilename--)------->< @@ -2138,7 +2138,7 @@ <section id="pbdToTheTop" xreflabel="toTheTop"><title>toTheTop</title> <programlisting> -PlainBaseDialog::<xref linkend="mthToTheTop" /> +PlainBaseDialog::<xref linkend="mthToTheTop"/> <![CDATA[ >>--toTheTop------------------------------------->< @@ -2148,7 +2148,7 @@ <section id="pbdValidate" xreflabel="validate"><title>validate</title> <programlisting> -PlainBaseDialog::<xref linkend="mthValidate" /> +PlainBaseDialog::<xref linkend="mthValidate"/> <![CDATA[ >>--validate------------------------------------->< @@ -2166,11 +2166,10 @@ <emphasis role="italic">DialogControl</emphasis> is the base class of all dialog control classes in the ooDialog framework. It implements methods that are common to every dialog control. DialogControl is also an abstract class. A programmer can not instantiate a new DialogControl object. Rather, one of the concrete dialog control classes such as, - the <xref linkend="clsDateTimePicker"/> or the ListView (<xref linkend="clsListView" />(, are - used. + the <xref linkend="clsDateTimePicker"/> or the <xref linkend="clsListView"/>, are used. </para> <para> - See <xref linkend="figComponentClassesDiagram" /> to visualize the mixin classes that the + See <xref linkend="figComponentClassesDiagram"/> to visualize the mixin classes that the DialogControl inherits. In essence the DialogControl is the dialog <xref linkend="chpDialogControlObject"/> object. All the methods and attributes of the DialogControl are listed and documented in the dialog control object chapter. This includes the methods and attributes of its inherited mixin classes. @@ -2178,8 +2177,8 @@ <para> The DialogControl inherits the following mixin classes: <itemizedlist> - <listitem><para>Windoebase (<xref linkend="clsWindowBase" />)</para></listitem> - <listitem><para>WindowExtensions (<xref linkend="clsWindowExtensions" />)</para></listitem> + <listitem><para><xref linkend="clsWindowBase"/></para></listitem> + <listitem><para><xref linkend="clsWindowExtensions"/></para></listitem> </itemizedlist> </para> @@ -2245,7 +2244,7 @@ <entry>Reprieves the <emphasis role="italic">data</emphasis> (the value) of the underlying control's state.</entry> </row> <row> -<entry>data= (<xref linkend="dcoDataEquals" />)</entry> +<entry><xref linkend="dcoDataEquals"/></entry> <entry>Sets the state of the underlying dialog control to the <emphasis role="italic">data</emphasis> (the value) specified.</entry> </row> <row> @@ -2258,7 +2257,7 @@ </row> <row> <entry><xref linkend="dcoGroup"/></entry> -<entry>Adds or removes the group style (<xref linkend="wsgroup" />) for the control.</entry> +<entry>Adds or removes the <xref linkend="wsgroup"/> style for the control.</entry> </row> <row> <entry><xref linkend="dcoHasKeyPressConnection"/></entry> @@ -2301,7 +2300,7 @@ <section id="dcoAssignFocus"><title>assignFocus</title> <programlisting> -DialogControl::<xref linkend="mthAssignFocus" /> +DialogControl::<xref linkend="mthAssignFocus"/> <![CDATA[ >>--assignFocus---------------------------------->< @@ -2311,7 +2310,7 @@ <section id="dcoClearRect"><title>clearRect</title> <programlisting> -DialogControl::<xref linkend="mthClearRectClsDialogControl" /> +DialogControl::<xref linkend="mthClearRectClsDialogControl"/> <![CDATA[ Form 1: @@ -2339,7 +2338,7 @@ <section id="dcoConnectCharEvent"><title>connectCharEvent</title> <programlisting> -DialogControl::<xref linkend="mthConnectCharEvent" /> +DialogControl::<xref linkend="mthConnectCharEvent"/> <![CDATA[ >>--connectCharEvent(--+--------------+--)------->< @@ -2350,7 +2349,7 @@ <section id="dcoConnectFKeyPress"><title>connectFKeyPress</title> <programlisting> -DialogControl::<xref linkend="mthConnectFKeyPressDialogControlObject" /> +DialogControl::<xref linkend="mthConnectFKeyPressDialogControlObject"/> <![CDATA[ >>--connectFKeyPress(--methodName--)------------->< @@ -2360,7 +2359,7 @@ <section id="dcoConnectKeyPress"><title>connectKeyPress</title> <programlisting> -DialogControl::<xref linkend="mthConnectKeyPressDialogControlObject" /> +DialogControl::<xref linkend="mthConnectKeyPressDialogControlObject"/> <![CDATA[ >>--connectKeyPress(--methodName--,--keys--+-----------+--)----->< @@ -2371,7 +2370,7 @@ <section id="dcoData"><title>data</title> <programlisting> -DialogControl::<xref linkend="mthData" /> +DialogControl::<xref linkend="mthData"/> <![CDATA[ >>--data----------------------------------------->< @@ -2381,7 +2380,7 @@ <section id="dcoDataEquals"><title>data=</title> <programlisting> -DialogControl::data= (<xref linkend="mthDataEquals" />) +DialogControl::<xref linkend="mthDataEquals"/> <![CDATA[ >>--data = newData------------------------------->< @@ -2391,7 +2390,7 @@ <section id="dcoDisconnectKeyPress"><title>disconnectKeyPress</title> <programlisting> -DialogControl::<xref linkend="mthDisconnectKeyPressDialogControlObject" /> +DialogControl::<xref linkend="mthDisconnectKeyPressDialogControlObject"/> <![CDATA[ >>--disconnectKeyPress(--+--------------+--)----->< @@ -2402,7 +2401,7 @@ <section id="dcoGetTextSizeDlg"><title>getTextSizeDlg</title> <programlisting> -DialogControl::<xref linkend="mthGetTextSizeDlgClsDialogControl" /> +DialogControl::<xref linkend="mthGetTextSizeDlgClsDialogControl"/> <![CDATA[ >>--getTextSizeDlg(--text--+-------------+--+-------------+--+---------+--)---->< @@ -2413,7 +2412,7 @@ <section id="dcoGroup"><title>group</title> <programlisting> -DialogControl::<xref linkend="mthGroup" /> +DialogControl::<xref linkend="mthGroup"/> <![CDATA[ >>--group(--+-----------+--)--------------------->< @@ -2424,7 +2423,7 @@ <section id="dcoHasKeyPressConnection"><title>hasKeyPressConnection</title> <programlisting> -DialogControl::<xref linkend="mthHasKeyPressConnectionDialogControlObject" /> +DialogControl::<xref linkend="mthHasKeyPressConnectionDialogControlObject"/> <![CDATA[ >>--hasKeyPressConnection(--+--------------+--)-->< @@ -2464,7 +2463,7 @@ <section id="dcoSetColor"><title>setColor</title> <programlisting> -DialogControl::<xref linkend="mthSetColor" /> +DialogControl::<xref linkend="mthSetColor"/> <![CDATA[ >>--setColor(--bk--+-------+--)------------------>< @@ -2475,7 +2474,7 @@ <section id="dcoSetSysColor"><title>setSysColor</title> <programlisting> -DialogControl::<xref linkend="mthSetSysColor" /> +DialogControl::<xref linkend="mthSetSysColor"/> <![CDATA[ >>--setSysColor(--bk--+-------+--)--------------->< @@ -2486,7 +2485,7 @@ <section id="dcoTabStop"><title>tabStop</title> <programlisting> -DialogControl::<xref linkend="mthTabStop" /> +DialogControl::<xref linkend="mthTabStop"/> <![CDATA[ >>--tabStop(--+-----------+--)------------------->< @@ -2497,7 +2496,7 @@ <section id="dcoTextSize"><title>textSize</title> <programlisting> -DialogControl::<xref linkend="mthTextSize" /> +DialogControl::<xref linkend="mthTextSize"/> <![CDATA[ >>--textSize(--text--,--size--)------------------>< @@ -2507,7 +2506,7 @@ <section id="dcoUseUnicode"><title>useUnicode</title> <programlisting> -DialogControl::<xref linkend="mthUseUnicode" /> +DialogControl::<xref linkend="mthUseUnicode"/> <![CDATA[ >>--useUnicode(--use--)-------------------------->< @@ -2517,7 +2516,7 @@ <section id="dcoUsingUnicode"><title>usingUnicode</title> <programlisting> -DialogControl::<xref linkend="mthUsingUnicode" /> +DialogControl::<xref linkend="mthUsingUnicode"/> <![CDATA[ >>--usingUnicode--------------------------------->< @@ -2547,12 +2546,11 @@ <section id="clsResourceUtils" xreflabel="ResourceUtils"><title>ResourceUtils Mixin Class</title> <indexterm><primary>ResourceUtils Class</primary></indexterm> <para> - The <computeroutput>ResourceUtils</computeroutput> class provides utility methods for dealing with resource IDs (<xref - linkend="defResourceId" />) and parsing resource <xref linkend="defResourceScript"/> files. The - class is inherited by the <xref linkend="chpDialogObject" /> object and the ApplicationManager (<xref - linkend="clsApplicationManager" />) class. Most of the methods of the - <computeroutput>ResourceUtils</computeroutput> class are used internally (<xref linkend="ovvUndocumented" />) and - not documented. + The <computeroutput>ResourceUtils</computeroutput> class provides utility methods for dealing with <xref + linkend="defResourceId"/>s and parsing resource <xref linkend="defResourceScript"/> files. The + class is inherited by the <xref linkend="chpDialogObject"/> object and the <xref linkend="clsApplicationManager" /> + class. Most of the methods of the <computeroutput>ResourceUtils</computeroutput> class are used <link + linkend="ovvUndocumented">internally</link> and not documented. </para> <section id="sctMethodsResourceUtils"><title>Method Table</title> @@ -2616,9 +2614,9 @@ <para> The <emphasis role="italic">constDir</emphasis> attribute is assigned a <computeroutput>Directory</computeroutput> - object whose indexes are <xref linkend="defSymbolicId" /> resource IDs. It is part of the mechanism (<xref - linkend="ovvSymbolicIDMechanism" />) provided by the ooDialog framework to allow the use of symbolic IDs - in ooDialog programs. Although the use of the <emphasis role="italic">constDir</emphasis> is mostly transparent to the + object whose indexes are <xref linkend="defSymbolicId"/> resource IDs. It is part of the<xref + linkend="ovvSymbolicIDMechanism"/> provided by the ooDialog framework to allow the use of symbolic IDs in ooDialog + programs. Although the use of the <emphasis role="italic">constDir</emphasis> is mostly transparent to the programmer, it is important to understand how the mechanism works when using symbolic IDs in ooDialog programs </para> <variablelist> @@ -2646,22 +2644,21 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Both <xref linkend="chpDialogObject" /> objects and the ApplicationManager (<xref - linkend="clsApplicationManager" />) class inherit the ResourceUtils (<xref - linkend="clsResourceUtils" />) mixin class. <emphasis role="bold">Note</emphasis> that the - <emphasis role="italic">constDir</emphasis> attribute of the <xref linkend="dotApplication" /> <emphasis - role="bold">is</emphasis> the global <xref linkend="dotConstDir" />. + Both <xref linkend="chpDialogObject"/> objects and the <xref linkend="clsApplicationManager" /> class inherit the + <xref linkend="clsResourceUtils" /> mixin class. <emphasis role="bold">Note</emphasis> that the <emphasis + role="italic">constDir</emphasis> attribute of the <xref linkend="dotApplication"/> <emphasis + role="bold">is</emphasis> the global <xref linkend="dotConstDir"/>. </para> <para> Each index in the the <computeroutput>Directory</computeroutput> object assigned to the <emphasis role="italic">constDir</emphasis> attribute is the symbolic name of a resource ID. The item at that index is the - numeric value of the <xref linkend="defResourceId" />. Once a symbolic ID is added to the <emphasis + numeric value of the <xref linkend="defResourceId"/>. Once a symbolic ID is added to the <emphasis role="italic">constDir</emphasis> directory as an index, that symbolic ID can be used in place of the numeric resource ID as the resource ID argument in methods that use a resource ID. </para> <para> - This is dependent, however, on the global <computeroutput>.constDir</computeroutput> usage strategy (<xref - linkend="entConstDirStrategy" />) the programmer has chosen. If the programmer has elected to not use + This is dependent, however, on the global <computeroutput>.constDir</computeroutput> usage <xref + linkend="entConstDirStrategy"/> the programmer has chosen. If the programmer has elected to not use the global <computeroutput>.constDir</computeroutput> at all, then symbolic IDs can only be used in the methods of the dialog or dialog control classes. If the programmer has elected to use the <computeroutput>.constdir</computeroutput> then symbolic IDs can be used in any class the ooDialog framework @@ -2672,7 +2669,7 @@ linkend="ovvSymbolicIDMechanism">mechanism</link> used by ooDialog to support symbolic IDs. </para> <para> - The global <xref linkend="dotConstDir" /> was introduced in ooDialog 4.2.0 to overcome limitations inherent in + The global <xref linkend="dotConstDir"/> was introduced in ooDialog 4.2.0 to overcome limitations inherent in using the <emphasis role="italic">constDir</emphasis> attribute of the dialog object. The global <computeroutput>.constDir</computeroutput> is more efficient and capable than the <emphasis role="... [truncated message content] |
From: <mie...@us...> - 2012-09-01 18:39:27
|
Revision: 8340 http://sourceforge.net/p/oorexx/code-0/8340 Author: miesfeld Date: 2012-09-01 18:39:24 +0000 (Sat, 01 Sep 2012) Log Message: ----------- Publican ooDialog fix tags Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/userdialog.xml Modified: docs/trunk/publican/oodialog/en-US/dialogExtensions.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-01 18:25:40 UTC (rev 8339) +++ docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-01 18:39:24 UTC (rev 8340) @@ -2227,7 +2227,7 @@ time the button is clicked. </para></listitem></varlistentry> <varlistentry><term>cls</term> -<listitem><para>The class that controls the animation. The default is <xref linkend="AnimatedButton"/> Class. +<listitem><para>The class that controls the animation. The default is <xref linkend="clsAnimatedButton"/> Class. </para></listitem></varlistentry> <varlistentry><term>bmpF</term> <listitem><para>The ID of the first bitmap in the animation sequence within a binary Modified: docs/trunk/publican/oodialog/en-US/userdialog.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-01 18:25:40 UTC (rev 8339) +++ docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-01 18:39:24 UTC (rev 8340) @@ -1004,10 +1004,9 @@ be created. </para> <para> - When <link linkend="mthInitAutoDetection">automatic</link> data field <xref linkend=""/> is on, the create... methods - automatically create and connect the associated data <link - linkend="sctUnderstandingDataAttributes">attribute</link>) by invoking the matching <xref linkend="sctConnectDataMethods"/> - methods. + When <link linkend="mthInitAutoDetection">automatic</link> data field is on, the create... methods automatically create + and connect the associated data <link linkend="sctUnderstandingDataAttributes">attribute</link> by invoking the matching + <xref linkend="sctConnectDataMethods"/> methods. </para> <para> The create... methods cannot be invoked until after the dialog template is started. This is after the @@ -1337,7 +1336,7 @@ <varlistentry><term>DISABLED</term> <listitem> <para> - The <xref linkend="wsdisable"/> window style. + The <xref linkend="wsdisabled"/> window style. </para> </listitem></varlistentry> <varlistentry><term>BORDER</term> |
From: <mie...@us...> - 2012-09-01 19:44:13
|
Revision: 8342 http://sourceforge.net/p/oorexx/code-0/8342 Author: miesfeld Date: 2012-09-01 19:44:10 +0000 (Sat, 01 Sep 2012) Log Message: ----------- Work on Publican ooDialog doc Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/combobox.xml docs/trunk/publican/oodialog/en-US/edit.xml docs/trunk/publican/oodialog/en-US/eventNotification.xml docs/trunk/publican/oodialog/en-US/userdialog.xml docs/trunk/publican/oodialog/en-US/windowBase.xml Modified: docs/trunk/publican/oodialog/en-US/combobox.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/combobox.xml 2012-09-01 18:46:30 UTC (rev 8341) +++ docs/trunk/publican/oodialog/en-US/combobox.xml 2012-09-01 19:44:10 UTC (rev 8342) @@ -218,41 +218,34 @@ role="italic">new</emphasis> method. Rather, a combo box object is obtained by using the <xref linkend="mthNewComboBox" /> method of the <xref linkend="chpDialogObject"/> object. The syntax is: <programlisting> -<![CDATA[ >>-newComboBox(--id--)--------------------------->< - -]]> </programlisting> </para> </section> <!-- End Dialog::newComboBox() (dialog object method) --> -<section id="tmthCreateComboBox"><title>createComboBox (UserDialog method)</title> +<section id="tmthCreateComboBox" xreflabel="createComboBox"><title>createComboBox (UserDialog method)</title> <para> A combo box control can be created in the dialog template of a <xref linkend="clsUserDialog"/> through the <xref linkend="mthCreateComboBox"/> method. The basic syntax is: <programlisting> -<![CDATA[ >>-createComboBox(-id-,--x-,--y-,--cx-,--cy-+----------+-+-------------+--)---->< +-,--style-+ +-,--attrName-+ - -]]> </programlisting> </para> </section> <!-- End UserDialog::createComboBox() (UserDialog method) --> -<section id="tmthConnectComboBoxEvent"><title>connectComboBoxEvent (dialog object method)</title> +<section id="tmthConnectComboBoxEvent" xreflabel="connectComboBoxEvent"> +<title>connectComboBoxEvent (dialog object method)</title> <para> To connect event notifications from a combo box control use the <xref linkend="mthConnectComboBoxEvent" /> method of the <xref linkend="chpDialogObject"/> object. The basic syntax is: -<programlisting> <![CDATA[ +<programlisting> >>-connectComboBoxEvent(--id--,--event--+----------------+--)------------------>< +--,-methodName--+ - -]]> </programlisting> </para> </section> <!-- End EventNotification::connectComboBoxEvent() (dialog object method) --> @@ -262,11 +255,7 @@ <indexterm><primary>add</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>add</secondary></indexterm> <programlisting> -<![CDATA[ >>--add(--listEntry--)--------------------------->< - - -]]> </programlisting> <para> @@ -321,12 +310,8 @@ <indexterm><primary>addDirectory</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>addDirectory</secondary></indexterm> <programlisting> -<![CDATA[ - >>--addDirectory(--filePattern--+-------------------+--)-------->< +-,-fileAttributes--+ - -]]> </programlisting> <para> @@ -469,10 +454,7 @@ <indexterm><primary>closeDropDown</primary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>closeDropDown</secondary></indexterm> <programlisting> -<![CDATA[ >>--closeDropDown-------------------------------->< - -]]> </programlisting> <para> @@ -499,11 +481,8 @@ <indexterm><primary>delete</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>delete</secondary></indexterm> <programlisting> -<![CDATA[ >>--delete(--+---------+--)---------------------->< +--index--+ - -]]> </programlisting> <para> @@ -545,10 +524,7 @@ <indexterm><primary>deleteAll</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>deleteAll</secondary></indexterm> <programlisting> -<![CDATA[ >>--deleteAll------------------------------------>< - -]]> </programlisting> <para> @@ -574,11 +550,8 @@ <indexterm><primary>find</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>find</secondary></indexterm> <programlisting> -<![CDATA[ >>--find(--textOrPrefix--+--------------+--+---------+--)------->< +-,-startIndex-+ +-,-exact-+ - -]]> </programlisting> <para> @@ -691,10 +664,7 @@ <indexterm><primary>getHorizontalExtent</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>getHorizontalExtent</secondary></indexterm> <programlisting> -<![CDATA[ >>--getHorizontalExtent-------------------------->< - -]]> </programlisting> <para> @@ -738,11 +708,7 @@ <indexterm><primary>getText</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>getText</secondary></indexterm> <programlisting> -<![CDATA[ >>--getText(--index--)--------------------------->< - - -]]> </programlisting> <para> @@ -782,11 +748,7 @@ <indexterm><primary>isDropDownOpen</primary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>isDropDownOpen</secondary></indexterm> <programlisting> -<![CDATA[ >>--isDropDownOpen------------------------------->< - - -]]> </programlisting> <para> @@ -813,11 +775,8 @@ <indexterm><primary>insert</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>insert</secondary></indexterm> <programlisting> -<![CDATA[ >>--insert(--+-------+--,--item--)--------------->< +-index-+ - -]]> </programlisting> <para> @@ -874,11 +833,7 @@ <indexterm><primary>items</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>items</secondary></indexterm> <programlisting> -<![CDATA[ >>--items---------------------------------------->< - - -]]> </programlisting> <para> @@ -905,11 +860,8 @@ <indexterm><primary>modify</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>modify</secondary></indexterm> <programlisting> -<![CDATA[ >>--modify(--+--------+--,--newText--)----------->< +--index-+ - -]]> </programlisting> <para> @@ -962,9 +914,7 @@ <indexterm><primary>openDropDown</primary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>openDropDown</secondary></indexterm> <programlisting> -<![CDATA[ >>--openDropDown--------------------------------->< -]]> </programlisting> <para> @@ -991,10 +941,7 @@ <indexterm><primary>select</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>select</secondary></indexterm> <programlisting> -<![CDATA[ >>--select(--itemText--)------------------------->< - -]]> </programlisting> <para> @@ -1077,10 +1024,7 @@ <indexterm><primary>selected</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>selected</secondary></indexterm> <programlisting> -<![CDATA[ >>--selected------------------------------------->< - -]]> </programlisting> <para> @@ -1107,10 +1051,7 @@ <indexterm><primary>selectedIndex</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>selectedIndex</secondary></indexterm> <programlisting> -<![CDATA[ >>--selectedIndex-------------------------------->< - -]]> </programlisting> <para> @@ -1191,10 +1132,8 @@ <indexterm><primary>setEditSelection</primary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>setEditSelection</secondary></indexterm> <programlisting> -<![CDATA[ >>--setEditSelection(--+--------------+--+-------------+--)----->< +--startIndex--+ +-,-endIndex--+ -]]> </programlisting> <para> @@ -1274,10 +1213,7 @@ <indexterm><primary>setHorizontalExtent</primary><secondary>ComboBox class</secondary></indexterm> <indexterm><primary>ComboBox class</primary><secondary>setHorizontalExtent</secondary></indexterm> <programlisting> -<![CDATA[ >>--setHorizontalExtent(--pixels--)-------------->< - -]]> </programlisting> <para> Modified: docs/trunk/publican/oodialog/en-US/edit.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/edit.xml 2012-09-01 18:46:30 UTC (rev 8341) +++ docs/trunk/publican/oodialog/en-US/edit.xml 2012-09-01 19:44:10 UTC (rev 8342) @@ -56,8 +56,8 @@ </para> <para> The <computeroutput>Edit</computeroutput> class provides methods to work with and manipulate the underlying - Windows edit dialog control which it represents. It is a concrete subclass of the dialog control - object (<xref linkend="chpDialogControlObject"/>) and therefore has all methods of the of the dialog control object. + Windows edit dialog control which it represents. It is a concrete subclass of the dialog <xref + linkend="chpDialogControlObject"/> object and therefore has all methods of the of the dialog control object. </para> <para> In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are @@ -66,7 +66,7 @@ <varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term> <listitem> <para> - Use the newEdit (<xref linkend="tmthNewEdit"/>)() method of the + Use the <xref linkend="tmthNewEdit"/> method of the <xref linkend="chpDialogObject"/> object to retrieve a new Edit object. </para> </listitem></varlistentry> @@ -287,7 +287,7 @@ <entry>Displays an informational window, a balloon tip, for the edit control.</entry> </row> <row> -<entry>tab= (<xref linkend="mthTabEquals"/>)</entry> +<entry><xref linkend="mthTabEquals"/></entry> <entry>An alias for the <emphasis role="italic">setTabStops</emphasis> method.</entry> </row> <row> @@ -299,11 +299,10 @@ </section> -<section id="tmthNewEdit"><title>newEdit (dialog object method)</title> +<section id="tmthNewEdit" xreflabel="newEdit"><title>newEdit (dialog object method)</title> <para> Edit objects can not be instantiated by the programmer from Rexx code. Rather an Edit object is obtained - by using the <xref linkend="mthNewEdit"/>() method of the dialog - object (<xref linkend="chpDialogObject"/>). The syntax is: + by using the <xref linkend="mthNewEdit"/> method of the dialog <xref linkend="chpDialogObject"/> object. The syntax is: <programlisting> <![CDATA[ >>--newEdit(--id--)------------------------------>< @@ -314,11 +313,12 @@ </section> <!-- End newEdit() [PlainBaseDialog method] --> -<section id="tmthCreateEdit"><title>createEdit (UserDialog method)</title> +<section id="tmthCreateEdit" xreflabel="createEdit"><title>createEdit (UserDialog method)</title> <para> An edit control can be added to the dialog template for a <xref linkend="clsUserDialog"/> - dialog through the <xref linkend="mthCreateEdit"/>() method. The basic syntax is: -<programlisting> <![CDATA[ + dialog through the <xref linkend="mthCreateEdit"/> method. The basic syntax is: +<programlisting> +<![CDATA[ >>--createEdit(-id-,--x-,--y-,--cx-,--cy-+---------+--+-----------------+--)--->< +-,-style-+ +-,-attributeName-+ @@ -328,13 +328,13 @@ </section> <!-- End UserDialog::createEdit() [UserDialog method] --> -<section id="tmthConnectEditEvent"><title>connectEditEvent (dialog object method)</title> +<section id="tmthConnectEditEvent" xreflabel="connectEditEvent"><title>connectEditEvent (dialog object method)</title> <para> - To connect event notifications from an edit control use the - <xref linkend="mthConnectEditEvent"/>() method of the + To connect event notifications from an edit control use the <xref linkend="mthConnectEditEvent"/> method of the <xref linkend="chpDialogObject"/> object. The basic syntax is: -<programlisting> <![CDATA[ +<programlisting> +<![CDATA[ >>--connectEditEvent(--id--,--event--+----------------+--)----->< +--,-methodName--+ @@ -381,7 +381,7 @@ </para> <para> When the operating system creates the underlying edit control, if it has the PASSWORD style, it sets the password - character to the default. This is an asterisk for earlier versions of Comctl32 (<xref linkend="ovvComctl32"/>), a + character to the default. This is an asterisk for earlier versions of Common Contorl <xref linkend="ovvComctl32"/>, a solid circle for Comctl32 version 6.0 and later. </para> </listitem></varlistentry> @@ -459,7 +459,7 @@ back again to the Windows character set. This ensures proper character conversion in certain circumstances. Microsoft states that this style is most useful when edit controls contain file names that will be used with file systems that do not support Unicode. For further details see the - Windows documentation (<xref linkend="defWindowsDoc"/>) provided by Microsoft. + Windows <xref linkend="defWindowsDoc"/> provided by Microsoft. </para> </listitem></varlistentry> <varlistentry><term>TAB</term> @@ -492,8 +492,8 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - This method only works with the window styles (<xref linkend="paraDialogControlStyles"/>) that can be changed - after the edit control has been created. Not all window styles can be changed after the control is created. + This method only works with the window <link linkend="paraDialogControlStyles">styles</link> that can be changed after + the edit control has been created. Not all window styles can be changed after the control is created. </para> <para> If an operating system error occurs, this method returns the negated value of the system error code. However, this @@ -1283,7 +1283,7 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - For an example see the showBalloon (<xref linkend="exampleShowBalloon"/>) example. + For an example see the showBalloon <link linkend="exampleShowBalloon">example</link>. </para> </listitem></varlistentry> </variablelist> @@ -1715,7 +1715,7 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The <emphasis role="italic">lineIndex</emphasis> example (<xref linkend="exampleLineIndex"/>) uses the <emphasis + The <emphasis role="italic">lineIndex</emphasis> <link linkend="exampleLineIndex">example</link> uses the <emphasis role="italic">lines</emphasis> method </para> </listitem></varlistentry> @@ -1990,9 +1990,9 @@ </simplelist> </para> <para> - The argument list (<xref linkend="argsAddStyle"/>) for the <xref linkend="mthAddStyleClsEdit"/> - method details the meaning of the keywords. The <xref linkend="mthCreateEdit"/> method documents - the meaning of all the edit control style keywords. + The <link linkend="argsAddStyle">argument</link> list for the <xref linkend="mthAddStyleClsEdit"/> method details + the meaning of the keywords. The <xref linkend="mthCreateEdit"/> method documents the meaning of all the edit + control style keywords. </para> </listitem></varlistentry> </variablelist> @@ -2010,8 +2010,8 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - This method only works with the window styles (<xref linkend="paraDialogControlStyles"/>) that can be changed - after the edit control has been created. Not all window styles can be changed after the control is created. + This method only works with the window <link linkend="paraDialogControlStyles">styles</link> that can be changed after + the edit control has been created. Not all window styles can be changed after the control is created. </para> <para> If an operating system error occurs, this method returns the negated value of the system error code. However, this @@ -2179,9 +2179,8 @@ </simplelist> </para> <para> - The argument list (<xref linkend="argsAddStyle"/>) for the <xref linkend="mthAddStyleClsEdit"/> - method details the meaning of the keywords. The <xref linkend="mthCreateEdit"/> method documents - the meaning of all the edit control style keywords. + The <link linkend="argsAddStyle">argument</link> list for the <xref linkend="mthAddStyleClsEdit"/> method details + the meaning of the keywords. The <xref linkend="mthCreateEdit"/> method documents the meaning of all the edit control style keywords. </para> </listitem></varlistentry> </variablelist> @@ -2199,8 +2198,8 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - This method only works with the window styles (<xref linkend="paraDialogControlStyles"/>) that can be changed - after the edit control has been created. Not all window styles can be changed after the control is created. + This method only works with the window <link linkend="paraDialogControlStyles">styles</link> that can be changed after + the edit control has been created. Not all window styles can be changed after the control is created. </para> <para> If an operating system error occurs, this method returns the negated value of the system error code. However, this @@ -2324,8 +2323,8 @@ <listitem> <para> For the UP and PAGEUP commands, the number of lines scrolled by the operating system is negative. Be sure to use the - <emphasis role="italic">signed</emphasis> version of the loWord method (sLoWord (<xref linkend="mthSLoWord"/>)) - to get the correct value. + <emphasis role="italic">signed</emphasis> version of the loWord method (<xref linkend="mthSLoWord"/>) to get the correct + value. </para> <para> When the <emphasis role="italic">repetitions</emphasis> argument is used, ooDialog issues the scroll command in a Modified: docs/trunk/publican/oodialog/en-US/eventNotification.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-01 18:46:30 UTC (rev 8341) +++ docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-01 19:44:10 UTC (rev 8342) @@ -696,7 +696,7 @@ The <emphasis role="italic">addUserMsg</emphasis> method connects a Windows window message (<xref linkend="ovvWindowMessages"/>) sent to the <xref linkend="ovvUnderlying"/> dialog with a method in the Rexx dialog. This method is designed to be used by ooDialog programmers who are familiar with the - Windows API. It's use will require access to the Windows documentation (<xref linkend="defWindowsDoc"/>) at a + Windows API. It's use will require access to the Windows <xref linkend="defWindowsDoc"/> at a minimum, and will likely also require access to the Windows header files in the Windows platform SDK (<xref linkend="defPlatformSDK"/>). </para> Modified: docs/trunk/publican/oodialog/en-US/userdialog.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-01 18:46:30 UTC (rev 8341) +++ docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-01 19:44:10 UTC (rev 8342) @@ -4996,7 +4996,7 @@ Converts text entered in the edit control from the Windows character set to the OEM character set and then back again to the Windows character set. This ensures proper character conversion in certain circumstances. Microsoft states that this style is most useful when edit controls contain file names that will be used with file systems - that do not support Unicode. For further details see the Windows documentation (<xref linkend="defWindowsDoc"/>) + that do not support Unicode. For further details see the Windows <xref linkend="defWindowsDoc"/> provided by Microsoft. </para> </listitem></varlistentry> @@ -5295,7 +5295,7 @@ Converts text entered in the edit control from the Windows character set to the OEM character set and then back again to the Windows character set. This ensures proper character conversion in certain circumstances. Microsoft states that this style is most useful when edit controls contain file names that will be used with - file systems that do not support Unicode. For further details see the Windows documentation (<xref linkend="defWindowsDoc"/>) + file systems that do not support Unicode. For further details see the Windows <xref linkend="defWindowsDoc"/> provided by Microsoft. </para> </listitem></varlistentry> @@ -5626,7 +5626,7 @@ Converts text entered in the edit control from the Windows character set to the OEM character set and then back again to the Windows character set. This ensures proper character conversion in certain circumstances. Microsoft states that this style is most useful when edit controls contain file names that will be used with file systems - that do not support Unicode. For further details see the Windows documentation (<xref linkend="defWindowsDoc"/>) + that do not support Unicode. For further details see the Windows <xref linkend="defWindowsDoc"/> provided by Microsoft. </para> </listitem></varlistentry> @@ -5945,7 +5945,7 @@ Converts text entered in the edit control from the Windows character set to the OEM character set and then back again to the Windows character set. This ensures proper character conversion in certain circumstances. Microsoft states that this style is most useful when edit controls contain file names that will be used with file systems - that do not support Unicode. For further details see the Windows documentation (<xref linkend="defWindowsDoc"/>) + that do not support Unicode. For further details see the Windows <xref linkend="defWindowsDoc"/> provided by Microsoft. </para> </listitem></varlistentry> @@ -6251,7 +6251,7 @@ Converts text entered in the edit control from the Windows character set to the OEM character set and then back again to the Windows character set. This ensures proper character conversion in certain circumstances. Microsoft states that this style is most useful when edit controls contain file names that will be used with file systems - that do not support Unicode. For further details see the Windows documentation (<xref linkend="defWindowsDoc"/>) + that do not support Unicode. For further details see the Windows <xref linkend="defWindowsDoc"/> provided by Microsoft. </para> </listitem></varlistentry> Modified: docs/trunk/publican/oodialog/en-US/windowBase.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/windowBase.xml 2012-09-01 18:46:30 UTC (rev 8341) +++ docs/trunk/publican/oodialog/en-US/windowBase.xml 2012-09-01 19:44:10 UTC (rev 8342) @@ -1503,7 +1503,7 @@ The flags are returned in their numeric format. This function is very similar to the <xref linkend="mthGetStyleRaw"/>() method, allowing the programmer to get the extended window flags. The numeric value of the extended style flags can be looked up using the - Windows documentation (<xref linkend="defWindowsDoc"/>) and the Platform SDK (<xref linkend="defPlatformSDK"/>). + Windows <xref linkend="defWindowsDoc"/> and the Platform SDK (<xref linkend="defPlatformSDK"/>). </para> <variablelist> <varlistentry><term><emphasis role="bold">Details:</emphasis></term> @@ -1890,7 +1890,7 @@ The <emphasis role="italic">getStyleRaw</emphasis> method retrieves the window style flags of the window. The flags are returned in their numeric format. This allows the programmer to determine the current style of any dialog or control. However, the programmer needs to be able to look up the numeric value of the window style flags to make use - of this functionality. This can be done using the Windows documentation (<xref linkend="defWindowsDoc"/>) and the + of this functionality. This can be done using the Windows <xref linkend="defWindowsDoc"/> and the Platform SDK (<xref linkend="defPlatformSDK"/>). </para> <variablelist> |
From: <mie...@us...> - 2012-09-01 20:55:46
|
Revision: 8344 http://sourceforge.net/p/oorexx/code-0/8344 Author: miesfeld Date: 2012-09-01 20:55:44 +0000 (Sat, 01 Sep 2012) Log Message: ----------- Work on Publican ooDialog doc Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/dataAttributes.xml docs/trunk/publican/oodialog/en-US/userdialog.xml Modified: docs/trunk/publican/oodialog/en-US/dataAttributes.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dataAttributes.xml 2012-09-01 19:47:17 UTC (rev 8343) +++ docs/trunk/publican/oodialog/en-US/dataAttributes.xml 2012-09-01 20:55:44 UTC (rev 8344) @@ -50,7 +50,7 @@ <indexterm><primary>dialog object</primary><secondary>data attributes</secondary></indexterm> <indexterm><primary>dialog object</primary><secondary>get and set data methods</secondary></indexterm> -<section id="sctUnderstandingDataAttributes"><title>Understanding Data Attributes</title> +<section id="sctUnderstandingDataAttributes" xreflabel="attribute"><title>Understanding Data Attributes</title> <indexterm><primary>dialog object</primary><secondary>understanding data attributes</secondary></indexterm> <para> This section contains methods for working with <emphasis role="bold">data attributes</emphasis>. It contains methods @@ -88,7 +88,7 @@ of the attribute in the Rexx dialog object to match the state of the corresponding dialog control in the underlying dialog. </para> -<para id="paraAutomaticDataDetection"> +<para id="paraAutomaticDataDetection" xreflabel="automatic data detection"> The term <emphasis role="italic">automatic data field detection</emphasis> is used for this process of creating and connecting data attributes. In addition to creating and connecting the data attributes, if automatic data field detection is on, when the underling dialog is created, the state of its controls are automatically set to the values @@ -183,7 +183,8 @@ following list is intended to be complete description of the rules in all circumstances. <variablelist> - <varlistentry id="termConnectAutoNames"><term><emphasis role="bold">connect... data attribute methods:</emphasis></term> + <varlistentry id="termConnectAutoNames" xreflabel="generated automatically"> + <term><emphasis role="bold">connect... data attribute methods:</emphasis></term> <listitem> <para> When the programmer uses one of the <xref linkend="sctConnectDataMethods"/> methods, the attribute name can be @@ -479,8 +480,8 @@ </programlisting> <para> - When the <emphasis role="italic">autoDetection</emphasis> method is invoked, it switches on <link - linkend="paraAutomaticDataDetection">automatic</link> data detection. + When the <emphasis role="italic">autoDetection</emphasis> method is invoked, it switches on + <xref linkend="paraAutomaticDataDetection"/>. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -540,7 +541,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated <link linkend="termConnectAutoNames">automatically</link>/>. + <link linkend="termConnectAutoNames">automatically</link>/>. </para> </listitem></varlistentry> </variablelist> @@ -572,24 +573,24 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the check box control manually. This can be done globally with the <xref - linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the - <xref linkend="mthSetCheckBoxData"/> or <xref linkend="mthGetCheckBoxData"/> methods. The <xref - linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods could also be used. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a check <xref linkend="clsCheckBox"/> is defined to be its - check state. For normal check boxes this is 0 for not checked and 1 for checked. Three-state check boxes have the - additional indeterminate state. The value for the indeterminate state is 2. - </para> - <para> - The <emphasis role="italic" >connectCheckBox</emphasis> method should only be used when <link - linkend="paraAutomaticDataDetection">automatic</link> data detection is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the check box control manually. This can be done globally with the <xref + linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the + <xref linkend="mthSetCheckBoxData"/> or <xref linkend="mthGetCheckBoxData"/> methods. The <xref + linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods could also be used. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a check <xref linkend="clsCheckBox"/> is defined to be its + check state. For normal check boxes this is 0 for not checked and 1 for checked. Three-state check boxes have the + additional indeterminate state. The value for the indeterminate state is 2. + </para> + <para> + The <emphasis role="italic" >connectCheckBox</emphasis> method should only be used when + <xref linkend="paraAutomaticDataDetection"/> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> @@ -632,7 +633,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated <link linkend="termConnectAutoNames">automatically</link>. + <link linkend="termConnectAutoNames">automatically</link>. </para> </listitem></varlistentry> </variablelist> @@ -663,29 +664,29 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the combo box control manually. This can be done globally with the <xref - linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref - linkend="mthSetComboBoxData"/> or <xref linkend="mthGetComboBoxData" />) methods. The <xref - linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods can also be used. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a combo <xref linkend="clsComboBox"/> is defined to be the - text in the selection field or the selected combo box item. - </para> - <para> - The <emphasis role="italic">connectComboBox</emphasis> should only be used when <link - linkend="paraAutomaticDataDetection">automatic</link> data detection is off. - </para> - </listitem></varlistentry> + <vrarlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the combo box control manually. This can be done globally with the <xref + linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref + linkend="mthSetComboBoxData"/> or <xref linkend="mthGetComboBoxData" />) methods. The <xref + linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods can also be used. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a combo <xref linkend="clsComboBox"/> is defined to be the + text in the selection field or the selected combo box item. + </para> + <para> + The <emphasis role="italic">connectComboBox</emphasis> should only be used when + <xref linkend="paraAutomaticDataDetection"/> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The example (<xref linkend="exampleConnectEdit"/>) for the <emphasis role="italic">connectEdit</emphasis> method - demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply - substitute a combo box for the edit control. + The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method + demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute + a combo box for the edit control. </para> </listitem></varlistentry> </variablelist> @@ -704,7 +705,7 @@ <para> The <emphasis role="italic">connectDateTimePicker</emphasis> method connects a date time picker control in the - underlying dialog, through its resource ID, to a newly created data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) + underlying dialog, through its resource ID, to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in the Rexx dialog object. </para> <variablelist> @@ -723,7 +724,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -755,23 +756,23 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the date time control manually. This can be done globally with the - <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer - grain of control use the <xref linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a date time <xref linkend="clsDateTimePicker"/> is - defined to be a <computeroutput>DateTime</computeroutput> object that represents it currently selected date and - time. - </para> - <para> - The <emphasis role="italic">connectDateTimePicker</emphasis> method should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the date time control manually. This can be done globally with the + <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer + grain of control use the <xref linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a date time <xref linkend="clsDateTimePicker"/> is + defined to be a <computeroutput>DateTime</computeroutput> object that represents it currently selected date and + time. + </para> + <para> + The <emphasis role="italic">connectDateTimePicker</emphasis> method should only be used when + <xref linkend="paraAutomaticDataDetection"/> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> @@ -796,9 +797,9 @@ </programlisting> <para> - The <emphasis role="italic">connectEdit</emphasis> method creates a new data (<xref - linkend="sctUnderstandingDataAttributes" />) attribute in the Rexx dialog object and connects it to the - underlying edit control using its resource id. + The <emphasis role="italic">connectEdit</emphasis> method creates a new data + <xref linkend="sctUnderstandingDataAttributes"/> attribute in the Rexx dialog object and connects it to the underlying + edit control using its resource id. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -816,7 +817,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -848,23 +849,23 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the edit control manually. This can be done globally with the <xref - linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref - linkend="mthSetEditData"/> or <xref linkend="mthGetEditData"/> methods. The <xref linkend="mthSetDataAttribute"/> or - <xref linkend="mthGetDataAttribute"/> methods can also be used. - </para> - <para> - The <emphasis role="italic">data</emphasis> of an edit control is defined to be the text entered in the control. - If there is no text, the data is the empty string. - </para> - <para> - The <emphasis role="italic">connectEdit</emphasis> should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the edit control manually. This can be done globally with the <xref + linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref + linkend="mthSetEditData"/> or <xref linkend="mthGetEditData"/> methods. The <xref linkend="mthSetDataAttribute"/> or + <xref linkend="mthGetDataAttribute"/> methods can also be used. + </para> + <para> + The <emphasis role="italic">data</emphasis> of an edit control is defined to be the text entered in the control. + If there is no text, the data is the empty string. + </para> + <para> + The <emphasis role="italic">connectEdit</emphasis> should only be used when + <xref linkend="paraAutomaticDataDetection" /> is off. + </para> + </listitem></varlistentry> <varlistentry id="exampleConnectEdit"><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> @@ -932,7 +933,7 @@ <para> The <emphasis role="italic">connectListBox</emphasis> method uses the resource ID of the control to connect a list box - in the underlying dialog to a newly created data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) in + in the underlying dialog to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in the Rexx dialog object. </para> <variablelist> @@ -951,7 +952,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -983,30 +984,30 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the list box manually. This can be done globally with the - <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain - of control use the <xref linkend="mthSetListBoxData"/> or the <xref linkend="mthGetListBoxData"/>. The <xref - linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods could also be used. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a <emphasis role="bold">single-selection</emphasis> list box (<xref - linkend="clsListBox" /> is defined to be text of the selected item in the list box. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a <emphasis role="bold">multi-selection</emphasis> <xref - linkend="clsListBox"/> is defined to be a string containing the item numbers of its selected items, - separated by a blank. For a multi-selection list box the string could contain any number of list items depending - on what the user has selected, (for getting data,) or what the programmer is setting to be selected, (for setting - data.) - </para> - <para> - The <emphasis role="italic">connectListBox</emphasis> method should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the list box manually. This can be done globally with the + <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain + of control use the <xref linkend="mthSetListBoxData"/> or the <xref linkend="mthGetListBoxData"/>. The <xref + linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods could also be used. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a <emphasis role="bold">single-selection</emphasis> <xref + linkend="clsListBox"/> is defined to be text of the selected item in the list box. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a <emphasis role="bold">multi-selection</emphasis> <xref + linkend="clsListBox"/> is defined to be a string containing the item numbers of its selected items, + separated by a blank. For a multi-selection list box the string could contain any number of list items depending + on what the user has selected, (for getting data,) or what the programmer is setting to be selected, (for setting + data.) + </para> + <para> + The <emphasis role="italic">connectListBox</emphasis> method should only be used when + <xref linkend="paraAutomaticDataDetection" /> is off. + </para> + </listitem></varlistentry> <varlistentry id="exampleConnectListBoxSingle"><term><emphasis role="bold">Example Single Selection:</emphasis></term> <listitem> <para> @@ -1321,7 +1322,7 @@ <para> The <emphasis role="italic">connectListView</emphasis> method connects a list view in the underlying dialog, through - its resource ID, to a newly created data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) in the Rexx + its resource ID, to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in the Rexx dialog object. </para> <variablelist> @@ -1340,7 +1341,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -1372,28 +1373,28 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the list view control manually. This can be done globally with the <xref - linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref - linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a list <xref linkend="clsListView"/> is defined to be a - string containing the blank seperated index(es) of its selected item(s). - </para> - <para> - The <emphasis role="italic">connectCheckBox</emphasis> method should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the list view control manually. This can be done globally with the <xref + linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref + linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a list <xref linkend="clsListView"/> is defined to be a + string containing the blank seperated index(es) of its selected item(s). + </para> + <para> + The <emphasis role="italic">connectCheckBox</emphasis> method should only be used when + <xref linkend="paraAutomaticDataDetection" /> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The example (<xref linkend="exampleConnectEdit"/>) for the <emphasis role="italic">connectEdit</emphasis> method - demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply - substitute a list view for the edit control. + The <link linkend="exampleConnectEdit">example</link>/> for the <emphasis role="italic">connectEdit</emphasis> method + demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute + a list view for the edit control. </para> </listitem></varlistentry> </variablelist> @@ -1412,7 +1413,7 @@ <para> The <emphasis role="italic">connectMonthCalendar</emphasis> method connects a month calendar control in the underlying - dialog, through its resource ID, to a newly created data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) + dialog, through its resource ID, to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in the Rexx dialog object. </para> <variablelist> @@ -1431,7 +1432,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -1463,30 +1464,28 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the month calendar control manually. This can be done globally with the - <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain - of control use the <xref linkend="mthSetDataAttribute"/> or getDataAttribute (<xref - linkend="mthGetDataAttribute" />) methods. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a month <xref linkend="clsMonthCalendar"/> is defined - to be a <computeroutput>DateTime</computeroutput> object that specifies the selected date in the month calendar - control. - </para> - <para> - The <emphasis role="italic">connectMonthCalendar</emphasis> method should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the month calendar control manually. This can be done globally with the + <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain + of control use the <xref linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a <xref linkend="clsMonthCalendar"/> is defined to be a + <computeroutput>DateTime</computeroutput> object that specifies the selected date in the month calendar control. + </para> + <para> + The <emphasis role="italic">connectMonthCalendar</emphasis> method should only be used when + <xref linkend="paraAutomaticDataDetection" /> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The example (<xref linkend="exampleConnectEdit"/>) for the <emphasis role="italic">connectEdit</emphasis> method - demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply - substitute a month calendar control for the edit control. + The <link linkend="exampleConnectEdit">example</link>/> for the <emphasis role="italic">connectEdit</emphasis> method + demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute + a month calendar control for the edit control. </para> </listitem></varlistentry> </variablelist> @@ -1506,8 +1505,8 @@ <para> The <emphasis role="italic">connectRadioButton</emphasis> method uses the resource id of a radio button control to - connect the control in the underlying dialog to a newly created data attribute (<xref - linkend="sctUnderstandingDataAttributes" />) in the Rexx dialog object. + connect the control in the underlying dialog to a newly created data<xref linkend="sctUnderstandingDataAttributes"/> in + the Rexx dialog object. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1525,7 +1524,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -1557,31 +1556,29 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the radio button control manually. This can be done globally with the - <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain - of control use the <xref linkend="mthSetRadioButtonData"/> or getRadioButtonData (<xref - linkend="mthGetRadioButtonData" />) methods. The setDataAttribute (<xref - linkend="mthSetDataAttribute" />) or getDataAttribute (<xref - linkend="mthGetDataAttribute" />) methods can also be used. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a radio button (<xref linkend="clsRadioButton"/>} is defined to - be the its check state. This is 0 for not checked and 1 for checked. - </para> - <para> - The <emphasis role="italic">connectRadioButton</emphasis> method should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the radio button control manually. This can be done globally with the + <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain + of control use the <xref linkend="mthSetRadioButtonData"/> or <xref linkend="mthGetRadioButtonData"/> methods. The + <xref linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods can also be used. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a <xref linkend="clsRadioButton"/> is defined to be the its check state. + This is 0 for not checked and 1 for checked. + </para> + <para> + The <emphasis role="italic">connectRadioButton</emphasis> method should only be used when + <xref linkend="paraAutomaticDataDetection" /> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The example (<xref linkend="exampleConnectEdit"/>) for the <emphasis role="italic">connectEdit</emphasis> method - demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply - substitute a radio button control for the edit control. + The <link linkend="exampleConnectEdit">example</link>/> for the <emphasis role="italic">connectEdit</emphasis> method + demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute + a radio button control for the edit control. </para> </listitem></varlistentry> </variablelist> @@ -1601,7 +1598,7 @@ <para> The <emphasis role="italic">connectTab</emphasis> method uses the resource id of a tab control to connect the control - in the underlying dialog to a newly created data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) in + in the underlying dialog to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in the Rexx dialog object. </para> <variablelist> @@ -1620,7 +1617,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -1652,29 +1649,28 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the tab control manually. This can be done globally with the - <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain - of control use the <xref linkend="mthSetDataAttribute"/> or getDataAttribute (<xref - linkend="mthGetDataAttribute" />) methods. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a <xref linkend="clsTab"/> control is defined to the text - of its currently selected tab. - </para> - <para> - The <emphasis role="italic">connectTab</emphasis> method should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the tab control manually. This can be done globally with the + <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain + of control use the <xref linkend="mthSetDataAttribute"/> or<xref linkend="mthGetDataAttribute"/> methods. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a <xref linkend="clsTab"/> control is defined to the text + of its currently selected tab. + </para> + <para> + The <emphasis role="italic">connectTab</emphasis> method should only be used when + <xref linkend="paraAutomaticDataDetection" /> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The example (<xref linkend="exampleConnectEdit"/>) for the <emphasis role="italic">connectEdit</emphasis> method - demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply - substitute a tab control for the edit control. + The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method + demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute + a tab control for the edit control. </para> </listitem></varlistentry> </variablelist> @@ -1694,7 +1690,7 @@ <para> The <emphasis role="italic">connectTrackBar</emphasis> method uses the resource id of a trackbar control to connect - the control in the underlying dialog to a newly created data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) + the control in the underlying dialog to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in the Rexx dialog object. </para> <variablelist> @@ -1713,7 +1709,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -1745,29 +1741,28 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the trackbar control manually. This can be done globally with the setData (<xref - linkend="mthSetData" /> and getData (<xref linkend="mthGetData"/> methods. For a finer grain of - control use the <xref linkend="mthSetDataAttribute"/> or getDataAttribute (<xref - linkend="mthGetDataAttribute" />) methods. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a <xref linkend="clsTab"/> control is defined to be - the current logical position of the slider in the trackbar. - </para> - <para> - The <emphasis role="italic">connectTab</emphasis> method should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the trackbar control manually. This can be done globally with the <xref + linkend="mthSetData" /> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref + linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a <xref linkend="clsTab"/> control is defined to be + the current logical position of the slider in the trackbar. + </para> + <para> + The <emphasis role="italic">connectTab</emphasis> method should only be used when + <xref linkend="paraAutomaticDataDetection" /> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The example (<xref linkend="exampleConnectEdit"/>) for the <emphasis role="italic">connectEdit</emphasis> method - demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply - substitute a trackbar control for the edit control. + The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method + demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute + a trackbar control for the edit control. </para> </listitem></varlistentry> </variablelist> @@ -1785,9 +1780,9 @@ </programlisting> <para> - The <emphasis role="italic">connectTreeView</emphasis> method creates a data attribute (<xref - linkend="sctUnderstandingDataAttributes" />) in the Rexx dialog object and connects it to a tree - view control in the underlying dialog using its resource id. + The <emphasis role="italic">connectTreeView</emphasis> method creates a data <xref + linkend="sctUnderstandingDataAttributes"/> in the Rexx dialog object and connects it to a tree view control in the + underlying dialog using its resource id. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1803,7 +1798,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -1834,29 +1829,28 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the tree view control manually. This can be done globally with the setData (<xref - linkend="mthSetData" /> and <xref linkend="mthGetData"/> methods. For a finer grain of - control use the <xref linkend="mthSetDataAttribute"/> or getDataAttribute (<xref - linkend="mthGetDataAttribute" />) methods. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a tree <xref linkend="clsTreeView"/> is defined to be the - text of the selected tree view item. - </para> - <para> - The <emphasis role="italic">connectTreeview</emphasis> should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the tree view control manually. This can be done globally with the <xref + linkend="mthSetData" /> and <xref linkend="mthGetData"/> methods. For a finer grain of control use the <xref + linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a tree <xref linkend="clsTreeView"/> is defined to be the + text of the selected tree view item. + </para> + <para> + The <emphasis role="italic">connectTreeview</emphasis> should only be used when + <xref linkend="paraAutomaticDataDetection" /> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The example (<xref linkend="exampleConnectEdit"/>) for the <emphasis role="italic">connectEdit</emphasis> method - demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply - substitute a tree view for the edit control. + The <link linkend="exampleConnectEdit">example</link>/> for the <emphasis role="italic">connectEdit</emphasis> method + demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute + a tree view for the edit control. </para> </listitem></varlistentry> </variablelist> @@ -1875,7 +1869,7 @@ <para> The <emphasis role="italic">connectUpDown</emphasis> method connects an up down control in the underlying dialog, - through its resource ID, to a newly created data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) in + through its resource ID, to a newly created data <xref linkend="sctUnderstandingDataAttributes"/> in the Rexx dialog object. </para> <variablelist> @@ -1894,7 +1888,7 @@ <listitem> <para> The name of the data attribute to be created. If this argument is omitted or invalid, the attribute name is - generated automatically (<xref linkend="termConnectAutoNames"/>). + <xref linkend="termConnectAutoNames"/>. </para> </listitem></varlistentry> </variablelist> @@ -1926,29 +1920,28 @@ </variablelist> </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> - <listitem> - <para> - The attribute has to be synchronized with the up down control manually. This can be done globally with the - <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain - of control use the <xref linkend="mthSetDataAttribute"/> or getDataAttribute (<xref - linkend="mthGetDataAttribute" />) methods. - </para> - <para> - The <emphasis role="italic">data</emphasis> of a up <xref linkend="clsUpDown"/> control is defined to be - the value of its current position. - </para> - <para> - The <emphasis role="italic">connectUpDown</emphasis> method should only be used when automatic data detection (<xref - linkend="paraAutomaticDataDetection" />) is off. - </para> - </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + The attribute has to be synchronized with the up down control manually. This can be done globally with the + <xref linkend="mthSetData"/> and <xref linkend="mthGetData"/> methods. For a finer grain + of control use the <xref linkend="mthSetDataAttribute"/> or <xref linkend="mthGetDataAttribute"/> methods. + </para> + <para> + The <emphasis role="italic">data</emphasis> of a up <xref linkend="clsUpDown"/> control is defined to be + the value of its current position. + </para> + <para> + The <emphasis role="italic">connectUpDown</emphasis> method should only be used when + <xref linkend="paraAutomaticDataDetection" /> is off. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The example (<xref linkend="exampleConnectEdit"/>) for the <emphasis role="italic">connectEdit</emphasis> method - demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply - substitute an up down control for the edit control. + The <link linkend="exampleConnectEdit">example</link> for the <emphasis role="italic">connectEdit</emphasis> method + demonstrates all the pertinent steps to manually connect and use a data attribute for a dialog control. Simply substitute + an up down control for the edit control. </para> </listitem></varlistentry> </variablelist> @@ -1968,8 +1961,8 @@ </programlisting> <para> - The <emphasis role="italic">getCheckBoxData</emphasis> method gets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of a a check box. + The <emphasis role="italic">getCheckBoxData</emphasis> method gets the data <xref + linkend="sctUnderstandingDataAttributes"/> of a check box. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2021,8 +2014,8 @@ </programlisting> <para> - The <emphasis role="italic">getComboBoxData</emphasis> method gets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of a combo box. + The <emphasis role="italic">getComboBoxData</emphasis> method gets the data <xref + linkend="sctUnderstandingDataAttributes"/> of a combo box. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2088,9 +2081,9 @@ </programlisting> <para> - The <emphasis role="italic">getControlData</emphasis> method gets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of a dialog control, regardless of the type of the control. The - control <emphasis role="bold">should</emphasis> have been previously connected to a data attribute. + The <emphasis role="italic">getControlData</emphasis> method gets the data <xref + linkend="sctUnderstandingDataAttributes"/> of a dialog control, regardless of the type of the control. The control + <emphasis role="bold">should</emphasis> have been previously connected to a data attribute. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2133,14 +2126,13 @@ </para> <para> A better method to use, if the programmer is insistent on thinking in terms of data attributes, is probably to use - the <xref linkend="mthData"/> method of the dialog control object (<xref - linkend="chpDialogControlObject" />). + the <xref linkend="mthData"/> method of the dialog <xref linkend="chpDialogControlObject"/> object. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> <para> - This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if + This method can only be invoked after the underlying Windows dialog has been created. A syntax condition is raised if the underlying dialog does not exist. </para> </listitem></varlistentry> @@ -2159,8 +2151,8 @@ </programlisting> <para> - The <emphasis role="italic">getData</emphasis> method sets the Rexx dialog data (<xref - linkend="sctUnderstandingDataAttributes" />) attribute values to the state of the underlying, connected, + The <emphasis role="italic">getData</emphasis> method sets the Rexx dialog data <xref + linkend="sctUnderstandingDataAttributes"/> values to the state of the underlying, connected, dialog controls. </para> <variablelist> @@ -2233,7 +2225,7 @@ <para> The <emphasis role="italic">getDataAttribute</emphasis> method transfers the data of a dialog control to the - connected data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) of the Rexx dialog object. + connected data <xref linkend="sctUnderstandingDataAttributes"/> of the Rexx dialog object. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2254,10 +2246,9 @@ <listitem> <para> The terms <emphasis role="italic">transfers</emphasis> and <emphasis role="italic">receives</emphasis> the data are - holdovers from the original documentation and the original data attribute abstraction (<xref - linkend="sctUnderstandingDataAttributes" />). What the <emphasis - role="italic">getDataAttribute</emphasis> method actually does is to set the value of the connected data attribute - to the defined value of the underlying dialog control. The defined value for the <emphasis + holdovers from the original documentation and the original data <xref linkend="sctUnderstandingDataAttributes"/> + abstraction. What the <emphasis role="italic">getDataAttribute</emphasis> method actually does is to set the value of the + connected data attribute to the defined value of the underlying dialog control. The defined value for the <emphasis role="italic">data</emphasis> of any dialog control is documented in the <xref linkend="sctConnectDataMethods"/> method for the control. </para> @@ -2298,11 +2289,10 @@ </programlisting> <para> - The <emphasis role="italic">getDataStem</emphasis>() method is the reverse of the setDataStem (<xref - linkend="mthSetDataStem" />) method. The method gets the <emphasis role="italic">data</emphasis> of - all the dialog controls in the underlying dialog that have been connected to a data attribute (<xref - linkend="sctUnderstandingDataAttributes" />) of the Rexx dialog object. The data of each control is - copied to the specified stem. + The <emphasis role="italic">getDataStem</emphasis> method is the reverse of the <xref linkend="mthSetDataStem"/> method. + The method gets the <emphasis role="italic">data</emphasis> of all the dialog controls in the underlying dialog that have + been connected to a data <xref linkend="sctUnderstandingDataAttributes"/> of the Rexx dialog object. The data of each + control is copied to the specified stem. </para> <para> A stem index for each connected control is set. The stem index is the numeric ID for the control. The value at that @@ -2349,8 +2339,8 @@ </programlisting> <para> - The <emphasis role="italic">getEditData</emphasis> method gets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of an edit control. + The <emphasis role="italic">getEditData</emphasis> method gets the data <xref linkend="sctUnderstandingDataAttributes"/> + of an edit control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2404,8 +2394,8 @@ </programlisting> <para> - The <emphasis role="italic">getListBoxData</emphasis> method gets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of a list box. + The <emphasis role="italic">getListBoxData</emphasis> method gets the data <xref linkend="sctUnderstandingDataAttributes"/> + of a list box. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2483,8 +2473,8 @@ </programlisting> <para> - The <emphasis role="italic">getRadioButtonData</emphasis> method gets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of a a radio button. + The <emphasis role="italic">getRadioButtonData</emphasis> method gets the data <xref + linkend="sctUnderstandingDataAttributes"/> of a a radio button. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2539,8 +2529,7 @@ <para> The <emphasis role="italic">initAutoDetection</emphasis> method is invoked automatically by the ooDialog framework when any dialog is first instantiated. The default implementation of <emphasis - role="italic">initAutoDetection</emphasis> turns automatically (<xref linkend="paraAutomaticDataDetection"/>) data field - detection on. + role="italic">initAutoDetection</emphasis> turns <xref linkend="paraAutomaticDataDetection"/> on. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2592,8 +2581,8 @@ </programlisting> <para> - When the <emphasis role="italic">noAutoDetection</emphasis> method is invoked, it switches off automatic (<xref - linkend="paraAutomaticDataDetection" />) data detection. + When the <emphasis role="italic">noAutoDetection</emphasis> method is invoked, it switches off + <xref linkend="paraAutomaticDataDetection"/>. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2623,8 +2612,8 @@ </programlisting> <para> - The <emphasis role="italic">setCheckBoxData</emphasis> method sets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of a check box control. + The <emphasis role="italic">setCheckBoxData</emphasis> method sets the data <xref + linkend="sctUnderstandingDataAttributes"/> of a check box control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2707,8 +2696,8 @@ </programlisting> <para> - The <emphasis role="italic">setComboBoxData</emphasis> method sets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of a combo box control. + The <emphasis role="italic">setComboBoxData</emphasis> method sets the data <xref + linkend="sctUnderstandingDataAttributes"/> of a combo box control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2790,9 +2779,8 @@ </programlisting> <para> - The <emphasis role="italic">setControlData</emphasis> method sets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of a dialog control. The programmer does not have to know what - kind of control it is. + The <emphasis role="italic">setControlData</emphasis> method sets the data <xref linkend="sctUnderstandingDataAttributes"/> + of a dialog control. The programmer does not have to know what kind of control it is. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2861,8 +2849,7 @@ </para> <para> A better method to use, if the programmer is insistent on thinking in terms of data attributes, is probably to use - the data= (<xref linkend="mthDataEquals"/>) method of the dialog control object (<xref - linkend="chpDialogControlObject" />). + the <xref linkend="mthDataEquals"/> method of the dialog <xref linkend="chpDialogControlObject"/> object. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details:</emphasis></term> @@ -2903,7 +2890,7 @@ <para> The <emphasis role="italic">setData</emphasis> method sets the state of all underlying, connected, dialog controls to - the values of the matching dialog object data (<xref linkend="sctUnderstandingDataAttributes"/>) attributes. + the values of the matching dialog object data <xref linkend="sctUnderstandingDataAttributes"/>s. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2923,9 +2910,9 @@ <para> <emphasis role="bold">Note</emphasis> that this method sets the state for every connected attribute. This may not always be desirable. For instance the focused node of a tree-view control may be changed. For finely grained control - of which dialog controls have their state set, the programmer should use the setControlData (<xref - linkend="mthSetControlData" />) or <xref linkend="mthSetDataAttribute"/> - methods. Both of these methods transfer the value of a single object attribute that is specified by the programmer. + of which dialog controls have their state set, the programmer should use the <xref linkend="mthSetControlData"/> or + <xref linkend="mthSetDataAttribute"/> methods. Both of these methods transfer the value of a single object attribute that + is specified by the programmer. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details:</emphasis></term> @@ -2978,8 +2965,8 @@ </programlisting> <para> - The <emphasis role="italic">setDataAttribute</emphasis> method transfers the value of a connected data attribute (<xref - linkend="sctUnderstandingDataAttributes" />) of the Rexx dialog object to the underlying dialog + The <emphasis role="italic">setDataAttribute</emphasis> method transfers the value of a connected data <xref + linkend="sctUnderstandingDataAttributes"/> of the Rexx dialog object to the underlying dialog control. </para> <variablelist> @@ -3027,11 +3014,11 @@ <listitem> <para> The terms <emphasis role="italic">transfers</emphasis> and <emphasis role="italic">receives</emphasis> the data are - holdovers from the original documentation and the original data attribute abstraction (<xref - linkend="sctUnderstandingDataAttributes" />). What the <emphasis - role="italic">setDataAttribute</emphasis> method actually does is to set the state of the underyling dialog control - to the value of the connected data attribute. The defined value for the <emphasis role="italic">data</emphasis> of - any dialog control is documented in the <xref linkend="sctConnectDataMethods"/> method for the control. + holdovers from the original documentation and the original data <xref linkend="sctUnderstandingDataAttributes"/> + abstraction. What the <emphasis role="italic">setDataAttribute</emphasis> method actually does is to set the state of the + underyling dialog control to the value of the connected data attribute. The defined value for the <emphasis + role="italic">data</emphasis> of any dialog control is documented in the <xref linkend="sctConnectDataMethods"/> method + for the control. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -3075,8 +3062,8 @@ </para> <para> This method only works for controls that have been connected to a <link - linkend="sctUnderstandingDataAttributes">data</link> attributue. Either by <link - linkend="paraAutomaticDataDetection">automatic</link> data detection, or through one of the + linkend="sctUnderstandingDataAttributes">data</link> attributue. Either by <xref + linkend="paraAutomaticDataDetection"/>, or through one of the <xref linkend="sctConnectDataMethods"/>) methods. Every connected control has its state set when this method is invoked. If the data stem, <emphasis role="italic">data.</emphasis> has no matching index for a connected control, that control's state is set to the empty string. Any indexes in the data stem that do not match the resource ID of a registered control @@ -3147,8 +3134,8 @@ </programlisting> <para> - The <emphasis role="italic">setEditData</emphasis> method sets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of an edit control. + The <emphasis role="italic">setEditData</emphasis> method sets the data <xref linkend="sctUnderstandingDataAttributes"/> + of an edit control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -3256,8 +3243,8 @@ </programlisting> <para> - The <emphasis role="italic">setListBoxData</emphasis> method sets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of the underly list box to the value specified. + The <emphasis role="italic">setListBoxData</emphasis> method sets the data <xref linkend="sctUnderstandingDataAttributes"/> + of the underly list box to the value specified. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -3279,8 +3266,8 @@ selected item in the list box. </para> <para> - The <emphasis role="italic">data</emphasis> of a <emphasis role="bold">multi-selection</emphasis> list box (<xref - linkend="clsListBox" />) is defined to be a string containing the item numbers of its selected items, + The <emphasis role="italic">data</emphasis> of a <emphasis role="bold">multi-selection</emphasis> <xref + linkend="clsListBox"/> is defined to be a string containing the item numbers of its selected items, separated by a blank. For a multi-selection list box the string could contain any number of list items depending on what the programmer is setting to be selected. </para> @@ -3371,8 +3358,8 @@ </programlisting> <para> - The <emphasis role="italic">setRadioData</emphasis> method sets the data (<xref - linkend="sctUnderstandingDataAttributes" />) of a radio button control. + The <emphasis role="italic">setRadioData</emphasis> method sets the data <xref linkend="sctUnderstandingDataAttributes"/> + of a radio button control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> Modified: docs/trunk/publican/oodialog/en-US/userdialog.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-01 19:47:17 UTC (rev 8343) +++ docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-01 20:55:44 UTC (rev 8344) @@ -1689,7 +1689,7 @@ <varlistentry><term>attributeName [optional]</term> <listitem> <para> - The name of a data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) to connect with the check + The name of a data <xref linkend="sctUnderstandingDataAttributes"/> to connect with the check box. Using this argument allows the programmer to control the name of the data attribute. If you omit this argument, or the supplied name is not valid, then the data attribute name is constructed automatically (<xref linkend="sctDataAttributeNames"/>). @@ -2959,7 +2959,7 @@ <varlistentry><term>attr [optional]</term> <listitem> <para> - The name of the data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) associated with the radio + The name of the data <xref linkend="sctUnderstandingDataAttributes"/> associated with the radio button. If you omit this argument then the name of the data attribute is constructed automatically (<xref linkend="sctDataAttributeNames"/>). If auto <xref linkend="mthInitAutoDetection"/> is off, this argument is ignored. @@ -4314,7 +4314,7 @@ <varlistentry><term>attrName [optional]</term> <listitem> <para> - The name of the data attribute (<xref linkend="sctUnderstandingDataAttributes"/>) associated with the combo box + The name of the data <xref linkend="sctUnderstandingDataAttributes"/> associated with the combo box control. If you omit this argument then the name of the data attribu... [truncated message content] |
From: <mie...@us...> - 2012-09-02 02:46:41
|
Revision: 8346 http://sourceforge.net/p/oorexx/code-0/8346 Author: miesfeld Date: 2012-09-02 02:46:35 +0000 (Sun, 02 Sep 2012) Log Message: ----------- Work on Publican ooDialog docs Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/button.xml docs/trunk/publican/oodialog/en-US/combobox.xml docs/trunk/publican/oodialog/en-US/datetimepicker.xml docs/trunk/publican/oodialog/en-US/deprecated.xml docs/trunk/publican/oodialog/en-US/dialogControlObject.xml docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/dialogObject.xml docs/trunk/publican/oodialog/en-US/edit.xml docs/trunk/publican/oodialog/en-US/eventNotification.xml docs/trunk/publican/oodialog/en-US/listbox.xml docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/menus.xml docs/trunk/publican/oodialog/en-US/monthcalendar.xml docs/trunk/publican/oodialog/en-US/mouse.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/progressbar.xml docs/trunk/publican/oodialog/en-US/propertySheetDialogs.xml docs/trunk/publican/oodialog/en-US/resources.xml docs/trunk/publican/oodialog/en-US/scrollbar.xml docs/trunk/publican/oodialog/en-US/static.xml docs/trunk/publican/oodialog/en-US/trackbar.xml docs/trunk/publican/oodialog/en-US/treeview.xml docs/trunk/publican/oodialog/en-US/updown.xml docs/trunk/publican/oodialog/en-US/userInput.xml docs/trunk/publican/oodialog/en-US/userdialog.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml docs/trunk/publican/oodialog/en-US/windowBase.xml docs/trunk/publican/oodialog/en-US/windowExtensions.xml Modified: docs/trunk/publican/oodialog/en-US/button.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/button.xml 2012-09-01 20:59:10 UTC (rev 8345) +++ docs/trunk/publican/oodialog/en-US/button.xml 2012-09-02 02:46:35 UTC (rev 8346) @@ -80,19 +80,19 @@ <tbody> <row> <entry>Push Button</entry> -<entry>Button <xref linkend="clsButton"/></entry> +<entry><xref linkend="clsButton"/> class</entry> </row> <row> <entry>Check Box Button</entry> -<entry>CheckBox <xref linkend="clsCheckBox"/></entry> +<entry><xref linkend="clsCheckBox"/> class</entry> </row> <row> <entry>Radio Button</entry> -<entry>RadioButton <xref linkend="clsRadioButton"/></entry> +<entry><xref linkend="clsRadioButton"/> class</entry> </row> <row> <entry>Group Box</entry> -<entry><xref linkend="clsGroupBox"/></entry> +<entry><xref linkend="clsGroupBox"/> class</entry> </row> <row> <entry>Owner Drawn Button</entry> @@ -329,7 +329,7 @@ <xref linkend="mthInstallAnimatedButton"/>.</para> </section> -<section id="clsCheckBox"><title>Check Boxes</title> +<section id="clsCheckBox" xreflabel="CheckBox"><title>Check Boxes</title> <indexterm><primary>CheckBox class</primary></indexterm> <para> Check boxes are similar in many ways to radio buttons. A check box consists of a square box and a @@ -439,7 +439,7 @@ </section> -<section id="tmthNewCheckBox"><title>newCheckBox (dialog object method)</title> +<section id="tmthNewCheckBox" xreflabel="newCheckBoxe"><title>newCheckBox (dialog object method)</title> <para> Check box objects can not be instantiated by the programmer from Rexx code. Rather a check box object is obtained by using the <xref linkend="mthNewCheckBox"/> method of the <xref linkend="chpDialogObject"/> object. The @@ -454,7 +454,7 @@ </section> <!-- End Dialog::newCheckBox() (dialog object method) --> -<section id="tmthCreateCheckBox"><title>createCheckBox (UserDialog method)</title> +<section id="tmthCreateCheckBox" xreflabel="createCheckBox"><title>createCheckBox (UserDialog method)</title> <para> A check box object can be created in the dialog template for a <xref linkend="clsUserDialog"/> dialog through the <xref linkend="mthCreateCheckBox"/> method. The basic syntax is: @@ -610,7 +610,7 @@ </section> -<section id="clsGroupBox"><title>Group Boxes</title> +<section id="clsGroupBox" xreflabel="GroupBox"><title>Group Boxes</title> <indexterm><primary>GroupBox class</primary></indexterm> <para> The Windows Group Box control is actually a button control, not a static control. Its purpose is to @@ -788,7 +788,7 @@ </section> -<section id="clsRadioButton"><title>Radio Buttons</title> +<section id="clsRadioButton" xreflabel="RadioButton"><title>Radio Buttons</title> <indexterm><primary>RadioButton class</primary></indexterm> <para> Radio buttons consist of a round button and a programmer defined label, icon, or bitmap that indicates @@ -899,7 +899,7 @@ </section> -<section id="tmthNewRadioButton"><title>newRadioButton (dialog object method)</title> +<section id="tmthNewRadioButton" xreflabel="newRadioButton"><title>newRadioButton (dialog object method)</title> <para> Radio button objects can not be instantiated by the programmer from Rexx code. Rather a radio button object is obtained by using the <xref linkend="mthNewRadioButton"/> method of the <xref linkend="chpDialogObject" /> object. The @@ -914,7 +914,7 @@ </section> <!-- End newRadioButton() [PlainBaseDialog method] --> -<section id="tmthCreateRadioButton"><title>createRadioButton (UserDialog method)</title> +<section id="tmthCreateRadioButton" xreflabel="createRadioButton"><title>createRadioButton (UserDialog method)</title> <para> A radio button object can be created in the dialog template for a <xref linkend="clsUserDialog"/> dialog through the <xref linkend="mthCreateRadioButton"/> method. The basic syntax is: @@ -998,7 +998,7 @@ <varlistentry><term><emphasis role="bold">Details:</emphasis></term> <listitem> <para> - Sets the <xref linkend="dotSystemErrorCode"/> variable. + Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> Raises syntax errors when incorrect arguments are detected. @@ -1186,7 +1186,7 @@ </section> -<section id="clsButton"><title>Push Buttons</title> +<section id="clsButton" xreflabel="Button"><title>Push Buttons</title> <indexterm><primary>Button class</primary></indexterm> <indexterm><primary>Push buttons</primary></indexterm> <para> @@ -1578,7 +1578,7 @@ <varlistentry><term>imageList</term> <listitem> <para> - The<xref linkend="clsImageList"/> object containing the images for the button. + The <xref linkend="clsImageList"/> object containing the images for the button. </para> </listitem></varlistentry> <varlistentry><term>rect</term> @@ -1988,7 +1988,7 @@ determine the current version of the library. </para> <para> - Sets the <xref linkend="dotSystemErrorCode"/> variable. + Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> Raises syntax errors when incorrect arguments are detected. Modified: docs/trunk/publican/oodialog/en-US/combobox.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/combobox.xml 2012-09-01 20:59:10 UTC (rev 8345) +++ docs/trunk/publican/oodialog/en-US/combobox.xml 2012-09-02 02:46:35 UTC (rev 8346) @@ -212,7 +212,7 @@ </section> -<section id="tmthNewComboBox"><title>newComboBox (dialog object method)</title> +<section id="tmthNewComboBox" xreflabel="newComboBox"><title>newComboBox (dialog object method)</title> <para> <computeroutput>ComboBox</computeroutput> objects can not be instantiated by the programmer from Rexx code using a <emphasis role="italic">new</emphasis> method. Rather, a combo box object is obtained by using the <xref Modified: docs/trunk/publican/oodialog/en-US/datetimepicker.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/datetimepicker.xml 2012-09-01 20:59:10 UTC (rev 8345) +++ docs/trunk/publican/oodialog/en-US/datetimepicker.xml 2012-09-02 02:46:35 UTC (rev 8346) @@ -410,7 +410,7 @@ </section> -<section id="tmthNewDateTimePicker"><title>newDateTimePicker (dialog object method)</title> +<section id="tmthNewDateTimePicker" xreflabel="newDateTimePicker"><title>newDateTimePicker (dialog object method)</title> <para> <computeroutput>DateTimePicker</computeroutput> objects can not be instantiated by the programmer from Rexx code using a <emphasis role="italic">new</emphasis>() method. Rather, a date and time picker object is obtained by using the newDateTimePicker (<xref @@ -426,7 +426,8 @@ </section> <!-- End Dialog::newDateTimePicker() (dialog object method) --> -<section id="tmthCreateDateTimePicker"><title>createDateTimePicker (UserDialog method)</title> +<section id="tmthCreateDateTimePicker" xreflabel="createDateTimePicker"> +<title>createDateTimePicker (UserDialog method)</title> <para> A date and time picker control can be added to the dialog template of a UserDialog (<xref linkend="clsUserDialog" />) through the createDateTimePicker (<xref @@ -441,7 +442,8 @@ </section> <!-- End UserDialog::createDateTimePicker() (UserDialog method) --> -<section id="tmthConnectDateTimePickerEvent"><title>connectDateTimePickerEvent (dialog object method)</title> +<section id="tmthConnectDateTimePickerEvent" xreflabel="connectDateTimePickerEvent"> +<title>connectDateTimePickerEvent (dialog object method)</title> <para> To connect event notifications from a DTP control use the connectDateTimePickerEvent (<xref linkend="mthConnectDateTimePickerEvent" />) method of the dialog (<xref @@ -1026,7 +1028,7 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - The return is a handle (<xref linkend="defHandle"/>) to the font, the same return as the getFont (<xref + The return is a <xref linkend="defHandle"/> to the font, the same return as the getFont (<xref linkend="mthGetFont" />) or <xref linkend="mthCreateFontEx"/> methods of the dialog (<xref linkend="chpDialogObject" />) object would return. </para> Modified: docs/trunk/publican/oodialog/en-US/deprecated.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-09-01 20:59:10 UTC (rev 8345) +++ docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-09-02 02:46:35 UTC (rev 8346) @@ -1714,7 +1714,7 @@ methods. To control a window not owned by your program use the <emphasis role="italic">find</emphasis>() method of the <emphasis role="italic">WindowsManager</emphasis> class. The <emphasis role="italic">WindowsManager</emphasis>is part of the <emphasis role="italic">WinSystm.cls</emphasis> package. In certain cases it may be desirable to invoke a - method common to all windows when only the window handle (<xref linkend="defHandle"/>) is known. For these cases + method common to all windows when only the window <xref linkend="defHandle"/> is known. For these cases use a <xref linkend="clsWindow"/> object. </para> </section> Modified: docs/trunk/publican/oodialog/en-US/dialogControlObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-09-01 20:59:10 UTC (rev 8345) +++ docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-09-02 02:46:35 UTC (rev 8346) @@ -597,7 +597,7 @@ </programlisting> <para> - The <emphasis role="italic">hDlg</emphasis> attribute reflects the window handle (<xref linkend="defHandle"/>) of + The <emphasis role="italic">hDlg</emphasis> attribute reflects the window <xref linkend="defHandle"/> of the <xref linkend="ovvUnderlying"/> Windows dialog that this dialog control belongs to. </para> <variablelist> @@ -884,7 +884,7 @@ Raises syntax errors when incorrect arguments are detected. </para> <para> - Sets the <xref linkend="dotSystemErrorCode"/> variable. + Sets the <xref linkend="dotSystemErrorCode"/>. </para> </listitem></varlistentry> </variablelist> @@ -2256,7 +2256,7 @@ Raises syntax errors when incorrect arguments are detected. </para> <para> - Sets the <xref linkend="dotSystemErrorCode"/> variable. + Sets the <xref linkend="dotSystemErrorCode"/>. </para> </listitem></varlistentry> </variablelist> @@ -2433,7 +2433,7 @@ Raises syntax errors when incorrect arguments are detected. </para> <para> - Sets the <xref linkend="dotSystemErrorCode"/> variable. + Sets the <xref linkend="dotSystemErrorCode"/>. </para> </listitem></varlistentry> </variablelist> @@ -2672,7 +2672,7 @@ Raises syntax errors when incorrect arguments are detected. </para> <para> - Sets the <xref linkend="dotSystemErrorCode"/> variable. + Sets the <xref linkend="dotSystemErrorCode"/>. </para> </listitem></varlistentry> </variablelist> @@ -2731,7 +2731,7 @@ Raises syntax errors when |
From: <mie...@us...> - 2012-09-02 05:06:45
|
Revision: 8349 http://sourceforge.net/p/oorexx/code-0/8349 Author: miesfeld Date: 2012-09-02 05:06:41 +0000 (Sun, 02 Sep 2012) Log Message: ----------- Work on Publican ooDialog docs Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/datetimepicker.xml docs/trunk/publican/oodialog/en-US/deprecated.xml docs/trunk/publican/oodialog/en-US/dialogControlObject.xml docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/dialogObject.xml docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/menus.xml docs/trunk/publican/oodialog/en-US/mouse.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/propertySheetDialogs.xml docs/trunk/publican/oodialog/en-US/userInput.xml docs/trunk/publican/oodialog/en-US/userdialog.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml docs/trunk/publican/oodialog/en-US/windowBase.xml docs/trunk/publican/oodialog/en-US/windowExtensions.xml Modified: docs/trunk/publican/oodialog/en-US/datetimepicker.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/datetimepicker.xml 2012-09-02 03:05:25 UTC (rev 8348) +++ docs/trunk/publican/oodialog/en-US/datetimepicker.xml 2012-09-02 05:06:41 UTC (rev 8349) @@ -78,8 +78,8 @@ <varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term> <listitem> <para> - Use the <xref linkend="mthNewDateTimePicker"/> method of the dialog (<xref - linkend="chpDialogObject" />) to retrieve a date and time picker object. + Use the <xref linkend="mthNewDateTimePicker"/> method of the <xref linkend="chpDialogObject" /> to retrieve a date and + time picker object. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Dynamic Definition:</emphasis></term> @@ -92,8 +92,7 @@ <varlistentry><term><emphasis role="bold">Event Notification</emphasis></term> <listitem> <para> - To receive notification of date and time picker events use the connectDataTimePickerEvent (<xref - linkend="mthConnectDateTimePickerEvent" />) method. + To receive notification of date and time picker events use the <xref linkend="mthConnectDateTimePickerEvent"/> method. </para> </listitem></varlistentry> </variablelist> @@ -284,19 +283,17 @@ <section id="sctDTPCallback"><title>Callback Fields</title> <para> - The date and time picker control supports <emphasis role="italic">call back fields</emphasis> within the format (<xref - linkend="sctDTPFormatStrings" />) strings. The call back fields allow the programmer to display custom + The date and time picker control supports <emphasis role="italic">call back fields</emphasis> within the + <link linkend="sctDTPFormatStrings">format</link> strings. The call back fields allow the programmer to display custom information at the point of the call back field by allowing the control to query the application for information. For instance, the control can query the application for what text to display in the call back field or the maximum length the display text in a field will be. </para> <para> The queries are done through <xref linkend="ovvEvents"/> notification messages from the control. - Specifically, the FORMAT and FORMATQUERY events connected using the connectDataTimePickerEvent (<xref - linkend="mthConnectDateTimePickerEvent" />). The programmer must respond to the event - notification to ensure that the custom information is displayed properly. The response comes from the FORMAT (<xref - linkend="evtDateTimePickerFORMAT" />) and FORMATQUERY (<xref linkend="evtDateTimePickerFORMATQUERY"/>) - event handlers. + Specifically, the FORMAT and FORMATQUERY events connected using the <xref linkend="mthConnectDateTimePickerEvent"/>. The + programmer must respond to the event notification to ensure that the custom information is displayed properly. The response + comes from the <xref linkend="evtDateTimePickerFORMAT"/> and <xref linkend="evtDateTimePickerFORMATQUERY"/> event handlers. </para> <para> Call back fields are declared using one or more capital <emphasis role="bold">X</emphasis> characters (ASCII Code 88) @@ -413,9 +410,8 @@ <section id="tmthNewDateTimePicker" xreflabel="newDateTimePicker"><title>newDateTimePicker (dialog object method)</title> <para> <computeroutput>DateTimePicker</computeroutput> objects can not be instantiated by the programmer from Rexx code using a <emphasis - role="italic">new</emphasis>() method. Rather, a date and time picker object is obtained by using the newDateTimePicker (<xref - linkend="mthNewDateTimePicker" />) method of the <xref linkend="chpDialogObject"/> - object. The syntax is: + role="italic">new</emphasis>() method. Rather, a date and time picker object is obtained by using the <xref + linkend="mthNewDateTimePicker"/> method of the <xref linkend="chpDialogObject"/> object. The syntax is: <programlisting> <![CDATA[ >>-newDateTimePicker(--id--)--------------------->< @@ -429,10 +425,11 @@ <section id="tmthCreateDateTimePicker" xreflabel="createDateTimePicker"> <title>createDateTimePicker (UserDialog method)</title> <para> - A date and time picker control can be added to the dialog template of a UserDialog (<xref - linkend="clsUserDialog" />) through the createDateTimePicker (<xref - linkend="mthCreateDateTimePicker" />) method. The basic syntax is: -<programlisting> <![CDATA[ + A date and time picker control can be added to the dialog template of a <xref linkend="clsUserDialog" />) through the + <xref linkend="mthCreateDateTimePicker"/> method. The basic syntax is: + +<programlisting> +<![CDATA[ >>-createDateTimePicker(-id-,--x-,--y-,--cx-,--cy-+----------+-+-------------+-->< +-,--style-+ +-,--attrName-+ @@ -445,11 +442,11 @@ <section id="tmthConnectDateTimePickerEvent" xreflabel="connectDateTimePickerEvent"> <title>connectDateTimePickerEvent (dialog object method)</title> <para> - To connect event notifications from a DTP control use the connectDateTimePickerEvent (<xref - linkend="mthConnectDateTimePickerEvent" />) method of the dialog (<xref - linkend="chpDialogObject" />) object. The basic syntax is: + To connect event notifications from a DTP control use the <xref linkend="mthConnectDateTimePickerEvent"/> method of the + <xref linkend="chpDialogObject"/> object. The basic syntax is: -<programlisting> <![CDATA[ +<programlisting> +<![CDATA[ >>--connectDateTimePickerEvent(--id-,-evt--+----------+-+------------+-)------>< +-,--mName-+ +-,-wilReply-+ @@ -489,14 +486,13 @@ <listitem> <para> This method causes the date time picker to destroy the month calendar control and to send the DTN_CLOSEUP - notification (the CLOSEUP (<xref linkend="evtDateTimePickerCLOSEUP"/>) event notification) that the drop-down has - been closed. + notification (the <xref linkend="evtDateTimePickerCLOSEUP"/> event notification) that the drop-down has been closed. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> <para> - Requires Windows Vista (<xref linkend="ovvRequiredWindows"/>) or later. + <xref linkend="ovvRequiredWindows"/> Windows Vista or later. </para> </listitem></varlistentry> </variablelist> @@ -595,7 +591,7 @@ <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> <para> - Requires Windows Vista (<xref linkend="ovvRequiredWindows"/>) or later. + <xref linkend="ovvRequiredWindows"/> Windows Vista or later. </para> <para> Raises syntax errors when incorrect usage is detected. @@ -735,7 +731,7 @@ <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> <para> - Requires Windows Vista (<xref linkend="ovvRequiredWindows"/>) or later. + <xref linkend="ovvRequiredWindows"/> Windows Vista or later. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> @@ -840,22 +836,19 @@ <listitem> <para> <emphasis role="bold">Note:</emphasis> The following information mostly applies to Windows XP and earlier. For - Windows Vista and later the date and time picker control has the setMonthCalStyle (<xref - linkend="mthSetMonthCalStyle" />) and getMonthCalStyle (<xref - linkend="mthGetMonthCalStyle" />) methods to directly manipulate the month calendar control's - styles. + Windows Vista and later the date and time picker control has the <xref linkend="mthSetMonthCalStyle"/> and + <xref linkend="mthGetMonthCalStyle"/> methods to directly manipulate the month calendar control's styles. </para> <para> Obtaining the month calendar control allows the programmer to change its style or appearance. For instance the - <xref linkend="mthSetFirstDayOfWeek"/> day of the week could be changed or the <emphasis + <xref linkend="mthSetFirstDayOfWeek"/> day of the week could be changed or the <emphasis role="italic">Go To Today</emphasis> could be removed by setting the NOTODAY style. </para> <para> DTP controls do not create a static month calendar control. Rather, they create the month calendar when needed and - destroy the month calendar as soon as it is not needed. The DROPDOWN (<xref - linkend="evtDateTimePickerDROPDOWN" />) notification is sent after the DTP creates the month calendar - and the CLOSEUP (<xref linkend="evtDateTimePickerCLOSEUP"/>) notification is sent when the month calendar is - destroyed. + destroy the month calendar as soon as it is not needed. The <xref linkend="evtDateTimePickerDROPDOWN"/> notification is + sent after the DTP creates the month calendar and the <xref linkend="evtDateTimePickerCLOSEUP"/> notification is sent + when the month calendar is destroyed. </para> <para> After the underlying month calendar control is destroyed, Rexx month calendar object is no longer valid. @@ -866,9 +859,8 @@ <para> This example will work on any version of Windows that ooDialog supports. It gets the month calendar for the DTP control and changes the first day of the week to Friday. The <emphasis role="italic">Today</emphasis> selection is - also removed. This is an example of a DROPDOWN (<xref linkend="evtDateTimePickerDROPDOWN"/>) event handler. Note - that no reference is kept for the month calendar. The object will be invalid as soon as the user closes the drop - down: + also removed. This is an example of a <xref linkend="evtDateTimePickerDROPDOWN"/> event handler. Note that no reference + is kept for the month calendar. The object will be invalid as soon as the user closes the drop down: <programlisting> <![CDATA[ @@ -978,9 +970,8 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - This method is essentially the same as the <xref linkend="mthGetColor"/> method of the Month Calendar (<xref - linkend="clsMonthCalendar" />) class, except that DTP control is asked to get the color from its - child month calendar. + This method is essentially the same as the <xref linkend="mthGetColor"/> method of the <xref linkend="clsMonthCalendar"/> + class, except that DTP control is asked to get the color from its child month calendar. </para> <para> The <xref linkend="clsImage"/> class has a number of convenience methods for working with COLORREFs, @@ -1028,11 +1019,9 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - The return is a <xref linkend="defHandle"/> to the font, the same return as the getFont (<xref - linkend="mthGetFont" />) or <xref linkend="mthCreateFontEx"/> methods of the dialog (<xref - linkend="chpDialogObject" />) object would return. - </para> - </listitem></varlistentry> + The return is a <xref linkend="defHandle"/> to the font, the same return as the <xref linkend="mthGetFont"/> or <xref + linkend="mthCreateFontEx"/> methods of the <xref linkend="chpDialogObject"/> object would return. + </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> @@ -1147,7 +1136,7 @@ <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> <para> - This method requires Windows Vista (<xref linkend="ovvRequiredWindows"/>) or later. + <xref linkend="ovvRequiredWindows"/> Windows Vista or later. </para> </listitem></varlistentry> <varlistentry id="exampleGetMonthCalStyle"><term><emphasis role="bold">Example:</emphasis></term> @@ -1158,8 +1147,8 @@ styles set. </para> <para> - For an expanded version of this example, see the example (<xref linkend="exampleSetMonthCalStyle"/>) for the - <xref linkend="mthSetMonthCalStyle"/> method. + For an expanded version of this example, see the <link linkend="exampleSetMonthCalStyle">example</link> for the + <xref linkend="mthSetMonthCalStyle"/> method. <programlisting> <![CDATA[ @@ -1406,8 +1395,8 @@ </programlisting> <para> - Sets the display of a date and time picker (DTP) control based the specified format (<xref - linkend="sctDTPFormatStrings" />) string. + Sets the display of a date and time picker (DTP) control based the specified <link + linkend="sctDTPFormatStrings">format</link> string. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1418,8 +1407,8 @@ <varlistentry><term>format [required]</term> <listitem> <para> - A format (<xref linkend="sctDTPFormatStrings"/>) string that dictates how the DTP control formats the data and - time in its display. + A <link linkend="sctDTPFormatStrings">format</link> string that dictates how the DTP control formats the data and time + in its display. </para> </listitem></varlistentry> </variablelist> @@ -1750,7 +1739,7 @@ <listitem> <para> This example is a stand-alone program. It is a slightly expanded version of the <emphasis - role="italic">getMonthCalStyle</emphasis> example (<xref linkend="exampleGetMonthCalStyle"/>). + role="italic">getMonthCalStyle</emphasis> <link linkend="exampleGetMonthCalStyle">example</link>. <programlisting> <![CDATA[ Modified: docs/trunk/publican/oodialog/en-US/deprecated.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-09-02 03:05:25 UTC (rev 8348) +++ docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-09-02 05:06:41 UTC (rev 8349) @@ -134,7 +134,7 @@ </para> <para> Use the <xref linkend="clsPropertySheetDialog"/>, or a <xref linkend="clsTab"/> - control with one of the Control (<xref linkend="sctControlDialogs"/>) dialog classes, to replace the + control with one of the <xref linkend="sctControlDialogs"/> dialog classes, to replace the <computeroutput>CategoryDialog</computeroutput> class. </para> </section> @@ -150,7 +150,7 @@ </para> <para> Use the <xref linkend="clsPropertySheetDialog"/>, or a <xref linkend="clsTab"/> - control with one of the Control (<xref linkend="sctControlDialogs"/>) dialog classes, to replace the + control with one of the <xref linkend="sctControlDialogs"/> dialog classes, to replace the <computeroutput>PropertySheet</computeroutput> class. </para> </section> @@ -161,8 +161,7 @@ <section id="deprecatedDialogMethods"><title>Deprecated Dialog Methods</title> <indexterm><primary>Deprecated</primary><secondary>dialog object methods</secondary></indexterm> <para> - Deprecated (<xref linkend="apxDeprecated"/>) dialog methods and their replacement methods are listed in this - section. + <link linkend="apxDeprecated">Deprecated</link> dialog methods and their replacement methods are listed in this section. </para> <section><title>captureMouse</title> @@ -174,7 +173,7 @@ <section><title>checkMenuItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> @@ -273,7 +272,7 @@ <section><title>disableMenuItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> @@ -296,7 +295,7 @@ <section><title>enableMenuItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> @@ -415,7 +414,7 @@ <section><title>getMenuItemState</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> @@ -519,7 +518,7 @@ <section><title>grayMenuItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> @@ -640,7 +639,7 @@ <section><title>setMenuItemRadio</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> @@ -796,39 +795,31 @@ <section><title>removeImages</title> <para> - This method is deprecated. It is replaced by the functionally equivalent setImageList() (<xref - linkend="mthSetImageListClsListView" />) method. Do not use this method in new - code. Try to migrate existing code to to the <computeroutput>setImageList()</computeroutput> method. - This method may not exist in future versions of ooDialog. -</para> -</section> + This method is deprecated. It is replaced by the functionally equivalent <xref linkend="mthSetImageListClsListView"/> + method. Do not use this method in new code. Try to migrate existing code to to the + <computeroutput>setImageList()</computeroutput> method. This method may not exist in future versions of ooDialog. +</para> </section> <section><title>removeSmallImages</title> <para> - This method is deprecated. It is replaced by the functionally equivalent setImageList() (<xref - linkend="mthSetImageListClsListView" />) method. Do not use this method in new - code. Try to migrate existing code to to the <computeroutput>setImageList()</computeroutput> method. - This method may not exist in future versions of ooDialog. -</para> -</section> + This method is deprecated. It is replaced by the functionally equivalent <xref linkend="mthSetImageListClsListView"/> + method. Do not use this method in new code. Try to migrate existing code to to the + <computeroutput>setImageList()</computeroutput> method. This method may not exist in future versions of ooDialog. +</para> </section> <section><title>setImages</title> <para> - This method is deprecated. It is replaced by the functionally equivalent setImageList() (<xref - linkend="mthSetImageListClsListView" />) method. Do not use this method in new - code. Try to migrate existing code to to the <computeroutput>setImageList()</computeroutput> method. - This method may not exist in future versions of ooDialog. -</para> -</section> + This method is deprecated. It is replaced by the functionally equivalent <xref linkend="mthSetImageListClsListView"/> + method. Do not use this method in new code. Try to migrate existing code to to the + <computeroutput>setImageList()</computeroutput> method. This method may not exist in future versions of ooDialog. +</para> </section> <section><title>setSmallImages</title> <para> - This method is deprecated. It is replaced by the functionally equivalent setImageList() (<xref - linkend="mthSetImageListClsListView" />) method. Do not use this method in new - code. Try to migrate existing code to to the <computeroutput>setImageList()</computeroutput> method. - This method may not exist in future versions of ooDialog. -</para> -</section> + This method is deprecated. It is replaced by the functionally equivalent <xref linkend="mthSetImageListClsListView"/> + method. Do not use this method in new code. Try to migrate existing code to to the + <computeroutput>setImageList()</computeroutput> method. This method may not exist in future versions of ooDialog. +</para> </section> </section> <!-- End Deprecated TreeView Methods Section --> @@ -884,21 +875,17 @@ <section><title>removeImages</title> <para> - This method is deprecated. It is replaced by the functionally equivalent setImageList() (<xref - linkend="mthSetImageListClsTabControl" />) method. Do not use this method in new code. Try to - migrate existing code to to the <computeroutput>setImageList()</computeroutput> method. This method may not exist in - future versions of ooDialog. -</para> -</section> + This method is deprecated. It is replaced by the functionally equivalent <xref linkend="mthSetImageListClsTabControl"/> + method. Do not use this method in new code. Try to migrate existing code to to the + <computeroutput>setImageList()</computeroutput> method. This method may not exist in future versions of ooDialog. +</para> </section> <section><title>setImages</title> <para> - This method is deprecated. It is replaced by the functionally equivalent setImageList() (<xref - linkend="mthSetImageListClsTabControl" />) method. Do not use this method in new code. Try to - migrate existing code to to the <computeroutput>setImageList()</computeroutput> method. This method may not exist in - future versions of ooDialog. -</para> -</section> + This method is deprecated. It is replaced by the functionally equivalent <xref linkend="mthSetImageListClsTabControl"/> + method. Do not use this method in new code. Try to migrate existing code to to the + <computeroutput>setImageList()</computeroutput> method. This method may not exist in future versions of ooDialog. +</para> </section> </section> <!-- End Deprecated Tab Methods Section --> @@ -911,21 +898,17 @@ <section><title>removeImages</title> <para> - This method is deprecated. It is replaced by the functionally equivalent setImageList() (<xref - linkend="mthSetImageListClsTreeView" />) method. Do not use this method in new - code. Try to migrate existing code to to the <computeroutput>setImageList()</computeroutput> method. - This method may not exist in future versions of ooDialog. -</para> -</section> + This method is deprecated. It is replaced by the functionally equivalent <xref linkend="mthSetImageListClsTreeView"/> + method. Do not use this method in new code. Try to migrate existing code to to the + <computeroutput>setImageList()</computeroutput> method. This method may not exist in future versions of ooDialog. +</para> </section> <section><title>setImages</title> <para> - This method is deprecated. It is replaced by the functionally equivalent setImageList() (<xref - linkend="mthSetImageListClsTreeView" />) method. Do not use this method in new - code. Try to migrate existing code to to the <computeroutput>setImageList()</computeroutput> method. - This method may not exist in future versions of ooDialog. -</para> -</section> + This method is deprecated. It is replaced by the functionally equivalent <xref linkend="mthSetImageListClsTreeView"/> + method. Do not use this method in new code. Try to migrate existing code to to the + <computeroutput>setImageList()</computeroutput> method. This method may not exist in future versions of ooDialog. +</para> </section> </section> <!-- End Deprecated TreeView Methods Section --> @@ -1149,7 +1132,7 @@ <section><title>connectMenuItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) object + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> @@ -1532,14 +1515,14 @@ <section><title>addMenuItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> <section><title>addMenuSeparator</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> @@ -1581,7 +1564,7 @@ <section><title>addPopupMenu</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> @@ -1672,14 +1655,14 @@ <section><title>createMenu</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> <section><title>loadMenu</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu (<xref linkend="chpMenus"/>) + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. </para> </section> Modified: docs/trunk/publican/oodialog/en-US/dialogControlObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-09-02 03:05:25 UTC (rev 8348) +++ docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-09-02 05:06:41 UTC (rev 8349) @@ -47,8 +47,8 @@ <indexterm><primary>dialog control object</primary></indexterm> <indexterm><primary>dialog control object</primary></indexterm> <para> - This chapter discussses the <emphasis role="italic">dialog control object</emphasis> in a fashion similar to the dialog object (<xref - linkend="chpDialogObject" />(. It lists the methods that are common to all dialog controls. In the + This chapter discussses the <emphasis role="italic">dialog control object</emphasis> in a fashion similar to the <xref + linkend="chpDialogObject"/> object. It lists the methods that are common to all dialog controls. In the graphical user interface (GUI) for the Windows operating system both dialogs and dialog controls are windows. Therefore, many of the methods of a dialog control object are the same as the methods of the dialog object. These are the methods that are common to all windows, whether they are dialog windows or dialog control windows. @@ -200,7 +200,7 @@ <entry>Retrievs the <emphasis role="italic">data</emphasis> (the value) of the underlying control's state.</entry> </row> <row> -<entry>data= (<xref linkend="mthDataEquals"/>)</entry> +<entry><xref linkend="mthDataEquals"/></entry> <entry>Sets the state of the underlying dialog control to the <emphasis role="italic">data</emphasis> (the value) specified.</entry> </row> <row> @@ -508,7 +508,7 @@ <entry>Gets the text of the control.</entry> </row> <row> -<entry>title= (<xref linkend="wbdcoTitleEquals"/>)</entry> +<entry><xref linkend="wbdcoTitleEquals"/></entry> <entry>Sets the text of the control.</entry> </row> <row> @@ -649,20 +649,17 @@ <varlistentry><term><emphasis role="bold">id get:</emphasis></term> <listitem> <para> - Returns the resource ID of the dialog control. This is always the whole number resource ID, not the symbolic (<xref - linkend="defSymbolicId" />) ID, even if symbolic IDs are used for the control. + Returns the resource ID of the dialog control. This is always the whole number resource ID, not the <xref + linkend="defSymbolicId" />) ID, even if symbolic IDs are used for the control. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">id set:</emphasis></term> <listitem> <para> - The programmer can not set the value of this attribute. Its value is the value of the underlying (<xref - linkend="ovvUnderlying" />) dialog control's ID, which is set when the dialog control is created by - the operating system and can not be changed. - </para> - </listitem></varlistentry> -</variablelist> -</section> <!-- End DialogControl::id() [attribute] --> + The programmer can not set the value of this attribute. Its value is the value of the <xref linkend="ovvUnderlying"/> + dialog control's ID, which is set when the dialog control is created by the operating system and can not be changed. + </para> </listitem></varlistentry> +</variablelist> </section> <!-- End DialogControl::id() [attribute] --> <section id="wbdcoInitCode"><title>initCode (Attribute)</title> @@ -860,7 +857,7 @@ <xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner. </para> <para> - The coordinates are specified as <xref linkend="defClientArea"/> area coordinates, in pixels. + The coordinates are specified as <xref linkend="defClientArea"/> coordinates, in pixels. </para> </listitem></varlistentry> </variablelist> @@ -932,10 +929,9 @@ <para> The operating system translates the numeric <xref linkend="clsVK"/> key code produced by a key down / key up combination into a numeric <emphasis role="italic">character</emphasis> code. The character code is sent to - the window with the keyboard focus in a character event notification. For enhanced 101-key and 102-key keyboards, - the character (<xref linkend="evtDialogControlCHAR"/>) event handler will also receive extended key - notifications. The extended keys are the INS, DEL, HOME, END, PAGE UP, PAGE DOWN and the arrow keys in the clusters - to the left of the numeric keypad. + the window with the keyboard focus in a character event notification. For enhanced 101-key and 102-key keyboards, the + <xref linkend="evtDialogControlCHAR"/> event handler will also receive extended key notifications. The extended keys are + the INS, DEL, HOME, END, PAGE UP, PAGE DOWN and the arrow keys in the clusters to the left of the numeric keypad. </para> <para> There is not a one to one correspondence between the numeric value of a virtual key code and the numeric character @@ -944,9 +940,8 @@ <computeroutput>45~d2c == -</computeroutput>. </para> <para> - The character codes expected to reach the character (<xref linkend="evtDialogControlCHAR"/>) event handler are in - the following table. The explanation for the character event handler describes how to determine which character is - received. + The character codes expected to reach the <xref linkend="evtDialogControlCHAR"/> event handler are in the following + table. The explanation for the character event handler describes how to determine which character is received. <table id="tblCharacterCode" frame="all"> <title>Numeric Character Code for the Character Event</title> <tgroup cols="2"> @@ -1054,13 +1049,13 @@ <indexterm><primary>dialog control object Event</primary><secondary>CHAR</secondary></indexterm> <para> The <xref linkend="ovvEvents"/> handler for the char event is invoked when the dialog control has the - keyboard focus and the user types a key or a keyboard combination that the operating system translates to a character (<xref - linkend="rmkConnectCharEvent" />). + keyboard focus and the user types a key or a keyboard combination that the operating system translates to a + <link linkend="rmkConnectCharEvent">character</link>. </para> <para> The programmer must return a value from the event handler and the interpreter waits for this return. Generic - information on how to code (<xref linkend="sctCodingEventHandlers"/>) event handlers is included in the - documentation for the EventNotification (<xref linkend="clsEventNotification"/>( class. + information on how to <link linkend="sctCodingEventHandlers">code</link>) event handlers is included in the + documentation for the <xref linkend="clsEventNotification"/> class. </para> <programlisting> @@ -1091,7 +1086,7 @@ <para> To determine the character received use <computeroutput>char~d2c</computeroutput> when <emphasis role="italic">isCtrl</emphasis> is false and <emphasis role="italic">misc</emphasis> does <emphasis - role="italic">not</emphasis> contain the word <emphasis role="italic">extended</emphasis>. Use the VK (<xref + role="italic">not</emphasis> contain the word <emphasis role="italic">extended</emphasis>. Use the <xref linkend="clsVK" />) class when <emphasis role="italic">isCtrl</emphasis> is false and <emphasis role="italic">misc</emphasis> contains the word <emphasis role="italic">extended</emphasis>. </para> @@ -1325,8 +1320,8 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - The <emphasis role="italic">connectFKeyPress</emphasis> method is a convenience method for the connectKeyPress (<xref - linkend="mthConnectKeyPressDialogControlObject" />) method. It is equivalent to using the + The <emphasis role="italic">connectFKeyPress</emphasis> method is a convenience method for the <xref + linkend="mthConnectKeyPressDialogControlObject"/> method. It is equivalent to using the <emphasis role="italic">connectKeyPress</emphasis> method and supplying the FKEYS keyword for the <emphasis role="italic">keys</emphasis> argument and omitting the <emphasis role="italic">filter</emphasis> argument. The <emphasis role="italic">connectKeyPress</emphasis> method documentation goes into deeper detail in explaining how @@ -1406,8 +1401,8 @@ </programlisting> <para> - The <emphasis role="italic">connectKeyPress</emphasis> method connects a key press event (<xref - linkend="ovvEvents" />) notification with a method in the Rexx dialog. A single key or multiple keys can be + The <emphasis role="italic">connectKeyPress</emphasis> method connects a key press <xref linkend="ovvEvents"/> + notification with a method in the Rexx dialog. A single key or multiple keys can be connected to the same method. Multiple methods can be connected for key press events, but only 1 method can be connected to any single key. </para> @@ -1451,8 +1446,8 @@ <varlistentry><term>FKEYS</term> <listitem> <para> - All Function keys, other than F1. (In Windows the F1 key is the help key and the connectHelp (<xref - linkend="mthConnectHelp" />) method should be used for F1.) + All Function keys, other than F1. (In Windows the F1 key is the help key and the <xref + linkend="mthConnectHelp"/> method should be used for F1.) </para> </listitem></varlistentry> <varlistentry><term>ALPHA</term> @@ -1815,8 +1810,8 @@ </programlisting> <para> - The <emphasis role="italic">data</emphasis> method retrieves the current data (<xref - linkend="sctUnderstandingDataAttributes" />) of the dialog control. + The <emphasis role="italic">data</emphasis> method retrieves the current + <link linkend="sctUnderstandingDataAttributes">data</link> of the dialog control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1829,9 +1824,9 @@ <listitem> <para> The current <emphasis role="italic">data</emphasis> of the dialog control. Exactly what the format of the <emphasis - role="italic">data</emphasis> takes is dependent on the type of the control. The Data Attribute Methods (<xref - linkend="sctDataAttributes" />) section of this reference has a detailed discussion on - data attributes and the meaning of the <emphasis role="italic">data</emphasis> of a dialog control. + role="italic">data</emphasis> takes is dependent on the type of the control. The Data Attribute Methods + <link linkend="sctDataAttributes">xection</link> of this reference has a detailed discussion on data attributes and the + meaning of the <emphasis role="italic">data</emphasis> of a dialog control. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> @@ -1913,7 +1908,7 @@ </programlisting> <para> - Sets the data (<xref linkend="sctUnderstandingDataAttributes"/>) of the dialog control to the new value specified. + Sets the <link linkend="sctUnderstandingDataAttributes">data</link> of the dialog control to the new value specified. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1923,9 +1918,9 @@ <listitem> <para> The value used to set the <emphasis role="italic">data</emphasis> of the dialog control. The exact format of this - value is dependent on the type of the control. The Data Attribute Methods (<xref linkend="sctDataAttributes"/>) - section of this reference has a detailed discussion on data attributes and the meaning of the <emphasis - role="italic">data</emphasis> of a dialog control. + value is dependent on the type of the control. The Data Attribute Methods <link + linkend="sctDataAttributes">section</link> of this reference has a detailed discussion on data attributes and the + meaning of the <emphasis role="italic">data</emphasis> of a dialog control. </para> </listitem></varlistentry> </variablelist> @@ -2040,9 +2035,8 @@ The method of the dialog control object (this method) can only disconnect key press events that were set with the dialog control object's versions of <xref linkend="mthConnectKeyPressDialogControlObject"/> and <xref linkend="mthConnectFKeyPressDialogControlObject"/> methods. This method can not - disconnect key press events that were set with the dialog object's versions of connectKeyPress (<xref - linkend="mthConnectKeyPressDialogObject" />) and connectFKeyPress (<xref - linkend="mthConnectFKeyPressDialogObject" />) methods. + disconnect key press events that were set with the dialog object's versions of <xref + linkend="mthConnectKeyPressDialogObject"/> and <xref linkend="mthConnectFKeyPressDialogObject"/> methods. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -2096,7 +2090,7 @@ </programlisting> <para> - Calculates the size, (width and height,) in dialog units (<xref linkend="defDialogUnit"/>) for a given string. + Calculates the size, (width and height,) in <xref linkend="defDialogUnit"/> for a given string. </para> <para> <emphasis role="bold">Note:</emphasis> The convoluted arguments to this method are needed to retain backwards @@ -2111,8 +2105,8 @@ make much sense for this method to be a method of a dialog control in the first place. </para> <para> - The ooDialog programmer is therefore <emphasis role="bold">strongly</emphasis> encouraged to use the getTextSizeDu (<xref - linkend="mthGetTextSizeDu" />) method of the <xref linkend="chpDialogObject"/> object. + The ooDialog programmer is therefore <emphasis role="bold">strongly</emphasis> encouraged to use the <xref + linkend="mthGetTextSizeDu"/> method of the <xref linkend="chpDialogObject"/> object. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2244,8 +2238,8 @@ navigation depending on the options the user selects. </para> <para> - The negative return value from this method is a hold over from a period prior to the introduction of the .systemErrorCode (<xref - linkend="dotSystemErrorCode" />). This method now sets the + The negative return value from this method is a hold over from a period prior to the introduction of the <xref + linkend="dotSystemErrorCode"/>. This method now sets the <computeroutput>.systemErrorCode</computeroutput>, making it easier to use the negative return as a failure indication and use the <computeroutput>.systemErrorCode</computeroutput> value to look up the actual error. </para> @@ -2308,10 +2302,9 @@ The dialog object also has a <xref linkend="mthHasKeyPressConnectionDialogObject"/> method. The method of the dialog control object (this method) can only check for connections that were set with the dialog control object's versions of <xref linkend="mthConnectKeyPressDialogControlObject"/> and - connectFKeyPress (<xref linkend="mthConnectFKeyPressDialogControlObject"/> methods. This method can not check - for connections that were set with the dialog object's versions of connectKeyPress (<xref - linkend="mthConnectKeyPressDialogObject" />) and connectFKeyPress (<xref - linkend="mthConnectFKeyPressDialogObject" />) methods. + <xref linkend="mthConnectFKeyPressDialogControlObject"/> methods. This method can not check + for connections that were set with the dialog object's versions of <xref linkend="mthConnectKeyPressDialogObject"/> and + <xref linkend="mthConnectFKeyPressDialogObject"/> methods. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> @@ -2382,9 +2375,9 @@ </programlisting> <para> - The <emphasis role="italic">redrawRect</emphasis> method redraws the specified bounding (<xref - linkend="ovvRectangleCoordinates" />) rectangular within the client area of this dialog control. - Optionally the background of the rectangle can be erased first. + The <emphasis role="italic">redrawRect</emphasis> method redraws the specified + <link linkend="ovvRectangleCoordinates">bounding</link> rectangle within the client area of this dialog control. Optionally + the background of the rectangle can be erased first. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2397,10 +2390,10 @@ <para> The coordinates of the rectangle to be redrawn. The coordinates specify the upper left and lower right corners of the rectangle. The corners can be specified using either a <xref linkend="clsRect"/> object, two - <xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner. + <xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner. </para> <para> - The coordinates are specified as <xref linkend="defClientArea"/> area coordinates, in pixels. + The coordinates are specified as <xref linkend="defClientArea"/> coordinates, in pixels. </para> </listitem></varlistentry> <varlistentry><term>erase [optional]</term> @@ -2463,13 +2456,13 @@ <varlistentry><term>bk [required]</term> <listitem> <para> - The color number (<xref linkend="defColor"/>) for the background color of the dialog control. + The <xref linkend="defColor"/> for the background color of the dialog control. </para> </listitem></varlistentry> <varlistentry><term>fg [optional]</term> <listitem> <para> - The color number (<xref linkend="defColor"/>) for the foreground color of the dialog control. The foreground + The <xref linkend="defColor"/> for the foreground color of the dialog control. The foreground color is the color that text is written in. </para> </listitem></varlistentry> @@ -2522,8 +2515,8 @@ </programlisting> <para> - Sets the background color, and optionally the text color, for this dialog control using the system colors (<xref - linkend="defSysColor" />). + Sets the background color, and optionally the text color, for this dialog control using the system + <link linkend="defSysColor">colors</link>. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2535,7 +2528,7 @@ <listitem> <para> The system color ID for the background color of the dialog control. This can be either the whole number ID or - the keyword ID. IDs can be looked up in the System Color Elements table (<xref linkend="tblSysColors"/>) + the keyword ID. IDs can be looked up in the System Color Elements (<link linkend="tblSysColors">table</link> </para> </listitem></varlistentry> <varlistentry><term>fg [optional]</term> @@ -2543,7 +2536,7 @@ <para> The system color for the foreground color of the dialog control. The foreground color is the color that text is written in. This can be either the whole number ID or the keyword ID. IDs can be looked up in the System Color - Elements table (<xref linkend="tblSysColors"/>). + Elements <link linkend="tblSysColors">table</link>. </para> </listitem></varlistentry> </variablelist> @@ -2597,7 +2590,7 @@ </programlisting> <para> - Add or remove the tab stop style (<xref linkend="wstabstop"/>) for this control. + Add or remove the <xref linkend="wstabstop"/> style for this control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2660,8 +2653,8 @@ execution of a dialog allows the programmer to alter how the user navigates through the dialog controls. </para> <para> - The negative return value from this method is a hold over from a period prior to the introduction of the .systemErrorCode (<xref - linkend="dotSystemErrorCode" />). This method now sets the + The negative return value from this method is a hold over from a period prior to the introduction of the <xref + linkend="dotSystemErrorCode"/>. This method now sets the <computeroutput>.systemErrorCode</computeroutput>, making it easier to use the negative return as a failure indication and use the <computeroutput>.systemErrorCode</computeroutput> value to look up the actual error. </para> Modified: docs/trunk/publican/oodialog/en-US/dialogExtensions.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-02 03:05:25 UTC (rev 8348) +++ docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-02 05:06:41 UTC (rev 8349) @@ -621,7 +621,8 @@ </programlisting> <para> - The <emphasis role="italic">clearRect</emphasis> method clears the specified bounding (<xref linkend="ovvRectangleCoordinates"/>) rectangular within the client area of a window. The rectangle is + The <emphasis role="italic">clearRect</emphasis> method clears the specified bounding <xref + linkend="ovvRectangleCoordinates"/> within the client area of a window. The rectangle is <emphasis role="italic">cleared</emphasis> by redrawing it with the background brush set to the typical background color for dialog boxes and three dimensional elements. </para> @@ -645,7 +646,7 @@ <xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner. </para> <para> - The coordinates are specified as <xref linkend="defClientArea"/> area coordinates, in pixels. + The coordinates are specified as <xref linkend="defClientArea"/> coordinates, in pixels. </para> </listitem></varlistentry> </variablelist> @@ -819,7 +820,7 @@ <varlistentry><term>color [optional]</term> <listitem> <para> - The color number (<xref linkend="defColor"/>). When this argument is omitted and <emphasis + The <xref linkend="defColor"/>. When this argument is omitted and <emphasis role="italic">brushSpecifier</emphasis> is used, the color number defaults to 1. </para> </listitem></varlistentry> @@ -1082,7 +1083,7 @@ <para> The <emphasis role="italic">displaceBitmap</emphasis> method sets the position of a bitmap within the - client <xref linkend="defClientArea"/> of a bitmap button. + <xref linkend="defClientArea"/> of a bitmap button. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1186,7 +1187,7 @@ <varlistentry><term>x, y [optional]</term> <listitem> <para> - The client area coordinates (<xref linkend="defScreenCoordinates"/>) where the upper left corner of the + The client area <xref linkend="defScreenCoordinates"/> where the upper left corner of the bitmap is to be drawn, in pixels. The default is (0, 0). </para> </listitem></varlistentry> @@ -1588,7 +1589,7 @@ </programlisting> <para> - Retrieves the position in client coordinates (<xref linkend="defScreenCoordinates"/>) of the upper left corner of a + Retrieves the position in client <xref linkend="defScreenCoordinates"/> of the upper left corner of a bitmap within a bitmap button. </para> <variablelist> @@ -1843,7 +1844,7 @@ </programlisting> <para> - Returns a string containing the client (<xref linkend="defClientArea"/>) coordinates of the bitmap in a bitmap + Returns a string containing the <xref linkend="defClientArea"/> coordinates of the bitmap in a bitmap button. </para> <variablelist> @@ -2983,7 +2984,7 @@ <xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner. </para> <para> - The coordinates are specified as <xref linkend="defClientArea"/> area coordinates, in pixels. + The coordinates are specified as <xref linkend="defClientArea"/> coordinates, in pixels. </para> </listitem></varlistentry> <varlistentry><term>erase [optional]</term> @@ -3242,14 +3243,14 @@ <varlistentry><term>fromX, fromY [required]</term> <listitem> <para> - The starting position, in client coordinates (<xref linkend="defScreenCoordinates"/>), where the upper + The starting position, in client <xref linkend="defScreenCoordinates"/>, where the upper left corner of the bitmap is first drawn. This is specified in pixels. </para> </listitem></varlistentry> <varlistentry><term>toX, toY [required]</term> <listitem> <para> - The ending position, in client coordinates (<xref linkend="defScreenCoordinates"/>), where the upper + The ending position, in client <xref linkend="defScreenCoordinates"/>, where the upper left corner of the bitmap is drawn last. This is specified in pixels. </para> </listitem></varlistentry> @@ -3335,14 +3336,14 @@ <varlistentry><term>xPos, yPos [required]</term> <listitem> <para> - The client area coordinates (<xref linkend="defScreenCoordinates"/>) of the new position for the upper left + The client area <xref linkend="defScreenCoordinates"/> of the new position for the upper left corner of the specified rectangle. The coordinates are specified in pixels. </para> </listitem></varlistentry> <varlistentry><term>lft, top, rght, bttm [required]</term> <listitem> <para> - The client area coordinates (<xref linkend="defScreenCoordinates"/>) of the upper left and bottom right + The client area <xref linkend="defScreenCoordinates"/> of the upper left and bottom right corners of the rectangular area to be moved. The coordinates are specified in pixels. </para> </listitem></varlistentry> @@ -3521,7 +3522,7 @@ <varlistentry><term>displaceY</term> <listitem> <para> - The Y client area coordinate (<xref linkend="defScreenCoordinates"/>) of the text. The default is 0. This + The Y client area <xref linkend="defScreenCoordinates"/> of the text. The default is 0. This argument is used to shift the text down from the top edge of the control, if needed. </para> </listitem></varlistentry> @@ -3733,7 +3734,7 @@ <varlistentry><term>displaceY</term> <listitem> <para> - The Y client area coordinate (<xref linkend="defScreenCoordinates"/>) of the text. The default is 0. This + The Y client area <xref linkend="defScreenCoordinates"/> of the text. The default is 0. This argument is used to shift the text down from the top edge of the window, if needed. </para> </listitem></varlistentry> @@ -3828,7 +3829,7 @@ </programlisting> <para> - Sets the position of the upper left corner of the bitmap within the client <xref linkend="defClientArea"/> + Sets the position of the upper left corner of the bitmap within the <xref linkend="defClientArea"/> of a bitmap button. </para> <variablelist> @@ -3938,13 +3939,13 @@ <varlistentry><term>bk [required]</term> <listitem> <para> - The color number (<xref linkend="defColor"/>) for the background color of the dialog control. + The <xref linkend="defColor"/> for the background color of the dialog control. </para> </listitem></varlistentry> <varlistentry><term>fg [optional]</term> <listitem> <para> - The color number (<xref linkend="defColor"/>) for the foreground color of the dialog control. The foreground + The <xref linkend="defColor"/> for the foreground color of the dialog control. The foreground color is the color that text is written in. </para> </listitem></varlistentry> @@ -4686,7 +4687,7 @@ <xref linkend="clsSize"/> objects, or the individual x and y coordinates, width, and height values. </para> <para> - The coordinates are specified as <xref linkend="defClientArea"/> area coordinates, in pixels. All 4 + The coordinates are specified as <xref linkend="defClientArea"/> coordinates, in pixels. All 4 of the coordinates </para> </listitem></varlistentry> @@ -4778,7 +4779,7 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example resizes an edit control so that it takes up the entire client <xref linkend="defClientArea"/> + This example resizes an edit control so that it takes up the entire <xref linkend="defClientArea"/> of the dialog: <programlisting> <![CDATA[ @@ -4903,7 +4904,7 @@ <varlistentry><term>CLIENT</term> <listitem> <para> - The position for the text will be relative to the client <xref linkend="defClientArea"/> of the + The position for the text will be relative to the <xref linkend="defClientArea"/> of the specified window, rather than relative to the window itself. </para> </listitem></varlistentry> @@ -5140,7 +5141,7 @@ <varlistentry><term>CLIENT</term> <listitem> <para> - The position for the text will be relative to the client <xref linkend="defClientArea"/> of the + The position for the text will be relative to the <xref linkend="defClientArea"/> of the specified window, rather than relative to the window itself. </para> </listitem></varlistentry> Modified: docs/trunk/publican/oodialog/en-US/dialogObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-09-02 03:05:25 UTC (rev 8348) +++ docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-09-02 05:06:41 UTC (rev 8349) @@ -1714,7 +1714,7 @@ <listitem> <para> A file, (often called a header (<xref linkend="defHeaderFile"/>) file,) defining - symbolic IDs (<xref linkend="defSymbolicId"/>) for resources. The symbolic IDs defined within the file will be + <xref linkend="defSymbolicId"/> IDs for resources. The symbolic IDs defined within the file will be added to the <xref linkend="atrConstDir"/> directory. </para> </listitem></varlistentry> @@ -2091,7 +2091,7 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - In order to accurately calculate dialog units (<xref linkend="defDialogUnit"/>) in methods such as + In order to accurately calculate <xref linkend="defDialogUnit"/> in methods such as <xref linkend="mthGetTextSizeDu"/>(), it is important that the <emphasis role="italic">fontName</emphasis> and <xref linkend="atrFontSize"/> attributes match the actual font that the dialog will use. Therefore, whenever dialog unit calculations are going to be made before the underlying @@ -2272,7 +2272,7 @@ on owned windows. See the remarks section for a more detailed discussion of the owner window. </para> <para> - In the ooDialog framework, <emphasis role="italic">all</emphasis> control (<xref linkend="sctControlDialogs"/>) + In the ooDialog framework, <emphasis role="italic">all</emphasis> <xref linkend="sctControlDialogs"/> dialogs <emphasis role="italic">must</emphasis> have an owner dialog. Dialogs like the <xref linkend="clsPropertySheetDialog"/> can <emphasis role="italic">not</emphasis> have an owner dialog. For the most part other dialogs would not have an owner dialog. @@ -2645,7 +2645,7 @@ dialog, <xref linkend="mthShowClsPlainBaseDialog"/> it, starts the <xref linkend="mthAddAutoStartMethod"/> methods, if any, and destroys the underlying dialog when the user closes it. If auto <xref linkend="mthInitAutoDetection"/> is on, the dialog - data (<xref linkend="sctUnderstandingDataAttributes"/>) is passed to the underlying dialog before execution and received + <link linkend="sctUnderstandingDataAttributes">data</link> is passed to the underlying dialog before execution and received from it after the dialog is terminated. </para> <variablelist> @@ -8191,7 +8191,7 @@ <indexterm><primary>dialog object</primary><secondary>menu methods</secondary></indexterm> <para> Prior to ooDialog level 4.2.0, menus were really only minimally supported, through a few methods of the dialog class. - In ooDialog 4.2.0 true menu (<xref linkend="chpMenus"/>) objects were introduced. Therefore the menu methods of + In ooDialog 4.2.0 true <xref linkend="chpMenus"/> objects were introduced. Therefore the menu methods of the dialog object, other than <xref linkend="mthGetMenuBar"/>() and <xref linkend="mthHasMenuBar"/>(), are deprecated. Use the methods of the menu classes directly to work with menus. The listing of the deprecated (<xref linkend="deprecatedDialogMethods"/>) dialog methods documents all @@ -8210,7 +8210,7 @@ <para> The <emphasis role="italic">getMenuBar</emphasis> method returns the - menu (<xref linkend="chpMenus"/>) object attached to the dialog, or <emphasis + <xref linkend="chpMenus"/> object attached to the dialog, or <emphasis role="bold">.nil</emphasis> if there is no menu attached. </para> <variablelist> @@ -8719,7 +8719,7 @@ <para> Calculates the size the given string will occupy in the dialog. The size is returned in - dialog units (<xref linkend="defDialogUnit"/>). To calculate the size in pixels use the + <xref linkend="defDialogUnit"/>. To calculate the size in pixels use the <xref linkend="mthGetTextSizePx"/>() method. The <xref linkend="mthGetTextSizeDlgClsPlainBaseDialog"/>() method is similar to <emphasis role="italic">getTextSizeDu</emphasis>, but should only be used when necessary @@ -8820,7 +8820,7 @@ </programlisting> <para> - Calculates the size, (width and height,) in dialog units (<xref linkend="defDialogUnit"/>) for a given string. + Calculates the size, (width and height,) in <xref linkend="defDialogUnit"/> for a given string. </para> <para> <emphasis role="bold">Note:</emphasis> The convoluted arguments to this method are needed to retain backwards Modified: docs/trunk/publican/oodialog/en-US/listview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-02 03:05:25 UTC (rev 8348) +++ docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-02 05:06:41 UTC (rev 8349) @@ -3028,7 +3028,7 @@ </programlisting> <para> - Retrieves the client <xref linken... [truncated message content] |
From: <mie...@us...> - 2012-09-02 19:59:06
|
Revision: 8351 http://sourceforge.net/p/oorexx/code-0/8351 Author: miesfeld Date: 2012-09-02 19:59:01 +0000 (Sun, 02 Sep 2012) Log Message: ----------- Work on Publican ooDialog doc Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/deprecated.xml docs/trunk/publican/oodialog/en-US/dialogObject.xml docs/trunk/publican/oodialog/en-US/edit.xml docs/trunk/publican/oodialog/en-US/eventNotification.xml docs/trunk/publican/oodialog/en-US/listbox.xml docs/trunk/publican/oodialog/en-US/menus.xml docs/trunk/publican/oodialog/en-US/mouse.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/propertySheetDialogs.xml docs/trunk/publican/oodialog/en-US/userInput.xml docs/trunk/publican/oodialog/en-US/userdialog.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml docs/trunk/publican/oodialog/en-US/windowBaseDO.xml Modified: docs/trunk/publican/oodialog/en-US/deprecated.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-09-02 05:29:09 UTC (rev 8350) +++ docs/trunk/publican/oodialog/en-US/deprecated.xml 2012-09-02 19:59:01 UTC (rev 8351) @@ -91,15 +91,13 @@ <section id="deprecatedAdvancedControls"><title>AdvancedControls Mixin Class</title> <indexterm><primary>Deprecated</primary><secondary>AdvancedControls Class</secondary></indexterm> <para> - This class is <xref linkend="apxDeprecated"/>. The ooDialog framework no longer (<xref - linkend="sctHistory" /> makes a distinction between some types of dialog controls, and how to use the - controls. I.e., the programmer no longer needs to inherit a special class to use some of the dialog controls. All the - methods of the AdvancedControls have been moved into the appropriate dialog class. Therefore the programmer does not - need to do anything to use any dialog control in any dialog. In new code simply omit inheriting AdvancedControls. In - old code, <emphasis role="italic">inherit AdvancedControls</emphasis> can be deleted from any dialog class declaration - and the program will behave the same. -</para> -</section> + This class is <xref linkend="apxDeprecated"/>. The ooDialog framework no <link linkend="sctHistory">longer</link> makes a + distinction between some types of dialog controls, and how to use the controls. I.e., the programmer no longer needs to + inherit a special class to use some of the dialog controls. All the methods of the AdvancedControls have been moved into + the appropriate dialog class. Therefore the programmer does not need to do anything to use any dialog control in any + dialog. In new code simply omit inheriting AdvancedControls. In old code, <emphasis role="italic">inherit + AdvancedControls</emphasis> can be deleted from any dialog class declaration and the program will behave the same. +</para> </section> <section id="deprecatedMessageExtensions"><title>MessageExtensions Mixin Class</title> <indexterm><primary>Deprecated</primary><secondary>MessageExtensions Class</secondary></indexterm> @@ -116,10 +114,11 @@ <section id="deprecatedPlainUserDialog" xreflabel="PlainUserDialog"><title>PlainUserDialog Class</title> <indexterm><primary>Deprecated</primary><secondary>PlainUserDialog Class</secondary></indexterm> <para> - This class is <xref linkend="apxDeprecated"/>. The ooDialog framework no longer (<xref - linkend="sctHistory" />) makes a distinction between a plain user dialog and an user dialog (<xref - linkend="clsUserDialog" />). Directly subclass the <emphasis role="italic">Userdialog</emphasis> - instead of the <emphasis role="italic">PlainUserDialog</emphasis>. + This class is <xref linkend="apxDeprecated"/>. The ooDialog framework no <link linkend="sctHistory">longer</link> makes a + distinction between a PlainUserDialog and an + <xref linkend="clsUserDialog"/>. Directly + subclass the <emphasis role="italic">Userdialog</emphasis> instead of the <emphasis + role="italic">PlainUserDialog</emphasis>. </para> </section> @@ -158,7 +157,7 @@ </section> -<section id="deprecatedDialogMethods"><title>Deprecated Dialog Methods</title> +<section id="deprecatedDialogMethods" xreflabel="deprecated"><title>Deprecated Dialog Methods</title> <indexterm><primary>Deprecated</primary><secondary>dialog object methods</secondary></indexterm> <para> <link linkend="apxDeprecated">Deprecated</link> dialog methods and their replacement methods are listed in this section. @@ -193,8 +192,8 @@ <section><title>combineELwithSB</title> <para> This method is <xref linkend="apxDeprecated"/>. It uses an outdated process to add function to a - dialog that is similar to a modern up-down control. The method does not work properly. The up-down (<xref - linkend="clsUpDown" />) dialog control should be used directly to replace this method. + dialog that is similar to a modern up-down control. The method does not work properly. The <xref linkend="clsUpDown"/> + dialog control should be used directly to replace this method. </para> </section> @@ -309,8 +308,7 @@ <section><title>focusItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Replace this method with the focusControl() (<xref - linkend="mthFocusControl" />) method. + This method is <xref linkend="apxDeprecated"/>. Replace this method with the <xref linkend="mthFocusControl"/> method. </para> </section> @@ -485,8 +483,8 @@ <section><title>getTextSize</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with, preferably, the -<xref linkend="mthGetTextSizeDu"/> method, or the getTextSizeDialog() (<xref - linkend="mthGetTextSizeDlgClsPlainBaseDialog" />) method if absolutely necessary. + <xref linkend="mthGetTextSizeDu"/> method, or the <xref linkend="mthGetTextSizeDlgClsPlainBaseDialog"/> method if + absolutely necessary. </para> <para> This method never worked correctly, the previous documentation for this method was incorrect and / @@ -511,10 +509,8 @@ <section><title>getWindowRect</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the windowRext() (<xref - linkend="mthWindowRect" />) method instead. -</para> -</section> + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="mthWindowRect"/> method instead. +</para> </section> <section><title>grayMenuItem</title> <para> @@ -560,10 +556,8 @@ <section><title>moveItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the moveControl() (<xref - linkend="mthMoveControl" />) method instead. -</para> -</section> + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="mthMoveControl"/> method instead. +</para> </section> <section><title>peekDialogMessage</title> <para> @@ -587,10 +581,8 @@ <section><title>resizeItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the resizeControl() (<xref - linkend="mthResizeControl" />) method instead. -</para> -</section> + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="mthResizeControl"/> method instead. +</para> </section> <section><title>run</title> <para> @@ -653,10 +645,8 @@ <section><title>uncheckMenuItem</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu(<xref linkend="chpMenus"/>) - object methods directly. -</para> -</section> + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. +</para> </section> <section><title>writeToButton</title> <para> @@ -676,8 +666,8 @@ <para> The following lists the <xref linkend="apxDeprecated"/> methods of the <emphasis role="italic">Button</emphasis> class and how to replace those methods in ooDialog programs. The implementation of the - following <emphasis role="italic">bitmap</emphasis> button methods was done in the dialog (<xref - linkend="chpDialogObject" />) object. The methods are methods of the dialog, not the button. + following <emphasis role="italic">bitmap</emphasis> button methods was done in the <xref linkend="chpDialogObject"/> + object. The methods are methods of the dialog, not the button. </para> <section><title>changeBitmap</title> @@ -691,80 +681,70 @@ <section><title>dimBitmap</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthDimBitmap"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthDimBitmap"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> <section><title>displaceBitmap</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthDisplaceBitmap"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthDisplaceBitmap"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> <section><title>drawBitmap</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthDrawBitmap"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthDrawBitmap"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> <section><title>getBitmapPosition</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthGetBitmapPosition"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthGetBitmapPosition"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> <section><title>getBitmapSizeX</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthGetBitmapSizeX"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthGetBitmapSizeX"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> <section><title>getBitmapSizeY</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthGetBitmapSizeY"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthGetBitmapSizeY"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> <section><title>scroll</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthScrollButton"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthScrollButton"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> <section><title>scrollBitmapFromTo</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthScrollBitmapFromTo"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthScrollBitmapFromTo"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> <section><title>scrollText</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthScrollText"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthScrollText"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> <section><title>setBitmapPosition</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthSetBitmapPosition"/> method of the the dialog (<xref - linkend="chpDialogObject" />) object. +<xref linkend="mthSetBitmapPosition"/> method of the the <xref linkend="chpDialogObject"/> object. </para> </section> @@ -779,10 +759,8 @@ <section><title>editSelection</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use setEditSelection() (<xref - linkend="mthSetEditSelection" />). -</para> -</section> + This method is <xref linkend="apxDeprecated"/>. Use <xref linkend="mthSetEditSelection"/>. +</para> </section> </section> <!-- End Deprecated ComboBox Methods Section --> @@ -946,9 +924,8 @@ <section><title>getTextSize</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the -<xref linkend="mthGetTextSizeDu"/> method. The getTextSizeDlg() (<xref - linkend="mthGetTextSizeDlgClsDialogControl" />) method could also be used, if absolutely - necessary. However, that is not recommended. + <xref linkend="mthGetTextSizeDu"/> method. The <xref linkend="mthGetTextSizeDlgClsDialogControl"/> method could also be + used, if absolutely necessary. However, that is not recommended. </para> <para> This method never worked correctly, the previous documentation for this method was incorrect and / @@ -965,10 +942,8 @@ <section><title>processMessage</title> <para> - This method is <xref linkend="apxDeprecated"/>. Replace this method with the sendMessage() (<xref - linkend="wbdcoSendMessage" />) method. -</para> -</section> + This method is <xref linkend="apxDeprecated"/>. Replace this method with the <xref linkend="wbdcoSendMessage"/> method. +</para> </section> <section><title>releaseMouseCapture</title> <para> @@ -1000,15 +975,13 @@ <section><title>value</title> <para> - This method is <xref linkend="apxDeprecated"/>. Replace this method with the dat() (<xref - linkend="mthData" />) method. + This method is <xref linkend="apxDeprecated"/>. Replace this method with the <xref linkend="mthData"/> method. </para> </section> <section><title>value=</title> <para> - This method is <xref linkend="apxDeprecated"/>. Replace this method with the data= (<xref - linkend="mthDataEquals" />) method. + This method is <xref linkend="apxDeprecated"/>. Replace this method with the <xref linkend="mthDataEquals"/> method. </para> </section> @@ -1198,11 +1171,10 @@ <para> The ooDialog documentation prior to ooDialog 4.0.0 documented ten external functions as <emphasis role="italic">callable functions that can be used in your Object Rexx programs</emphasis>. It then - mentioned in passing that the Public Routines (<xref linkend="sctPublicRoutines"/>) were a more - convenient way to use these functions. It was noted that the external routines were registered - automatically when the first dialog was initialized, but if the programmer wanted to use the external - routines when no dialog was created, he could register the individual functions using - <computeroutput>RxFuncAdd</computeroutput>. + mentioned in passing that the Public <link linkend="sctPublicRoutines">Routines</link> were a more convenient way to use + these functions. It was noted that the external routines were registered automatically when the first dialog was + initialized, but if the programmer wanted to use the external routines when no dialog was created, he could register the + individual functions using <computeroutput>RxFuncAdd</computeroutput>. </para> <para> The 3.2.0 documentation expounded on that a little and also mentioned that there were other external @@ -1241,77 +1213,72 @@ <section><title>errorMessage</title> <para> This function is <xref linkend="apxDeprecated"/>. Use the public routine - errorDialog (<xref linkend="rtnErrorDialog"/>). + <xref linkend="rtnErrorDialog"/>. </para> </section> <section><title>getFileNameWindow</title> <para> - This function is deprecated. See this explanation (<xref linkend="deprecatedExternalFunctions"/>). Use the public routine - FileNameDialog (<xref linkend="rtnFileNameDialog"/>). Do not use this function in new code. Try to migrate existing + This function is deprecated. See this <link linkend="deprecatedExternalFunctions">explanation</link>). Use the public routine + <xref linkend="rtnFileNameDialog"/>. Do not use this function in new code. Try to migrate existing code to FileNameDialog. This function may not exist in future versions of ooDialog. </para> </section> <section><title>getScreenSize</title> <para> - This function is deprecated. See this explanation (<xref linkend="deprecatedExternalFunctions"/>). Use the - public routine screeSize (<xref linkend="rtnScreenSize"/>). Do not use this method in new code. Try to migrate + This function is deprecated. See this <link linkend="deprecatedExternalFunctions">explanation</link>). Use the + public routine <xref linkend="rtnScreenSize"/>. Do not use this method in new code. Try to migrate existing code to screenSize. This function may not exist in future versions of ooDialog. </para> </section> <section><title>getSysMetrics</title> <para> - This function is deprecated. It is replaced by the functionally equivalent getSystemMetrics() (<xref - linkend="mthGetSystemMetricsClsDlgUtil" />) method of the .DlgUtil class. Do not - use this function in new code. Try to migrate existing code to to the - <computeroutput>.DlgUtil~getSystemMetrics()</computeroutput> method. This function may not exist in - future versions of ooDialog. + This function is deprecated. It is replaced by the functionally equivalent <xref linkend="mthGetSystemMetricsClsDlgUtil"/> + method of the .DlgUtil class. Do not use this function in new code. Try to migrate existing code to to the + <computeroutput>.DlgUtil~getSystemMetrics()</computeroutput> method. This function may not exist in future versions of + ooDialog. </para> </section> <section><title>infoMessage</title> <para> - This function is <xref linkend="apxDeprecated"/>. Use the public routine infoDialog (<xref - linkend="rtnInfoDialog" />). -</para> -</section> + This function is <xref linkend="apxDeprecated"/>. Use the public routine <xref linkend="rtnInfoDialog"/>. +</para> </section> <section><title>playSoundFile</title> <para> - This function is deprecated. See this explanation (<xref linkend="deprecatedExternalFunctions"/>). Use the public routine - Play (<xref linkend="rtnPlay"/>). Do not use this function in new code. Try to migrate existing code to Play. This + This function is deprecated. See this <link linkend="deprecatedExternalFunctions">explanation</link>). Use the public routine + <xref linkend="rtnPlay"/>. Do not use this function in new code. Try to migrate existing code to Play. This function may not exist in future versions of ooDialog. </para> </section> <section><title>playSoundFileInLoop</title> <para> - This function is deprecated. See this explanation (<xref linkend="deprecatedExternalFunctions"/>). Use the public routine - play (<xref linkend="rtnPlay"/>). Do not use this function in new code. Try to migrate existing code to <emphasis + This function is deprecated. See this <link linkend="deprecatedExternalFunctions">explanation</link>). Use the public routine + <xref linkend="rtnPlay"/>. Do not use this function in new code. Try to migrate existing code to <emphasis role="italic">play</emphasis>(). This function may not exist in future versions of ooDialog. </para> </section> <section><title>sleepMS</title> <para> - This function is <xref linkend="apxDeprecated"/>. Use the public routine msSleep (<xref - linkend="rtnMSSleep" />). + This function is <xref linkend="apxDeprecated"/>. Use the public routine <xref linkend="rtnMSSleep"/>. </para> </section> <section><title>stopSoundFile</title> <para> - This function is deprecated. See this explanation (<xref linkend="deprecatedExternalFunctions"/>). Use the public routine - play (<xref linkend="rtnPlay"/>). Do not use this function in new code. Try to migrate existing code to <emphasis + This function is deprecated. See this <link linkend="deprecatedExternalFunctions">explanation</link>). Use the public routine + <xref linkend="rtnPlay"/>. Do not use this function in new code. Try to migrate existing code to <emphasis role="italic">play</emphasis>(). This function may not exist in future versions of ooDialog. </para> </section> <section><title>systemMetrics Routine</title> <para> - This routine is deprecated. It is replaced by the functionally equivalent getSystemMetrics() (<xref - linkend="mthGetSystemMetricsClsDlgUtil" />) method of the .DlgUtil class. Do not use this - routine in new code. Try to migrate existing code to to the + This routine is deprecated. It is replaced by the functionally equivalent <xref linkend="mthGetSystemMetricsClsDlgUtil"/> + method of the .DlgUtil class. Do not use this routine in new code. Try to migrate existing code to to the <computeroutput>.DlgUtil~getSystemMetrics()</computeroutput> method. This routine may not exist in future versions of ooDialog. </para> @@ -1330,8 +1297,7 @@ <section><title>yesNoMessage</title> <para> - This function is <xref linkend="apxDeprecated"/>. Use the public routine askDialog (<xref - linkend="rtnAskDialog" />). + This function is <xref linkend="apxDeprecated"/>. Use the public routine <xref linkend="rtnAskDialog"/>. </para> </section> @@ -1341,8 +1307,7 @@ <section id="deprecatedUserDialogMethods"><title>Deprecated UserDialog Methods</title> <indexterm><primary>Deprecated</primary><secondary>UserDialog methods</secondary></indexterm> <para> - Deprecated (<xref linkend="apxDeprecated"/>) <computeroutput>UserDialog</computeroutput> methods and their - replacement methods are listed in this section. + Deprecated <computeroutput>UserDialog</computeroutput> methods and their replacement methods are listed in this section. </para> <section><title>addBitmapButton</title> @@ -1495,7 +1460,7 @@ <section><title>addInputStem</title> <para> This method is <xref linkend="apxDeprecated"/>. Replace this method with the - createEditInputStem () (<xref linkend="mthCreateEditInputStem"/>) method. + <xref linkend="mthCreateEditInputStem"/> method. </para> </section> @@ -1669,10 +1634,8 @@ <section><title>setMenu</title> <para> - This method is <xref linkend="apxDeprecated"/>. Use the menu(<xref linkend="chpMenus"/>) - object methods directly. -</para> -</section> + This method is <xref linkend="apxDeprecated"/>. Use the <xref linkend="chpMenus"/> object methods directly. +</para> </section> </section> <!-- End Deprecated UserDialog Methods Section --> @@ -1680,10 +1643,9 @@ <section id="deprecatedWindowBase"><title>Deprecated WindowBase Methods</title> <indexterm><primary>Deprecated</primary><secondary>WindowBase methods</secondary></indexterm> <para> - The <xref linkend="clsWindowBase"/> class is inherited by both the dialog - object (<xref linkend="chpDialogObject"/>) and the dialog <xref linkend="chpDialogControlObject"/> object. - Therefore, depending on the point of view of the reader, these deprecated methods may be thought of as either - deprecated dialog methods or deprecated dialog control methods. + The <xref linkend="clsWindowBase"/> class is inherited by both the dialog <xref linkend="chpDialogObject"/> object and the + dialog <xref linkend="chpDialogControlObject"/> object. Therefore, depending on the point of view of the reader, these + deprecated methods may be thought of as either deprecated dialog methods or deprecated dialog control methods. </para> <para> The following lists the <xref linkend="apxDeprecated"/> methods of the <emphasis @@ -1716,10 +1678,9 @@ <section id="deprecatedWindowExtensions"><title>Deprecated WindowExtensions Methods</title> <indexterm><primary>Deprecated</primary><secondary>WindowExtensions methods</secondary></indexterm> <para> - The <xref linkend="clsWindowExtensions"/> class is inherited by both the dialog - object (<xref linkend="chpDialogObject"/>) and the dialog <xref linkend="chpDialogControlObject"/> object. - Therefore, depending on the point of view of the reader, these deprecated methods may be thought of as either - deprecated dialog methods or deprecated dialog control methods. + The <xref linkend="clsWindowExtensions"/> class is inherited by both the <xref linkend="chpDialogObject"/> object and the + dialog <xref linkend="chpDialogControlObject"/> object. Therefore, depending on the point of view of the reader, these + deprecated methods may be thought of as either deprecated dialog methods or deprecated dialog control methods. </para> <para> The following lists the <xref linkend="apxDeprecated"/> methods of the <emphasis @@ -1729,8 +1690,7 @@ <section><title>absRect2LogRect</title> <para> This method is <xref linkend="apxDeprecated"/> because it is incorrectly implemented and - <xref linkend="ovvInaccurate"/>. Replace this method with the pixel2dlgUnit() (<xref - linkend="mthPixel2dlgUnit" />) method. + <xref linkend="ovvInaccurate"/>. Replace this method with the <xref linkend="mthPixel2dlgUnit"/> method. </para> </section> @@ -1779,8 +1739,7 @@ <section><title>logRect2AbsRect</title> <para> This method is <xref linkend="apxDeprecated"/> because it is incorrectly implemented and - <xref linkend="ovvInaccurate"/>. Replace this method with the dlgUnit2pixel() (<xref - linkend="mthDlgUnit2pixel" />) method. + <xref linkend="ovvInaccurate"/>. Replace this method with the <xref linkend="mthDlgUnit2pixel"/> method. </para> </section> Modified: docs/trunk/publican/oodialog/en-US/dialogObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-09-02 05:29:09 UTC (rev 8350) +++ docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-09-02 19:59:01 UTC (rev 8351) @@ -75,7 +75,7 @@ </thead> <tbody> <row> -<entry>Constant Methods (<xref linkend="sctDialogConstantMethods"/>)</entry> +<entry><link linkend="sctDialogConstantMethods">Constant Methods</link></entry> <entry>The dialog object provides a number of <emphasis role="italic">constant</emphasis> values through the <computeroutput>::constant</computeroutput>directive.</entry> </row> <row> @@ -1347,7 +1347,7 @@ <entry>Gets the text of the dialog.</entry> </row> <row> -<entry>title= (<xref linkend="wbdoTitleEquals"/>)</entry> +<entry><xref linkend="wbdoTitleEquals"/></entry> <entry>Sets the text of the dialog.</entry> </row> <row> @@ -1637,7 +1637,7 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - See the previous getFontName (<xref linkend="exampleGetFontNameCls"/>)() example. + See the previous getFontName <link linkend="exampleGetFontNameCls">example</link>. </para> </listitem></varlistentry> </variablelist> @@ -1689,7 +1689,7 @@ <para> A dialog data stem variable (don't forget the trailing period) that contains data used to initialize the underlying dialog's controls. This is part of the automatic - data detection (<xref linkend="sctUnderstandingDataAttributes"/>) feature. When + data <link linkend="sctUnderstandingDataAttributes">detection</link> feature. When <xref linkend="mthInitAutoDetection"/> data detection is off, using this argument does nothing. </para> <para> @@ -1704,18 +1704,17 @@ <para> <emphasis role="bold">Note:</emphasis> when the argument is used the behavior of automatic data detection is changed in this way. When the underlying dialog is created, the data stem <emphasis role="bold">only</emphasis> - is used to set the state of the dialog controls. The values of the - data attributes (<xref linkend="sctUnderstandingDataAttributes"/>) are ignored. However, when the dialog closes - with the <emphasis role="italic">ok</emphasis> command, the values of both the data attributes <emphasis + is used to set the state of the dialog controls. The values of the data <link + linkend="sctUnderstandingDataAttributes">attributes</link> are ignored. However, when the dialog closes with the + <emphasis role="italic">ok</emphasis> command, the values of both the data attributes <emphasis role="bold">and</emphasis> the data stem indexes are updated. </para> </listitem></varlistentry> <varlistentry id="termHFile"><term>hFile [optional]</term> <listitem> <para> - A file, (often called a header (<xref linkend="defHeaderFile"/>) file,) defining - <xref linkend="defSymbolicId"/> IDs for resources. The symbolic IDs defined within the file will be - added to the <xref linkend="atrConstDir"/> directory. + A file, (often called a header <xref linkend="defHeaderFile"/>,) defining <xref linkend="defSymbolicId"/> IDs for + resources. The symbolic IDs defined within the file will be added to the <xref linkend="atrConstDir"/> directory. </para> </listitem></varlistentry> </variablelist> @@ -1819,8 +1818,8 @@ This method changes the default dialog font used for all dialogs. The default dialog font is used whenever a dynamically defined dialog template does not specify a font. Since it is very unusual for a resource script to not specify a font, this mostly effects the <xref linkend="clsUserDialog"/> classes. Binary compiled - dialog templates (ResDialog (<xref linkend="clsResDialog"/>)) can not be changed, so the default dialog font has no - meaning for a ResDialog. + dialog templates (<xref linkend="clsResDialog"/>) can not be changed, so the default dialog font has no meaning for a + ResDialog. </para> <para> Currently the default font is <computeroutput>MS Shell Dlg</computeroutput> with a size of @@ -1838,7 +1837,7 @@ dynamic dialogs, that don't specify a font, that are created afterwards will use the new default font. </para> <para> - The actual font used by a dialog directly effects the value of a dialog unit (<xref linkend="defDialogUnit"/>). + The actual font used by a dialog directly effects the value of a <xref linkend="defDialogUnit"/>. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1869,27 +1868,27 @@ </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> - <para> - This example shows a change to the oostddlg.rex sample program. The default font is changed to - Tahoma pt 10. This causes all the Standard Dialogs (<xref linkend="sctStandardDialogs"/>) to - be created using this font. - <programlisting> - <![CDATA[ + <para> + This example shows a change to the oostddlg.rex sample program. The default font is changed to + Tahoma pt 10. This causes all the Standard <link linkend="sctStandardDialogs">Dialogs</link> to be created using this + font. +<programlisting> +<![CDATA[ - /*--------------------------------------------------------------------------*/ - /* */ - /* oodialog\samples\oostddlg.rex Standard Dialog demonstration */ - /* */ - /*--------------------------------------------------------------------------*/ +/*--------------------------------------------------------------------------*/ +/* */ +/* oodialog\samples\oostddlg.rex Standard Dialog demonstration */ +/* */ +/*--------------------------------------------------------------------------*/ - .PlainBaseDialog~setDefaultFont("Tahoma", 10) - say - say 'Starting standard dialog demonstration...' +.PlainBaseDialog~setDefaultFont("Tahoma", 10) +say +say 'Starting standard dialog demonstration...' - ... - ]]> - </programlisting> - </para> +... +]]> +</programlisting> + </para> </listitem></varlistentry> </variablelist> </section> <!-- End PlainBaseDialog::setDefaultFont() [class method?] --> @@ -1917,7 +1916,7 @@ </programlisting> <para> - Reflects whether automatic data field detection (<xref linkend="sctUnderstandingDataAttributes"/>) is on or off. + Reflects whether automatic data field <link linkend="sctUnderstandingDataAttributes">detection</link> is on or off. </para> <variablelist> <varlistentry><term><emphasis role="bold">autoDetect get:</emphasis></term> @@ -2064,16 +2063,15 @@ Prior to the creation of the underlying Windows dialog, the font name attribute specifies the name of the font that will be used to create the dialog. This font is used in a <xref linkend="clsUserDialog"/> when the font is not specified in the <xref linkend="mthCreate"/>() or the - <xref linkend="mthCreateCenter"/>() methods, or in a <xref linkend="clsRcDialog"/> where the - font is not specified in the resource script file. With a binary compiled dialog resource - (ResDialog (<xref linkend="clsResDialog"/>)) the font has already been specified when the dialog template - was compiled and can not be changed. Therefore the font name attribute has no effect on a ResDialog prior to the - execution of the dialog. + <xref linkend="mthCreateCenter"/>() methods, or in a <xref linkend="clsRcDialog"/> where the + font is not specified in the resource script file. With a binary compiled dialog resource (<xref + linkend="clsResDialog"/>) the font has already been specified when the dialog template was compiled and can not be + changed. Therefore the font name attribute has no effect on a ResDialog prior to the execution of the dialog. </para> <para> After the creation of the dialog, the attribute always reflects the font name that was actually used the underlying - dialog was created. The public <xref linkend="mthSetDlgFont"/>() method can be used to set both the - font name and font size attributes at the same time. + dialog was created. The public <xref linkend="mthSetDlgFont"/> method can be used to set both the font name and font size + attributes at the same time. </para> <variablelist> <varlistentry><term><emphasis role="bold">fontName get:</emphasis>[public]</term> @@ -2221,7 +2219,7 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - See the fontName (<xref linkend="exampleFontName"/>)() example, which also uses the fontSize attribute. + See the fontName <link linkend="exampleFontName">example</link>/>, which also uses the fontSize attribute. </para> </listitem></varlistentry> </variablelist> @@ -2719,7 +2717,7 @@ <varlistentry><term>icon [optional]</term> <listitem> <para> - The resource ID of the dialog's icon (<xref linkend="defDialogIcon"/>). May be numeric or + The resource ID of the <xref linkend="defDialogIcon"/>. May be numeric or <xref linkend="defSymbolicId"/>. If an icon ID is not supplied, the default ooDialog icon will be used. </para> </listitem></varlistentry> @@ -2761,19 +2759,19 @@ </para> <para> If another ooDialog dialog has been started by the Rexx program, it is disabled when <emphasis - role="italic">execute</emphasis> is invoked. This in effect makes the dialog a - modal (<xref linkend="defModalModeless"/>) dialog. To start a <emphasis role="italic">modeless</emphasis> dialog use - the <xref linkend="mthPopup"/> or <xref linkend="mthPopupAsChild"/> methods. + role="italic">execute</emphasis> is invoked. This in effect makes the dialog a <xref linkend="defModalModeless"/> + dialog. To start a <emphasis role="italic">modeless</emphasis> dialog use the <xref linkend="mthPopup"/> or <xref + linkend="mthPopupAsChild"/> methods. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> The following example instantiates a new <xref linkend="clsUserDialog"/> subclass object. The dialog - template (<xref linkend="ovvDialogTemplate"/>) is started by the <emphasis role="italic">create</emphasis> + <xref linkend="ovvDialogTemplate"/> is started by the <emphasis role="italic">create</emphasis> method and finished in the <emphasis role="italic">defineDialog</emphasis> method. Then the <emphasis role="italic">execute</emphasis> method runs the dialog as the topmost window. The - dialog icon (<xref linkend="defDialogIcon"/>) is set to one of the pre-defined icons supplied by ooDialog. + <xref linkend="defDialogIcon"/> is set to one of the pre-defined icons supplied by ooDialog. </para> <para> When the user terminates the dialog, the return from <emphasis role="italic">execute</emphasis> is checked to @@ -3031,10 +3029,9 @@ <listitem> <para> This example sets the dialog font for a <xref linkend="clsUserDialog"/> dialog before the dialog - template (<xref linkend="ovvDialogTemplate"/>) is started. This allows the code to - <xref linkend="ovvInaccurate"/> calculate the size of the bitmap in dialog - units (<xref linkend="defDialogUnit"/>). The size of the bitmap is then used to size the dialog and to place the other - controls in the dialog. + <xref linkend="ovvDialogTemplate"/> is started. This allows the code to + <xref linkend="ovvInaccurate"/> calculate the size of the bitmap in <xref linkend="defDialogUnit"/>s. The size of the + bitmap is then used to size the dialog and to place the other controls in the dialog. <programlisting> <![CDATA[ @@ -3072,9 +3069,9 @@ <section id="sctInstantiateControls"><title>Instantiating Dialog Controls</title> <para> - The methods in this section are used to instantiate one of the concrete dialog - control (<xref linkend="chpDialogControlObject"/>) objects. The dialog control objects can not be instantiated directly by the programmer in Rexx code. - Dialog controls are instantiated indirectly through the dialog object. + The methods in this section are used to instantiate one of the concrete dialog <xref linkend="chpDialogControlObject"/> + objects. The dialog control objects can not be instantiated directly by the programmer in Rexx code. Dialog controls are + instantiated indirectly through the dialog object. </para> <para> <emphasis role="bold">All</emphasis> dialog control objects are obtained through one of the methods in this section. @@ -3131,8 +3128,8 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The following example determines the check state of a 3STATE (<xref linkend="termThreeStateStyle"/>) check box - and displays a message announcing the state: + The following example determines the check state of a <link linkend="termThreeStateStyle">3STATE</link> check box and + displays a message announcing the state: <programlisting> <![CDATA[ @@ -3195,8 +3192,8 @@ <para> The following example comes from a fictious accounting program. In one of the dialogs for the program, when the user selects a specific city, say San Diego, the zip code combo box is populated with the valid zip codes for that city. - In the program, symbolic ID (<xref linkend="defSymbolicId"/>)s have been used for the controls. The valid zip - codes are passed into the method as an array. + In the program, symbolic ID <xref linkend="defSymbolicId"/>s have been used for the controls. The valid zip codes are + passed into the method as an array. <programlisting> <![CDATA[ @@ -4027,9 +4024,9 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Prior to the effort to unify (<xref linkend="termMethodNameUnification"/>) the class and method names in - ooDialog, the track bar control was called a slider. This may have been the most egregious misnomer in ooDialog and - the term <emphasis role="italic">slider</emphasis> is no longer used. + Prior to the effort to <link linkend="termMethodNameUnification">unify</link> the class and method names in ooDialog, + the track bar control was called a slider. This may have been the most egregious misnomer in ooDialog and the term + <emphasis role="italic">slider</emphasis> is no longer used. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> @@ -4631,8 +4628,8 @@ <para> A default <emphasis role="italic">cancel</emphasis> method is provided by the ooDialog framework. The <computeroutput>cancel</computeroutput> event notification is - automatically (<xref linkend="sctStandardEventMethods"/>) connected to this method. This method is meant to be over-ridden - by the programmer if the default implementation is not sufficient for the needs of the program. + <link linkend="sctStandardEventMethods">automatically</link> connected to this method. This method is meant to be + over-ridden by the programmer if the default implementation is not sufficient for the needs of the program. </para> <para> The method is invoked in response to the <computeroutput>cancel</computeroutput> command event. The default @@ -4655,9 +4652,9 @@ role="italic">cancel</emphasis> method. </para> <para> - The example (<xref linkend="exampleOk"/>) given for the <emphasis role="italic">ok</emphasis> method shows the - proper way to over-ride the <emphasis role="italic">ok</emphasis> method. The general principle could be used to - over-ride the <emphasis role="italic">cancel</emphasis> method as well. + The <link linkend="exampleOk">example</link> given for the <emphasis role="italic">ok</emphasis> method shows the proper + way to over-ride the <emphasis role="italic">ok</emphasis> method. The general principle could be used to over-ride the + <emphasis role="italic">cancel</emphasis> method as well. </para> </section> @@ -4674,9 +4671,9 @@ <para> A default <emphasis role="italic">help</emphasis> method is provided by the ooDialog framework. The <computeroutput>help</computeroutput> event notification is - automatically (<xref linkend="sctStandardEventMethods"/>) connected to this method. This method is meant to be over-ridden - by the programmer. The default implementation does nothing and returns 0. The programmer could over-ride this method to - display some form of help to the user. + <link linkend="sctStandardEventMethods">automatically</link> connected to this method. This method is meant to be + over-ridden by the programmer. The default implementation does nothing and returns 0. The programmer could over-ride this + method to display some form of help to the user. </para> </section> @@ -4692,7 +4689,7 @@ <para> A default <emphasis role="italic">ok</emphasis> method is provided by the ooDialog framework. The - <computeroutput>ok</computeroutput> event notification is automatically (<xref linkend="sctStandardEventMethods"/>) + <computeroutput>ok</computeroutput> event notification is <link linkend="sctStandardEventMethods">automatically</link> connected to this method. This method is meant to be over-ridden by the programmer if the default implementation is not sufficient for the needs of the program. </para> @@ -4884,7 +4881,7 @@ <variablelist> <varlistentry><term>color</term> <listitem><para>A color-palette index specifying the background color. For information -on the color numbers, refer to Definition of Terms (<xref linkend="sctTermDefs"/>). +on the color numbers, refer to Definition of <link linkend="sctTermDefs">Terms</link>. </para></listitem></varlistentry> </variablelist> </para></listitem></varlistentry> @@ -4948,7 +4945,7 @@ <varlistentry><term>id</term> <listitem> <para> - The resource id (<xref linkend="defResourceId"/>) of the control to be disabled. May be numeric or + The <xref linkend="defResourceId"/> of the control to be disabled. May be numeric or <xref linkend="defSymbolicId"/>. </para> </listitem></varlistentry> @@ -5030,7 +5027,7 @@ <varlistentry><term>id</term> <listitem> <para> - The resource id (<xref linkend="defResourceId"/>) of the control to be enabled. May be numeric or + The <xref linkend="defResourceId"/> of the control to be enabled. May be numeric or <xref linkend="defSymbolicId"/>. </para> </listitem></varlistentry> @@ -5701,7 +5698,7 @@ and, if it is, the <computeroutput>restore</computeroutput> method is used to show the dialog in the size and position it was prior to being minimized. The complete program listing that this code snippet comes from is available (see the -File Viewer (<xref linkend="exampleFileViewer"/>) example.) +File Viewer <link linkend="exampleFileViewer">example</link>.) <programlisting> <![CDATA[ @@ -5755,7 +5752,7 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem><para>The following code snippet minimizes the dialog to the taskbar. It is used in the FileViewer example. The complete program listing is available -(see the File Viewer (<xref linkend="exampleFileViewer"/>) example.) +(see the File Viewer <link linkend="exampleFileViewer">example</link>.) <programlisting> <![CDATA[ @@ -5815,7 +5812,7 @@ <listitem><para>This example creates a secondary dialog to display the contents of a file. The secondary dialog is show full screen (maximized.) At the same time the parent dialog is minimized to the taskbar. The complete program -listing is available (see the File Viewer (<xref linkend="exampleFileViewer"/>) example.) +listing is available (see the File Viewer <link linkend="exampleFileViewer">example</link>.) <programlisting> <![CDATA[ @@ -5907,7 +5904,7 @@ and, if it is, the <computeroutput>restore</computeroutput> method is used to show the dialog in the size and position it was prior to being minimized. The complete program listing for this code snippet is available (see the -File Viewer (<xref linkend="exampleFileViewer"/>) example.) +File Viewer <link linkend="exampleFileViewer">example</link>.) <programlisting> <![CDATA[ @@ -6258,7 +6255,7 @@ ]]> </programlisting> -<para>Add or remove the tab stop style (<xref linkend="wstabstop"/>) for the +<para>Add or remove the <xref linkend="wstabstop"/> style for the specified control. When a control has the tabstop style, the user can set the focus to the control by using the tab key. When a control does not have this style, the tab key will skip over the control. Adding or removing this style @@ -8193,9 +8190,9 @@ Prior to ooDialog level 4.2.0, menus were really only minimally supported, through a few methods of the dialog class. In ooDialog 4.2.0 true <xref linkend="chpMenus"/> objects were introduced. Therefore the menu methods of the dialog object, other than <xref linkend="mthGetMenuBar"/>() and - <xref linkend="mthHasMenuBar"/>(), are deprecated. Use the methods of the menu classes directly to work - with menus. The listing of the deprecated (<xref linkend="deprecatedDialogMethods"/>) dialog methods documents all - the methods to use to replace all deprecated methods. + <xref linkend="mthHasMenuBar"/>(), are deprecated. Use the methods of the menu classes directly to work + with menus. The listing of the <xref linkend="deprecatedDialogMethods"/> dialog methods documents all the + methods to use to replace all deprecated methods. </para> <section id="mthGetMenuBar" xreflabel="getMenuBar"><title>getMenuBar</title> @@ -9104,8 +9101,7 @@ <varlistentry><term>msg [required]</term> <listitem> <para> - The Windows message ID. This may be numeric or a string in conventional (<xref linkend="defConventionalHex"/>) - hexadecimal format. + The Windows message ID. This may be numeric or a string in conventional <xref linkend="defConventionalHex"/> format. </para> </listitem></varlistentry> <varlistentry><term>wParam [required]</term> @@ -9143,7 +9139,7 @@ Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> - This method requires an understanding (<xref linkend="ovvWindowMessages"/>) of Windows messages. + This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> @@ -9190,8 +9186,7 @@ <varlistentry><term>msg [required]</term> <listitem> <para> - The Windows message ID. This may be numeric or a string in conventional (<xref linkend="defConventionalHex"/>) - hexadecimal format. + The Windows message ID. This may be numeric or a string in conventional <xref linkend="defConventionalHex"/> format. </para> </listitem></varlistentry> <varlistentry><term>wParam [required]</term> @@ -9229,7 +9224,7 @@ Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> - This method requires an understanding (<xref linkend="ovvWindowMessages"/>) of Windows messages. + This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> @@ -9286,8 +9281,7 @@ <varlistentry><term>msg [required]</term> <listitem> <para> - The Windows message ID. This may be numeric or a string in conventional (<xref linkend="defConventionalHex"/>) - hexadecimal format. + The Windows message ID. This may be numeric or a string in conventional <xref linkend="defConventionalHex"/> format. </para> </listitem></varlistentry> <varlistentry><term>wParam [required]</term> @@ -9325,7 +9319,7 @@ Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> - This method requires an understanding (<xref linkend="ovvWindowMessages"/>) of Windows messages. + This method requires an understanding of Windows messages <xref linkend="ovvWindowMessages"/>. </para> </listitem></varlistentry> <varlistentry id="exampleSendMessageToWindow"><term><emphasis role="bold">Example:</emphasis></term> @@ -9385,8 +9379,7 @@ <varlistentry><term>msg [required]</term> <listitem> <para> - The Windows message ID. This may be numeric or a string in conventional (<xref linkend="defConventionalHex"/>) - hexadecimal format. + The Windows message ID. This may be numeric or a string in conventional <xref linkend="defConventionalHex"/> format. </para> </listitem></varlistentry> <varlistentry><term>wParam [required]</term> @@ -9423,14 +9416,14 @@ Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> - This method requires an understanding (<xref linkend="ovvWindowMessages"/>) of Windows messages. + This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The <emphasis role="italic">sendMessageToWindow</emphasis> example (<xref linkend="exampleSendMessageToWindow"/>) - also uses the <emphasis role="italic">sendMessageToWindowH</emphasis> method. + The <emphasis role="italic">sendMessageToWindow</emphasis> <link linkend="exampleSendMessageToWindow">example</link> also + uses the <emphasis role="italic">sendMessageToWindowH</emphasis> method. </para> </listitem></varlistentry> </variablelist> @@ -9448,8 +9441,8 @@ displaying text. </para> <para> - All drawing operations make use of a device context (<xref linkend="defDeviceContext"/>). The ooDialog framework - provides a number of methods, such as the <xref linkend="mthGetWindowDC"/>, + All drawing operations make use of a <xref linkend="defDeviceContext"/>. The ooDialog framework provides a number of + methods, such as the <xref linkend="mthGetWindowDC"/>, <xref linkend="mthGetDC"/>, and <xref linkend="mthGetControlDC"/> methods that allow the programmer to retrieve a device context. </para> Modified: docs/trunk/publican/oodialog/en-US/edit.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/edit.xml 2012-09-02 05:29:09 UTC (rev 8350) +++ docs/trunk/publican/oodialog/en-US/edit.xml 2012-09-02 19:59:01 UTC (rev 8351) @@ -2323,7 +2323,7 @@ <listitem> <para> For the UP and PAGEUP commands, the number of lines scrolled by the operating system is negative. Be sure to use the - <emphasis role="italic">signed</emphasis> version of the loWord method (<xref linkend="mthSLoWord"/>) to get the correct + <emphasis role="italic">signed</emphasis> version of the loWord method, <xref linkend="mthSLoWord"/>, to get the correct value. </para> <para> Modified: docs/trunk/publican/oodialog/en-US/eventNotification.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-02 05:29:09 UTC (rev 8350) +++ docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-02 19:59:01 UTC (rev 8351) @@ -4158,7 +4158,7 @@ Label editing has ended. Do not connect this event if you are using the DEFAULTEDIT keyword. </para> </listitem></varlistentry> - <varlistentry id="kwListViewDEFAULTEDIT"><term>DEFAULTEDIT</term> + <varlistentry id="kwListViewDEFAULTEDIT" xreflabel="DEFAULTEDIT"><term>DEFAULTEDIT</term> <listitem> <para> This keyword connects the event that label editing has been started and the ended event with event handling @@ -4606,7 +4606,7 @@ </section> -<section id="evtListViewENDEDIT"><title>EndEdit Event Handler</title> +<section id="evtListViewENDEDIT" xreflabel="ENDEDIT"><title>EndEdit Event Handler</title> <indexterm><primary>ListView Event</primary><secondary>ENDEDIT</secondary></indexterm> <para> The event-handling method connected to ENDEDIT receives two arguments: the item ID of which the label has been edited Modified: docs/trunk/publican/oodialog/en-US/listbox.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/listbox.xml 2012-09-02 05:29:09 UTC (rev 8350) +++ docs/trunk/publican/oodialog/en-US/listbox.xml 2012-09-02 19:59:01 UTC (rev 8351) @@ -124,7 +124,7 @@ <entry>Adds all or selected file names of a given directory to the list box.</entry> </row> <row> -<entry>columnWidth= (<xref linkend="mthColumnWidthEquals"/>)</entry> +<entry><xref linkend="mthColumnWidthEquals"/></entry> <entry>Sets the width, in dialog units, of the list box columns in a multicolumn list box control. <emphasis role="bold">(Inaccurate.)</emphasis></entry> </row> <row> @@ -172,11 +172,11 @@ <entry>Retrieves the height, in pixels, of the items in the list box.</entry> </row> <row> -<entry>itemHeight= (<xref linkend="mthItemHeightEquals"/>)</entry> +<entry><xref linkend="mthItemHeightEquals"/></entry> <entry>Sets the height, in dialog units, of the items in the list box. <emphasis role="bold">(Inaccurate.)</emphasis></entry> </row> <row> -<entry>itemHeightPx= (<xref linkend="mthItemHeightPxEquals"/>)</entry> +<entry><xref linkend="mthItemHeightPxEquals"/></entry> <entry>Sets the height, in pixels, of the items in the list box.</entry> </row> <row> @@ -434,7 +434,7 @@ </variablelist> </section> <!-- End ListBox::addDirectory() --> -<section id="mthColumnWidthEquals"><title>columnWidth=</title> +<section id="mthColumnWidthEquals" xreflabel="columnWidth="><title>columnWidth=</title> <indexterm><primary>columnWidth=</primary></indexterm> <indexterm><primary>ListBox class</primary><secondary>columnWidth=</secondary></indexterm> <programlisting> @@ -459,7 +459,7 @@ </variablelist> </section> <!-- End ListBox::columnWidth=() --> -<section id="mthColumnWidthPxEquals"><title>columnWidthPx=</title> +<section id="mthColumnWidthPxEquals" xreflabel="columnWidthPx="><title>columnWidthPx=</title> <indexterm><primary>columnWidthPx=</primary></indexterm> <indexterm><primary>ListBox class</primary><secondary>columnWidthPx=</secondary></indexterm> <programlisting> @@ -784,7 +784,7 @@ </variablelist> </section> <!-- End ListBox::itemHeight() --> -<section id="mthItemHeightEquals"><title>itemHeight=</title> +<section id="mthItemHeightEquals" xreflabel="itemHeight="><title>itemHeight=</title> <indexterm><primary>itemHeight=</primary></indexterm> <indexterm><primary>ListBox class</primary><secondary>itemHeight=</secondary></indexterm> <programlisting> @@ -829,7 +829,7 @@ </variablelist> </section> <!-- End ListBox::itemHeightPx() --> -<section id="mthItemHeightPxEquals"><title>itemHeightPx=</title> +<section id="mthItemHeightPxEquals" xreflabel="itemHeightPx="><title>itemHeightPx=</title> <indexterm><primary>itemHeightPx=</primary></indexterm> <indexterm><primary>ListBox class</primary><secondary>itemHeightPx=</secondary></indexterm> <programlisting> Modified: docs/trunk/publican/oodialog/en-US/menus.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/menus.xml 2012-09-02 05:29:09 UTC (rev 8350) +++ docs/trunk/publican/oodialog/en-US/menus.xml 2012-09-02 19:59:01 UTC (rev 8351) @@ -132,25 +132,26 @@ </table> </para> -<section id="sctMenuItemIDs"><title>Menu Item IDs</title> +<section id="sctMenuItemIDs" xreflabel="ID"><title>Menu Item IDs</title> <para> Each menu item in a menu can be uniquely identified. This documentation generically refers to a menu item <emphasis role="italic">ID</emphasis>, but there are really two ways of identifying a menu item. </para> <variablelist> - <varlistentry id="entMenuItemIdentifier"><term><emphasis role="bold">Menu Item Identifier</emphasis></term> + <varlistentry id="entMenuItemIdentifier" xreflabel="ID(s)"> + <term><emphasis role="bold">Menu Item Identifier</emphasis></term> <listitem> <para> Each menu item has a unique, non-negative, integer assigned to it by the programmer, called a menu item identifier. These numbers are essentially the same as any other <xref linkend="defResourceId"/> used in - ooDialog. The Rexx programmer can use numeric or symbolic (<xref linkend="itmMenuSymbolicIDs"/>) IDs for menu + ooDialog. The Rexx programmer can use numeric or <xref linkend="itmMenuSymbolicIDs"/> IDs for menu item identifier's, in the same way as for other resource IDs. </para> <para> All menus assign menu item identifiers to command items and submenus. ooDialog uses what the Windows operating system calls <emphasis role="italic">extended</emphasis> menus. Extended menus also assign identifiers to - separators. Identifiers are used for menu command events (<xref linkend="sctMenuCommandEvents"/>). In addition, a + separators. Identifiers are used for <xref linkend="sctMenuCommandEvents"/>s. In addition, a menu item can be specified using its identifier in method invocations. For example, to <xref linkend="mthEnableClsMenu"/> or <xref linkend="mthDisableClsMenu"/> a menu item. </para> @@ -160,7 +161,8 @@ specified position </para> </listitem></varlistentry> - <varlistentry id="entMenuItemPosition"><term><emphasis role="bold">Menu Item Position</emphasis></term> + <varlistentry id="entMenuItemPosition" xreflabel="menu item position"> + <term><emphasis role="bold">Menu Item Position</emphasis></term> <listitem> <para> In addition to having a unique identifier, each menu item in a menu bar or menu has a unique position value. @@ -176,13 +178,14 @@ submenu. </para> </listitem></varlistentry> - <varlistentry id="itmMenuSymbolicIDs"><term><emphasis role="bold">Symbolic Menu Item IDs</emphasis></term> + <varlistentry id="itmMenuSymbolicIDs" xreflabel="symbolic"> + <term><emphasis role="bold">Symbolic Menu Item IDs</emphasis></term> <listitem> <para> - Menu <emphasis role="italic">item identifiers</emphasis> are essentially resource - IDs (<xref linkend="defResourceId"/>). The programmer can use <xref linkend="defSymbolicId"/> IDs for - menu item identifiers rather than numeric IDs for any argument in a menu object method that uses a menu item - identifier. However, to do so, the programmer <emphasis role="italic">must</emphasis> use the global + Menu <emphasis role="italic">item identifiers</emphasis> are essentially <xref linkend="defResourceId"/>s. The programmer + can use <xref linkend="defSymbolicId"/> IDs for menu item identifiers rather than numeric IDs for any argument in a menu + object method that uses a menu item identifier... [truncated message content] |
From: <mie...@us...> - 2012-09-02 20:21:23
|
Revision: 8352 http://sourceforge.net/p/oorexx/code-0/8352 Author: miesfeld Date: 2012-09-02 20:21:21 +0000 (Sun, 02 Sep 2012) Log Message: ----------- Work on Publican ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/userdialog.xml Modified: docs/trunk/publican/oodialog/en-US/dialogExtensions.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-02 19:59:01 UTC (rev 8351) +++ docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-02 20:21:21 UTC (rev 8352) @@ -1127,7 +1127,8 @@ <listitem> <para> The following example moves the bitmap within the associated bitmap button 4 screen pixels to the right and 3 - pixels upward. Contrast this with the setBitmapPosition (<xref linkend="exampleSetBitmapPosition"/>) example: + pixels upward. Contrast this with the setBitmapPosition <link linkend="exampleSetBitmapPosition">example</link>: + <programlisting> <![CDATA[ Modified: docs/trunk/publican/oodialog/en-US/userdialog.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-02 19:59:01 UTC (rev 8351) +++ docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-02 20:21:21 UTC (rev 8352) @@ -1349,7 +1349,7 @@ <varlistentry><term>NOTAB</term> <listitem> <para> - The no <xref linkend="wstabstopr"/> control style. By default the button is created with the + The no <xref linkend="wstabstop"/> control style. By default the button is created with the tabstop style except in these conditions: the bmpFocused is omitted, and the bmpSelected is omitted, and the FRAME style keyword is not used. </para> @@ -1357,7 +1357,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. The button is normally created with the tabstop + The <xref linkend="wstabstop"/> control style. The button is normally created with the tabstop style and this keyword is not necessary. However, if the bmpFocused argument is omitted, and the bmpSelected argument is omitted, and the FRAME style keyword is not used, the button is created without the tabstop style. In this case only, it is necessary to use the TAB keyword to change the default behavior. @@ -4688,7 +4688,7 @@ <varlistentry><term>UPDOWN</term> <listitem> <para> - This style shows an <ref linkend="clsUpDown"/> control to the right of the date and time picker. The use can + This style shows an <xref linkend="clsUpDown"/> control to the right of the date and time picker. The use can modify date and time values using the up-down control. This style can be used in place of the drop-down <xref linkend="clsMonthCalendar"/> calendar. The drop-down month calendar is the default style. </para> @@ -5897,7 +5897,7 @@ Characters typed into the edit control are masked. Rather than displaying the character typed, the edit control displays the mask character. Prior to Windows XP the default mask character was the asterisk. In Windows XP the default mask character is a black circle. The default password character can be changed through the - <xref linkend="atrPasswordChar"/> attribute of the <xref linkend="clsEdit"/> control. + <xref linkend="atrPasswordChar"/> attribute of the <xref linkend="clsEdit"/> control. </para> </listitem></varlistentry> <varlistentry><term>CENTER</term> @@ -7165,7 +7165,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The progress bar has the <xref linkend="wstabstopr"/> control style. Normally, a progress bar is + The progress bar has the <xref linkend="wstabstop"/> control style. Normally, a progress bar is not a tab stop. </para> </listitem></varlistentry> @@ -7483,7 +7483,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -7619,7 +7619,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -7754,7 +7754,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -7888,7 +7888,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -8023,7 +8023,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -8159,7 +8159,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -8295,7 +8295,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -8666,7 +8666,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The control is created with the <xref linkend="wstabstopr"/> style. By default, static controls do + The control is created with the <xref linkend="wstabstop"/> style. By default, static controls do not have the tabstop style. </para> </listitem></varlistentry> @@ -8901,7 +8901,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -9101,7 +9101,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -9347,7 +9347,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -9583,7 +9583,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> @@ -9719,7 +9719,7 @@ <varlistentry><term>TAB</term> <listitem> <para> - The <xref linkend="wstabstopr"/> control style. + The <xref linkend="wstabstop"/> control style. </para> </listitem></varlistentry> </variablelist> |
From: <mie...@us...> - 2012-09-03 02:56:05
|
Revision: 8353 http://sourceforge.net/p/oorexx/code-0/8353 Author: miesfeld Date: 2012-09-03 02:56:02 +0000 (Mon, 03 Sep 2012) Log Message: ----------- Work on Publican ooDialog doc Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/dialogObject.xml docs/trunk/publican/oodialog/en-US/eventNotification.xml docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/menus.xml docs/trunk/publican/oodialog/en-US/monthcalendar.xml docs/trunk/publican/oodialog/en-US/mouse.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/propertySheetDialogs.xml docs/trunk/publican/oodialog/en-US/resdialog.xml docs/trunk/publican/oodialog/en-US/resources.xml docs/trunk/publican/oodialog/en-US/scrollbar.xml docs/trunk/publican/oodialog/en-US/trackbar.xml docs/trunk/publican/oodialog/en-US/treeview.xml docs/trunk/publican/oodialog/en-US/userInput.xml docs/trunk/publican/oodialog/en-US/userdialog.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml docs/trunk/publican/oodialog/en-US/windowBase.xml docs/trunk/publican/oodialog/en-US/windowExtensions.xml Modified: docs/trunk/publican/oodialog/en-US/dialogExtensions.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-02 20:21:21 UTC (rev 8352) +++ docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-03 02:56:02 UTC (rev 8353) @@ -1344,7 +1344,7 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The executeAsync (<xref linkend="exampleExecuteAsync"/>) example shows the proper use of the <emphasis + The executeAsync <link linkend="exampleExecuteAsync">example</link> shows the proper use of the <emphasis role="italic">endAsyncExecution</emphasis> method. </para> </listitem></varlistentry> @@ -1450,8 +1450,8 @@ <varlistentry><term>icon [optional]</term> <listitem> <para> - The resource ID of the dialog's icon (<xref linkend="defDialogIcon"/>). May be numeric or - <xref linkend="defSymbolicId"/>. If an icon ID is not supplied, the default ooDialog icon will be used. + The resource ID of the <xref linkend="defDialogIcon"/>. May be numeric or <xref linkend="defSymbolicId"/>. If an + icon ID is not supplied, the default ooDialog icon will be used. </para> </listitem></varlistentry> </variablelist> @@ -1488,8 +1488,8 @@ <para> If another ooDialog dialog has been started by the Rexx program, it is disabled when <emphasis role="italic">executeAsync</emphasis> is invoked. This in effect makes the dialog a - modal (<xref linkend="defModalModeless"/>) dialog. To start a <emphasis role="italic">modeless</emphasis> dialog use - the <xref linkend="mthPopup"/> or <xref linkend="mthPopupAsChild"/> methods. + <xref linkend="defModalModeless"/> dialog. To start a <emphasis role="italic">modeless</emphasis> dialog use the <xref + linkend="mthPopup"/> or <xref linkend="mthPopupAsChild"/> methods. </para> </listitem></varlistentry> <varlistentry id="exampleExecuteAsync"><term><emphasis role="bold">Example:</emphasis></term> @@ -2539,7 +2539,7 @@ </programlisting> <para> - The <emphasis role="italic">popup</emphasis> method starts a modeless (<xref linkend="defModalModeless"/>) dialog + The <emphasis role="italic">popup</emphasis> method starts a <link linkend="defModalModeless">modeless</link> dialog executing and returns immediately. </para> <variablelist> @@ -2622,8 +2622,8 @@ <varlistentry><term>icon [optional]</term> <listitem> <para> - The resource ID of the dialog's icon (<xref linkend="defDialogIcon"/>). May be numeric or - <xref linkend="defSymbolicId"/>. If an icon ID is not supplied, the default ooDialog icon will be used. + The resource ID of the <xref linkend="defDialogIcon"/>. May be numeric or <xref linkend="defSymbolicId"/>. If an + icon ID is not supplied, the default ooDialog icon will be used. </para> </listitem></varlistentry> </variablelist> @@ -2708,10 +2708,10 @@ </programlisting> <para> - The <emphasis role="italic">popupAsChild</emphasis> method starts a modeless (<xref linkend="defModalModeless"/>) - dialog executing and returns immediately. It is very similar to the <xref linkend="mthPopup"/> method, but - has the additional functionality that it is closed automatically when the <emphasis role="italic">parent</emphasis> - dialog is closed. + The <emphasis role="italic">popupAsChild</emphasis> method starts a <link linkend="defModalModeless">modeless</link> + dialog executing and returns immediately. It is very similar to the + <xref linkend="mthPopup"/> method, but has the additional functionality + that it is closed automatically when the <emphasis role="italic">parent</emphasis> dialog is closed. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2802,8 +2802,8 @@ <varlistentry><term>icon [optional]</term> <listitem> <para> - The resource ID of the dialog's icon (<xref linkend="defDialogIcon"/>). May be numeric or - <xref linkend="defSymbolicId"/>. If an icon ID is not supplied, the default ooDialog icon will be used. + The resource ID of the <xref linkend="defDialogIcon"/>. May be numeric or <xref linkend="defSymbolicId"/>. If an + icon ID is not supplied, the default ooDialog icon will be used. </para> </listitem></varlistentry> </variablelist> @@ -2961,7 +2961,7 @@ <para> The <emphasis role="italic">redrawRect</emphasis> method redraws the specified - bounding (<xref linkend="ovvRectangleCoordinates"/>) rectangular within the client area of this dialog. Optionally, + <link linkend="ovvRectangleCoordinates">bounding</link> rectangular within the client area of this dialog. Optionally, another window can be specified, and the background of the rectangle can be erased first. </para> <variablelist> @@ -3118,7 +3118,7 @@ <para> The <emphasis role="italic">redrawWindowRect</emphasis> method, by default, forces this dialog to completely - redraw its client (<xref linkend="defClientArea"/>. + redraw its <xref linkend="defClientArea"/>. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -3129,8 +3129,8 @@ <para> Optionally, some other window can be forced to redraw by specifying the <xref linkend="defHandle"/> to the window. All Rexx dialog and dialog controls have the <xref linkend="atrHwnd"/> attribute which - contains the handle of the window (<xref linkend="ovvUnderlying"/>). In addition, methods like - <xref linkend="mthGetControlHandle"/> can be used to obtain a window handle. If you omit this + contains the handle of the <xref linkend="ovvUnderlying"/> window. In addition, methods like + <xref linkend="mthGetControlHandle"/> can be used to obtain a window handle. If you omit this argument, the handle of the dialog itself is used. </para> </listitem></varlistentry> @@ -4057,7 +4057,7 @@ <para> Sets the background color, and optionally the text color, for the specified dialog control using the system - colors (<xref linkend="defSysColor"/>). + <xref linkend="defSysColor"/>s. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -4076,7 +4076,7 @@ <listitem> <para> The system color ID for the background color of the dialog control. This can be either the whole number ID or - the keyword ID. IDs can be looked up in the System Color Elements table (<xref linkend="tblSysColors"/>) + the keyword ID. IDs can be looked up in the System Color Elements <link linkend="tblSysColors">table</link>. </para> </listitem></varlistentry> <varlistentry><term>fg [optional]</term> @@ -4084,7 +4084,7 @@ <para> The system color for the foreground color of the dialog control. The foreground color is the color that text is written in. This can be either the whole number ID or the keyword ID. IDs can be looked up in the System Color - Elements table (<xref linkend="tblSysColors"/>) + Elements <link linkend="tblSysColors">table</link>. </para> </listitem></varlistentry> </variablelist> @@ -4681,11 +4681,11 @@ <varlistentry><term>rectCoordinates [required]</term> <listitem> <para> - The coordinates for the new size and position of the window as a - point/size (<xref linkend="ovvRectangleCoordinates"/>) rectangle. The coordinates specify the upper left point of - the the new position, the width of the window and the height of the window. These coordinates can be specified - using either a <xref linkend="clsRect"/> object, a <xref linkend="clsPoint"/> object and a - <xref linkend="clsSize"/> objects, or the individual x and y coordinates, width, and height values. + The coordinates for the new size and position of the window as a <link + linkend="ovvRectangleCoordinates">point/size</link> rectangle. The coordinates specify the upper left point of the + the new position, the width of the window and the height of the window. These coordinates can be specified using + either a <xref linkend="clsRect"/> object, a <xref linkend="clsPoint"/> and a + <xref linkend="clsSize"/> object, or the individual x and y coordinates, width, and height values. </para> <para> The coordinates are specified as <xref linkend="defClientArea"/> coordinates, in pixels. All 4 Modified: docs/trunk/publican/oodialog/en-US/dialogObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-09-02 20:21:21 UTC (rev 8352) +++ docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-09-03 02:56:02 UTC (rev 8353) @@ -1818,8 +1818,8 @@ This method changes the default dialog font used for all dialogs. The default dialog font is used whenever a dynamically defined dialog template does not specify a font. Since it is very unusual for a resource script to not specify a font, this mostly effects the <xref linkend="clsUserDialog"/> classes. Binary compiled - dialog templates (<xref linkend="clsResDialog"/>) can not be changed, so the default dialog font has no meaning for a - ResDialog. + dialog templates, subclasses of the <xref linkend="clsResDialog"/> class, can not be changed, so the default dialog font + has no meaning for a <computeroutput>ResDialog</computeroutput>. </para> <para> Currently the default font is <computeroutput>MS Shell Dlg</computeroutput> with a size of @@ -2064,9 +2064,10 @@ will be used to create the dialog. This font is used in a <xref linkend="clsUserDialog"/> when the font is not specified in the <xref linkend="mthCreate"/>() or the <xref linkend="mthCreateCenter"/>() methods, or in a <xref linkend="clsRcDialog"/> where the - font is not specified in the resource script file. With a binary compiled dialog resource (<xref - linkend="clsResDialog"/>) the font has already been specified when the dialog template was compiled and can not be - changed. Therefore the font name attribute has no effect on a ResDialog prior to the execution of the dialog. + font is not specified in the resource script file. With a binary compiled dialog resource, subclasses of the <xref + linkend="clsResDialog"/> class, the font has already been specified when the dialog template was compiled and can not be + changed. Therefore the font name attribute has no effect on a <computeroutput>ResDialog</computeroutput> prior to the + execution of the dialog. </para> <para> After the creation of the dialog, the attribute always reflects the font name that was actually used the underlying @@ -9139,7 +9140,7 @@ Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> - This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>. + This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>s. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> @@ -9224,7 +9225,7 @@ Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> - This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>. + This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>s. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> @@ -9319,7 +9320,7 @@ Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> - This method requires an understanding of Windows messages <xref linkend="ovvWindowMessages"/>. + This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>s. </para> </listitem></varlistentry> <varlistentry id="exampleSendMessageToWindow"><term><emphasis role="bold">Example:</emphasis></term> @@ -9416,7 +9417,7 @@ Sets the <xref linkend="dotSystemErrorCode"/>. </para> <para> - This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>. + This method requires an understanding of Windows <xref linkend="ovvWindowMessages"/>s. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> Modified: docs/trunk/publican/oodialog/en-US/eventNotification.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-02 20:21:21 UTC (rev 8352) +++ docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-03 02:56:02 UTC (rev 8353) @@ -110,7 +110,7 @@ because the method handles the event. In order to properly code an event handler, the Rexx programmer needs to understand somewhat the underlying mechanism of event notification. This is particularly important in ooDialog 4.2.0 and later with its ability to <xref linkend="ovvEventsDirectReply"/> invoke the event handling method from the window - <link linkend="ovvWindowMessages">message</link> processing loop. + <xref linkend="ovvWindowMessages"/> processing loop. </para> <para> When the operating system sends an event notification to the underlying dialog, the operating system waits for a reply @@ -692,7 +692,7 @@ <para> The <emphasis role="italic">addUserMsg</emphasis> method connects a Windows window - <link linkend="ovvWindowMessages">message</link> sent to the <xref linkend="ovvUnderlying"/> dialog with a + <xref linkend="ovvWindowMessages"/> sent to the <xref linkend="ovvUnderlying"/> dialog with a method in the Rexx dialog. This method is designed to be used by ooDialog programmers who are familiar with the Windows API. It's use will require access to the Windows <xref linkend="defWindowsDoc"/> at a minimum, and will likely also require access to the Windows header files in the @@ -1067,9 +1067,9 @@ <xref linkend="clsEventNotification"/> class. </para> <para> - The interpreter invokes the event handler directly and waits in the window - <link linkend="ovvWindowMessages">message</link> processing loop for the return from the event handler. Connecting the - activate event requires that the programmer reply to the event from the event handler in a timely manner. + The interpreter invokes the event handler directly and waits in the window <xref linkend="ovvWindowMessages"/> processing + loop for the return from the event handler. Connecting the activate event requires that the programmer reply to the event + from the event handler in a timely manner. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details:</emphasis></term> @@ -5767,9 +5767,9 @@ <xref linkend="clsEventNotification"/> class. </para> <para> - The interpreter invokes the event handler directly and waits in the window - <link linkend="ovvWindowMessages">message</link> processing loop for the return from the event handler. Connecting the - sizing event requires that the programmer reply to the event from the event handler in a timely manner. + The interpreter invokes the event handler directly and waits in the window <xref linkend="ovvWindowMessages"/> processing + loop for the return from the event handler. Connecting the sizing event requires that the programmer reply to the event + from the event handler in a timely manner. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Event Handler:</emphasis></term> @@ -6217,11 +6217,11 @@ <varlistentry><term>willReply [optional]</term> <listitem> <para> - The default behavior is for the interpreter to wait in the window <link linkend="ovvWindowMessages">message</link> - processing loop for the return from the event handler, (the default for <emphasis - role="italic">willReply</emphasis> is <computeroutput>.true</computeroutput>). However, the operating system - ignores the return from this event notification. Specifying <computeroutput>.false</computeroutput> changes the - default behavior so that the interpreter does not wait for the return from the event handling method. + The default behavior is for the interpreter to wait in the window <xfer linkend="ovvWindowMessages"/> processing loop + for the return from the event handler, (the default for <emphasis role="italic">willReply</emphasis> is + <computeroutput>.true</computeroutput>). However, the operating system ignores the return from this event notification. + Specifying <computeroutput>.false</computeroutput> changes the default behavior so that the interpreter does not wait + for the return from the event handling method. </para> </listitem></varlistentry> </variablelist> Modified: docs/trunk/publican/oodialog/en-US/listview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-02 20:21:21 UTC (rev 8352) +++ docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-03 02:56:02 UTC (rev 8353) @@ -806,12 +806,9 @@ </programlisting> <para>The <computeroutput>addExtendedStyle</computeroutput> method adds one or -more of the -extended (<xref linkend="listControlExtendedStyles"/>) List-View styles to a ListControl. -These styles can not be added until -the underlying Windows List-View control has been created. They can be added in -the <computeroutput>initDialog</computeroutput> method or any time thereafter. -</para> +more of the <link linkend="listControlExtendedStyles">extended</link> List-View styles to a ListControl. These styles can +not be added until the underlying Windows List-View control has been created. They can be added in the +<computeroutput>initDialog</computeroutput> method or any time thereafter. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem><para>The only argument is: @@ -1242,8 +1239,7 @@ for a list-view control.</para> <variablelist> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> -<listitem><para>The color-palette index specifier (0 to 18). For more information on -color palettes, refer to Definition of Terms (<xref linkend="sctTermDefs"/>). +<listitem><para>The <xref linkend="defColorPalette"/> index specifier (0 to 18). </para></listitem></varlistentry> </variablelist> </section> @@ -1265,11 +1261,14 @@ <listitem><para>The only argument is: <variablelist> <varlistentry><term>color</term> -<listitem><para>The new background color. Specify the color-palette index specifier -(0 to 18). For more information on color palettes, refer to Definition of Terms (<xref linkend="sctTermDefs"/>). -</para></listitem></varlistentry> +<listitem> +<para> + The new background color. Specify the <xref linkend="defColorPalette"/> index specifier (0 to 18). +</para> +</listitem></varlistentry> </variablelist> -</para></listitem></varlistentry> +</para> +</listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem><para>The following example sets the background color of a list control to yellow: @@ -2446,7 +2445,7 @@ </programlisting> <para>The <computeroutput>getExtendedStyle</computeroutput> method returns -the extended (<xref linkend="listControlExtendedStyles"/>) styles of a +the extended <link linkend="listControlExtendedStyles">styles</link> of a <computeroutput>ListView</computeroutput>. The styles are returned as a string of blank delimited style keywords. These are the same keywords as those used to set the styles. @@ -2544,7 +2543,7 @@ </programlisting> <para>The <computeroutput>getExtendedStyleRaw</computeroutput> method returns -the extended (<xref linkend="listControlExtendedStyles"/>) styles of a +the extended <link linkend="listControlExtendedStyles">styles</link> of a <computeroutput>ListView</computeroutput> as the numeric value of the extended style flags. This method is provided for programmers familiar with the Windows API who may wish to know, or to work with, the actual value of the @@ -2691,9 +2690,8 @@ <varlistentry><term>type</term> <listitem> <para> - Optional. Specifies which image list to retrieve. You can use - .Image~toID() (<xref linkend="mthToIDClsImage"/>) to get the correct numeric value for one of the - following symbols: + Optional. Specifies which image list to retrieve. You can use the <xref linkend="mthToIDClsImage"/> method of the + <xref linkend="clsImage"/> class to get the correct numeric value for one of the following symbols: <simplelist type='horiz' columns='2'> <member>LVSIL_NORMAL</member> <member>LVSIL_SMALL </member> @@ -4777,7 +4775,7 @@ </programlisting> <para>The <computeroutput>removeExtendedStyle</computeroutput> method removes -one or more extended (<xref linkend="listControlExtendedStyles"/>) styles of +one or more extended <link linkend="listControlExtendedStyles">styles</link> of a List-View control. </para> <variablelist> @@ -4909,7 +4907,7 @@ <para>The <computeroutput>replaceExtendedStyle</computeroutput> method removes some of the List-View control's -extended (<xref linkend="listControlExtendedStyles"/>) styles and adds new +extended <link linkend="listControlExtendedStyles">styles</link> and adds new extended styles. This is the equivalent of first using the <computeroutput>RemoveExtendeStyle</computeroutput> method and then using the <computeroutput>addExtendedStyle</computeroutput> method. @@ -5619,8 +5617,8 @@ <para> <emphasis role="bold">type</emphasis>: When <emphasis role="italic">src</emphasis> is an <computeroutput>ImageList</computeroutput> object, this argument specifies which image list to - assign, (or remove.) You can use .Image~toID() (<xref linkend="mthToIDClsImage"/>) to get the - correct numeric value for one of the following symbols: + assign, (or remove.) You can use the <xref linkend="mthToIDClsImage"/> method of the <xref linkend="clsImage"/> + class to get the correct numeric value for one of the following symbols: <simplelist type='horiz' columns='2'> <member>LVSIL_NORMAL</member> <member>LVSIL_SMALL </member> @@ -6362,8 +6360,8 @@ color of the text in a list-view control.</para> <variablelist> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> -<listitem><para>The color-palette index specifier (0 to 18). For more information on -color palettes, refer to Definition of Terms (<xref linkend="sctTermDefs"/>). +<listitem><para>The <xref linkend="defColorPalette"/> index specifier (0 to 18). + </para></listitem></varlistentry> </variablelist> </section> @@ -6385,8 +6383,8 @@ <listitem><para>The only argument is: <variablelist> <varlistentry><term>color</term> -<listitem><para>The new background color for text. Specify the color-palette index specifier -(0 to 18). For more information on color palettes, refer to Definition of Terms (<xref linkend="sctTermDefs"/>). +<listitem><para> + The new background color for text. Specify the <xref linkend="defColorPalette"/> index specifier (0 to 18). </para></listitem></varlistentry> </variablelist> </para></listitem></varlistentry> @@ -6407,8 +6405,8 @@ a list-view control.</para> <variablelist> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> -<listitem><para>The color-palette index specifier (0 to 18). For more information on -color palettes, refer to Definition of Terms (<xref linkend="sctTermDefs"/>). +<listitem><para> + The <xref linkend="defColorPalette"/> index specifier (0 to 18). </para></listitem></varlistentry> </variablelist> </section> @@ -6430,8 +6428,8 @@ <listitem><para>The only argument is: <variablelist> <varlistentry><term>color</term> -<listitem><para>The new text color. Specify the color-palette index specifier (0 to -18). For more information on color palettes, refer to Definition of Terms (<xref linkend="sctTermDefs"/>). +<listitem><para> + The new text color. Specify the <xref linkend="defColorPalette"/> index specifier (0 to 18). </para></listitem></varlistentry> </variablelist> </para></listitem></varlistentry> Modified: docs/trunk/publican/oodialog/en-US/menus.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/menus.xml 2012-09-02 20:21:21 UTC (rev 8352) +++ docs/trunk/publican/oodialog/en-US/menus.xml 2012-09-03 02:56:02 UTC (rev 8353) @@ -6041,8 +6041,9 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - If auto <xref linkend="sctMenuCommandEventConnections"/> is turned on (<xref linkend="mthGetAutoConnectStatus"/>) then - all menu command items are connected to a method in the <emphasis role="italic">dlg</emphasis> dialog at this time. + If auto <xref linkend="sctMenuCommandEventConnections"/>s is turned on, (this can be checked through the <xref + linkend="mthGetAutoConnectStatus"/> method,) then all menu command items are connected to a method in the <emphasis + role="italic">dlg</emphasis> dialog at this time. </para> <para> A menu bar can only be attached to a dialog after the <xref linkend="ovvUnderlying"/> dialog exists. Modified: docs/trunk/publican/oodialog/en-US/monthcalendar.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/monthcalendar.xml 2012-09-02 20:21:21 UTC (rev 8352) +++ docs/trunk/publican/oodialog/en-US/monthcalendar.xml 2012-09-03 02:56:02 UTC (rev 8353) @@ -2852,9 +2852,9 @@ <para> Normally in a program using day states with a month calendar, the programmer will not have to continually invoke the <emphasis role="italic">setDayState</emphasis> method as the user scrolls through the calendar. Rather he will - connect the <xref linkend="mthConnectMonthCalendar"/> event of the month calendar and return an - array of day state objects from the event (<xref linkend="evtMonthCalendarGETDAYSTATE"/>) handler. The month - calendar then sets the day states internally using the array. + connect the <xref linkend="mthConnectMonthCalendar"/> event of the month calendar and return an array of day state + objects from the <xref linkend="evtMonthCalendarGETDAYSTATE"/> event handler. The month calendar then sets the day states + internally using the array. </para> <para> However, the programmer will need to use the <emphasis role="italic">setDayState</emphasis> method to properly @@ -3166,9 +3166,9 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - The PAGE UP and PAGE DOWN keys, (<computeroutput>.VK~PRIOR</computeroutput> (<xref linkend="clsVK"/>) and - <computeroutput>.VK~NEXT</computeroutput>,) change the selected month by one, regardless of the number of months - displayed or the value set by <emphasis role="italic">setMonthDelta</emphasis>. + The PAGE UP and PAGE DOWN keys, (<computeroutput>.VK~PRIOR</computeroutput> and + <computeroutput>.VK~NEXT</computeroutput> of the <xref linkend="clsVK"/> class,) change the selected month by one, + regardless of the number of months displayed or the value set by <emphasis role="italic">setMonthDelta</emphasis>. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details:</emphasis></term> Modified: docs/trunk/publican/oodialog/en-US/mouse.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/mouse.xml 2012-09-02 20:21:21 UTC (rev 8352) +++ docs/trunk/publican/oodialog/en-US/mouse.xml 2012-09-03 02:56:02 UTC (rev 8353) @@ -47,7 +47,7 @@ <indexterm><primary>Mouse class</primary></indexterm> <para> In Windows the mouse is one of the important user input devices for programs. A program receives mouse input in the - form of messages (<xref linkend="ovvWindowMessages"/>) that are sent or posted to the windows of the program. In + form of <xref linkend="ovvWindowMessages"/>s that are sent or posted to the windows of the program. In addition the operating system provides a number of functions to work with the mouse. These functions allow the programmer to change the mouse behavior, configure the mouse, change its appearence, etc.. </para> @@ -81,7 +81,7 @@ </thead> <tbody> <row> -<entry>Constant Methods (<xref linkend="sctMouseConstantMethods"/>)</entry> +<entry><link linkend="sctMouseConstantMethods">Constant Methods</link></entry> <entry>The <computeroutput>Mouse</computeroutput> class provides a single <emphasis role="italic">constant</emphasis> value through the <computeroutput>::constant</computeroutput>directive.</entry> </row> <row> @@ -250,11 +250,12 @@ <varlistentry><term>windowObj [required]</term> <listitem> <para> - A Rexx object that has an underlying Windows window. In all practical terms this is either a Rexx dialog - object (<xref linkend="chpDialogObject"/>) or a Rexx dialog control - object (<xref linkend="chpDialogControlObject"/>). - </para> </listitem></varlistentry> - </variablelist> </para> + A Rexx object that has an underlying Windows window. In all practical terms this is either a Rexx <xref + linkend="chpDialogObject"/> object or a Rexx dialog <xref linkend="chpDialogControlObject"/> object. + </para> + </listitem></varlistentry> + </variablelist> + </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> @@ -265,7 +266,7 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - The operating system sends all mouse related messages (<xref linkend="ovvWindowMessages"/>) to the window the + The operating system sends all mouse related <xref linkend="ovvWindowMessages"/>s to the window the mouse is over. Because of this, each Rexx mouse object is assoicated with a specific window. This is important for the programmer to understand, especially when connecting mouse event notifications. Since all dialog controls are windows, when the mouse is over a dialog, most messages go to one of the dialog controls that make up the dialog. @@ -1082,7 +1083,7 @@ <varlistentry><term>rect</term> <listitem> <para> - A bounding (<xref linkend="ovvRectangleCoordinates"/>) rectangle specified as a + A <link linkend="ovvRectangleCoordinates">bounding</link> rectangle specified as a <xref linkend="clsRect"/> object that defines the area the cursor is confined to. </para> </listitem></varlistentry> @@ -1181,10 +1182,8 @@ <listitem> <para> This event notification is sent to the window that is losing the mouse capture. The - CaptureChanged (<xref linkend="evtCAPTURCHANGED"/>) Event Handler contains information on coding the event - handler. - </para> - </listitem></varlistentry> + <xref linkend="evtCAPTURCHANGED"/> Event Handler contains information on coding the event handler. + </para> </listitem></varlistentry> <varlistentry><term>LBUTTONDBLCLK</term> <listitem> <para> @@ -1247,10 +1246,8 @@ <para> The event notification is sent when the cursor leaves the client area of the window specified in a prior call to the <xref linkend="mthTrackEvent"/> method. The - MouseLeave (<xref linkend="evtMOUSELEAVE"/>) Event Handler contains information on coding the event - handler. - </para> - </listitem></varlistentry> + <xref linkend="evtMOUSELEAVE"/> Event Handler contains information on coding the event handler. + </para> </listitem></varlistentry> <varlistentry><term>MOUSEMOVE</term> <listitem> <para> @@ -1263,7 +1260,7 @@ <listitem> <para> The event notification is sent when the mouse wheel is rotated. The - MouseWheel (<xref linkend="evtMOUSEWHEEL"/>) Event Handler contains information on coding the event handler. + <xref linkend="evtMOUSEWHEEL"/> Event Handler contains information on coding the event handler. </para> </listitem></varlistentry> <varlistentry><term>NCMOUSEHOVER</term> @@ -1272,19 +1269,15 @@ The event notification is sent when the cursor hovers over the non-<xref linkend="defClientArea"/> of the window for the period of time specified in a prior call to the <xref linkend="mthTrackEvent"/> method. The - NcMouseHover (<xref linkend="evtNCMOUSEHOVER"/>) Mouse Event Handler contains information on coding the event - handler. - </para> - </listitem></varlistentry> + <xref linkend="evtNCMOUSEHOVER"/> Mouse Event Handler contains information on coding the event handler. + </para> </listitem></varlistentry> <varlistentry><term>NCMOUSELEAVE</term> <listitem> <para> The event notification is sent when the cursor leaves the non-<xref linkend="defClientArea"/> - area of the window specified in a prior call to the <xref linkend="mthTrackEvent"/> method. - The MouseLeave (<xref linkend="evtMOUSELEAVE"/>) Event Handler contains information on coding the event - handler. - </para> - </listitem></varlistentry> + area of the window specified in a prior call to the <xref linkend="mthTrackEvent"/> method. The <xref + linkend="evtMOUSELEAVE"/> Event Handler contains information on coding the event handler. + </para> </listitem></varlistentry> <varlistentry><term>RBUTTONDBLCLK</term> <listitem> <para> @@ -1389,7 +1382,7 @@ <listitem> <para> Common <xref linkend="paraGuidelinesWhereToConnect"/> invoke event connection methods and on - how (<xref linkend="sctCodingEventHandlers"/>) to code event handlers are included in the documentation for the + <link linkend="sctCodingEventHandlers">how</link> to code event handlers are included in the documentation for the <xref linkend="clsEventNotification"/> class. Note that it is not possible to instantiate a mouse object tied to a dialog control window until after the <xref linkend="ovvUnderlying"/> dialog has been created. Therefore, for dialog control windows the <emphasis role="italic">connectEvent</emphasis> method @@ -1537,7 +1530,7 @@ </variablelist> -<section id="evtCAPTURCHANGED"><title>CaptureChanged Event Handler</title> +<section id="evtCAPTURCHANGED" xreflabel="CAPTURECHANGED"><title>CaptureChanged Event Handler</title> <indexterm><primary>Mouse class</primary><secondary>events</secondary><tertiary>CAPTURECHANGED</tertiary></indexterm> <para> The event handler for the capture changed event is invoked when the window assigned to the mouse object is losing the @@ -1587,7 +1580,7 @@ <para> In general, return <computeroutput>.true</computeroutput> to indicate the event has been processed and <computeroutput>.false</computeroutput> to indicate it was not processed. However, the correct response is dependent - on how the event was connected, and is summarized in the Remarks (<xref linkend="tblReplyCombinationsMouse"/>) + on how the event was connected, and is summarized in the <link linkend="tblReplyCombinationsMouse">Remarks</link> section for the <emphasis role="italic">connectEvent</emphasis> method. </para> </listitem></varlistentry> @@ -1732,7 +1725,7 @@ <para> In general, return <computeroutput>.true</computeroutput> to indicate the event has been processed and <computeroutput>.false</computeroutput> to indicate it was not processed. However, the correct response is dependent - on how the event was connected, and is summarized in the Remarks (<xref linkend="tblReplyCombinationsMouse"/>) + on how the event was connected, and is summarized in the <link linkend="tblReplyCombinationsMouse">Remarks</link> section for the <xref linkend="mthConnectEvent"/> method. </para> </listitem></varlistentry> @@ -1801,7 +1794,7 @@ </section> <!-- End General Mouse Event Handler --> -<section id="evtNCMOUSEHOVER"><title>NcMouseHover Event Handler</title> +<section id="evtNCMOUSEHOVER" xreflabel="NCMOUSEHOVER"><title>NcMouseHover Event Handler</title> <indexterm><primary>Mouse class</primary><secondary>events</secondary><tertiary>NCMOUSEHOVER</tertiary></indexterm> <para> The event handler for the nc mouse leave event is invoked when the cursor leaves the @@ -1896,7 +1889,7 @@ <para> In general, return <computeroutput>.true</computeroutput> to indicate the event has been processed and <computeroutput>.false</computeroutput> to indicate it was not processed. However, the correct response is dependent - on how the event was connected, and is summarized in the Remarks (<xref linkend="tblReplyCombinationsMouse"/>) + on how the event was connected, and is summarized in the <link linkend="tblReplyCombinationsMouse">Remarks</link> section for the <emphasis role="italic">connectEvent</emphasis> method. </para> </listitem></varlistentry> @@ -1913,7 +1906,7 @@ </section> <!-- End MouseLeave Event Handler --> -<section id="evtMOUSELEAVE"><title>MouseLeave Event Handler</title> +<section id="evtMOUSELEAVE" xreflabel="MOUSELEAVE"><title>MouseLeave Event Handler</title> <indexterm><primary>Mouse class</primary><secondary>events</secondary><tertiary>MOUSELEAVE</tertiary></indexterm> <indexterm><primary>Mouse class</primary><secondary>events</secondary><tertiary>NCMOUSELEAVE</tertiary></indexterm> <para> @@ -1963,7 +1956,7 @@ <para> In general, return <computeroutput>.true</computeroutput> to indicate the event has been processed and <computeroutput>.false</computeroutput> to indicate it was not processed. However, the correct response is dependent - on how the event was connected, and is summarized in the Remarks (<xref linkend="tblReplyCombinationsMouse"/>) + on how the event was connected, and is summarized in the <link linkend="tblReplyCombinationsMouse">Remarks</link> section for the <emphasis role="italic">connectEvent</emphasis> method. </para> </listitem></varlistentry> @@ -1980,7 +1973,7 @@ </section> <!-- End MouseLeave Event Handler --> -<section id="evtMOUSEWHEEL"><title>MouseWheel Event Handler</title> +<section id="evtMOUSEWHEEL" xreflabel="MOUSEWHEEL"><title>MouseWheel Event Handler</title> <indexterm><primary>Mouse class</primary><secondary>events</secondary><tertiary>MOUSEWHEEL</tertiary></indexterm> <para> The event handler for the mouse wheel event is invoked each time the user scrolls the mouse wheel. @@ -2105,7 +2098,7 @@ <para> In general, return <computeroutput>.true</computeroutput> to indicate the event has been processed and <computeroutput>.false</computeroutput> to indicate it was not processed. However, the correct response is dependent - on how the event was connected, and is summarized in the Remarks (<xref linkend="tblReplyCombinationsMouse"/>) + on how the event was connected, and is summarized in the <link linkend="tblReplyCombinationsMouse">Remarks</link> section for the <xref linkend="mthConnectEvent"/> method. </para> </listitem></varlistentry> @@ -2127,10 +2120,8 @@ </para> <para> Additional information on the mouse wheel and handling mouse wheel events is found in the system parameters - information (SPI (<xref linkend="clsSPI"/>)) class's <xref linkend="atrWheelScrollLines"/> - attribute. - </para> - </listitem></varlistentry> + information <xref linkend="clsSPI"/> class's <xref linkend="atrWheelScrollLines"/> attribute. + </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example</emphasis></term> <listitem> <para> @@ -2450,7 +2441,7 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - If the cursor is not confined, (clipped (<xref linkend="mthClipCursor"/>),) then on return <emphasis + If the cursor is not confined, i.e., it is <link linkend="mthClipCursor">clipped</link>/>, then on return <emphasis role="italic">rect</emphasis> will contain the coordinates of the screen. </para> </listitem></varlistentry> @@ -2490,7 +2481,7 @@ <listitem> <para> Returns the postion, in screen <xref linkend="defScreenCoordinates"/>) coodinates, as a - <xref linkend="clsPoint"/> object. + <xref linkend="clsPoint"/> object. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -2505,7 +2496,7 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - The setCursorPos (<xref linkend="exampleSetCursorPos"/>) example uses the <emphasis + The setCursorPos <link linkend="exampleSetCursorPos">example</link> uses the <emphasis role="italic">getCursorPos</emphasis> method. </para> </listitem></varlistentry> @@ -3373,7 +3364,7 @@ </para> <para> The only anomaly is that the hover time out returned is always the actual time out and not - HOVER_DEFAULT (<xref linkend="sctMouseConstantMethods"/>), if HOVER_DEFAULT was specified as <emphasis + <link linkend="sctMouseConstantMethods">HOVER_DEFAULT</link>, if HOVER_DEFAULT was specified as <emphasis role="italic">hoverTime</emphasis> during the original <emphasis role="italic">trackEvent</emphasis> request. </para> @@ -3385,10 +3376,10 @@ <listitem> <para> Specifies the hover time out, (if HOVER was specified in <emphasis role="italic">event</emphasis>,) in - milliseconds. The constant, HOVER_DEFAULT (<xref linkend="sctMouseConstantMethods"/>) can also be use to - specify the system default hover time out. The value of the system default hover time out can be determined, or - changed, through the <xref linkend="atrMouseHoverTime"/> attribute of the - <xref linkend="clsSPI"/> (System Parameters Infomation) class. + milliseconds. The constant, <link linkend="sctMouseConstantMethods">HOVER_DEFAULT</link> can also be use to specify + the system default hover time out. The value of the system default hover time out can be determined, or changed, + through the <xref linkend="atrMouseHoverTime"/> attribute of the <xref linkend="clsSPI"/> (System Parameters + Infomation) class. </para> </listitem></varlistentry> <varlistentry><term>answer [optional] [in / out]</term> @@ -3432,9 +3423,8 @@ <para> The mouse pointer is considered to be <emphasis role="italic">hovering</emphasis> when it stays within a specific rectangle for a specific period of time. The <xref linkend="clsSPI"/> class has attributes that can be used - to retrieve (or change) the hover rectangle or hover time out value. The - <xref linkend="atrMouseHoverWidth"/> and <xref linkend="atrMouseHoverHeight"/> - attributes reflect the hover rectangle. The <xref linkend="atrMouseHoverTime"/> attribute + to retrieve (or change) the hover rectangle or hover time out value. The <xref linkend="atrMouseHoverWidth"/> and <xref + linkend="atrMouseHoverHeight"/> attributes reflect the hover rectangle. The <xref linkend="atrMouseHoverTime"/> attribute reflects the hover time out. </para> <para> Modified: docs/trunk/publican/oodialog/en-US/overview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/overview.xml 2012-09-02 20:21:21 UTC (rev 8352) +++ docs/trunk/publican/oodialog/en-US/overview.xml 2012-09-03 02:56:02 UTC (rev 8353) @@ -365,7 +365,7 @@ </para> </section> -<section id="defScreenCoordinates" xreflabel="co-ordinates"><title>Screen / Client Coordinates</title> +<section id="defScreenCoordinates" xreflabel="coordinates"><title>Screen / Client Coordinates</title> <para> Points on the screen are described as x and y coordinate pairs (x,y). The x coordinates increase to the right, y coordinates increase towards the bottom. <emphasis role="italic">Screen</emphasis> and <emphasis @@ -373,7 +373,7 @@ coordinate, the origin is the upper left corner of the primary display device, typically a monitor, and usually called the screen. Client coordinates on the other hand have an origin of the upper left corner of the <xref linkend="defClientArea"/> of the window. Both screen and client coordinates are always given in the - device unit of the display, which for all practical purposes is a pixel (<xref linkend="defPixel"/>). + device unit of the display, which for all practical purposes is a<xref linkend="defPixel"/>. </para> </section> @@ -720,9 +720,9 @@ <xref linkend="clsResDialog"/> to use a binary resource. Resource scripts, (usually a .rc file) supply the dialog template in a text file. The programmer subclasses a <xref linkend="clsRcDialog"/> to create a dialog from a resource script. To create a dialog template dynamically in the program code, the programmer subclasses - a <xref linkend="clsUserDialog"/> and then uses the create (<xref linkend="sctCreateMethods"/>) - methods of that class to create the dialog template. The <computeroutput>UserDialog</computeroutput> object translates - the program statements into the in-memory dialog template required by the operating system. The + a <xref linkend="clsUserDialog"/> and then uses the <xref linkend="sctCreateMethods"/> methods of that class to create the + dialog template. The <computeroutput>UserDialog</computeroutput> object translates the program statements into the + in-memory dialog template required by the operating system. The <computeroutput>RcDialog</computeroutput> object parses the resource script and converts the resource script statements into an in-memory dialog template by invoking the proper methods of its superclass, the <computeroutput>UserDialog</computeroutput>. @@ -737,11 +737,10 @@ system is designed to be programmed this way. The Windows operating system uses <emphasis role="italic">messages</emphasis> to notify each window in the system of events specific to that window. Typically events are generated by the user. For instance, clicking a button, typing a key, moving the mouse, all generate - events. The operating system notifies the window with the input focus of those events by sending - messages (<xref linkend="ovvWindowMessages"/>) to the window. Note that some events are generated by the - operating system itself. For instance, when the user moves a window that uncovers a portion of a window beneath it, - the operating system will send a message to the underlying window notifying it that it needs to redraw the uncovered - portion. + events. The operating system notifies the window with the input focus of those events by sending <xref + linkend="ovvWindowMessages"/>s to the window. Note that some events are generated by the operating system itself. For + instance, when the user moves a window that uncovers a portion of a window beneath it, the operating system will send a + message to the underlying window notifying it that it needs to redraw the uncovered portion. </para> <para> Once the basic set up for an ooDialog program is done, the dialog object basically sits there waiting for an @@ -754,8 +753,8 @@ </para> <para id="ovvEventsDirectReply" xreflabel="directly"> Event notification messages in Windows fall into two groups, messages where the reply is ignored and messages where - the reply is significant. Prior to the introduction of the C++ (<xref linkend="sctHistory"/>) native APIs, there - was <emphasis role="bold">no way</emphasis> in ooDialog to <emphasis role="italic">directly</emphasis> reply to the + the reply is significant. Prior to the introduction of the C++ (<link linkend="sctHistory">native</link> APIs, there was + <emphasis role="bold">no way</emphasis> in ooDialog to <emphasis role="italic">directly</emphasis> reply to the notification message. This placed a severe restriction on ooDialog programs. Many of the features of the operating system could not be used with this restriction. For instance, when a user selects a new tab in a <xref linkend="clsTab"/> control, the operating system sends a SELCHANGING event notification before the selected @@ -787,10 +786,9 @@ <para> The <emphasis role="italic">factorX</emphasis> and <emphasis role="italic">factorY</emphasis> attributes of the <xref linkend="chpDialogObject"/> object were intended to provide a way to convert between - pixels (<xref linkend="defPixel"/>) and <xref linkend="defDialogUnit"/>, and vice versa. Although their - values may have been correct when ooDialog was originally designed (<xref linkend="sctHistory"/>), in almost all - cases the values are now incorrect. The method used to calculate the ratio between dialog units and pixels is not - correct. + <xref linkend="ovvWindowMessages"/> and <xref linkend="defDialogUnit"/>, and vice versa. Although their + values may have been correct when ooDialog was originally <link linkend="sctHistory">designed</link>, in almost all cases + the values are now incorrect. The method used to calculate the ratio between dialog units and pixels is not correct. </para> <para> Unfortunately, many of the methods in the ooDialog framework use <emphasis role="italic">factorX</emphasis> and @@ -803,8 +801,8 @@ <section id="ovvResourceWorkshop"><title>IBM Resource Workshop</title> <para> - The IBM Resource Workshop was a visual resource editor (<xref linkend="defResourceEditor"/>) included with IBM Object - Rexx. The Resource Workshop could not be contributed to the open source community and is therefore not a part of the + The IBM Resource Workshop was a visual <xfer linkend="defResourceEditor"/> included with IBM Object Rexx. The Resource + Workshop could not be contributed to the open source community and is therefore not a part of the Open Object Rexx project. </para> <para><emphasis role="bold">Note</emphasis>, there is <emphasis role="bold">no loss</emphasis> of functionality in @@ -940,7 +938,7 @@ </table> <para id="paraGenericResources"> The symbolic IDs in the table following IDC_STATIC are the IDs of some generic - resources (<xref linkend="chapResources"/>) that are bound to the oodialog.dll file. They can be used in any ooDialog + <xref linkend="chapResources"/> that are bound to the oodialog.dll file. They can be used in any ooDialog program and are accessed using the <xref linkend="clsResourceImage"/> class. Programmers should always use their symbolic ID rather than their numeric ID in case the numeric value changes in future versions of ooDialog. @@ -956,10 +954,10 @@ </para> <para> Each new version of the library is backwards compatible with previous versions, but, it will contain features not - available in older versions. For instance, some of the List-View - extended styles (<xref linkend="listControlExtendedStyles"/>) are only available with a 6.0, or later, version of the - common controls library. ooDialog can only provide the features available in the version of the common controls library - on the system ooDialog is running on. + available in older versions. For instance, some of the List-View extended <link + linkend="listControlExtendedStyles">styles</link>) are only available with a 6.0, or later, version of the common + controls library. ooDialog can only provide the features available in the version of the common controls library on the + system ooDialog is running on. </para> <para> Therefore, an ooDialog program running on a Windows 2000 machine will not have available some of the features that are @@ -1187,7 +1185,7 @@ <para> The easiest way to add symbols is to have the ooDialog framework add the symbols itself from a file. Whenever ooDialog parses a resource <xref linkend="defResourceScript"/> or a - header file (<xref linkend="defHeaderFile"/>), it automatically adds any symbol + header <xref linkend="defHeaderFile"/>, it automatically adds any symbol <xref linkend="defPoundDefine"/>s it finds to a constant directory. Which constant directory is dependent on the global <computeroutput>.constDir</computeroutput> usage strategy in effect. </para> @@ -1195,24 +1193,21 @@ Resource scripts are parsed whenever a <xref linkend="clsRcDialog"/>, or subclass, is instantiated. In addition, all the ooDialog dialog classes accept a header file as an optional parameter when a new instance of a dialog object is created. (See for example the <computeroutput>new</computeroutput> method in the - <xref linkend="mthNewDialogObject"/> object or the <xref linkend="mthNewClsUserDialog"/> + <xref linkend="mthNewDialogObject"/> object or the <xref linkend="mthNewClsUserDialog"/> class.) If the programmer supplies the optional header file argument, the ooDialog framework automatically parses the file and adds all defined symbols it finds in the file to a constant directory. Again, to be clear, which constant directory the symbol is placed in is dependent on which <computeroutput>.constDir</computeroutput> <xref linkend="entConstDirStrategy"/> the programmer has elected to use. </para> <para> - In practice, most resource scripts are written by resource editors (<xref linkend="defResourceEditor"/>) and - place the symbol definitions in a separate header file. Therefore having the ooDialog framework read and parse a - header file is the most practical way to add symbols to a constant directory. In addition to using the optional - header file argument in the <xref linkend="mthNewDialogObject"/> method of a dialog, the ooDialog framework - provides some additional methods for reading a file and adding the symbol definitions to a constant directory. The - dialog object has the <xref linkend="mthParseIncludeFile"/> method. The - <xref linkend="clsApplicationManager"/> class has several methods, which are accessed through the - <xref linkend="dotApplication"/>. These are: the - <xref linkend="mthUseGlobalConstDir"/>, <xref linkend="mthAddToConstDir"/>, - <xref linkend="mthSetDefaults"/>, and <xref linkend="mthParseIncludeFile"/> - methods. + In practice, most resource scripts are written by <xref linkend="defResourceEditor"/>s and place the symbol definitions + in a separate header file. Therefore having the ooDialog framework read and parse a header file is the most practical way + to add symbols to a constant directory. In addition to using the optional header file argument in the <xref + linkend="mthNewDialogObject"/> method of a dialog, the ooDialog framework provides some additional methods for reading a + file and adding the symbol definitions to a constant directory. The dialog object has the <xref + linkend="mthParseIncludeFile"/> method. The <xref linkend="clsApplicationManager"/> class has several methods, which are + accessed through the <xref linkend="dotApplication"/>. These are: the <xref linkend="mthUseGlobalConstDir"/>, <xref + linkend="mthAddToConstDir"/>, <xref linkend="mthSetDefaults"/>, and <xref linkend="mthParseIncludeFile"/> methods. </para> <para> Of course, symbolic IDs can also be added directly in the program as the following code snippet shows: @@ -1252,14 +1247,13 @@ <varlistentry><term><emphasis role="bold">Classes Requiring the Global .constDir for Symbolic IDs:</emphasis></term> <listitem> <para> - As explained previously, the dialog object's <xref linkend="atrConstDir"/> attribute allows - programmers to use symbolic IDs for arguments requiring resource IDs in the methods of the - <xref linkend="chpDialogObject"/> object and the dialog (<xref linkend="chpDialogControlObject"/>) control - object. However, the ooDialog framework contains other classes with methods requiring resource IDs. The - <xref linkend="clsMenu"/> classes and the <xref linkend="clsResourceImage"/> class are - examples of these classes. If the programmer wishes to use symbolic IDs in classes other than the dialog and - dialog control classes, then the global <computeroutput>.constDir</computeroutput> <emphasis - role="bold">must</emphasis> be used. + As explained previously, the dialog object's <xref linkend="atrConstDir"/> attribute allows programmers to use symbolic + IDs for arguments requiring resource IDs in the methods of the <xref linkend="chpDialogObject"/> object and the dialog + <xref linkend="chpDialogControlObject"/> object. However, the ooDialog framework contains other classes with methods + requiring resource IDs. The <xref linkend="clsMenu"/> classes and the <xref linkend="clsResourceImage"/> class are + examples of these classes. If the programmer wishes to use symbolic IDs in classes other than the dialog and dialog + control classes, then the global <computeroutput>.constDir</computeroutput> <emphasis role="bold">must</emphasis> be + used. </para> <para> Programmers that do not want to use the <computeroutput>.constDir</computeroutput>, <emphasis @@ -1315,7 +1309,7 @@ </variablelist> </section> -<section id="ovvWindowMessages"><title>Window Messages</title> +<section id="ovvWindowMessages" xreflabel="message"><title>Window Messages</title> <para> In the Windows operating system, not surprisingly, most everything is a window. In a nutshell, the Windows operating system works by routing and sending <emphasis role="italic">messages</emphasis> to these windows. Each window has a @@ -1557,11 +1551,10 @@ methods connecting event notifications, etc.. </para> <para> - The primary areas that should be looked at for this unification are the - create (<xref linkend="sctCreateMethods"/>) methods of the UserDialog, methods concerned with connecting - <link linkend="sctUnderstandingDataAttributes">data</link> attributes, methods returning an - instantiated (<xref linkend="sctInstantiateControls"/>) dialog control object, and methods that connect event - notifications (<xref linkend="sctMethodsEventNotification"/>). + The primary areas that should be looked at for this unification are the <xref linkend="sctCreateMethods"/> methods of + the UserDialog, methods concerned with connecting <link linkend="sctUnderstandingDataAttributes">data</link> attributes, + methods returning an <link linkend="sctInstantiateControls">instantiated</link> dialog control object, and methods that + connect <xref linkend="sctMethodsEventNotification"/> notification... [truncated message content] |
From: <mie...@us...> - 2012-09-03 03:21:45
|
Revision: 8355 http://sourceforge.net/p/oorexx/code-0/8355 Author: miesfeld Date: 2012-09-03 03:21:43 +0000 (Mon, 03 Sep 2012) Log Message: ----------- Work on Publican ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/eventNotification.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml docs/trunk/publican/oodialog/en-US/windowExtensions.xml Modified: docs/trunk/publican/oodialog/en-US/eventNotification.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-03 03:17:31 UTC (rev 8354) +++ docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-03 03:21:43 UTC (rev 8355) @@ -6217,7 +6217,7 @@ <varlistentry><term>willReply [optional]</term> <listitem> <para> - The default behavior is for the interpreter to wait in the window <xfer linkend="ovvWindowMessages"/> processing loop + The default behavior is for the interpreter to wait in the window <xref linkend="ovvWindowMessages"/> processing loop for the return from the event handler, (the default for <emphasis role="italic">willReply</emphasis> is <computeroutput>.true</computeroutput>). However, the operating system ignores the return from this event notification. Specifying <computeroutput>.false</computeroutput> changes the default behavior so that the interpr |
From: <mie...@us...> - 2012-09-03 04:08:38
|
Revision: 8356 http://sourceforge.net/p/oorexx/code-0/8356 Author: miesfeld Date: 2012-09-03 04:08:36 +0000 (Mon, 03 Sep 2012) Log Message: ----------- ooDialog doc, try to regain correct column widths Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/eventNotification.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml Modified: docs/trunk/publican/oodialog/en-US/eventNotification.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-03 03:21:43 UTC (rev 8355) +++ docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-03 04:08:36 UTC (rev 8356) @@ -43,7 +43,7 @@ # ######################################################################### --> -<section id="clsEventNotification"><title>EventNotification Mixin Class</title> +<section id="clsEventNotification" xreflabel="EventNotification"><title>EventNotification Mixin Class</title> <indexterm><primary>EventNotification class</primary></indexterm> <para> The event notification class is a <emphasis role="italic">Mixin</emphasis> class that contains methods that connect Modified: docs/trunk/publican/oodialog/en-US/overview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/overview.xml 2012-09-03 03:21:43 UTC (rev 8355) +++ docs/trunk/publican/oodialog/en-US/overview.xml 2012-09-03 04:08:36 UTC (rev 8356) @@ -753,11 +753,11 @@ </para> <para id="ovvEventsDirectReply" xreflabel="directly"> Event notification messages in Windows fall into two groups, messages where the reply is ignored and messages where - the reply is significant. Prior to the introduction of the C++ (<link linkend="sctHistory">native</link> APIs, there was + the reply is significant. Prior to the introduction of the C++ <link linkend="sctHistory">native</link> APIs, there was <emphasis role="bold">no way</emphasis> in ooDialog to <emphasis role="italic">directly</emphasis> reply to the notification message. This placed a severe restriction on ooDialog programs. Many of the features of the operating system could not be used with this restriction. For instance, when a user selects a new tab in a - <xref linkend="clsTab"/> control, the operating system sends a SELCHANGING event notification before the selected + <xref linkend="clsTab |
From: <mie...@us...> - 2012-09-03 04:26:36
|
Revision: 8357 http://sourceforge.net/p/oorexx/code-0/8357 Author: miesfeld Date: 2012-09-03 04:26:33 +0000 (Mon, 03 Sep 2012) Log Message: ----------- ooDialog doc, proof reading fixes Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-03 04:08:36 UTC (rev 8356) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-03 04:26:33 UTC (rev 8357) @@ -94,7 +94,7 @@ </para> <para> Many of the methods of the PlainBaseDialog are actually implemented in one of the mixin classes inherited by the - PlainBaseDialog. See this <xref linkend="figComponentClassesDiagram"/> to visualize the inheritance. In + PlainBaseDialog. See this <link linkend="figComponentClassesDiagram">diagram</link>/> to visualize the inheritance. In essence the PlainBaseDialog is the <xref linkend="chpDialogObject"/> object. All the methods and attributes of the PlainBaseDialog are listed in the dialog object chapter. This includes the methods and attributes of its inherited mixin classes. @@ -707,7 +707,7 @@ </table> </section> -<section id="pbdGetFontName"><title>getFontName (Class method)</title> +<section id="pbdGetFontName xreflabel="getFontName"><title>getFontName (Class method)</title> <programlisting> PlainBaseDialog::<xref linkend="mthClsGetFontName"/> @@ -717,7 +717,7 @@ </programlisting> </section> -<section id="pbdGetFontSize"><title>getFontSize (Class method)</title> +<section id="pbdGetFontSize xreflabel="getFontSize"><title>getFontSize (Class method)</title> <programlisting> PlainBaseDialog::<xref linkend="mthClsGetFontSize"/> @@ -727,7 +727,7 @@ </programlisting> </section> -<section id="pbdNew"><title>new (Class method)</title> +<section id="pbdNew xreflabel="new"><title>new (Class method)</title> <programlisting> PlainBaseDialog::<xref linkend="mthNewDialogObject"/> @@ -738,7 +738,7 @@ </programlisting> </section> -<section id="pbdSetDefaultFont"><title>setDefaultFont (Class method)</title> +<section id="pbdSetDefaultFont xreflabel="setDefaultFont"><title>setDefaultFont (Class method)</title> <programlisting> PlainBaseDialog::<xref linkend="mthClsSetDefaultFont"/> @@ -748,7 +748,7 @@ </programlisting> </section> -<section id="pbdAutoDetect"><title>autoDetect (Attribute)</title> +<section id="pbdAutoDetect xreflabel="autoDetect"><title>autoDetect (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrAutoDetect"/> @@ -760,7 +760,7 @@ </programlisting> </section> -<section id="pbdDlgHandle"><title>dlgHandle (Attribute)</title> +<section id="pbdDlgHandle xreflabel="dlgHandle"><title>dlgHandle (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrDlgHandle"/> @@ -769,7 +769,7 @@ </programlisting> </section> -<section id="pbdFontName"><title>fontName (Attribute)</title> +<section id="pbdFontName xreflabel="fontName"><title>fontName (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrFontName"/> @@ -781,7 +781,7 @@ </programlisting> </section> -<section id="pbdFontSize"><title>fontSize (Attribute)</title> +<section id="pbdFontSize xreflabel="fontSize"><title>fontSize (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrFontSize"/> @@ -793,7 +793,7 @@ </programlisting> </section> -<section id="pbdOwnerDialog"><title>ownerDialog (Attribute)</title> +<section id="pbdOwnerDialog xreflabel="ownerDialog"><title>ownerDialog (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrOwnerDialog"/> Modified: docs/trunk/publican/oodialog/en-US/utilityclasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/utilityclasses.xml 2012-09-03 04:08:36 UTC (rev 8356) +++ docs/trunk/publican/oodialog/en-US/utilityclasses.xml 2012-09-03 04:26:33 UTC (rev 8357) @@ -10362,7 +10362,7 @@ </variablelist> </section> -<section id="wbwInitCode"><title>initCode (Attribute)</title> +<section id="wbwInitCode xreflabel="initCode"><title>initCode (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrInitCode"/> @@ -10375,7 +10375,7 @@ </programlisting> </section> -<section id="wbwHwnd"><title>hwnd (Attribute)</title> +<section id="wbwHwnd xreflabel="hwnd"><title>hwnd (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrHwnd"/> @@ -10386,7 +10386,7 @@ </programlisting> </section> -<section id="wbwFactorX"><title>factorX (Attribute)</title> +<section id="wbwFactorX xreflabel="factorX"><title>factorX (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrFactorX"/> @@ -10399,7 +10399,7 @@ </programlisting> </section> -<section id="wbwFactorY"><title>factorY (Attribute)</title> +<section id="wbwFactorY xreflabel="factorY"><title>factorY (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrFactorY"/> @@ -10412,7 +10412,7 @@ </programlisting> </section> -<section id="wbwPixelCX"><title>pixelCX (Attribute)</title> +<section id="wbwPixelCX xreflabel="pixelCX"><title>pixelCX (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrPixelCX"/> @@ -10422,7 +10422,7 @@ </programlisting> </section> -<section id="wbwPixelCY"><title>pixelCY (Attribute)</title> +<section id="wbwPixelCY xreflabel="pixelCY"><title>pixelCY (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrPixelCY"/> @@ -10432,7 +10432,7 @@ </programlisting> </section> -<section id="wbwSizeX"><title>sizeX (Attribute)</title> +<section id="wbwSizeX xreflabel="sizeX"><title>sizeX (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrSizeX"/> @@ -10444,7 +10444,7 @@ </programlisting> </section> -<section id="wbwSizeY"><title>sizeY (Attribute)</title> +<section id="wbwSizeY xreflabel="sizeY"><title>sizeY (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrSizeY"/> @@ -10457,7 +10457,7 @@ </section> -<section id="wbwClear"><title>clear</title> +<section id="wbwClear xreflabel="clear"><title>clear</title> <programlisting> WindowBase::<xref linkend="mthClear"/> @@ -10468,7 +10468,7 @@ </section> -<section id="wbwClient2screen"><title>client2screen</title> +<section id="wbwClient2screen xreflabel="client2screen"><title>client2screen</title> <programlisting> WindowBase::<xref linkend="mthClient2screen"/> @@ -10479,7 +10479,7 @@ </section> -<section id="wbwClientRect"><title>clientRect</title> +<section id="wbwClientRect xreflabel="clientRect"><title>clientRect</title> <programlisting> WindowBase::<xref linkend="mthClientRect"/> @@ -10491,7 +10491,7 @@ </section> -<section id="wbwClientToScreen"><title>clientToScreen</title> +<section id="wbwClientToScreen xreflabel="clientToScreen"><title>clientToScreen</title> <programlisting> WindowBase::<xref linkend="mthClientToScreen"/> @@ -10502,7 +10502,7 @@ </section> -<section id="wbwDisable"><title>disable</title> +<section id="wbwDisable xreflabel="disable"><title>disable</title> <programlisting> WindowBase::<xref linkend="mthDisable"/> @@ -10513,7 +10513,7 @@ </section> -<section id="wbwDisplay"><title>display</title> +<section id="wbwDisplay xreflabel="display"><title>display</title> <programlisting> WindowBase::<xref linkend="mthDisplay"/> @@ -10523,7 +10523,7 @@ </section> -<section id="wbwDraw"><title>draw</title> +<section id="wbwDraw xreflabel="draw"><title>draw</title> <programlisting> WindowBase::<xref linkend="mthDraw"/> @@ -10534,7 +10534,7 @@ </section> -<section id="wbwEnable"><title>enable</title> +<section id="wbwEnable xreflabel="enable"><title>enable</title> <programlisting> WindowBase::<xref linkend="mthEnable"/> @@ -10545,7 +10545,7 @@ </section> -<section id="wbwForegroundWindow"><title>foregroundWindow</title> +<section id="wbwForegroundWindow xreflabel="foregroundWindow"><title>foregroundWindow</title> <programlisting> WindowBase::<xref linkend="mthForegroundWindow"/> @@ -10556,7 +10556,7 @@ </section> -<section id="wbwGetClientRect"><title>getClientRect</title> +<section id="wbwGetClientRect xreflabel="getClientRect"><title>getClientRect</title> <programlisting> WindowBase::<xref linkend="mthGetClientRect"/> @@ -10568,7 +10568,7 @@ </section> -<section id="wbwGetExStyleRaw"><title>getExStyleRaw</title> +<section id="wbwGetExStyleRaw xreflabel="getExStyleRaw"><title>getExStyleRaw</title> <programlisting> WindowBase::<xref linkend="mthGetExStyleRaw"/> @@ -10579,7 +10579,7 @@ </section> -<section id="wbwGetID"><title>getID</title> +<section id="wbwGetID xreflabel="getID"><title>getID</title> <programlisting> WindowBase::<xref linkend="mthGetID"/> @@ -10590,7 +10590,7 @@ </section> -<section id="wbwGetPos"><title>getPos</title> +<section id="wbwGetPos xreflabel="getPos"><title>getPos</title> <programlisting> WindowBase::<xref linkend="mthGetPos"/> @@ -10602,7 +10602,7 @@ </section> -<section id="wbwGetRealPos"><title>getRealPos</title> +<section id="wbwGetRealPos xreflabel="getRealPos"><title>getRealPos</title> <programlisting> WindowBase::<xref linkend="mthGetSize"/> @@ -10613,7 +10613,7 @@ </section> -<section id="wbwGetRealSize"><title>getRealSize</title> +<section id="wbwGetRealSize xreflabel="getRealSize"><title>getRealSize</title> <programlisting> WindowBase::<xref linkend="mthGetRealSize"/> @@ -10624,7 +10624,7 @@ </section> -<section id="wbwGetRect"><title>getRect</title> +<section id="wbwGetRect xreflabel="getRect"><title>getRect</title> <programlisting> WindowBase::<xref linkend="mthGetRect"/> @@ -10635,7 +10635,7 @@ </section> -<section id="wbwGetSize"><title>getSize</title> +<section id="wbwGetSize xreflabel="getSize"><title>getSize</title> <programlisting> WindowBase::<xref linkend="mthGetSize"/> @@ -10646,7 +10646,7 @@ </section> -<section id="wbwGetStyleRaw"><title>getStyleRaw</title> +<section id="wbwGetStyleRaw xreflabel="getStyleRaw"><title>getStyleRaw</title> <programlisting> WindowBase::<xref linkend="mthGetStyleRaw"/> @@ -10657,7 +10657,7 @@ </section> -<section id="wbwGetText"><title>getText</title> +<section id="wbwGetText xreflabel="getText"><title>getText</title> <programlisting> WindowBase::<xref linkend="mthGetText"/> @@ -10668,7 +10668,7 @@ </section> -<section id="wbwGetTextSizePx"><title>getTextSizePx</title> +<section id="wbwGetTextSizePx xreflabel="getTextSizePx"><title>getTextSizePx</title> <programlisting> WindowBase::<xref linkend="mthGetTextSizePx"/> @@ -10679,7 +10679,7 @@ </section> -<section id="wbwGetTextSizeScreen"><title>getTextSizeScreen</title> +<section id="wbwGetTextSizeScreen xreflabel="getTextSizeScreen"><title>getTextSizeScreen</title> <programlisting> WindowBase::<xref linkend="mthGetTextSizeScreen"/> @@ -10691,7 +10691,7 @@ </section> -<section id="wbwHide"><title>hide</title> +<section id="wbwHide xreflabel="hide"><title>hide</title> <programlisting> WindowBase::<xref linkend="mthHide"/> @@ -10702,7 +10702,7 @@ </section> -<section id="wbwHideFast"><title>hideFast</title> +<section id="wbwHideFast xreflabel="hideFast"><title>hideFast</title> <programlisting> WindowBase::<xref linkend="mthHideFast"/> @@ -10713,7 +10713,7 @@ </section> -<section id="wbwIsEnabled"><title>isEnabled</title> +<section id="wbwIsEnabled xreflabel="isEnabled"><title>isEnabled</title> <programlisting> WindowBase::<xref linkend="mthIsEnabled"/> @@ -10724,7 +10724,7 @@ </section> -<section id="wbwIsVisible"><title>isVisible</title> +<section id="wbwIsVisible xreflabel="isVisible"><title>isVisible</title> <programlisting> WindowBase::<xref linkend="mthIsVisible"/> @@ -10735,7 +10735,7 @@ </section> -<section id="wbwMove"><title>move</title> +<section id="wbwMove xreflabel="move"><title>move</title> <programlisting> WindowBase::<xref linkend="mthMove"/> @@ -10747,7 +10747,7 @@ </section> -<section id="wbwMoveTo"><title>moveTo</title> +<section id="wbwMoveTo xreflabel="moveTo"><title>moveTo</title> <programlisting> WindowBase::<xref linkend="mthMoveTo"/> @@ -10769,7 +10769,7 @@ </section> -<section id="wbwRedraw"><title>redraw</title> +<section id="wbwRedraw xreflabel="redraw"><title>redraw</title> <programlisting> WindowBase::<xref linkend="mthRedraw"/> @@ -10780,7 +10780,7 @@ </section> -<section id="wbwRedrawClient"><title>redrawClient</title> +<section id="wbwRedrawClient xreflabel="redrawClient"><title>redrawClient</title> <programlisting> WindowBase::<xref linkend="mthRedrawClient"/> @@ -10792,7 +10792,7 @@ </section> -<section id="wbwResize"><title>resize</title> +<section id="wbwResize xreflabel="resize"><title>resize</title> <programlisting> WindowBase::<xref linkend="mthResize"/> @@ -10804,7 +10804,7 @@ </section> -<section id="wbwResizeTo"><title>resizeTo</title> +<section id="wbwResizeTo xreflabel="resizeTo"><title>resizeTo</title> <programlisting> WindowBase::<xref linkend="mthResizeTo"/> @@ -10825,7 +10825,7 @@ </section> -<section id="wbwScreen2client"><title>screen2client</title> +<section id="wbwScreen2client xreflabel="screen2client"><title>screen2client</title> <programlisting> WindowBase::<xref linkend="mthScreen2client"/> @@ -10836,7 +10836,7 @@ </section> -<section id="wbwScreenToClient"><title>screenToClient</title> +<section id="wbwScreenToClient xreflabel="screenToClient"><title>screenToClient</title> <programlisting> WindowBase::<xref linkend="mthScreenToClient"/> @@ -10847,7 +10847,7 @@ </section> -<section id="wbwSendMessage"><title>sendMessage</title> +<section id="wbwSendMessage xreflabel="sendMessage"><title>sendMessage</title> <programlisting> WindowBase::<xref linkend="mthSendMessage"/> @@ -10858,7 +10858,7 @@ </section> -<section id="wbwSendMessageHandle"><title>sendMessageHandle</title> +<section id="wbwSendMessageHandle xreflabel="sendMessageHandle"><title>sendMessageHandle</title> <programlisting> <xref linkend="mthSendMessageHandle"/> @@ -10869,7 +10869,7 @@ </section> -<section id="wbwSetRect"><title>setRect</title> +<section id="wbwSetRect xreflabel="setRect"><title>setRect</title> <programlisting> WindowBase::<xref linkend="mthSetRect"/> @@ -10898,7 +10898,7 @@ </section> -<section id="wbwSetText"><title>setText</title> +<section id="wbwSetText xreflabel="setText"><title>setText</title> <programlisting> WindowBase::<xref linkend="mthSetText"/> @@ -10909,7 +10909,7 @@ </section> -<section id="wbwSetTitle"><title>setTitle</title> +<section id="wbwSetTitle xreflabel="setTitle"><title>setTitle</title> <programlisting> WindowBase::<xref linkend="mthSetTitle"/> @@ -10920,7 +10920,7 @@ </section> -<section id="wbwShowFast"><title>showFast</title> +<section id="wbwShowFast xreflabel="showFast"><title>showFast</title> <programlisting> WindowBase::<xref linkend="mthShowFast"/> @@ -10931,7 +10931,7 @@ </section> -<section id="wbwTitle"><title>title</title> +<section id="wbwTitle xreflabel="title"><title>title</title> <programlisting> WindowBase::<xref linkend="mthTitle"/> @@ -10953,7 +10953,7 @@ </section> -<section id="wbwUpdate"><title>update</title> +<section id="wbwUpdate xreflabel="update"><title>update</title> <programlisting> WindowBase::<xref linkend="mthUpdate"/> @@ -10963,7 +10963,7 @@ </section> -<section id="wbwWindowRect"><title>windowRect</title> +<section id="wbwWindowRect xreflabel="windowRect"><title>windowRect</title> <programlisting> WindowBase::<xref linkend="mthWindowRect"/> |
From: <mie...@us...> - 2012-09-03 04:35:08
|
Revision: 8358 http://sourceforge.net/p/oorexx/code-0/8358 Author: miesfeld Date: 2012-09-03 04:35:06 +0000 (Mon, 03 Sep 2012) Log Message: ----------- ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/utilityclasses.xml Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-03 04:26:33 UTC (rev 8357) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-03 04:35:06 UTC (rev 8358) @@ -707,7 +707,7 @@ </table> </section> -<section id="pbdGetFontName xreflabel="getFontName"><title>getFontName (Class method)</title> +<section id="pbdGetFontName" xreflabel="getFontName"><title>getFontName (Class method)</title> <programlisting> PlainBaseDialog::<xref linkend="mthClsGetFontName"/> @@ -717,7 +717,7 @@ </programlisting> </section> -<section id="pbdGetFontSize xreflabel="getFontSize"><title>getFontSize (Class method)</title> +<section id="pbdGetFontSize" xreflabel="getFontSize"><title>getFontSize (Class method)</title> <programlisting> PlainBaseDialog::<xref linkend="mthClsGetFontSize"/> @@ -727,7 +727,7 @@ </programlisting> </section> -<section id="pbdNew xreflabel="new"><title>new (Class method)</title> +<section id="pbdNew" xreflabel="new"><title>new (Class method)</title> <programlisting> PlainBaseDialog::<xref linkend="mthNewDialogObject"/> @@ -738,7 +738,7 @@ </programlisting> </section> -<section id="pbdSetDefaultFont xreflabel="setDefaultFont"><title>setDefaultFont (Class method)</title> +<section id="pbdSetDefaultFont" xreflabel="setDefaultFont"><title>setDefaultFont (Class method)</title> <programlisting> PlainBaseDialog::<xref linkend="mthClsSetDefaultFont"/> @@ -748,7 +748,7 @@ </programlisting> </section> -<section id="pbdAutoDetect xreflabel="autoDetect"><title>autoDetect (Attribute)</title> +<section id="pbdAutoDetect" xreflabel="autoDetect"><title>autoDetect (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrAutoDetect"/> @@ -760,7 +760,7 @@ </programlisting> </section> -<section id="pbdDlgHandle xreflabel="dlgHandle"><title>dlgHandle (Attribute)</title> +<section id="pbdDlgHandle" xreflabel="dlgHandle"><title>dlgHandle (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrDlgHandle"/> @@ -769,7 +769,7 @@ </programlisting> </section> -<section id="pbdFontName xreflabel="fontName"><title>fontName (Attribute)</title> +<section id="pbdFontName" xreflabel="fontName"><title>fontName (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrFontName"/> @@ -781,7 +781,7 @@ </programlisting> </section> -<section id="pbdFontSize xreflabel="fontSize"><title>fontSize (Attribute)</title> +<section id="pbdFontSize" xreflabel="fontSize"><title>fontSize (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrFontSize"/> @@ -793,7 +793,7 @@ </programlisting> </section> -<section id="pbdOwnerDialog xreflabel="ownerDialog"><title>ownerDialog (Attribute)</title> +<section id="pbdOwnerDialog" xreflabel="ownerDialog"><title>ownerDialog (Attribute)</title> <programlisting> PlainBaseDialog::<xref linkend="atrOwnerDialog"/> Modified: docs/trunk/publican/oodialog/en-US/utilityclasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/utilityclasses.xml 2012-09-03 04:26:33 UTC (rev 8357) +++ docs/trunk/publican/oodialog/en-US/utilityclasses.xml 2012-09-03 04:35:06 UTC (rev 8358) @@ -9129,8 +9129,8 @@ <table id="tblVKMethods" frame="all"> <title>Methods of the VK class</title> <tgroup cols="2"> -<colspec colwidth="2*" /> -<colspec colwidth="7*" /> +<colspec colwidth="1*" /> +<colspec colwidth="3*" /> <thead> <row> <entry>Method</entry> @@ -10362,7 +10362,7 @@ </variablelist> </section> -<section id="wbwInitCode xreflabel="initCode"><title>initCode (Attribute)</title> +<section id="wbwInitCode" xreflabel="initCode"><title>initCode (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrInitCode"/> @@ -10375,7 +10375,7 @@ </programlisting> </section> -<section id="wbwHwnd xreflabel="hwnd"><title>hwnd (Attribute)</title> +<section id="wbwHwnd" xreflabel="hwnd"><title>hwnd (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrHwnd"/> @@ -10386,7 +10386,7 @@ </programlisting> </section> -<section id="wbwFactorX xreflabel="factorX"><title>factorX (Attribute)</title> +<section id="wbwFactorX" xreflabel="factorX"><title>factorX (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrFactorX"/> @@ -10399,7 +10399,7 @@ </programlisting> </section> -<section id="wbwFactorY xreflabel="factorY"><title>factorY (Attribute)</title> +<section id="wbwFactorY" xreflabel="factorY"><title>factorY (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrFactorY"/> @@ -10412,7 +10412,7 @@ </programlisting> </section> -<section id="wbwPixelCX xreflabel="pixelCX"><title>pixelCX (Attribute)</title> +<section id="wbwPixelCX" xreflabel="pixelCX"><title>pixelCX (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrPixelCX"/> @@ -10422,7 +10422,7 @@ </programlisting> </section> -<section id="wbwPixelCY xreflabel="pixelCY"><title>pixelCY (Attribute)</title> +<section id="wbwPixelCY" xreflabel="pixelCY"><title>pixelCY (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrPixelCY"/> @@ -10432,7 +10432,7 @@ </programlisting> </section> -<section id="wbwSizeX xreflabel="sizeX"><title>sizeX (Attribute)</title> +<section id="wbwSizeX" xreflabel="sizeX"><title>sizeX (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrSizeX"/> @@ -10444,7 +10444,7 @@ </programlisting> </section> -<section id="wbwSizeY xreflabel="sizeY"><title>sizeY (Attribute)</title> +<section id="wbwSizeY" xreflabel="sizeY"><title>sizeY (Attribute)</title> <programlisting> WindowBase::<xref linkend="atrSizeY"/> @@ -10457,7 +10457,7 @@ </section> -<section id="wbwClear xreflabel="clear"><title>clear</title> +<section id="wbwClear" xreflabel="clear"><title>clear</title> <programlisting> WindowBase::<xref linkend="mthClear"/> @@ -10468,7 +10468,7 @@ </section> -<section id="wbwClient2screen xreflabel="client2screen"><title>client2screen</title> +<section id="wbwClient2screen" xreflabel="client2screen"><title>client2screen</title> <programlisting> WindowBase::<xref linkend="mthClient2screen"/> @@ -10479,7 +10479,7 @@ </section> -<section id="wbwClientRect xreflabel="clientRect"><title>clientRect</title> +<section id="wbwClientRect" xreflabel="clientRect"><title>clientRect</title> <programlisting> WindowBase::<xref linkend="mthClientRect"/> @@ -10491,7 +10491,7 @@ </section> -<section id="wbwClientToScreen xreflabel="clientToScreen"><title>clientToScreen</title> +<section id="wbwClientToScreen" xreflabel="clientToScreen"><title>clientToScreen</title> <programlisting> WindowBase::<xref linkend="mthClientToScreen"/> @@ -10502,7 +10502,7 @@ </section> -<section id="wbwDisable xreflabel="disable"><title>disable</title> +<section id="wbwDisable" xreflabel="disable"><title>disable</title> <programlisting> WindowBase::<xref linkend="mthDisable"/> @@ -10513,7 +10513,7 @@ </section> -<section id="wbwDisplay xreflabel="display"><title>display</title> +<section id="wbwDisplay" xreflabel="display"><title>display</title> <programlisting> WindowBase::<xref linkend="mthDisplay"/> @@ -10523,7 +10523,7 @@ </section> -<section id="wbwDraw xreflabel="draw"><title>draw</title> +<section id="wbwDraw" xreflabel="draw"><title>draw</title> <programlisting> WindowBase::<xref linkend="mthDraw"/> @@ -10534,7 +10534,7 @@ </section> -<section id="wbwEnable xreflabel="enable"><title>enable</title> +<section id="wbwEnable" xreflabel="enable"><title>enable</title> <programlisting> WindowBase::<xref linkend="mthEnable"/> @@ -10545,7 +10545,7 @@ </section> -<section id="wbwForegroundWindow xreflabel="foregroundWindow"><title>foregroundWindow</title> +<section id="wbwForegroundWindow" xreflabel="foregroundWindow"><title>foregroundWindow</title> <programlisting> WindowBase::<xref linkend="mthForegroundWindow"/> @@ -10556,7 +10556,7 @@ </section> -<section id="wbwGetClientRect xreflabel="getClientRect"><title>getClientRect</title> +<section id="wbwGetClientRect" xreflabel="getClientRect"><title>getClientRect</title> <programlisting> WindowBase::<xref linkend="mthGetClientRect"/> @@ -10568,7 +10568,7 @@ </section> -<section id="wbwGetExStyleRaw xreflabel="getExStyleRaw"><title>getExStyleRaw</title> +<section id="wbwGetExStyleRaw" xreflabel="getExStyleRaw"><title>getExStyleRaw</title> <programlisting> WindowBase::<xref linkend="mthGetExStyleRaw"/> @@ -10579,7 +10579,7 @@ </section> -<section id="wbwGetID xreflabel="getID"><title>getID</title> +<section id="wbwGetID" xreflabel="getID"><title>getID</title> <programlisting> WindowBase::<xref linkend="mthGetID"/> @@ -10590,7 +10590,7 @@ </section> -<section id="wbwGetPos xreflabel="getPos"><title>getPos</title> +<section id="wbwGetPos" xreflabel="getPos"><title>getPos</title> <programlisting> WindowBase::<xref linkend="mthGetPos"/> @@ -10602,7 +10602,7 @@ </section> -<section id="wbwGetRealPos xreflabel="getRealPos"><title>getRealPos</title> +<section id="wbwGetRealPos" xreflabel="getRealPos"><title>getRealPos</title> <programlisting> WindowBase::<xref linkend="mthGetSize"/> @@ -10613,7 +10613,7 @@ </section> -<section id="wbwGetRealSize xreflabel="getRealSize"><title>getRealSize</title> +<section id="wbwGetRealSize" xreflabel="getRealSize"><title>getRealSize</title> <programlisting> WindowBase::<xref linkend="mthGetRealSize"/> @@ -10624,7 +10624,7 @@ </section> -<section id="wbwGetRect xreflabel="getRect"><title>getRect</title> +<section id="wbwGetRect" xreflabel="getRect"><title>getRect</title> <programlisting> WindowBase::<xref linkend="mthGetRect"/> @@ -10635,7 +10635,7 @@ </section> -<section id="wbwGetSize xreflabel="getSize"><title>getSize</title> +<section id="wbwGetSize" xreflabel="getSize"><title>getSize</title> <programlisting> WindowBase::<xref linkend="mthGetSize"/> @@ -10646,7 +10646,7 @@ </section> -<section id="wbwGetStyleRaw xreflabel="getStyleRaw"><title>getStyleRaw</title> +<section id="wbwGetStyleRaw" xreflabel="getStyleRaw"><title>getStyleRaw</title> <programlisting> WindowBase::<xref linkend="mthGetStyleRaw"/> @@ -10657,7 +10657,7 @@ </section> -<section id="wbwGetText xreflabel="getText"><title>getText</title> +<section id="wbwGetText" xreflabel="getText"><title>getText</title> <programlisting> WindowBase::<xref linkend="mthGetText"/> @@ -10668,7 +10668,7 @@ </section> -<section id="wbwGetTextSizePx xreflabel="getTextSizePx"><title>getTextSizePx</title> +<section id="wbwGetTextSizePx" xreflabel="getTextSizePx"><title>getTextSizePx</title> <programlisting> WindowBase::<xref linkend="mthGetTextSizePx"/> @@ -10679,7 +10679,7 @@ </section> -<section id="wbwGetTextSizeScreen xreflabel="getTextSizeScreen"><title>getTextSizeScreen</title> +<section id="wbwGetTextSizeScreen" xreflabel="getTextSizeScreen"><title>getTextSizeScreen</title> <programlisting> WindowBase::<xref linkend="mthGetTextSizeScreen"/> @@ -10691,7 +10691,7 @@ </section> -<section id="wbwHide xreflabel="hide"><title>hide</title> +<section id="wbwHide" xreflabel="hide"><title>hide</title> <programlisting> WindowBase::<xref linkend="mthHide"/> @@ -10702,7 +10702,7 @@ </section> -<section id="wbwHideFast xreflabel="hideFast"><title>hideFast</title> +<section id="wbwHideFast" xreflabel="hideFast"><title>hideFast</title> <programlisting> WindowBase::<xref linkend="mthHideFast"/> @@ -10713,7 +10713,7 @@ </section> -<section id="wbwIsEnabled xreflabel="isEnabled"><title>isEnabled</title> +<section id="wbwIsEnabled" xreflabel="isEnabled"><title>isEnabled</title> <programlisting> WindowBase::<xref linkend="mthIsEnabled"/> @@ -10724,7 +10724,7 @@ </section> -<section id="wbwIsVisible xreflabel="isVisible"><title>isVisible</title> +<section id="wbwIsVisible" xreflabel="isVisible"><title>isVisible</title> <programlisting> WindowBase::<xref linkend="mthIsVisible"/> @@ -10735,7 +10735,7 @@ </section> -<section id="wbwMove xreflabel="move"><title>move</title> +<section id="wbwMove" xreflabel="move"><title>move</title> <programlisting> WindowBase::<xref linkend="mthMove"/> @@ -10747,7 +10747,7 @@ </section> -<section id="wbwMoveTo xreflabel="moveTo"><title>moveTo</title> +<section id="wbwMoveTo" xreflabel="moveTo"><title>moveTo</title> <programlisting> WindowBase::<xref linkend="mthMoveTo"/> @@ -10769,7 +10769,7 @@ </section> -<section id="wbwRedraw xreflabel="redraw"><title>redraw</title> +<section id="wbwRedraw" xreflabel="redraw"><title>redraw</title> <programlisting> WindowBase::<xref linkend="mthRedraw"/> @@ -10780,7 +10780,7 @@ </section> -<section id="wbwRedrawClient xreflabel="redrawClient"><title>redrawClient</title> +<section id="wbwRedrawClient" xreflabel="redrawClient"><title>redrawClient</title> <programlisting> WindowBase::<xref linkend="mthRedrawClient"/> @@ -10792,7 +10792,7 @@ </section> -<section id="wbwResize xreflabel="resize"><title>resize</title> +<section id="wbwResize" xreflabel="resize"><title>resize</title> <programlisting> WindowBase::<xref linkend="mthResize"/> @@ -10804,7 +10804,7 @@ </section> -<section id="wbwResizeTo xreflabel="resizeTo"><title>resizeTo</title> +<section id="wbwResizeTo" xreflabel="resizeTo"><title>resizeTo</title> <programlisting> WindowBase::<xref linkend="mthResizeTo"/> @@ -10825,7 +10825,7 @@ </section> -<section id="wbwScreen2client xreflabel="screen2client"><title>screen2client</title> +<section id="wbwScreen2client" xreflabel="screen2client"><title>screen2client</title> <programlisting> WindowBase::<xref linkend="mthScreen2client"/> @@ -10836,7 +10836,7 @@ </section> -<section id="wbwScreenToClient xreflabel="screenToClient"><title>screenToClient</title> +<section id="wbwScreenToClient" xreflabel="screenToClient"><title>screenToClient</title> <programlisting> WindowBase::<xref linkend="mthScreenToClient"/> @@ -10847,7 +10847,7 @@ </section> -<section id="wbwSendMessage xreflabel="sendMessage"><title>sendMessage</title> +<section id="wbwSendMessage" xreflabel="sendMessage"><title>sendMessage</title> <programlisting> WindowBase::<xref linkend="mthSendMessage"/> @@ -10858,7 +10858,7 @@ </section> -<section id="wbwSendMessageHandle xreflabel="sendMessageHandle"><title>sendMessageHandle</title> +<section id="wbwSendMessageHandle" xreflabel="sendMessageHandle"><title>sendMessageHandle</title> <programlisting> <xref linkend="mthSendMessageHandle"/> @@ -10869,7 +10869,7 @@ </section> -<section id="wbwSetRect xreflabel="setRect"><title>setRect</title> +<section id="wbwSetRect" xreflabel="setRect"><title>setRect</title> <programlisting> WindowBase::<xref linkend="mthSetRect"/> @@ -10898,7 +10898,7 @@ </section> -<section id="wbwSetText xreflabel="setText"><title>setText</title> +<section id="wbwSetText" xreflabel="setText"><title>setText</title> <programlisting> WindowBase::<xref linkend="mthSetText"/> @@ -10909,7 +10909,7 @@ </section> -<section id="wbwSetTitle xreflabel="setTitle"><title>setTitle</title> +<section id="wbwSetTitle" xreflabel="setTitle"><title>setTitle</title> <programlisting> WindowBase::<xref linkend="mthSetTitle"/> @@ -10920,7 +10920,7 @@ </section> -<section id="wbwShowFast xreflabel="showFast"><title>showFast</title> +<section id="wbwShowFast" xreflabel="showFast"><title>showFast</title> <programlisting> WindowBase::<xref linkend="mthShowFast"/> @@ -10931,7 +10931,7 @@ </section> -<section id="wbwTitle xreflabel="title"><title>title</title> +<section id="wbwTitle" xreflabel="title"><title>title</title> <programlisting> WindowBase::<xref linkend="mthTitle"/> @@ -10953,7 +10953,7 @@ </section> -<section id="wbwUpdate xreflabel="update"><title>update</title> +<section id="wbwUpdate" xreflabel="update"><title>update</title> <programlisting> WindowBase::<xref linkend="mthUpdate"/> @@ -10963,7 +10963,7 @@ </section> -<section id="wbwWindowRect xreflabel="windowRect"><title>windowRect</title> +<section id="wbwWindowRect" xreflabel="windowRect"><title>windowRect</title> <programlisting> WindowBase::<xref linkend="mthWindowRect"/> |
From: <mie...@us...> - 2012-09-03 04:44:09
|
Revision: 8359 http://sourceforge.net/p/oorexx/code-0/8359 Author: miesfeld Date: 2012-09-03 04:44:06 +0000 (Mon, 03 Sep 2012) Log Message: ----------- ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/windowExtensions.xml Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-03 04:35:06 UTC (rev 8358) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-03 04:44:06 UTC (rev 8359) @@ -2190,8 +2190,8 @@ <table id="tblDialogControl" frame="all"> <title>DialogControl Method Reference</title> <tgroup cols="2"> -<colspec colwidth="1*" /> -<colspec colwidth="4*" /> +<colspec colwidth="2*" /> +<colspec colwidth="7*" /> <thead> <row> <entry>DialogControl Method</entry> @@ -2298,7 +2298,7 @@ </section> -<section id="dcoAssignFocus"><title>assignFocus</title> +<section id="dcoAssignFocus" xreflabel="assignFocus"><title>assignFocus</title> <programlisting> DialogControl::<xref linkend="mthAssignFocus"/> @@ -2308,7 +2308,7 @@ </programlisting> </section> -<section id="dcoClearRect"><title>clearRect</title> +<section id="dcoClearRect" xreflabel="clearRect"><title>clearRect</title> <programlisting> DialogControl::<xref linkend="mthClearRectClsDialogControl"/> @@ -2336,7 +2336,7 @@ </programlisting> </section> -<section id="dcoConnectCharEvent"><title>connectCharEvent</title> +<section id="dcoConnectCharEvent" xreflabel="connectCharEvent"><title>connectCharEvent</title> <programlisting> DialogControl::<xref linkend="mthConnectCharEvent"/> @@ -2347,7 +2347,7 @@ </programlisting> </section> -<section id="dcoConnectFKeyPress"><title>connectFKeyPress</title> +<section id="dcoConnectFKeyPress" xreflabel="connectFKeyPress"><title>connectFKeyPress</title> <programlisting> DialogControl::<xref linkend="mthConnectFKeyPressDialogControlObject"/> @@ -2357,7 +2357,7 @@ </programlisting> </section> -<section id="dcoConnectKeyPress"><title>connectKeyPress</title> +<section id="dcoConnectKeyPress" xreflabel="connectKeyPress"><title>connectKeyPress</title> <programlisting> DialogControl::<xref linkend="mthConnectKeyPressDialogControlObject"/> @@ -2368,7 +2368,7 @@ </programlisting> </section> -<section id="dcoData"><title>data</title> +<section id="dcoData" xreflabel="data"><title>data</title> <programlisting> DialogControl::<xref linkend="mthData"/> @@ -2388,7 +2388,7 @@ </programlisting> </section> -<section id="dcoDisconnectKeyPress"><title>disconnectKeyPress</title> +<section id="dcoDisconnectKeyPress" xreflabel="disconnectKeyPress"><title>disconnectKeyPress</title> <programlisting> DialogControl::<xref linkend="mthDisconnectKeyPressDialogControlObject"/> @@ -2399,7 +2399,7 @@ </programlisting> </section> -<section id="dcoGetTextSizeDlg"><title>getTextSizeDlg</title> +<section id="dcoGetTextSizeDlg" xreflabel="getTextSizeDlg"><title>getTextSizeDlg</title> <programlisting> DialogControl::<xref linkend="mthGetTextSizeDlgClsDialogControl"/> @@ -2410,7 +2410,7 @@ </programlisting> </section> -<section id="dcoGroup"><title>group</title> +<section id="dcoGroup" xreflabel="group"><title>group</title> <programlisting> DialogControl::<xref linkend="mthGroup"/> @@ -2421,7 +2421,7 @@ </programlisting> </section> -<section id="dcoHasKeyPressConnection"><title>hasKeyPressConnection</title> +<section id="dcoHasKeyPressConnection" xreflabel="hasKeyPressConnection"><title>hasKeyPressConnection</title> <programlisting> DialogControl::<xref linkend="mthHasKeyPressConnectionDialogControlObject"/> @@ -2432,7 +2432,7 @@ </programlisting> </section> -<section id="dcoRedrawRect"><title>redrawRect</title> +<section id="dcoRedrawRect" xreflabel="redrawRect"><title>redrawRect</title> <programlisting> DialogControl::<xref linkend="mthRedrawRectClsDialogControl"/> @@ -2461,7 +2461,7 @@ </programlisting> </section> -<section id="dcoSetColor"><title>setColor</title> +<section id="dcoSetColor" xreflabel="setColor"><title>setColor</title> <programlisting> DialogControl::<xref linkend="mthSetColor"/> @@ -2472,7 +2472,7 @@ </programlisting> </section> -<section id="dcoSetSysColor"><title>setSysColor</title> +<section id="dcoSetSysColor" xreflabel="setSysColor"><title>setSysColor</title> <programlisting> DialogControl::<xref linkend="mthSetSysColor"/> @@ -2483,7 +2483,7 @@ </programlisting> </section> -<section id="dcoTabStop"><title>tabStop</title> +<section id="dcoTabStop" xreflabel="tabStop"><title>tabStop</title> <programlisting> DialogControl::<xref linkend="mthTabStop"/> @@ -2494,7 +2494,7 @@ </programlisting> </section> -<section id="dcoTextSize"><title>textSize</title> +<section id="dcoTextSize" xreflabel="textSize"><title>textSize</title> <programlisting> DialogControl::<xref linkend="mthTextSize"/> @@ -2504,7 +2504,7 @@ </programlisting> </section> -<section id="dcoUseUnicode"><title>useUnicode</title> +<section id="dcoUseUnicode" xreflabel="useUnicode"><title>useUnicode</title> <programlisting> DialogControl::<xref linkend="mthUseUnicode"/> @@ -2514,7 +2514,7 @@ </programlisting> </section> -<section id="dcoUsingUnicode"><title>usingUnicode</title> +<section id="dcoUsingUnicode" xreflabel="usingUnicode"><title>usingUnicode</title> <programlisting> DialogControl::<xref linkend="mthUsingUnicode"/> Modified: docs/trunk/publican/oodialog/en-US/windowExtensions.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/windowExtensions.xml 2012-09-03 04:35:06 UTC (rev 8358) +++ docs/trunk/publican/oodialog/en-US/windowExtensions.xml 2012-09-03 04:44:06 UTC (rev 8359) @@ -73,7 +73,7 @@ </para> <table id="tblMethodsWindowExtensions" frame="all"> <title>WindowExtension Method Reference</title> <tgroup cols="2"> -<colspec colwidth="1*" /><colspec colwidth="3*" /> +<colspec colwidth="2*" /><colspec colwidth="7*" /> <thead> <row> <entry>Method</entry> |
From: <mie...@us...> - 2012-09-03 05:18:15
|
Revision: 8360 http://sourceforge.net/p/oorexx/code-0/8360 Author: miesfeld Date: 2012-09-03 05:18:12 +0000 (Mon, 03 Sep 2012) Log Message: ----------- ooDialog doc Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/eventNotification.xml docs/trunk/publican/oodialog/en-US/menus.xml docs/trunk/publican/oodialog/en-US/treeview.xml docs/trunk/publican/oodialog/en-US/userdialog.xml Modified: docs/trunk/publican/oodialog/en-US/dialogExtensions.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-03 04:44:06 UTC (rev 8359) +++ docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-03 05:18:12 UTC (rev 8360) @@ -43,7 +43,7 @@ # ######################################################################### --> -<section id="clsDialogExtensions"><title>DialogExtensions Mixin Class</title> +<section id="clsDialogExtensions" xreflabel="DialogExtensions"><title>DialogExtensions Mixin Class</title> <indexterm><primary>DialogExtensions Class</primary></indexterm> <para> The <computeroutput>DialogExtensions</computeroutput> class is a <emphasis role="italic">mixin</emphasis> class @@ -61,7 +61,7 @@ <table id="tblDialogExtensionsMethods" frame="all"> <title>DialogExtensions Methods</title> <tgroup cols="2"> -<colspec colwidth="1*" /><colspec colwidth="4*" /> +<colspec colwidth="2*" /><colspec colwidth="7*" /> <thead> <row> <entry>Method</entry> @@ -271,7 +271,7 @@ </row> <row> <entry><xref linkend="mthSetListItemHeightPx"/></entry> -<entry>Sets the height for all items in a list box in dialog units.</entry> +<entry>Sets the height for all items in a list box in pixels.</entry> </row> <row> <entry><xref linkend="mthSetListWidth"/></entry> Modified: docs/trunk/publican/oodialog/en-US/eventNotification.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-03 04:44:06 UTC (rev 8359) +++ docs/trunk/publican/oodialog/en-US/eventNotification.xml 2012-09-03 05:18:12 UTC (rev 8360) @@ -537,8 +537,8 @@ <table id="tblEventNotificationMethods" frame="all"> <title>EventNotification Methods</title> <tgroup cols="2"> -<colspec colwidth="1*" /> -<colspec colwidth="3*" /> +<colspec colwidth="2*" /> +<colspec colwidth="5*" /> <thead> <row> <entry>Method</entry> Modified: docs/trunk/publican/oodialog/en-US/menus.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/menus.xml 2012-09-03 04:44:06 UTC (rev 8359) +++ docs/trunk/publican/oodialog/en-US/menus.xml 2012-09-03 05:18:12 UTC (rev 8360) @@ -763,7 +763,7 @@ </section> <!-- End Section::Menu Command Items --> -<section id="clsMenu"><title>The Menu Object</title> +<section id="clsMenu" xreflabel="Menu"><title>The Menu Object</title> <indexterm><primary>Menu class</primary></indexterm> <indexterm><primary>The Menu Object</primary></indexterm> <indexterm><primary>menu object</primary></indexterm> @@ -5946,7 +5946,7 @@ </section> <!-- End Menu class --> -<section id="clsMenuBar"><title>The Menu Bar Object</title> +<section id="clsMenuBar" xreflabel="MenuBar"><title>The Menu Bar Object</title> <indexterm><primary>MenuBar class</primary></indexterm> <indexterm><primary>The MenuBar Object</primary></indexterm> <indexterm><primary>menu bar object</primary></indexterm> Modified: docs/trunk/publican/oodialog/en-US/treeview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-03 04:44:06 UTC (rev 8359) +++ docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-03 05:18:12 UTC (rev 8360) @@ -2391,7 +2391,7 @@ </variablelist> </section> -<section id="clsTvCustomDrawSimple"><title>TvCustomDrawSimple Class</title> +<section id="clsTvCustomDrawSimple" xreflabel="TvCustomDrawSimple"><title>TvCustomDrawSimple Class</title> <indexterm><primary>TvCustomDrawSimple class</primary></indexterm> <para> A <computeroutput>TvCustomDrawSimple</computeroutput> object is used when a <link Modified: docs/trunk/publican/oodialog/en-US/userdialog.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-03 04:44:06 UTC (rev 8359) +++ docs/trunk/publican/oodialog/en-US/userdialog.xml 2012-09-03 05:18:12 UTC (rev 8360) @@ -1167,7 +1167,7 @@ The height of the control in dialog units. </para> </listitem></varlistentry> - <varlistentry><term id="idArgument"><emphasis role="bold">id</emphasis></term> + <varlistentry><term id="idArgument" xreflabel="resource ID"><emphasis role="bold">id</emphasis></term> <listitem> <para id="paraResourceIDs" xreflabel="resource ID"> All dialog controls have a numeric <xref linkend="defResourceId"/>. The ooDialog framework is designed to accept a @@ -1214,14 +1214,13 @@ internally handles the drawing of the button. </para> <para> - <emphasis role="bold">Note:</emphasis> On Windows XP and later, using an <xref linkend="mthSetImageList"/> - list with the button will produce a better overall appearance in the dialog. Using an image list gives the button the - same look and feel as other buttons on the system. The buttons produced using the <emphasis - role="italic">createBitmapButton</emphasis> method and the - <xref linkend="mthInstallBitmapButton"/>() have the look and feel of Windows 98 buttons. When an - image list is used with a button, the other button styles, such as the NOTIFY style can still be used. Whereas with - the bitmap button the other button styles can not be used. The image list button supports all the features of the - bitmap button, and more. + <emphasis role="bold">Note:</emphasis> On Windows XP and later, using an <link linkend="mthSetImageList">image</link> list + with the button will produce a better overall appearance in the dialog. Using an image list gives the button the same look + and feel as other buttons on the system. The buttons produced using the <emphasis + role="italic">createBitmapButton</emphasis> and the <xref linkend="mthInstallBitmapButton"/> methods have the look and feel + of Windows 98 buttons. When an image list is used with a button, the other button styles, such as the NOTIFY style can + still be used. Whereas with the bitmap button the other button styles can not be used. The image list button supports all + the features of the bitmap button, and more. </para> <para> The bitmap arguments can be specified by either a file name, a bitmap handle, or the numeric resource ID of a bitmap @@ -1264,7 +1263,7 @@ <emphasis role="bold">Note:</emphasis> The 3.2.0 ooDialog documentation incorrectly stated you could use the NOTIFY style keyword. Do not do this. Owner-drawn buttons should not use any other button styles than OWNER or DEFAULT, and the OWNER style is automatically added by the ooDialog framework. The result of using the - NOTIFY style will be less than satisfactory. A button that uses an image <xref linkend="mthSetImageList"/> + NOTIFY style will be less than satisfactory. A button that uses an image <link linkend="mthSetImageList">list</link> allows the use of the NOTIFY style and will give a better overall look to the dialog. Using a button with an image list should be the preferred method for non-text buttons. </para> |
From: <mie...@us...> - 2012-09-03 16:48:17
|
Revision: 8361 http://sourceforge.net/p/oorexx/code-0/8361 Author: miesfeld Date: 2012-09-03 16:48:15 +0000 (Mon, 03 Sep 2012) Log Message: ----------- ooDialog doc work Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/overview.xml Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-03 05:18:12 UTC (rev 8360) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-03 16:48:15 UTC (rev 8361) @@ -3790,7 +3790,79 @@ <indexterm><primary>custom draw</primary><secondary>overview</secondary></indexterm> <para> + All windows in the Windows operating system periodically paint and erase themselves based on messages received from the + system or other applications. This process of painting or erasing is called a paint cycle. The common controls + that support custom draw send <xref linkend="ovvEvents"/> notifications at specific points while the control is being + drawn. The notifications describe drawing operations that apply to the entire control as well as drawing operations + specific to items within the control. +</para> +<para> + Part of the the information sent in the custom draw notification is what stage of paint cycle the control is in. The stage + will either be part of the overall painting of the control or part of the painting of an item the control contains. The + stage is identified by a constant value supplied by the <xref linkend="clsCustomDraw"/> class. The possible draw stages are + described in the following table: +<table id="tblCustomDrawStage" frame="all"> <title>Stages of Custom Draw</title> +<tgroup cols="2"> +<colspec colwidth="1*"/> +<colspec colwidth="4*"/> +<thead> +<row> +<entry>Constant Value</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry align="center"><emphasis role="bold">Global Stages</emphasis></entry> +<entry align="center"><emphasis role="bold">Draw Stages</emphasis></entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_PREPAINT"/></entry> +<entry>This stage is before the paint cycle begins.</entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_POSTPAINT"/></entry> +<entry>This stage is after the paint cycle is complete.</entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_PREERASE"/></entry> +<entry>This stage is before the erase cycle begins. </entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_POSTERASE"/></entry> +<entry>This stage is after the erase cycle is complete.</entry> +</row> +<row> +<entry align="center"><emphasis role="bold">Item Specific</emphasis></entry> +<entry align="center"><emphasis role="bold">Draw Stages</emphasis></entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_ITEMPREPAINT"/></entry> +<entry>This stage is before an item is drawn.</entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_ITEMPOSTPAINT"/></entry> +<entry>This stage is after an item has been drawn.</entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_ITEMPREERASE "/></entry> +<entry>This stage is before an item is erased.</entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_ITEMPOSTERASE"/></entry> +<entry>This stage is after an item has been erased.</entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_SUBITEMPREPAINT"/></entry> +<entry>This stage is before an subitem is drawn. Only used in <xref linkend="clsListView"/> controls in report mode.</entry> +</row> +<row> +<entry><xref linkend="cnstCDDS_SUBITEMPOSTPAINT"/></entry> +<entry>This stage is after an subitem has been drawn. Only used in list-view controls in report mode.</entry> +</row> +</tbody></tgroup> +</table> </para> @@ -3877,30 +3949,108 @@ </para> <variablelist> - <varlistentry><term><emphasis role="bold">CDRF_DODEFAULT</emphasis></term> + <varlistentry id="cnstCDDS_PREPAINT" xreflabel="CDDS_PREPAINT"><term>CDDS_PREPAINT</term> <listitem> <para> xxx and xxx sss. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">CDRF_NEWFONT</emphasis></term> + <varlistentry id="cnstCDDS_POSTPAINT" xreflabel="CDDS_POSTPAINT"><term>CDDS_POSTPAINT</term> <listitem> <para> xxx and xxx sss. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">CDRF_SKIPDEFAULT</emphasis></term> + <varlistentry id="cnstCDDS_PREERASE" xreflabel="CDDS_PREERASE"><term>CDDS_PREERASE</term> <listitem> <para> xxx and xxx sss. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">CDRF_DOERASE</emphasis></term> + <varlistentry id="cnstCDDS_POSTERASE" xreflabel="CDDS_POSTERASE"><term><emphasis role="bold">CDDS_POSTERASE</emphasis></term> <listitem> <para> xxx and xxx sss. </para> </listitem></varlistentry> + <varlistentry id="cnstCDDS_ITEMPREPAINT " xreflabel="CDDS_ITEMPREPAINT "><term><emphasis role="bold">CDDS_ITEMPREPAINT </emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="cnstCDDS_ITEMPOSTPAINT" xreflabel="CDDS_ITEMPOSTPAINT"><term><emphasis role="bold">CDDS_ITEMPOSTPAINT</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="cnstCDDS_ITEMPREERASE" xreflabel="CDDS_ITEMPREERASE"><term><emphasis role="bold">CDDS_ITEMPREERASE</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="cnstCDDS_ITEMPOSTERASE" xreflabel="CDDS_ITEMPOSTERASE"><term><emphasis role="bold">CDDS_ITEMPOSTERASE</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="cnstCDDS_SUBITEMPREPAINT" xreflabel="CDDS_SUBITEMPREPAINT"><term><emphasis role="bold">CDDS_SUBITEMPREPAINT</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="cnstCDDS_SUBITEMPOSTPAINT" xreflabel="CDDS_SUBITEMPOSTPAINT"><term><emphasis role="bold">CDDS_SUBITEMPOSTPAINT</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="cnstCDRF_NOTIFYITEMDRAW " xreflabel="CDRF_NOTIFYITEMDRAW "><term><emphasis role="bold">CDRF_NOTIFYITEMDRAW</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="cnstCDRF_NOTIFYPOSTPAINT " xreflabel="CDRF_NOTIFYPOSTPAINT "><term><emphasis role="bold">CDRF_NOTIFYPOSTPAINT</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="cnst" xreflabel=""><term><emphasis role="bold"></emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="cnstCDRF_DODEFAULT" xreflabel="CDRF_DODEFAULT"><term><emphasis role="bold">CDRF_DODEFAULT</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="CDRF_NEWFONT" xreflabel="CDRF_NEWFONT"><term><emphasis role="bold">CDRF_NEWFONT</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="CDRF_SKIPDEFAULT" xreflabel="CDRF_SKIPDEFAULT"><term><emphasis role="bold">CDRF_SKIPDEFAULT</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> + <varlistentry id="CDRF_DOERASE" xreflabel="CDRF_DOERASE"><term><emphasis role="bold">CDRF_DOERASE</emphasis></term> + <listitem> + <para> + xxx and xxx sss. + </para> + </listitem></varlistentry> </variablelist> </section> Modified: docs/trunk/publican/oodialog/en-US/overview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/overview.xml 2012-09-03 05:18:12 UTC (rev 8360) +++ docs/trunk/publican/oodialog/en-US/overview.xml 2012-09-03 16:48:15 UTC (rev 8361) @@ -1554,7 +1554,7 @@ The primary areas that should be looked at for this unification are the <xref linkend="sctCreateMethods"/> methods of the UserDialog, methods concerned with connecting <link linkend="sctUnderstandingDataAttributes">data</link> attributes, methods returning an <link linkend="sctInstantiateControls">instantiated</link> dialog control object, and methods that - connect <xref linkend="sctMethodsEventNotification"/> notifications. + <link linkend="sctMethodsEventNotification">connect</link> notifications. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Simplification of Requires Statements</emphasis></term> |
From: <mie...@us...> - 2012-09-04 02:33:28
|
Revision: 8368 http://sourceforge.net/p/oorexx/code-0/8368 Author: miesfeld Date: 2012-09-04 02:33:25 +0000 (Tue, 04 Sep 2012) Log Message: ----------- ooDialog doc - work on custom draw doc Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/treeview.xml Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-04 02:30:39 UTC (rev 8367) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-04 02:33:25 UTC (rev 8368) @@ -3799,8 +3799,8 @@ <para> Part of the the information sent in the custom draw notification is what stage of the paint cycle the control is in. The stage will either be part of the overall painting of the control or part of the painting of an item the control contains. - The stage is identified by a constant value supplied by the <xref linkend="clsCustomDraw"/> class. The possible draw - stages are described in the following table: + The stage is identified by a constant value supplied by the <computeroutput>CustomDraw</computeroutput> class. The possible + draw stages are described in the following table: <table id="tblCustomDrawStage" frame="all"> <title>Stages of Custom Draw</title> <tgroup cols="2"> @@ -3814,7 +3814,7 @@ </thead> <tbody> <row> -<entry align="center"><emphasis role="bold">Global Stages</emphasis></entry> +<entry align="center"><emphasis role="bold">Global</emphasis></entry> <entry align="center"><emphasis role="bold">Draw Stages</emphasis></entry> </row> <row> @@ -3917,7 +3917,7 @@ <para> Custom draw can be used by the program to draw the entire item, or to change part of the way an item is drawn. Custom draw can be used to change the foreground and background colors, and the font used by the control for each item. For list-view - controls in report view, the programmer can also change change the colores and the font for each individual subitem. + controls in report view, the programmer can also change change the colors and the font for each individual subitem. </para> </section> <!-- End CustomDrawOverview section --> @@ -3944,7 +3944,7 @@ The dialog subclass does not have to be a <xref linkend="clsRcDialog"/> of course. It can be any dialog class supported by ooDialog, except the <xref linkend="clsPropertySheetDialog"/>. Recall that the property sheet dialog is managed by the operating system, not ooDialog. However, the pages of the property sheet dialog, any <xref - linkend="clsPropertySheetPage"/> dialog, can all use custom draw. + linkend="clsPropertySheetPage"/> dialogs, can use custom draw. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Initialize <computeroutput>CustomDraw</computeroutput></emphasis></term> @@ -4028,14 +4028,34 @@ </section> <!-- End CustomDrawInOODialog section --> -<section id="sctSimpleCustomDraw"><title>Simple Custom Draw</title> +<section id="sctSimpleCustomDraw" xreflabel="simple"><title>Simple Custom Draw</title> <indexterm><primary>custom draw</primary><secondary>simple custom draw</secondary></indexterm> <para> - + Currently, ooDialog supports a limited subset of the full functionality supplied by the Windows custom draw API. The + developers are denoting this as <emphasis role="italic">simple</emphasis> custom draw. Simple custom draw allows the + ooDialog programmer to change the foreground and background colors of individual dialog control items and subitems. It also + allows the programmer to change the font of individual items and subitems. </para> +<para> + There are a number of reasons for only supporting simple custom draw at this point. For one, it is probably sufficient for + everything an ooDialog programmer will want to do. It allows the most useful functionality of custom draw to be delievered + sooner and leaves the possiblity of future enhancements providing more functionality. Drawing in Windows needs to be done + quickly and efficiently. This type of programming is normally done in a low-level language. It is not clear that a complete + implementation of custom draw would produce satisfactory results. +</para> +<para> + In simple custom draw, the ooDialog framework does not invoke the custom draw event handler for every single custom draw + notification sent by the dialog control. Rather, it replies directly for a number of the drawing stages itself, returning + the correct information so that the item and subitem prepaint notifications are sent by the control. It then invokes the + Rexx event handler for the item and subitem prepaint notifications. This allows the ooDialog programmer to change the + colors and fonts for any individual item or subitem. +</para> +<para> + In simple custom draw, the Rexx event handler will not recieve notifications for the postpaint, preerase, and posterase + drawing stages. The ooDialog programmer just needs to focus on handling the prepaint notifications for items and subitems. +</para> - </section> <!-- End SimpleCustomDraw section --> @@ -4055,20 +4075,16 @@ </thead> <tbody> <row> -<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry> -<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry> +<entry align="center"><emphasis role="bold">Constant</emphasis></entry> +<entry align="center"><emphasis role="bold">Methods</emphasis></entry> </row> <row> -<entry align="center"><emphasis role="bold">Constant Methods</emphasis></entry> -<entry align="center"><emphasis role="bold">Constant Methods</emphasis></entry> -</row> -<row> <entry><link linkend="sctConstantsClsCustomDraw">constants</link></entry> -<entry>The <computeroutput>CustomDraw</computeroutput>class provides a number of constant values needed to work with the custom draw interface.</entry> +<entry>The <computeroutput>CustomDraw</computeroutput> class provides a number of constant values needed to work with the custom draw interface.</entry> </row> <row> -<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry> -<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry> +<entry align="center"><emphasis role="bold">Instance</emphasis></entry> +<entry align="center"><emphasis role="bold">Methods</emphasis></entry> </row> <row> <entry><link linkend="mthCustomDraw">customDraw</link></entry> @@ -4088,122 +4104,169 @@ </section> -<section id="sctConstantsClsCustomDraw"><title>Constants</title> +<section id="sctConstantsClsCustomDraw" xreflabel="CustomDraw constants"><title>Constants</title> <indexterm><primary>constants</primary><secondary>CustomDraw class</secondary></indexterm> <indexterm><primary>CustomDraw class</primary><secondary>constants</secondary></indexterm> <para> - + The Windows API for custom draw has a number of constant values used to specify varying things. There are constants used to + indicate the current stage of custom draw paint cycle, constants to use in replying to custom draw event notifications, + etc.. The <computeroutput>CustomDraw</computeroutput> class supplies the following <emphasis + role="italic">constant</emphasis> values to use with custom drawing. Note that, except where indicated, the CDRF_* response + codes can be combined together. The <xref linkend="mthOrClsDlgUtil"/> method can be used to combine values. </para> <variablelist> - <varlistentry id="cnstCDDS_PREPAINT" xreflabel="CDDS_PREPAINT"><term><emphasis role="bold">CDDS_PREPAINT</emphasis></term> + <varlistentry id="cnstCDDS_ITEMPREERASE" xreflabel="CDDS_ITEMPREERASE"><term><emphasis role="bold">CDDS_ITEMPREERASE</emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent + before an item is erased. </para> </listitem></varlistentry> - <varlistentry id="cnstCDDS_POSTPAINT" xreflabel="CDDS_POSTPAINT"><term><emphasis role="bold">CDDS_POSTPAINT</emphasis></term> + <varlistentry id="cnstCDDS_ITEMPREPAINT " xreflabel="CDDS_ITEMPREPAINT "><term><emphasis role="bold">CDDS_ITEMPREPAINT </emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent + before an item is drawn. </para> </listitem></varlistentry> - <varlistentry id="cnstCDDS_PREERASE" xreflabel="CDDS_PREERASE"><term><emphasis role="bold">CDDS_PREERASE</emphasis></term> + <varlistentry id="cnstCDDS_ITEMPOSTERASE" xreflabel="CDDS_ITEMPOSTERASE"><term><emphasis role="bold">CDDS_ITEMPOSTERASE</emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent + after an item has been erased. </para> </listitem></varlistentry> - <varlistentry id="cnstCDDS_POSTERASE" xreflabel="CDDS_POSTERASE"><term><emphasis role="bold">CDDS_POSTERASE</emphasis></term> + <varlistentry id="cnstCDDS_ITEMPOSTPAINT" xreflabel="CDDS_ITEMPOSTPAINT"><term><emphasis role="bold">CDDS_ITEMPOSTPAINT</emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent after + an item has been drawn. </para> </listitem></varlistentry> - <varlistentry id="cnstCDDS_ITEMPREPAINT " xreflabel="CDDS_ITEMPREPAINT "><term><emphasis role="bold">CDDS_ITEMPREPAINT </emphasis></term> + <varlistentry id="cnstCDDS_POSTERASE" xreflabel="CDDS_POSTERASE"><term><emphasis role="bold">CDDS_POSTERASE</emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent + when the erase cycle is complete. </para> </listitem></varlistentry> - <varlistentry id="cnstCDDS_ITEMPOSTPAINT" xreflabel="CDDS_ITEMPOSTPAINT"><term><emphasis role="bold">CDDS_ITEMPOSTPAINT</emphasis></term> + <varlistentry id="cnstCDDS_POSTPAINT" xreflabel="CDDS_POSTPAINT"><term><emphasis role="bold">CDDS_POSTPAINT</emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent when the paint cycle is complete. </para> </listitem></varlistentry> - <varlistentry id="cnstCDDS_ITEMPREERASE" xreflabel="CDDS_ITEMPREERASE"><term><emphasis role="bold">CDDS_ITEMPREERASE</emphasis></term> + <varlistentry id="cnstCDDS_PREERASE" xreflabel="CDDS_PREERASE"><term><emphasis role="bold">CDDS_PREERASE</emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent + before the erase cycle begins. </para> </listitem></varlistentry> - <varlistentry id="cnstCDDS_ITEMPOSTERASE" xreflabel="CDDS_ITEMPOSTERASE"><term><emphasis role="bold">CDDS_ITEMPOSTERASE</emphasis></term> + <varlistentry id="cnstCDDS_PREPAINT" xreflabel="CDDS_PREPAINT"><term><emphasis role="bold">CDDS_PREPAINT</emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent + before the paint cycle begins. </para> </listitem></varlistentry> <varlistentry id="cnstCDDS_SUBITEMPREPAINT" xreflabel="CDDS_SUBITEMPREPAINT"><term><emphasis role="bold">CDDS_SUBITEMPREPAINT</emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent + before a subitem is drawn. This only applies to list-view controls in report view. </para> </listitem></varlistentry> <varlistentry id="cnstCDDS_SUBITEMPOSTPAINT" xreflabel="CDDS_SUBITEMPOSTPAINT"><term><emphasis role="bold">CDDS_SUBITEMPOSTPAINT</emphasis></term> <listitem> <para> - xxx and xxx sss. + Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent + after a subitem has been drawn. It is only sent for list-view controls in report view. </para> </listitem></varlistentry> <varlistentry id="cnstCDRF_DODEFAULT" xreflabel="CDRF_DODEFAULT"><term><emphasis role="bold">CDRF_DODEFAULT</emphasis></term> <listitem> <para> - xxx and xxx sss. + One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates + that the control should draw itself. The control will not send any more notification messages for the current paint + cycle. This response can not be combined with other response values. </para> </listitem></varlistentry> + <varlistentry id="cnstCDRF_DOERASE" xreflabel="CDRF_DOERASE"><term><emphasis role="bold">CDRF_DOERASE</emphasis></term> + <listitem> + <para> + One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates + that the control should only draw the background. + </para> + </listitem></varlistentry> + <varlistentry id="cnstCDRF_NEWFONT" xreflabel="CDRF_NEWFONT"><term><emphasis role="bold">CDRF_NEWFONT</emphasis></term> + <listitem> + <para> + One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates + that the programmer has changed the font for the item being drawn. For list-view and tree-view custom draw, it should + also be used to indicate that the colors have been changed. + </para> + </listitem></varlistentry> <varlistentry id="cnstCDRF_NOTIFYITEMDRAW " xreflabel="CDRF_NOTIFYITEMDRAW "><term><emphasis role="bold">CDRF_NOTIFYITEMDRAW</emphasis></term> <listitem> <para> - xxx and xxx sss. + One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates + the control should send notification message for any item-specific drawing operations. The control will send + event notifications before and after it draws items. </para> </listitem></varlistentry> <varlistentry id="cnstCDRF_NOTIFYPOSTPAINT " xreflabel="CDRF_NOTIFYPOSTPAINT "><term><emphasis role="bold">CDRF_NOTIFYPOSTPAINT</emphasis></term> <listitem> <para> - xxx and xxx sss. + One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates + the control should send a notification when the painting cycle for the entire control is complete. </para> </listitem></varlistentry> - <varlistentry id="cnstCDRF_NEWFONT" xreflabel="CDRF_NEWFONT"><term><emphasis role="bold">CDRF_NEWFONT</emphasis></term> + <varlistentry id="cnstCDRF_SKIPDEFAULT" xreflabel="CDRF_SKIPDEFAULT"><term><emphasis role="bold">CDRF_SKIPDEFAULT</emphasis></term> <listitem> <para> - xxx and xxx sss. + One of the response values that can be returned to the dialog control from the custom draw 8event handler. It indicates + that the control should not do any painting, the application will paint the entire control. </para> </listitem></varlistentry> - <varlistentry id="cnstCDRF_SKIPDEFAULT" xreflabel="CDRF_SKIPDEFAULT"><term><emphasis role="bold">CDRF_SKIPDEFAULT</emphasis></term> + <varlistentry id="cnstCDRF_SKIPPOSTPAINT" xreflabel="CDRF_SKIPPOSTPAINT"><term><emphasis role="bold">CDRF_SKIPPOSTPAINT</emphasis></term> <listitem> <para> - xxx and xxx sss. + One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates + that the control should not draw the focus rectangle around an item. </para> </listitem></varlistentry> - <varlistentry id="cnstCDRF_DOERASE" xreflabel="CDRF_DOERASE"><term><emphasis role="bold">CDRF_DOERASE</emphasis></term> + <varlistentry id="cnstCLR_DEFAULT" xreflabel="CLR_DEFAULT"><term><emphasis role="bold">CLR_DEFAULT</emphasis></term> <listitem> <para> - xxx and xxx sss. + A special COLORREF value. COLORREFs are discussed in the documentation for both the <xref linkend="mthRGB"/> and <xref + linkend="mthColorRef"/> methods. The CLR_DEFAULT constant value is identical to the value returned either of those + methods when the CLR_DEFAULT keyword is used as the first argument to the method. </para> </listitem></varlistentry> - <varlistentry id="cnstCDRF_SKIPPOSTPAINT" xreflabel="CDRF_SKIPPOSTPAINT"><term><emphasis role="bold">CDRF_SKIPPOSTPAINT</emphasis></term> + <varlistentry id="cnstCLR_INVALID" xreflabel="CLR_INVALID"><term><emphasis role="bold">CLR_INVALID</emphasis></term> <listitem> <para> - xxx and xxx sss. + A special COLORREF value. COLORREFs are discussed in the documentation for both the <xref linkend="mthRGB"/> and <xref + linkend="mthColorRef"/> methods. The CLR_INVALID constant value is identical to the value returned either of those + methods when the CLR_INVALID keyword is used as the first argument to the method. </para> </listitem></varlistentry> + <varlistentry id="cnstCLR_NONE" xreflabel="CLR_NONE"><term><emphasis role="bold">CLR_NONE</emphasis></term> + <listitem> + <para> + A special COLORREF value. COLORREFs are discussed in the documentation for both the <xref linkend="mthRGB"/> and <xref + linkend="mthColorRef"/> methods. The CLR_NONE constant value is identical to the value returned either of those methods + when the CLR_NONE keyword is used as the first argument to the method. + </para> + </listitem></varlistentry> </variablelist> </section> -<section id="mthCustomDraw"><title>customDraw</title> +<section id="mthCustomDraw" xreflabel="customDraw"><title>customDraw</title> <indexterm><primary>customDraw</primary></indexterm> <indexterm><primary>CustomDraw class</primary><secondary>customDraw</secondary></indexterm> <programlisting> @@ -4260,7 +4323,7 @@ </variablelist> </section> <!-- End CustomDraw::customDraw() --> -<section id="mthCustomDrawControl"><title>customDrawControl</title> +<section id="mthCustomDrawControl" xreflabel="customDrawControl"><title>customDrawControl</title> <indexterm><primary>customDrawControl</primary></indexterm> <indexterm><primary>CustomDraw class</primary><secondary>customDrawControl</secondary></indexterm> <programlisting> @@ -4363,7 +4426,7 @@ </variablelist> </section> <!-- End CustomDraw::customDrawControl() --> -<section id="mthRGB"><title>rgb</title> +<section id="mthRGB" xreflabel="rgb"><title>rgb</title> <indexterm><primary>rgb</primary></indexterm> <indexterm><primary>CustomDraw class</primary><secondary>rgb</secondary></indexterm> <programlisting> Modified: docs/trunk/publican/oodialog/en-US/listview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-04 02:30:39 UTC (rev 8367) +++ docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-04 02:33:25 UTC (rev 8368) @@ -7001,39 +7001,46 @@ <indexterm><primary>LvCustomDrawSimple class</primary></indexterm> <para> A <computeroutput>LvCustomDrawSimple</computeroutput> object is used when a <link - linkend="clsListView">ListView</link> control is registered for <link linkend="clsCustomDraw">custom</link> draw. A - <computeroutput>LvCustomDrawSimple</computeroutput> object is passed to the CUSTOMDRAW event handler. It supplies both - information to the event handler and returns information back to the Windows control. The attributes of the object - convey the information both ways. + linkend="clsListView">ListView</link> control is registered for <emphasis role="italic">simple</emphasis> <link + linkend="clsCustomDraw">custom</link> draw. A <computeroutput>LvCustomDrawSimple</computeroutput> object is passed to the + CUSTOMDRAW event handler. It supplies both information to the event handler and returns information back to the Windows + control. The attributes of the object convey the information both ways. </para> <para> - When the ooDialog framework recieves information from the Windows custom draw control, it assigns values to the - attributes of the <computeroutput>LvCustomDrawSimple</computeroutput> object and sends the object to the Rexx dialog's - event handler. The programmer uses those values to determine what action to take and then assigns values to the - object's attributes to convey information back to the Windows control. The - <computeroutput>LvCustomDrawSimple</computeroutput> object is specific to the - <computeroutput>ListView</computeroutput> class. Other ooDialog controls that support custom draw have their own class - that performs a similar function, but whose attributes are specific to that control. For instance, the <link - linkend="clsTreeView">TreeView</link> class uses the <link linkend="clsTvCustomDrawSimple">TvCustomDrawSimple</link> - for its CUSTOMDRAW event handler. + When the ooDialog framework recieves information from the Windows custom draw control, it instantiates a + <computeroutput>LvCustomDrawSimple</computeroutput>object, assigns values to the attributes of the object, and sends the + object to the Rexx dialog's event handler. The programmer uses the assigned values to determine what action to take and + then assigns values to the object's attributes to convey information back to the Windows control. The + <computeroutput>LvCustomDrawSimple</computeroutput> object is specific to the <computeroutput>ListView</computeroutput> + class. Other ooDialog controls that support custom draw have their own class that performs a similar function, but whose + attributes are specific to that control. For instance, the <link linkend="clsTreeView">TreeView</link> class uses the <link + linkend="clsTvCustomDrawSimple">TvCustomDrawSimple</link> for its CUSTOMDRAW event handler. </para> -<section id="evtListViewCustomDraw"><title>CustomDraw Event Handler</title> +<section id="evtListViewCustomDraw" xreflabel="List-view CustomDraw Event Handler"><title>CustomDraw Event Handler</title> <indexterm><primary>ListView Event</primary><secondary>CUSTOMDRAW</secondary></indexterm> <indexterm><primary>custom draw</primary><secondary>list-view control</secondary></indexterm> <para> - The event handler for the xx xx event is invoked when ... + When the list-view control is registered for <xref linkend="sctSimpleCustomDraw"/> custom draw, the event handler is + invoked when the draw stage is item prepaint. Depending on the response from the event handler to the item prepaint + notification, the event handler will also be invoked when the draw stage is subitem prepaint. For simple custom draw, the + ooDialog framework handles the other draw stages internally. It makes the appropriate response to the dialog control so + that the dialog control will send the item prepaint notifications. It is then up to the programmer to request that the + control send the subitem prepaint notifcations. </para> <para> - The programmer must return xx and the interpreter waits (does not wait) for this return. + The single argument passed to the event handler is a <computeroutput>LvCustomdDrawSimple</computeroutput> object. The event + handler examines the values of the attributes of the object to determine the information sent by the underlying list-view + control. The event handler then assign values to the object that specify how the list-view control should draw the item, or + subitem. Finally, the programmer must always return true or false from the event handler. </para> <programlisting> <![CDATA[ ::method onCustomDraw unguarded - use arg x, y, z + use arg lvcdSimple - return zz + return boolean ]]> </programlisting> @@ -7041,10 +7048,10 @@ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - The event handling method recieves xx arguments: + The event handling method recieves 1 argument: </para> <variablelist> - <varlistentry><term>arg</term> + <varlistentry><term>lvcdSimple</term> <listitem> <para> xx @@ -7122,12 +7129,12 @@ </para> </section> -<section id="mthNewClsLvCustomDrawSimple"><title>new (Class Method)</title> +<section id="mthNewClsLvCustomDrawSimple" xreflabel="new"><title>new (Class Method)</title> <indexterm><primary>new</primary><secondary>LvCustomDrawSimple class</secondary></indexterm> <indexterm><primary>LvCustomDrawSimple class</primary><secondary>new</secondary></indexterm> <programlisting> <![CDATA[ ->>-->< +>>--new------------------------------------------>< ]]> </programlisting> Modified: docs/trunk/publican/oodialog/en-US/treeview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-04 02:30:39 UTC (rev 8367) +++ docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-04 02:33:25 UTC (rev 8368) @@ -2412,7 +2412,7 @@ for its CUSTOMDRAW event handler. </para> -<section id="evtTreeViewCustomDraw"><title>CustomDraw Event Handler</title> +<section id="evtTreeViewCustomDraw" xreflabel="TreeView CustomDraw Event Handler"><title>CustomDraw Event Handler</title> <indexterm><primary>TreeView Event</primary><secondary>CUSTOMDRAW</secondary></indexterm> <indexterm><primary>custom draw</primary><secondary>tree-view control</secondary></indexterm> <para> |
From: <mie...@us...> - 2012-09-05 02:42:06
|
Revision: 8370 http://sourceforge.net/p/oorexx/code-0/8370 Author: miesfeld Date: 2012-09-05 02:42:03 +0000 (Wed, 05 Sep 2012) Log Message: ----------- ooDialog doc - finish up the doc for custom draw Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/baseClasses.xml docs/trunk/publican/oodialog/en-US/dialogControlObject.xml docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/treeview.xml Modified: docs/trunk/publican/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-04 23:13:42 UTC (rev 8369) +++ docs/trunk/publican/oodialog/en-US/baseClasses.xml 2012-09-05 02:42:03 UTC (rev 8370) @@ -3900,6 +3900,10 @@ <entry>The control will send an event notification when the painting cycle for the entire control is complete.</entry> </row> <row> +<entry><xref linkend="cnstCDRF_NOTIFYSUBITEMDRAW"/></entry> +<entry>The control will send event notifications for any subitem-specific drawing operations. It will send event notification messages before and after it draws subitems.</entry> +</row> +<row> <entry><xref linkend="cnstCDRF_SKIPDEFAULT"/></entry> <entry>The control will not perform any painting at all. </entry> </row> @@ -4124,7 +4128,7 @@ before an item is erased. </para> </listitem></varlistentry> - <varlistentry id="cnstCDDS_ITEMPREPAINT " xreflabel="CDDS_ITEMPREPAINT "><term><emphasis role="bold">CDDS_ITEMPREPAINT </emphasis></term> + <varlistentry id="cnstCDDS_ITEMPREPAINT" xreflabel="CDDS_ITEMPREPAINT "><term><emphasis role="bold">CDDS_ITEMPREPAINT </emphasis></term> <listitem> <para> Part of the information sent in a custom draw event notification. It indicates the current draw stage. This is sent @@ -4224,6 +4228,14 @@ the control should send a notification when the painting cycle for the entire control is complete. </para> </listitem></varlistentry> + <varlistentry id="cnstCDRF_NOTIFYSUBITEMDRAW " xreflabel="CDRF_NOTIFYSUBITEMDRAW "><term><emphasis role="bold">CDRF_NOTIFYSUBITEMDRAW</emphasis></term> + <listitem> + <para> + One of the response values that can be returned to the dialog control from the custom draw event handler. It indicates + the control should send notification message for any subitem-specific drawing operations. The control will send + event notifications before and after it draws subitems. + </para> + </listitem>< |
From: <mie...@us...> - 2012-09-05 02:47:50
|
Revision: 8371 http://sourceforge.net/p/oorexx/code-0/8371 Author: miesfeld Date: 2012-09-05 02:47:46 +0000 (Wed, 05 Sep 2012) Log Message: ----------- ooDialog doc - fix tags Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/dialogControlObject.xml docs/trunk/publican/oodialog/en-US/treeview.xml Modified: docs/trunk/publican/oodialog/en-US/dialogControlObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-09-05 02:42:03 UTC (rev 8370) +++ docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-09-05 02:47:46 UTC (rev 8371) @@ -524,7 +524,7 @@ <entry>Sets the format flag telling the control to use, or not use, Unicode.</entry> </row> <row> -<entry><xref linkend="mthUseVersion"></entry> +<entry><xref linkend="mthUseVersion"/></entry> <entry>Informs the control that the programmer is expecting a behavior associated with a particular common control library version.</entry> </row> <row> @@ -532,7 +532,7 @@ <entry>Determines if the control is using Unicode or not.</entry> </row> <row> -<entry><xref linkend="mthUsingVersion"></entry> +<entry><xref linkend="mthUsingVersion"/></entry> <entry>Returns the version number for the control that was set by the most recent <emphasis role="italic">useVersion</emphasis>method call.</entry> </row> <row> Modified: docs/trunk/publican/oodialog/en-US/treeview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-05 02:42:03 UTC (rev 8370) +++ docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-05 02:47:46 UTC (rev 8371) @@ -2537,7 +2537,7 @@ <entry align="center"><emphasis role="bold">Methods</emphasis></entry> </row> <row> -<entry><xref linkend="mthNewClsTvCustomDrawSimple"/>/entry> +<entry><xref linkend="mthNewClsTvCustomDrawSimple"/></entry> <entry>The Rexx programmer can not instantiate a <computeroutput>TvCustomDrawSimple</computeroutput>object, the ooDialog framework instantiates these objects</entry> </row> <row> |
From: <mie...@us...> - 2012-09-05 02:50:45
|
Revision: 8372 http://sourceforge.net/p/oorexx/code-0/8372 Author: miesfeld Date: 2012-09-05 02:50:42 +0000 (Wed, 05 Sep 2012) Log Message: ----------- ooDialog doc - fix tags Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/treeview.xml Modified: docs/trunk/publican/oodialog/en-US/listview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-05 02:47:46 UTC (rev 8371) +++ docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-05 02:50:42 UTC (rev 8372) @@ -7137,7 +7137,7 @@ As an example, say the goal was to shade every other row in the list-view when in report mode. The event handler will be invoked before each item is to be painted. The programmer would examine the <xref linkend="atrItem"/> attrbute to determine if it was an odd or even row. If the row was even, the color attributes, <xref linkend="atrClrTextBk"/> and - <xref linkend="atrClrText"/>, would be set to the desired colors to shade the row. The <xref linkend="atrRepy"/> + <xref linkend="atrClrText"/>, would be set to the desired colors to shade the row. The <xref linkend="atrReply"/> attribute would be set to a response value that indicates to the list-view is to use the information in the object to draw the item, and the event handler would return true. If the row was odd, the event handler would simply return false to indicate that the list-view should draw the item itself. The following code snippet demonstrates this: @@ -7459,7 +7459,7 @@ notifications internaly and the event handler only gets invoked for 2 of the draw stages. Because of this, the draw stage value will always be either <xref linkend="cnstCDDS_ITEMPREPAINT"/> or <xref linkend="cnstCDDS_SUBITEMPREPAINT"/>. In addtion, the value will only be CDDS_SUBITEMPREPAINT if the programmer has requested subitem notifications by setting - the <xref linkend="atrRepy"/> attribute to <xref linkend="cnstCDRF_NOTIFYSUBITEMDRAW"/> in response to an item prepaint + the <xref linkend="atrReply"/> attribute to <xref linkend="cnstCDRF_NOTIFYSUBITEMDRAW"/> in response to an item prepaint notification. </para> </listitem></varlistentry> @@ -7907,7 +7907,7 @@ <para> The list-view allows the programmer to associate a value with any list-view item. This user data value is sent by the list-view in the event notification information. The programmer can set the user data for a list-view item in several - ways. The <xref linkend="mthSetItemData"/> of the <xref linkend="clsListview"/> class, the <emphasis + ways. The <xref linkend="mthSetItemData"/> of the <xref linkend="clsListView"/> class, the <emphasis role="italic">userData</emphasis> argument of the <xref linkend="mthNewClsLvItem"/> method of the <xref linkend="clsLvItem"/> class, or the <xref linkend="atrUserDataClsLvItem"/> attribute of the <computeroutput>LvItem</computeroutput> class are all used to set the user data value for an item. Modified: docs/trunk/publican/oodialog/en-US/treeview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-05 02:47:46 UTC (rev 8371) +++ docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-05 02:50:42 UTC (rev 8372) @@ -2480,7 +2480,7 @@ determine if it was an odd or even level. If the level was even, the color attributes, <xref linkend="atrClrTextBkTV"/> and <xref linkend="atrClrTextTV"/>, would be set to the desired colors to color the item. If the level was odd, the event handler would set the color attributes to the colors for a item at an odd level. Then the <xref - linkend="atrRepyTV"/> attribute would be set to a response value that indicates to the tree-view is to use the + linkend="atrReplyTV"/> attribute would be set to a response value that indicates to the tree-view is to use the information in the object to draw the item, and the event handler would return true to indicate that custom drawing is to be done. The example below demonstrates this: |
From: <mie...@us...> - 2012-09-05 02:57:48
|
Revision: 8373 http://sourceforge.net/p/oorexx/code-0/8373 Author: miesfeld Date: 2012-09-05 02:57:46 +0000 (Wed, 05 Sep 2012) Log Message: ----------- ooDialog doc - fix tags Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/listview.xml docs/trunk/publican/oodialog/en-US/treeview.xml Modified: docs/trunk/publican/oodialog/en-US/listview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-05 02:50:42 UTC (rev 8372) +++ docs/trunk/publican/oodialog/en-US/listview.xml 2012-09-05 02:57:46 UTC (rev 8373) @@ -7137,7 +7137,7 @@ As an example, say the goal was to shade every other row in the list-view when in report mode. The event handler will be invoked before each item is to be painted. The programmer would examine the <xref linkend="atrItem"/> attrbute to determine if it was an odd or even row. If the row was even, the color attributes, <xref linkend="atrClrTextBk"/> and - <xref linkend="atrClrText"/>, would be set to the desired colors to shade the row. The <xref linkend="atrReply"/> + <xref linkend="atrClrText"/>, would be set to the desired colors to shade the row. The <xref linkend="atrReplyLV"/> attribute would be set to a response value that indicates to the list-view is to use the information in the object to draw the item, and the event handler would return true. If the row was odd, the event handler would simply return false to indicate that the list-view should draw the item itself. The following code snippet demonstrates this: @@ -7268,7 +7268,7 @@ <entry>Reflects the 0-based index of the list-view item that needs to be drawn.</entry> </row> <row> -<entry><xref linkend="atrReply"/> </entry> +<entry><xref linkend="atrReplyLV"/> </entry> <entry>Reflects the <link linkend="sctConstantsClsCustomDraw">CDRF_*</link> response value that is used to reply to the event notification.</entry> </row> <row> @@ -7459,7 +7459,7 @@ notifications internaly and the event handler only gets invoked for 2 of the draw stages. Because of this, the draw stage value will always be either <xref linkend="cnstCDDS_ITEMPREPAINT"/> or <xref linkend="cnstCDDS_SUBITEMPREPAINT"/>. In addtion, the value will only be CDDS_SUBITEMPREPAINT if the programmer has requested subitem notifications by setting - the <xref linkend="atrReply"/> attribute to <xref linkend="cnstCDRF_NOTIFYSUBITEMDRAW"/> in response to an item prepaint + the <xref linkend="atrReplyLV"/> attribute to <xref linkend="cnstCDRF_NOTIFYSUBITEMDRAW"/> in response to an item prepaint notification. </para> </listitem></varlistentry> @@ -7726,7 +7726,7 @@ </variablelist> </section> <!-- End LvCustomDrawSimple::item() [attribute] --> -<section id="atrReply" xreflabel="reply"><title>reply (Attribute)</title> +<section id="atrReplyLV" xreflabel="reply"><title>reply (Attribute)</title> <indexterm><primary>reply</primary></indexterm> <indexterm><primary>LvCustomDrawSimple class</primary><secondary>reply</secondary></indexterm> <programlisting> Modified: docs/trunk/publican/oodialog/en-US/treeview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-05 02:50:42 UTC (rev 8372) +++ docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-05 02:57:46 UTC (rev 8373) @@ -2416,7 +2416,7 @@ for its CUSTOMDRAW event handler. </para> -r<section id="evtTreeViewCustomDraw" xreflabel="TreeView CustomDraw Event Handler"><title>CustomDraw Event Handler</title> +<section id="evtTreeViewCustomDraw" xreflabel="TreeView CustomDraw Event Handler"><title>CustomDraw Event Handler</title> <indexterm><primary>TreeView Event</primary><secondary>CUSTOMDRAW</secondary></indexterm> <indexterm><primary>custom draw</primary><secondary>tree-view control</secondary></indexterm> <para> |
From: <mie...@us...> - 2012-09-16 23:56:11
|
Revision: 8415 http://sourceforge.net/p/oorexx/code-0/8415 Author: miesfeld Date: 2012-09-16 23:56:08 +0000 (Sun, 16 Sep 2012) Log Message: ----------- ooDialog doc - document the enhancements to the background and control color methods Modified Paths: -------------- docs/trunk/publican/oodialog/en-US/dialogControlObject.xml docs/trunk/publican/oodialog/en-US/dialogExtensions.xml docs/trunk/publican/oodialog/en-US/dialogObject.xml docs/trunk/publican/oodialog/en-US/overview.xml docs/trunk/publican/oodialog/en-US/treeview.xml docs/trunk/publican/oodialog/en-US/windowBaseDCO.xml docs/trunk/publican/oodialog/en-US/windowExtensionsDCO.xml Modified: docs/trunk/publican/oodialog/en-US/dialogControlObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-09-16 23:50:49 UTC (rev 8414) +++ docs/trunk/publican/oodialog/en-US/dialogControlObject.xml 2012-09-16 23:56:08 UTC (rev 8415) @@ -2447,13 +2447,13 @@ <indexterm><primary>DialogControl class</primary><secondary>setColor</secondary></indexterm> <programlisting> <![CDATA[ ->>--setColor(--bk--+-------+--)------------------>< - +-,-fg--+ +>>--setColor(--+------+--+-------+--+---------+--)-------------->< + +-,-bk-+ +-,-fg--+ +-,-isClr-+ ]]> </programlisting> <para> - Sets the background color, and optionally the text color, for this dialog control. + Sets the background color or foreground color, or both, for this dialog control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2461,20 +2461,30 @@ <para> The arguments are: <variablelist> - <varlistentry><term>bk [required]</term> + <varlistentry><term>bk [optionaal]</term> <listitem> <para> - The <xref linkend="defColor"/> for the background color of the dialog control. + Specifies the the background color for this dialog control. This may either be a palette <xref linkend="defColor"/>, + or a <xref linkend="defColorRef"/> number. To use a COLORREF, the <emphasis role="italic">isClr</emphasis> argument + must be true. </para> </listitem></varlistentry> <varlistentry><term>fg [optional]</term> <listitem> <para> - The <xref linkend="defColor"/> for the foreground color of the dialog control. The foreground - color is the color that text is written in. + Specifies the the foreground color for this dialog control. This may either be a palette <xref linkend="defColor"/>, + or a <xref linkend="defColorRef"/> number. To use a COLORREF, the <emphasis role="italic">isClr</emphasis> argument + must be true. The foreground color is the color that text is written in. </para> </listitem></varlistentry> + <varlistentry><term>isClr [optional]</term> + <listitem> + <para> + Specifies if the <emphasis role="italic">bg</emphasis> and <emphasis role="italic">fg</emphasis> arguments are to be + interpreted as palette indexes or COLORREF numbers. The default if omitted is false. + </para> </variablelist> + </variablelist> </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> @@ -2486,6 +2496,12 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> + The <emphasis role="italic">bk</emphasis> and <emphasis role="italic">fg</emphasis> arguments must be specified in the + same way. They must both be either palette indexes or both be COLORREF numbers. If the <emphasis + role="italic">bk</emphasis> argument is omitted, the ooDialog framework ensures that the operating system paints the + background using the same color as the dialog background. + </para> + <para> Earlier versions of ooDialog had a restriction on the number of different dialog controls that could have their control changed from their default color. In ooDialog version 4.2.0 that restriction was lifted and there is no limit to the number of controls having their color set. @@ -2494,14 +2510,14 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example changes the background color of a push button in the dialog to red and the text color to yellow: + This example changes the text color of a static control in the dialog to a bright red using a COLORREF number: <programlisting> <![CDATA[ ::method changeColor - expose pushButton + expose staticText - pushButton~setColor(2, 4) + staticText~setColor( , .Image~colorRef(161, 6, 17), .true) ]]> </programlisting> @@ -2517,14 +2533,14 @@ <indexterm><primary>DialogControl class</primary><secondary>setSysColor</secondary></indexterm> <programlisting> <![CDATA[ ->>--setSysColor(--bk--+-------+--)--------------->< - +-,-fg--+ +>>--setSysColor(--+------+--+-------+--)--------->< + +-,-bk-+ +-,-fg--+ ]]> </programlisting> <para> - Sets the background color, and optionally the text color, for this dialog control using the system - <link linkend="defSysColor">colors</link>. + Sets the background color or foreground color, or both, for this dialog control using the system <link + linkend="defSysColor">colors</link>. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -2532,11 +2548,11 @@ <para> The arguments are: <variablelist> - <varlistentry><term>bk [required]</term> + <varlistentry><term>bk [optional]</term> <listitem> <para> The system color ID for the background color of the dialog control. This can be either the whole number ID or - the keyword ID. IDs can be looked up in the System Color Elements (<link linkend="tblSysColors">table</link> + the keyword ID. IDs can be looked up in the System Color Elements <link linkend="tblSysColors">table</link> </para> </listitem></varlistentry> <varlistentry><term>fg [optional]</term> @@ -2559,6 +2575,11 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> + If the <emphasis role="italic">bk</emphasis> is omitted, the ooDialog framework ensures that the operating system paints + the background of the control the same color as the background of the dialog. The <emphasis role="italic">bk</emphasis> and <emphasis role="italic">fg</emphasis> arguments must be specified in the + same way. They must both be either palette indexes or both be COLORREF numbers. + </para> + <para> Earlier versions of ooDialog had a restriction on the number of different dialog controls that could have their control changed from their default color. In ooDialog version 4.2.0 that restriction was lifted and there is no limit to the number of controls having their color set. @@ -2567,15 +2588,15 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example changes the background color of the push button in the dialog to the system background color for a + This example changes the background color of a static text lable in the dialog to the system background color for a menu: <programlisting> <![CDATA[ ::method changeColor - expose pushButton + expose label - pushButton~setSysColor('MENU') + label~setSysColor('MENU') ]]> </programlisting> Modified: docs/trunk/publican/oodialog/en-US/dialogExtensions.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-16 23:50:49 UTC (rev 8414) +++ docs/trunk/publican/oodialog/en-US/dialogExtensions.xml 2012-09-16 23:56:08 UTC (rev 8415) @@ -3916,19 +3916,20 @@ <indexterm><primary>DialogExtensions class</primary><secondary>setControlColor</secondary></indexterm> <programlisting> <![CDATA[ ->>--setControlColor(--id--,--bk--+-------+--)---->< - +-,-fg--+ +>>--setControlColor(--id--,--+------+--+-------+--+---------+--)--------------->< + +-,-bk-+ +-,-fg--+ +-,-isClr-+ ]]> </programlisting> <para> - Sets the background color, and optionally the text color, for the specified dialog control. + Sets the background color or the text color, or both, for the specified dialog control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> The arguments are: + </para> <variablelist> <varlistentry><term>id [required]</term> <listitem> @@ -3937,21 +3938,29 @@ <xref linkend="defSymbolicId"/>. </para> </listitem></varlistentry> - <varlistentry><term>bk [required]</term> + <varlistentry><term>bk [optional]</term> <listitem> <para> - The <xref linkend="defColor"/> for the background color of the dialog control. + Specifies the the background color of the dialog control. This may either be a palette <xref linkend="defColor"/>, or + a <xref linkend="defColorRef"/> number. To use a COLORREF, the <emphasis role="italic">isClr</emphasis> argument must + be true. </para> </listitem></varlistentry> <varlistentry><term>fg [optional]</term> <listitem> <para> - The <xref linkend="defColor"/> for the foreground color of the dialog control. The foreground - color is the color that text is written in. + Specifies the the foreground color of the dialog control. This may either be a palette <xref linkend="defColor"/>, or + a <xref linkend="defColorRef"/> number. To use a COLORREF, the <emphasis role="italic">isClr</emphasis> argument must + be true. The foreground color is the color that text is written in. </para> </listitem></varlistentry> + <varlistentry><term>isClr [optional]</term> + <listitem> + <para> + Specifies if the <emphasis role="italic">bg</emphasis> and <emphasis role="italic">fg</emphasis> arguments are to be + interpreted as palette indexes or COLORREF numbers. The default if omitted is false. + </para> </variablelist> - </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> @@ -3963,6 +3972,14 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> + If the <emphasis role="italic">bk</emphasis> argument is omitted, then ooDialog ensures that the background of the dialog + control is painted with the same color as the dialog background. + </para> + <para> + Both the <emphasis role="italic">bk</emphasis> and <emphasis role="italic">fg</emphasis> arguments must be specified in + the same manner. They must both be palette indexes or COLORREF numbers. + </para> + <para> Earlier versions of ooDialog had a restriction on the number of different dialog controls that could have their control changed from their default color. In ooDialog version 4.2.0 that restriction was lifted and there is no limit to the number of controls having their color set. @@ -3971,11 +3988,11 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example changes the background color of a push button to red and the text color to yellow: + This example changes the background color of a static control to red and the text color to yellow using palette indexes: <programlisting> <![CDATA[ -self~setControlColor(IDC_PB_PREVIOUS, 2, 4) +self~setControlColor(IDC_ST_EDIT_LABEL, 2, 4) ]]> </programlisting> @@ -4050,14 +4067,14 @@ <indexterm><primary>DialogExtensions class</primary><secondary>setControlSysColor</secondary></indexterm> <programlisting> <![CDATA[ ->>--setControlSysColor(--id--,--bk--+-------+--)->< - +-,-fg--+ +>>--setControlSysColor(--id--,--+------+--+-------+--)---------->< + +-,-bk-+ +-,-fg--+ ]]> </programlisting> <para> - Sets the background color, and optionally the text color, for the specified dialog control using the system - <xref linkend="defSysColor"/>s. + Sets the background color or foreground color, or both, for the specified dialog control using the specified system <link + linkend="defSysColor">color</link>. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -4072,19 +4089,19 @@ <xref linkend="defSymbolicId"/>. </para> </listitem></varlistentry> - <varlistentry><term>bk [required]</term> + <varlistentry><term>bk [optional]</term> <listitem> <para> - The system color ID for the background color of the dialog control. This can be either the whole number ID or - the keyword ID. IDs can be looked up in the System Color Elements <link linkend="tblSysColors">table</link>. + The system color ID for the background color of the dialog control. This can be either the non-negative whole number + ID or the keyword ID. IDs can be looked up in the System Color Elements <link linkend="tblSysColors">table</link>. </para> </listitem></varlistentry> <varlistentry><term>fg [optional]</term> <listitem> <para> The system color for the foreground color of the dialog control. The foreground color is the color that text is - written in. This can be either the whole number ID or the keyword ID. IDs can be looked up in the System Color - Elements <link linkend="tblSysColors">table</link>. + written in. This can be either the non-negative whole number ID or the keyword ID. IDs can be looked up in the System + Color Elements <link linkend="tblSysColors">table</link>. </para> </listitem></varlistentry> </variablelist> @@ -4100,6 +4117,10 @@ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> + If the <emphasis role="italic">bk</emphasis> argument is omitted, the ooDialog framework ensures that the operating + system paints the background using the background color of the dialog. + </para> + <para> Earlier versions of ooDialog had a restriction on the number of different dialog controls that could have their control changed from their default color. In ooDialog version 4.2.0 that restriction was lifted and there is no limit to the number of controls having their color set. @@ -4108,11 +4129,11 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example changes the background color of a push button to the system background color for a menu: + This example changes the background color of a static control to the system background color for a menu: <programlisting> <![CDATA[ -self~setControlSysColor(IDC_PB_NEXT, 'MENU') +self~setControlSysColor(IDC_ST_STATES, 'MENU') ]]> </programlisting> Modified: docs/trunk/publican/oodialog/en-US/dialogObject.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-09-16 23:50:49 UTC (rev 8414) +++ docs/trunk/publican/oodialog/en-US/dialogObject.xml 2012-09-16 23:56:08 UTC (rev 8415) @@ -199,6 +199,10 @@ <entry>Sets the background color of a dialog.</entry> </row> <row> +<entry><xref linkend="mthBackgroundSysColor"/></entry> +<entry>Sets the background color of a dialog using one of the system colors.</entry> +</row> +<row> <entry><xref linkend="mthCancel"/></entry> <entry>A default event handler, provided by the ooDialog framework , for the cancel event.</entry> </row> @@ -1947,7 +1951,7 @@ </section> <!-- End PlainBaseDialog::autoDetect() [attribute] --> -<section id="rudoConstDir"><title>constDir (Attribute)</title> +<section id="rudoConstDir" xreflabel="constDir"><title>constDir (Attribute)</title> <programlisting> ResourceUtils::<xref linkend="atrConstDir"/> @@ -2605,7 +2609,7 @@ </section> <!-- End dialog object::addNewAttribute() --> -<section id="deAddAutoStartMethod"><title>addAutoStartMethod</title> +<section id="deAddAutoStartMethod" xreflabel="addAutoStartMethod"><title>addAutoStartMethod</title> <programlisting> DialogExtensions::<xref linkend="mthAddAutoStartMethod"/> @@ -2617,7 +2621,7 @@ </section> -<section id="deEndAsyncExecution"><title>endAsyncExecution</title> +<section id="deEndAsyncExecution" xreflabel="endAsyncExecution"><title>endAsyncExecution</title> <programlisting> DialogExtensions::<xref linkend="mthEndAsyncExecution"/> @@ -2813,7 +2817,7 @@ </section> -<section id="deExecuteAsync"><title>executeAsync</title> +<section id="deExecuteAsync" xreflabel="executeAsync"><title>executeAsync</title> <programlisting> DialogExtensions::<xref linkend="mthExecuteAsync"/> @@ -2907,7 +2911,7 @@ </variablelist> </section> -<section id="rudoParseIncludeFile"><title>parseIncludefile</title> +<section id="rudoParseIncludeFile" xreflabel="parseIncludefile"><title>parseIncludefile</title> <programlisting> ResourceUtils::<xref linkend="mthParseIncludeFile"/> @@ -2919,7 +2923,7 @@ </section> -<section id="dePopup"><title>popup</title> +<section id="dePopup" xreflabel="popup"><title>popup</title> <programlisting> DialogExtensions::<xref linkend="mthPopup"/> @@ -2931,7 +2935,7 @@ </section> -<section id="dePopupAsChild"><title>popupAsChild</title> +<section id="dePopupAsChild" xreflabel="popupAsChild"><title>popupAsChild</title> <programlisting> DialogExtensions::<xref linkend="mthPopupAsChild"/> @@ -2943,7 +2947,7 @@ </section> -<section id="rudoResolveNumericID"><title>resolveNumericID</title> +<section id="rudoResolveNumericID" xreflabel="resolveNumericID"><title>resolveNumericID</title> <programlisting> ResourceUtils::<xref linkend="mthResolveNumericID"/> @@ -2954,7 +2958,7 @@ </programlisting> </section> -<section id="rudoResolveSymbolicID"><title>resolveSymbolicID</title> +<section id="rudoResolveSymbolicID" xreflabel="resolveSymbolicID"><title>resolveSymbolicID</title> <programlisting> ResourceUtils::<xref linkend="mthResolveSymbolicID"/> @@ -4203,7 +4207,7 @@ <xref linkend="clsEventNotification"/> class. These methods are documented here. </para> -<section id="enAddUserMsg"><title>addUserMsg</title> +<section id="enAddUserMsg" xreflabel="addUserMsg"><title>addUserMsg</title> <programlisting> EventNotification::<xref linkend="mthAddUserMsg"/> @@ -4215,7 +4219,7 @@ </programlisting> </section> -<section id="enConnectActivate"><title>connectActivate</title> +<section id="enConnectActivate" xreflabel="connectActivate"><title>connectActivate</title> <programlisting> EventNotification::<xref linkend="mthConnectActivate"/> @@ -4226,7 +4230,7 @@ </programlisting> </section> -<section id="enConnectAllSBEvents"><title>connectAllSBEvents</title> +<section id="enConnectAllSBEvents" xreflabel="connectAllSBEvents"><title>connectAllSBEvents</title> <programlisting> EventNotification::<xref linkend="mthConnectAllSBEvents"/> @@ -4237,7 +4241,7 @@ </programlisting> </section> -<section id="enConnectButtonEvent"><title>connectButtonEvent</title> +<section id="enConnectButtonEvent" xreflabel="connectButtonEvent"><title>connectButtonEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectButtonEvent"/> @@ -4248,7 +4252,7 @@ </programlisting> </section> -<section id="enConnectComboBoxEvent"><title>connectComboBoxEvent</title> +<section id="enConnectComboBoxEvent" xreflabel="connectComboBoxEvent"><title>connectComboBoxEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectComboBoxEvent"/> @@ -4259,7 +4263,7 @@ </programlisting> </section> -<section id="enConnectCommandEvents"><title>connectCommandEvents</title> +<section id="enConnectCommandEvents" xreflabel="connectCommandEvents"><title>connectCommandEvents</title> <programlisting> EventNotification::<xref linkend="mthConnectCommandEvents"/> @@ -4269,7 +4273,7 @@ </programlisting> </section> -<section id="enConnectDateTimePickerEvent"><title>connectDateTimePickerEvent</title> +<section id="enConnectDateTimePickerEvent" xreflabel="connectDateTimePickerEvent"><title>connectDateTimePickerEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectDateTimePickerEvent"/> @@ -4280,7 +4284,7 @@ </programlisting> </section> -<section id="enConnectDraw"><title>connectDraw</title> +<section id="enConnectDraw" xreflabel="connectDraw"><title>connectDraw</title> <programlisting> EventNotification::<xref linkend="mthConnectDraw"/> @@ -4291,7 +4295,7 @@ </programlisting> </section> -<section id="enConnectEachSBEvent"><title>connectEachSBEvent</title> +<section id="enConnectEachSBEvent" xreflabel="connectEachSBEvent"><title>connectEachSBEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectEachSBEvent"/> @@ -4305,7 +4309,7 @@ </programlisting> </section> -<section id="enConnectEditEvent"><title>connectEditEvent</title> +<section id="enConnectEditEvent" xreflabel="connectEditEvent"><title>connectEditEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectEditEvent"/> @@ -4316,7 +4320,7 @@ </programlisting> </section> -<section id="enConnectFKeyPress"><title>connectFKeyPress</title> +<section id="enConnectFKeyPress" xreflabel="connectFKeyPress"><title>connectFKeyPress</title> <programlisting> EventNotification::<xref linkend="mthConnectFKeyPressDialogObject"/> @@ -4327,7 +4331,7 @@ </programlisting> </section> -<section id="enConnectHelp"><title>connectHelp</title> +<section id="enConnectHelp" xreflabel="connectHelp"><title>connectHelp</title> <programlisting> EventNotification::<xref linkend="mthConnectHelp"/> @@ -4337,7 +4341,7 @@ </programlisting> </section> -<section id="enConnectKeyPress"><title>connectKeyPress</title> +<section id="enConnectKeyPress" xreflabel="connectKeyPress"><title>connectKeyPress</title> <programlisting> EventNotification::<xref linkend="mthConnectKeyPressDialogObject"/> @@ -4348,7 +4352,7 @@ </programlisting> </section> -<section id="enConnectListBoxEvent"><title>connectListBoxEvent</title> +<section id="enConnectListBoxEvent" xreflabel="connectListBoxEvent"><title>connectListBoxEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectListBoxEvent"/> @@ -4359,7 +4363,7 @@ </programlisting> </section> -<section id="enConnectListViewEvent"><title>connectListViewEvent</title> +<section id="enConnectListViewEvent" xreflabel="connectListViewEvent"><title>connectListViewEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectListViewEvent"/> @@ -4370,7 +4374,7 @@ </programlisting> </section> -<section id="enConnectMonthCalendarEvent"><title>connectMonthCalendarEvent</title> +<section id="enConnectMonthCalendarEvent" xreflabel="connectMonthCalendarEvent"><title>connectMonthCalendarEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectMonthCalendarEvent"/> @@ -4381,7 +4385,7 @@ </programlisting> </section> -<section id="enConnectMove"><title>connectMove</title> +<section id="enConnectMove" xreflabel="connectMove"><title>connectMove</title> <programlisting> EventNotification::<xref linkend="mthConnectMove"/> @@ -4391,7 +4395,7 @@ </programlisting> </section> -<section id="enConnectNotifyEvent"><title>connectNotifyEvent</title> +<section id="enConnectNotifyEvent" xreflabel="connectNotifyEvent"><title>connectNotifyEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectNotifyEvent"/> @@ -4402,7 +4406,7 @@ </programlisting> </section> -<section id="enConnectPosChanged"><title>connectPosChanged</title> +<section id="enConnectPosChanged" xreflabel="connectPosChanged"><title>connectPosChanged</title> <programlisting> EventNotification::<xref linkend="mthConnectPosChanged"/> @@ -4412,7 +4416,7 @@ </programlisting> </section> -<section id="enConnectResize"><title>connectResize</title> +<section id="enConnectResize" xreflabel="connectResize"><title>connectResize</title> <programlisting> EventNotification::<xref linkend="mthConnectResize"/> @@ -4422,7 +4426,7 @@ </programlisting> </section> -<section id="enConnectResizing"><title>connectResizing</title> +<section id="enConnectResizing" xreflabel="connectResizing"><title>connectResizing</title> <programlisting> EventNotification::<xref linkend="mthConnectResizing"/> @@ -4432,7 +4436,7 @@ </programlisting> </section> -<section id="enConnectScrollBarEvent"><title>connectScrollBarEvent</title> +<section id="enConnectScrollBarEvent" xreflabel="connectScrollBarEvent"><title>connectScrollBarEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectScrollBarEvent"/> @@ -4443,7 +4447,7 @@ </programlisting> </section> -<section id="enConnectSizeMoveEnded"><title>connectSizeMoveEnded</title> +<section id="enConnectSizeMoveEnded" xreflabel="connectSizeMoveEnded"><title>connectSizeMoveEnded</title> <programlisting> EventNotification::<xref linkend="mthConnectSizeMoveEnded"/> @@ -4455,7 +4459,7 @@ </programlisting> </section> -<section id="enConnectStaticEvent"><title>connectStaticEvent</title> +<section id="enConnectStaticEvent" xreflabel="connectStaticEvent"><title>connectStaticEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectStaticEvent"/> @@ -4466,7 +4470,7 @@ </programlisting> </section> -<section id="enConnectTabEvent"><title>connectTabEvent</title> +<section id="enConnectTabEvent" xreflabel="connectTabEvent"><title>connectTabEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectTabEvent"/> @@ -4477,7 +4481,7 @@ </programlisting> </section> -<section id="enConnectTrackBarEvent"><title>connectTrackBarEvent</title> +<section id="enConnectTrackBarEvent" xreflabel="connectTrackBarEvent"><title>connectTrackBarEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectTrackBarEvent"/> @@ -4488,7 +4492,7 @@ </programlisting> </section> -<section id="enConnectTreeViewEvent"><title>connectTreeViewEvent</title> +<section id="enConnectTreeViewEvent" xreflabel="connectTreeViewEvent"><title>connectTreeViewEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectTreeViewEvent"/> @@ -4499,7 +4503,7 @@ </programlisting> </section> -<section id="enConnectUpDownEvent"><title>connectUpDownEvent</title> +<section id="enConnectUpDownEvent" xreflabel="connectUpDownEvent"><title>connectUpDownEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectUpDownEvent"/> @@ -4511,7 +4515,7 @@ </section> -<section id="enDefListDragHandler"><title>defListDragHandler</title> +<section id="enDefListDragHandler" xreflabel="defListDragHandler"><title>defListDragHandler</title> <programlisting> EventNotification::<xref linkend="mthDefListDragHandler"/> @@ -4522,7 +4526,7 @@ </programlisting> </section> -<section id="enDefTreeDragHandler"><title>defTreeDragHandler</title> +<section id="enDefTreeDragHandler" xreflabel="defTreeDragHandler"><title>defTreeDragHandler</title> <programlisting> EventNotification::<xref linkend="mthDefTreeDragHandler"/> @@ -4533,7 +4537,7 @@ </programlisting> </section> -<section id="enDisconnectKeyPress"><title>disconnectKeyPress</title> +<section id="enDisconnectKeyPress" xreflabel="disconnectKeyPress"><title>disconnectKeyPress</title> <programlisting> EventNotification::<xref linkend="mthDisconnectKeyPressDialogObject"/> @@ -4545,7 +4549,7 @@ </programlisting> </section> -<section id="enHasKeyPressConnection"><title>hasKeyPressConnection</title> +<section id="enHasKeyPressConnection" xreflabel="hasKeyPressConnection"><title>hasKeyPressConnection</title> <programlisting> EventNotification::<xref linkend="mthHasKeyPressConnectionDialogObject"/> @@ -4866,31 +4870,149 @@ <section id="mthBackgroundColor" xreflabel="backgroundColor"><title>backgroundColor</title> <indexterm><primary>backgroundColor</primary></indexterm> +<indexterm><primary>dialog object</primary><secondary>backgroundColor</secondary></indexterm> <programlisting> <![CDATA[ ->>--backgroundColor(--color--)------------------->< +>>--backgroundColor(--color--+---------+--)------>< + +--isClr--+ +]]> +</programlisting> +<para> + Sets the background color of the dialog's <xref linkend="defClientArea"/>. This is the color used to paint all areas of the + dialog that are not covered by dialog controls. +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>color [required]</term> + <listitem> + <para> + Specifies the color to be used. This value can be either a palette color <link linkend="defColor">index</link>, or a + <xref linkend="defColorRef"/> number. To use a COLORREF number, the <emphasis role="italic">isClr</emphasis> argument + must be true. + </para> + </listitem></varlistentry> + <varlistentry><term>isClr [optional]</term> + <listitem> + <para> + Speicifes if the <emphasis role="italic">color</emphasis> argument is a COLORREF or a palette index. If true, the + <emphasis role="italic">color</emphasis> argument is interpreted as a COLORREF, if false it is interpreted to be a + pallete index. The default if this argument is omitted is false. + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + Returns true on success, false on error. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + To correctly construct a COLORREF, it is easist to use the <xref linkend="mthColorRef"/> method of the <xref + linkend="clsImage"/> class. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when 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 sets the background color to a palish blue: +<programlisting> +<![CDATA[ + self~backgroundColor(.Image~colorRef(171, 214, 245), .true) ]]> </programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End dialog object::backgroundColor() --> -<para>The backgroundColor method sets the background -color of a dialog. </para> + +<section id="mthBackgroundSysColor" xreflabel="backgroundSysColor"><title>backgroundSysColor</title> +<indexterm><primary>backgroundSysColor</primary></indexterm> +<indexterm><primary>dialog object</primary><secondary>backgroundSysColor</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--backgroundSysColor(--color--)------>< + +]]> +</programlisting> + +<para> + Sets the background color of the dialog's <xref linkend="defClientArea"/> to a system color. This is the color used to + paint all areas of the dialog that are not covered by dialog controls. +</para> <variablelist> -<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> -<listitem><para>The only argument is: -<variablelist> -<varlistentry><term>color</term> -<listitem><para>A color-palette index specifying the background color. For information -on the color numbers, refer to Definition of <link linkend="sctTermDefs">Terms</link>. -</para></listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The single argument is: + </para> + <variablelist> + <varlistentry><term>color [required]</term> + <listitem> + <para> + Specifies the system color to be used. This can be either the non-negative whole number ID or the keyword ID. IDs can + be looked up in the System Color Elements <link linkend="tblSysColors">table</link>. + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + Returns true on success, false on error. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + System colors are the colors used for display elements in the system. These colors can be customized by the user. By + using a system color ID, rather than using the <xref linkend="mthBackgroundColor"/> method, the Rexx programmer can be + sure the background matches that of the current system. Even if the user has changed from the normal default. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when 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 sets the background color of the dialog to be the same as the color of a multiple document interface (MDI) + application, +<programlisting> +<![CDATA[ + self~backgroundSysColor('APPWORKSPACE') + +]]> +</programlisting> + </para> + </listitem></varlistentry> </variablelist> -</para></listitem></varlistentry> -<varlistentry><term><emphasis role="bold">Return value:</emphasis></term> -<listitem><para>This method does not return a value. -</para></listitem></varlistentry> -</variablelist> -</section> +</section> <!-- End dialog object::backgroundColor() --> <section id="mthCenter" xreflabel="center"><title>center</title> @@ -5193,7 +5315,7 @@ </section> <!-- End dialog object::focusControl() --> -<section id="deGetControlRect"><title>getControlRect</title> +<section id="deGetControlRect" xreflabel="getControlRect"><title>getControlRect</title> <programlisting> DialogExtensions::<xref linkend="mthGetControlRect"/> @@ -5844,7 +5966,7 @@ </section> -<section id="deMoveControl"><title>moveControl</title> +<section id="deMoveControl" xreflabel="moveControl"><title>moveControl</title> <programlisting> DialogExtensions::<xref linkend="mthMoveControl"/> @@ -5855,7 +5977,7 @@ </programlisting> </section> -<section id="deResizeControl"><title>resizeControl</title> +<section id="deResizeControl" xreflabel="resizeControl"><title>resizeControl</title> <programlisting> DialogExtensions::<xref linkend="mthResizeControl"/> @@ -5923,7 +6045,7 @@ </section> -<section id="deSetControlColor"><title>setControlColor</title> +<section id="deSetControlColor" xreflabel="setControlColor"><title>setControlColor</title> <programlisting> DialogExtensions::<xref linkend="mthSetControlColor"/> @@ -5935,7 +6057,7 @@ </section> -<section id="deSetControlFont"><title>setControlFont</title> +<section id="deSetControlFont" xreflabel="setControlFont"><title>setControlFont</title> <programlisting> DialogExtensions::<xref linkend="mthSetControlFont"/> @@ -5947,7 +6069,7 @@ </section> -<section id="deSetControlSysColor"><title>setControlSysColor</title> +<section id="deSetControlSysColor" xreflabel="setControlSysColor"><title>setControlSysColor</title> <programlisting> DialogExtensions::<xref linkend="mthSetControlSysColor"/> @@ -6144,7 +6266,7 @@ </section> -<section id="deSetForegroundWindow"><title>setForegroundWindow</title> +<section id="deSetForegroundWindow" xreflabel="setForegroundWindow"><title>setForegroundWindow</title> <programlisting> DialogExtensions::<xref linkend="mthSetForegroundWindow"/> @@ -6308,7 +6430,7 @@ </section> -<section id="deSetWindowRect"><title>setWindowRect</title> +<section id="deSetWindowRect" xreflabel="setWindowRect"><title>setWindowRect</title> <programlisting> DialogExtensions::<xref linkend="mthSetWindowRect"/> @@ -7062,7 +7184,7 @@ </section> -<section id="deChangeBitmapButton"><title>changeBitmapButton</title> +<section id="deChangeBitmapButton" xreflabel="changeBitmapButton"><title>changeBitmapButton</title> <programlisting> DialogExtensions::<xref linkend="mthChangeBitmapButton"/> @@ -7077,7 +7199,7 @@ </section> -<section id="deDimBitmap"><title>dimBitmap</title> +<section id="deDimBitmap" xreflabel="dimBitmap"><title>dimBitmap</title> <programlisting> DialogExtensions::<xref linkend="mthDimBitmap"/> @@ -7089,7 +7211,7 @@ </section> -<section id="deDisplaceBitmap"><title>displaceBitmap</title> +<section id="deDisplaceBitmap" xreflabel="displaceBitmap"><title>displaceBitmap</title> <programlisting> DialogExtensions::<xref linkend="mthDisplaceBitmap"/> @@ -7099,7 +7221,7 @@ </programlisting> </section> -<section id="deDrawBitmap"><title>drawBitmap</title> +<section id="deDrawBitmap" xreflabel="drawBitmap"><title>drawBitmap</title> <programlisting> DialogExtensions::<xref linkend="mthDrawBitmap"/> @@ -7114,7 +7236,7 @@ </section> -<section id="deGetBitmapPosition"><title>getBitmapPosition</title> +<section id="deGetBitmapPosition" xreflabel="getBitmapPosition"><title>getBitmapPosition</title> <programlisting> DialogExtensions::<xref linkend="mthGetBitmapPosition"/> @@ -7125,7 +7247,7 @@ </section> -<section id="deGetBitmapSize"><title>getBitmapSize</title> +<section id="deGetBitmapSize" xreflabel="getBitmapSize"><title>getBitmapSize</title> <programlisting> DialogExtensions::<xref linkend="mthGetBitmapSize"/> @@ -7136,7 +7258,7 @@ </section> -<section id="deGetBitmapSizeX"><title>getBitmapSizeX</title> +<section id="deGetBitmapSizeX" xreflabel="getBitmapSizeX"><title>getBitmapSizeX</title> <programlisting> DialogExtensions::<xref linkend="mthGetBitmapSizeX"/> @@ -7147,7 +7269,7 @@ </section> -<section id="deGetBitmapSizeY"><title>getBitmapSizeY</title> +<section id="deGetBitmapSizeY" xreflabel="getBitmapSizeY"><title>getBitmapSizeY</title> <programlisting> DialogExtensions::<xref linkend="mthGetBitmapSizeY"/> @@ -7158,7 +7280,7 @@ </section> -<section id="deGetBmpDisplacement"><title>getBmpDisplacement</title> +<section id="deGetBmpDisplacement" xreflabel="getBmpDisplacement"><title>getBmpDisplacement</title> <programlisting> DialogExtensions::<xref linkend="mthGetBmpDisplacement"/> @@ -7169,7 +7291,7 @@ </section> -<section id="deInstallAnimatedButton"><title>installAnimatedButton</title> +<section id="deInstallAnimatedButton" xreflabel="installAnimatedButton"><title>installAnimatedButton</title> <programlisting> DialogExtensions::<xref linkend="mthInstallAnimatedButton"/> @@ -7184,7 +7306,7 @@ </section> -<section id="deInstallBitmapButton"><title>installBitmapButton</title> +<section id="deInstallBitmapButton" xreflabel="installBitmapButton"><title>installBitmapButton</title> <programlisting> DialogExtensions::<xref linkend="mthInstallBitmapButton"/> @@ -7196,7 +7318,7 @@ </section> -<section id="deScrollBitmapFromTo"><title>scrollBitmapFromTo</title> +<section id="deScrollBitmapFromTo" xreflabel="scrollBitmapFromTo"><title>scrollBitmapFromTo</title> <programlisting> DialogExtensions::<xref linkend="mthScrollBitmapFromTo"/> @@ -7211,7 +7333,7 @@ </section> -<section id="deScrollButton"><title>scrollButton</title> +<section id="deScrollButton" xreflabel="scrollButton"><title>scrollButton</title> <programlisting> DialogExtensions::<xref linkend="mthScrollButton"/> @@ -7222,7 +7344,7 @@ </section> -<section id="deSetBitmapPosition"><title>setBitmapPosition</title> +<section id="deSetBitmapPosition" xreflabel="setBitmapPosition"><title>setBitmapPosition</title> <programlisting> DialogExtensions::<xref linkend="mthSetBitmapPosition"/> @@ -7904,7 +8026,7 @@ </section> -<section id="deGetListItemHeight"><title>getListItemHeight</title> +<section id="deGetListItemHeight" xreflabel="getListItemHeight"><title>getListItemHeight</title> <programlisting> DialogExtensions::<xref linkend="mthGetListItemHeight"/> @@ -7915,7 +8037,7 @@ </section> -<section id="deGetListItemHeightPx"><title>getListItemHeightPx</title> +<section id="deGetListItemHeightPx" xreflabel="getListItemHeightPx"><title>getListItemHeightPx</title> <programlisting> DialogExtensions::<xref linkend="mthGetListItemHeightPx"/> @@ -7950,7 +8072,7 @@ </section> -<section id="deGetListWidth"><title>getListWidth</title> +<section id="deGetListWidth" xreflabel="getListWidth"><title>getListWidth</title> <programlisting> DialogExtensions::<xref linkend="mthGetListWidth"/> @@ -7961,7 +8083,7 @@ </section> -<section id="deGetListWidthPx"><title>getListWidthPx</title> +<section id="deGetListWidthPx" xreflabel="getListWidthPx"><title>getListWidthPx</title> <programlisting> DialogExtensions::<xref linkend="mthGetListWidthPx"/> @@ -8074,7 +8196,7 @@ </section> -<section id="deSetListColumnWidth"><title>setListColumnWidth</title> +<section id="deSetListColumnWidth" xreflabel="setListColumnWidth"><title>setListColumnWidth</title> <programlisting> DialogExtensions::<xref linkend="mthSetListColumnWidth"/> @@ -8085,7 +8207,7 @@ </section> -<section id="deSetListColumnWidthPx"><title>setListColumnWidthPx</title> +<section id="deSetListColumnWidthPx" xreflabel="setListColumnWidthPx"><title>setListColumnWidthPx</title> <programlisting> DialogExtensions::<xref linkend="mthSetListColumnWidthPx"/> @@ -8096,7 +8218,7 @@ </section> -<section id="deSetListItemHeight"><title>setListItemHeight</title> +<section id="deSetListItemHeight" xreflabel="setListItemHeight"><title>setListItemHeight</title> <programlisting> DialogExtensions::<xref linkend="mthSetListItemHeight"/> @@ -8107,7 +8229,7 @@ </section> -<section id="deSetListItemHeightPx"><title>setListItemHeightPx</title> +<section id="deSetListItemHeightPx" xreflabel="setListItemHeightPx"><title>setListItemHeightPx</title> <programlisting> DialogExtensions::<xref linkend="mthSetListItemHeightPx"/> @@ -8118,7 +8240,7 @@ </section> -<section id="deSetListWidth"><title>setListWidth</title> +<section id="deSetListWidth" xreflabel="setListWidth"><title>setListWidth</title> <programlisting> DialogExtensions::<xref linkend="mthSetListWidth"/> @@ -8129,7 +8251,7 @@ </section> -<section id="deSetListWidthPx"><title>setListWidthPx</title> +<section id="deSetListWidthPx" xreflabel="setListWidthPx"><title>setListWidthPx</title> <programlisting> DialogExtensions::<xref linkend="mthSetListWidthPx"/> @@ -9012,7 +9134,7 @@ The methods in this section are dialog object methods used to set or get the behavior of a scroll bar. </para> -<section id="deDetermineSBPosition"><title>determineSBPosition</title> +<section id="deDetermineSBPosition" xreflabel="determineSBPosition"><title>determineSBPosition</title> <programlisting> DialogExtensions::<xref linkend="mthDetermineSBPosition"/> @@ -9024,7 +9146,7 @@ </section> -<section id="deGetSBPos"><title>getSBPos</title> +<section id="deGetSBPos" xreflabel="getSBPos"><title>getSBPos</title> <programlisting> DialogExtensions::<xref linkend="mthGetSBPos"/> @@ -9035,7 +9157,7 @@ </section> -<section id="deGetSBRange"><title>getSBRange</title> +<section id="deGetSBRange" xreflabel="getSBRange"><title>getSBRange</title> <programlisting> DialogExtensions::<xref linkend="mthGetSBRange"/> @@ -9046,7 +9168,7 @@ </section> -<section id="deSetSBPos"><title>setSBPos</title> +<section id="deSetSBPos" xreflabel="setSBPos"><title>setSBPos</title> <programlisting> DialogExtensions::<xref linkend="mthSetSBPos"/> @@ -9058,7 +9180,7 @@ </section> -<section id="deSetSBRange"><title>setSBRange</title> +<section id="deSetSBRange" xreflabel="setSBRange"><title>setSBRange</title> <programlisting> DialogExtensions::<xref linkend="mthSetSBRange"/> @@ -9448,7 +9570,7 @@ programmer to retrieve a device context. </para> -<section id="deClearControlRect"><title>clearControlRect</title> +<section id="deClearControlRect" xreflabel="clearControlRect"><title>clearControlRect</title> <programlisting> DialogExtensions::<xref linkend="mthClearControlRect"/> @@ -9458,7 +9580,7 @@ </programlisting> </section> -<section id="deClearRectClsDialogExtensions"><title>clearRect</title> +<section id="deClearRectClsDialogExtensions" xreflabel="clearRect"><title>clearRect</title> <programlisting> DialogExtensions::<xref linkend="mthClearRectClsDialogExtensions"/> @@ -9485,7 +9607,7 @@ </programlisting> </section> -<section id="deClearWindowRect"><title>clearWindowRect</title> +<section id="deClearWindowRect" xreflabel="clearWindowRect"><title>clearWindowRect</title> <programlisting> DialogExtensions::<xref linkend="mthClearWindowRect"/> @@ -9496,7 +9618,7 @@ </section> -<section id="deCreateBrushClsDialogExtensions"><title>createBrush</title> +<section id="deCreateBrushClsDialogExtensions" xreflabel="createBrush"><title>createBrush</title> <programlisting> DialogExtensions::<xref linkend="mthCreateBrushClsDialogExtensions"/> @@ -9508,7 +9630,7 @@ </section> -<section id="deDrawButton"><title>drawButton</title> +<section id="deDrawButton" xreflabel="drawButton"><title>drawButton</title> <programlisting> DialogExtensions::<xref linkend="mthDrawButton"/> @@ -9519,7 +9641,7 @@ </section> -<section id="deFreeControlDC"><title>freeControlDC</title> +<section id="deFreeControlDC" xreflabel="freeControlDC"><title>freeControlDC</title> <programlisting> DialogExtensions::<xref linkend="mthFreeControlDC"/> @@ -9529,7 +9651,7 @@ </programlisting> </section> -<section id="deFreeWindowDC"><title>freeWindowDC</title> +<section id="deFreeWindowDC" xreflabel="freeWindowDC"><title>freeWindowDC</title> <programlisting> DialogExtensions::<xref linkend="mthFreeWindowDC"/> @@ -9540,7 +9662,7 @@ </section> -<section id="deGetControlDC"><title>getControlDC</title> +<section id="deGetControlDC" xreflabel="getControlDC"><title>getControlDC</title> <programlisting> DialogExtensions::<xref linkend="mthGetControlDC"/> @@ -9551,7 +9673,7 @@ </section> -<section id="deGetWindowDC"><title>getWindowDC</title> +<section id="deGetWindowDC" xreflabel="getWindowDC"><title>getWindowDC</title> <programlisting> DialogExtensions::<xref linkend="mthGetWindowDC"/> @@ -9562,7 +9684,7 @@ </section> -<section id="deRedrawControl"><title>redrawControl</title> +<section id="deRedrawControl" xreflabel="redrawControl"><title>redrawControl</title> <programlisting> DialogExtensions::<xref linkend="mthRedrawControl"/> @@ -9574,7 +9696,7 @@ </section> -<section id="deRedrawRectClsDialogExtensions"><title>redrawRect</title> +<section id="deRedrawRectClsDialogExtensions" xreflabel="redrawRect"><title>redrawRect</title> <programlisting> DialogExtensions::<xref linkend="mthRedrawRectClsDialogExtensions"/> @@ -9586,7 +9708,7 @@ </section> -<section id="deRedrawWindow"><title>redrawWindow</title> +<section id="deRedrawWindow" xreflabel="redrawWindow"><title>redrawWindow</title> <programlisting> DialogExtensions::<xref linkend="mthRedrawWindow"/> @@ -9597,7 +9719,7 @@ </section> -<section id="deRedrawWindowRect"><title>redrawWindowRect</title> +<section id="deRedrawWindowRect" xreflabel="redrawWindowRect"><title>redrawWindowRect</title> <programlisting> DialogExtensions::<xref linkend="mthRedrawWindowRect"/> @@ -9609,7 +9731,7 @@ </section> -<section id="deScrollInControl"><title>scrollInControl</title> +<section id="deScrollInControl" xreflabel="scrollInControl"><title>scrollInControl</title> <programlisting> DialogExtensions::<xref linkend="mthScrollInControl"/> @@ -9624,7 +9746,7 @@ </section> -<section id="deScrollText"><title>scrollText</title> +<section id="deScrollText" xreflabel="scrollText"><title>scrollText</title> <programlisting> DialogExtensions::<xref linkend="mthScrollText"/> @@ -9639,7 +9761,7 @@ </section> -<section id="deWriteToWindow"><title>writeToWindow</title> +<section id="deWriteToWindow" xreflabel="writeToWindow"><title>writeToWindow</title> <programlisting> DialogExtensions::<xref linkend="mthWriteToWindow"/> @@ -9651,7 +9773,7 @@ </section> -<section id="deWriteToControl"><title>writeToControl</title> +<section id="deWriteToControl" xreflabel="writeToControl"><title>writeToControl</title> <programlisting> DialogExtensions::<xref linkend="mthWriteToControl"/> Modified: docs/trunk/publican/oodialog/en-US/overview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/overview.xml 2012-09-16 23:50:49 UTC (rev 8414) +++ docs/trunk/publican/oodialog/en-US/overview.xml 2012-09-16 23:56:08 UTC (rev 8415) @@ -104,12 +104,11 @@ <section id="defColor" xreflabel="color number"><title>Color</title> <para> - Each color supported by the Windows operating system is assigned a number. Sample color indexes are 0 (black), 1 (dark - red), 2 (dark green), 3 (dark yellow), 4 (dark blue), 5 (purple), 6 (blue grey), 7 (light grey), 8 (pale green), 9 - (light blue), 10 (white), 11 (grey), 12 (dark grey), 13 (red), 14 (light green), 15 (yellow), 16 (blue), 17 (pink), 18 - (turquoise). -</para> -</section> + Windows supports a method of specifying colors by using an index into a <emphasis role="italic">color palette</emphasis>, + see below. Palette color indexes are limited in number. The typical palette color indexes are 0 (black), 1 (dark red), 2 + (dark green), 3 (dark yellow), 4 (dark blue), 5 (purple), 6 (blue grey), 7 (light grey), 8 (pale green), 9 (light blue), 10 + (white), 11 (grey), 12 (dark grey), 13 (red), 14 (light green), 15 (yellow), 16 (blue), 17 (pink), 18 (turquoise). +</para> </section> <section id="defColorPalette" xreflabel="color pallette"><title>Color Palette</title> <para> @@ -134,6 +133,20 @@ </para> </section> +<section id="defColorRef" xreflabel="COLORREF"><title>COLORREF</title> +<para> + Windows uses a type named COLORREF to specify colors as RGB values. The RGB color model specifies a color by using a + number, 0 to 255, to represent each of the three primary colors, red, green, and blue. A COLORREF is a single number that + Windows will interpret as the 3 values for red, green, and blue. Many of the Windows APIs use a COLORREF as an argument + when working with colors. +</para> +<para> + ooDialog provides a number of methods to make it easy for the programmer to create a COLORREF number by specifying the 3 + red, green, and blue values separately. Among these methods are the <xref linkend="mthColorRef"/> class method of the <xref + linkend="clsImage"/> class and the <xref linkend="RGB"/> method of the <xref linkend="clsCustomDraw"/> class. +</para> +</section> + <section id="defConventionalHex" xreflabel="hexidecimal"><title>Conventional Hexadecimal Format</title> <para> There are a number of methods in the ooDialog framework that have an argument that can be in numeric format, a whole Modified: docs/trunk/publican/oodialog/en-US/treeview.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-16 23:50:49 UTC (rev 8414) +++ docs/trunk/publican/oodialog/en-US/treeview.xml 2012-09-16 23:56:08 UTC (rev 8415) @@ -770,7 +770,7 @@ </variablelist> </section> -<section id="endedittrc"><title>endEdit</title> +<section id="mthEndEditClsTreeView" xreflabel="endEdit"><title>endEdit</title> <indexterm><primary>endEdit</primary> <secondary>TreeView class</secondary></indexterm> <programlisting> @@ -809,7 +809,7 @@ </variablelist> </section> -<section id="ensurevisibletrc"><title>ensureVisible</title> +<section id="mthEnsureVisibleClsTreeView" xreflabel="ensureVisible"><title>ensureVisible</title> <indexterm><primary>ensureVisible</primary> <secondary>TreeView class</secondary></indexterm> <programlisting> Modified: docs/trunk/publican/oodialog/en-US/windowBaseDCO.xml =================================================================== --- docs/trunk/publican/oodialog/en-US/windowBaseDCO.xml 2012-09-16 23:50:49 UTC (rev 8414) +++ docs/trunk/publican/oodialog/en-US/windowBaseDCO.xml 2012-09-16 23:56:08 UTC (rev 8415) @@ -54,7 +54,7 @@ object. </para> -<section id="wbdcoChildWindowFromPoint"><title>childWindowFromPoint</title> +<section id="wbdcoChildWindowFromPoint" xreflabel="childWindowFromPoint"><title>childWindowFromPoint</title> <programlisting> WindowBase::<xref linkend="mthChildWindowFromPoint"/> @@ -65,7 +65,7 @@ </programlisting> </section> -<section id="wbdcoClear"><title>clear</title> +<section id="wbdcoClear" xreflabel="clear"><title>clear</title> <programlisting> WindowBase::<xref linkend="mthClear"/> @@ -75,7 +75,7 @@ </programlisting> </section> -<section id="wbdcoClient2screen"><title>client2screen</title> +<section id="wbdcoClient2screen" xreflabel="client2screen"><title>client2screen</title> <programlisting> WindowBase::<xref linkend="mthClient2screen"/> @@ -86,7 +86,7 @@ </section> -<section id="wbdcoClientRect"><title>clientRect</title> +<section id="wbdcoClientRect" xreflabel="clientRect"><title>clientRect</title> <programlisting> WindowBase::<xref linkend="mthClientRect"/> @@ -97,7 +97,7 @@ </programlisting> </section> -<section id="wbdcoClientToScreen"><title>clientToScreen</title> +<section id="wbdcoClientToScreen" xreflabel="clientToScreen"><title>clientToScreen</title> <programlisting> WindowBase::<xref linkend="mthClientToScreen"/> @@ -108,7 +108,7 @@ </section> -<section id="wbdcoDisable"><title>disable</title> +<section id="wbdcoDisable" xreflabel="disable"><title>disable</title> <programlisting> WindowBase::<xref linkend="mthDisable"/> @@ -118,7 +118,7 @@ </programlisting> </section> -<section id="wbdcoDisplay"><title>display</title> +<section id="wbdcoDisplay" xreflabel="display"><title>display</title> <programlisting> WindowBase::<xref linkend="mthDisplay"/> @@ -127,7 +127,7 @@ </programlisting> </section> -<section id="wbdcoDraw"><title>draw</title> +<section id="wbdcoDraw" xreflabel="draw"><title>draw</title> <programlisting> WindowBase::<xref linkend="mthDraw"/> @@ -137,7 +137,7 @@ </programlisting> </section> -<section id="wbdcoEnable"><title>enable</title> +<section id="wbdcoEnable" xreflabel="enable"><title>enable</title> <programlisting> WindowBase::<xref linkend="mthEnable"/> @@ -147,7 +147,7 @@ </programlisting> </section> -<section id="wbdcoForegroundWindow"><title>foregroundWindow</title> +<section id="wbdcoForegroundWindow" xreflabel="foregroundWindow"><title>foregroundWindow</title> <programlisting> WindowBase::<xref linkend="mthForegroundWindow"/> @@ -158,7 +158,7 @@ </section> -<section id="wbdcoGetClientRect"><title>getClientRect</title> +<section id="wbdcoGetClientRect" xreflabel="getClientRect"><title>getClientRect</title> <programlisting> WindowBase::<xref linkend="mthGetClientRect"/> @@ -169,7 +169,7 @@ </programlisting> </section> -<section id="wbdcoGetExStyleRaw"><title>getExStyleRaw</title> +<section id="wbdcoGetExStyleRaw" xreflabel="getExStyleRaw"><title>getExStyleRaw</title> <programlisting> WindowBase::<xref linkend="mthGetExStyleRaw"/> @@ -179,7 +179,7 @@ </programlisting> </section> -<section id="wbdcoGetID"><title>getID</title> +<section id="wbdcoGetID" xreflabel="getID"><title>getID</title> <programlisting> WindowBase::<xref linkend="mthGetID"/> @@ -189,7 +189,7 @@ </programlisting> </section> -<section id="wbdcoGetPos"><title>getPos</title> +<section id="wbdcoGetPos" xreflabel="getPos"><title>getPos</title> <programlisting> WindowBase::<xref linkend="mthGetPos"/> @@ -200,7 +200,7 @@ </programlisting> </section> -<section id="wbdcoGetRealPos"><title>getRealPos</title> +<section id="wbdcoGetRealPos" xreflabel="getRealPos"><title>getRealPos</title> <programlisting> WindowBase::<xref linkend="mthGetSize"/> @@ -210,7 +210,7 @@ </programlisting> </section> -<section id="wbdcoGetRealSize"><title>getRealSize</title> +<section id="wbdcoGetRealSize" xreflabel="getRealSize"><title>getRealSize</title> <programlisting> WindowBase::<xref linkend="mthGetRealSize"/> @@ -220,7 +220,7 @@ </programlisting> </section> -<section id="wbdcoGetRect"><title>getRect</title> +<section id="wbdcoGetRect" xreflabel="getRect"><title>getRect</title> <programlisting> WindowBase::<xref linkend="mthGetRect"/> @@ -230,7 +230,7 @@ </programlisting> </section> -<section id="wbdcoGetSize"><title>getSize</title> +<section id="wbdcoGetSize" xreflabel="getSize"><title>getSize</title> <programlisting> WindowBase::<xref linkend="mthGetSize"/> @@ -240,7 +240,7 @@ </programlisting> </section> -<section id="wbdcoGetStyleRaw"><title>getStyleRaw</title> +<section id="wbdcoGetStyleRaw" xreflabel="getStyleRaw"><title>getStyleRaw</title> <programlisting> WindowBase::<xref linkend="mthGetStyleRaw"/> @@ -250,7 +250,7 @@ </programlisting> </section> -<section id="wbdcoGetText"><title>getText</title> +<section id="wbdcoGetText" xreflabel="getText"><title>getText</title> <programlisting> WindowBase::<xref linkend="mthGetText"/> @@ -260,7 +260,7 @@ </programlisting> </section> -<section id="wbdcoGetTextSizePx"><title>getTextSizePx</title> +<section id="wbdcoGetTextSizePx" xreflabel="getTextSizePx"><title>getTextSizePx</title> <programlisting> WindowBase::<xref linkend="mthGetTextSizePx"/> @@ -270,7 +270,7 @@ </programlisting> </section> -<section id="wbdcoGetTextSizeScreen"><title>getTextSizeScreen</title> +<section id="wbdcoGetTextSizeScreen" xreflabel="getTextSizeScreen"><title>getTextSizeScreen</title> <programlisting> WindowBase::<xref linkend="mthGetTextSizeScreen"/> @@ -281,7 +281,7 @@ </programlisting> </section> -<section id="wbdcoHide"><title>hide</title> +<section id="wbdcoHide" xreflabel="hide"><title>hide</title> <programlisting> WindowBase::<xref linkend="mthHide"/> @@ -291,7 +291,7 @@ </programlisting> </section> -<section id="wbdcoHideFast"><title>hideFast</title> +<section id="wbdcoHideFast" xreflabel="hideFast"><title>hideFast</title> <programlisting> WindowBase::<xref linkend="mthHideFast"/> @@ -300,7 +300,7 @@ ]]> </programlisting> </section> -<section id="wbdcoIsEnabled"><title>isEnabled</title> +<section id="wbdcoIsEnabled" xreflabel="isEnabled"><title>isEnabled</title> <programlisting> WindowBase::<xref linkend="mthIsEnabled"/> @@ -310,7 +310,7 @@ </programlisting> </section> -<section id="wbdcoIsVisible"><title>isVisible</title> +<section id="wbdcoIsVisible" xreflabel="isVisible"><title>isVisible</title> <programlisting> WindowBase::<xref linkend="mthIsVisible"/> @@ -320,7 +320,7 @@ </programlisting> </section> -<section id="wbdcoMove"><title>move</title> +<section id="wbdcoMove" xreflabel="move"><title>move</title> <programlisting> WindowBase::<xref linkend="mthMove"/> @@ -331,7 +331,7 @@ </programlisting> </section> -<section id="wbdcoMoveTo"><title>moveTo</title> +<section id="wbdcoMoveTo" xreflabel="moveTo"><title>moveTo</title> <programlisting> WindowBase::<xref linkend="mthMoveTo"/> @@ -352,7 +352,7 @@ </programlisting> </section> -<section id="wbdcoMoveWindow"><title>moveWindow</title> +<section id="wbdcoMoveWindow" xreflabel="moveWindow"><title>moveWindow</title> <programlisting> WindowBase::<xref linkend="mthMoveWindow"/> @@ -373,7 +373,7 @@ </programlisting> </section> -<section id="wbdcoRedraw"><title>redraw</title> +<section id="wbdcoRedraw" xreflabel="redraw"><title>redraw</title> <programlisting> WindowBase::<xref linkend="mthRedraw"/> @@ -383,7 +383,7 @@ </programlisting> </section> -<section id="wbdcoRedrawClient"><title>redrawClient</title> +<section id="wbdcoRedrawClient" xreflabel="redrawClient"><title>redrawClient</title> <programlisting> WindowB... [truncated message content] |