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] |