From: <mie...@us...> - 2012-01-13 00:39:41
|
Revision: 7421 http://oorexx.svn.sourceforge.net/oorexx/?rev=7421&view=rev Author: miesfeld Date: 2012-01-13 00:39:32 +0000 (Fri, 13 Jan 2012) Log Message: ----------- Continue ooDialog doc update Modified Paths: -------------- docs/trunk/oodialog/deprecated.xml docs/trunk/oodialog/dialogControlObject.xml docs/trunk/oodialog/dialogExtensions.xml docs/trunk/oodialog/dialogObject.xml docs/trunk/oodialog/edit.xml docs/trunk/oodialog/eventNotification.xml docs/trunk/oodialog/listview.xml docs/trunk/oodialog/mouse.xml docs/trunk/oodialog/userInput.xml docs/trunk/oodialog/windowExtensions.xml docs/trunk/oodialog/windowExtensionsDCO.xml docs/trunk/oodialog/windowExtensionsDO.xml Modified: docs/trunk/oodialog/deprecated.xml =================================================================== --- docs/trunk/oodialog/deprecated.xml 2012-01-13 00:38:27 UTC (rev 7420) +++ docs/trunk/oodialog/deprecated.xml 2012-01-13 00:39:32 UTC (rev 7421) @@ -124,26 +124,13 @@ section. </para> -<section><title>absRect2LogRect</title> +<section><title>captureMouse</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> because it is incorrectly implemented and <link - linkend="ovvInaccurate">inaccurate</link>. Replace this method with the <link - linkend="mthPixel2dlgUnit">pixel2dlgUnit</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="clsMouse">mouse</link> + object methods directly. </para> </section> -<section><title>assignWindow</title> -<para> - This method is deprecated and always returns 0, <emphasis role="italic">the assignment failed</emphasis>. To work with - a dialog or dialog control object, construct the proper ooDialog object. This ensures that the object has the correct - methods. To control a window not owned by your program use the <emphasis role="italic">find</emphasis>() method of the - <emphasis role="italic">WindowsManger</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 <link linkend="defHandle">handle</link> is known. For these cases - use a <link linkend="clsWindow">Window</link> object. -</para> -</section> - <section><title>checkMenuItem</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> @@ -393,6 +380,13 @@ </para> </section> +<section><title>getMouseCapture</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="clsMouse">mouse</link> + object methods directly. +</para> +</section> + <section><title>getMultiList</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link @@ -442,14 +436,6 @@ </para> </section> -<section><title>getSystemMetrics</title> -<para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method the functionally equivalent <link - linkend="mthGetSystemMetricsClsDlgUtil">getSystemMetrics()</link> method of the <emphasis - role="italic">.DlgUtil</emphasis>class. -</para> -</section> - <section><title>getTabControl</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link @@ -518,6 +504,13 @@ </para> </section> +<section><title>isMouseButtonDown</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="clsMouse">mouse</link> + object methods directly. +</para> +</section> + <section><title>itemText</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link @@ -526,14 +519,6 @@ </para> </section> -<section><title>logRect2AbsRect</title> -<para> - This method is <link linkend="ovvDeprecated">deprecated</link> because it is incorrectly implemented and <link - linkend="ovvInaccurate">inaccurate</link>. Replace this method with the <link - linkend="mthDlgUnit2pixel">dlgUnit2pixel</link>() method. -</para> -</section> - <section><title>moveItem</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link @@ -554,6 +539,13 @@ </para> </section> +<section><title>releaseMouseCapture</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="clsMouse">mouse</link> + object methods directly. +</para> +</section> + <section><title>resizeItem</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link @@ -637,345 +629,377 @@ </section> -<section id="deprecatedUserDialogMethods"><title>Deprecated UserDialog Methods</title> -<indexterm><primary>Deprecated</primary><secondary>UserDialog methods</secondary></indexterm> -<para> - <link linkend="ovvDeprecated">Deprecated</link> <computeroutput>UserDialog</computeroutput> methods and their - replacement methods are listed in this section. -</para> +<section id="deprecatedDialogControls"><title>Deprecated Dialog Control Methods</title> +<indexterm><primary>Deprecated</primary><secondary>dialog control methods</secondary></indexterm> -<section><title>addBitmapButton</title> +<section id="deprecatedButton"><title>Deprecated Button Methods</title> +<indexterm><primary>Deprecated</primary><secondary>button methods</secondary></indexterm> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateBitmapButton">createBitmapButton</link>() method. + The following lists the <link linkend="ovvDeprecated">deprecated</link> 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 <link + linkend="chpDialogObject">dialog</link> object. The methods are methods of the dialog, not the button. </para> -</section> -<section><title>addBlackFrame</title> +<section><title>changeBitmap</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateBlackFrame">createBlackFrame</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthChangeBitmapButton">changeBitmapButton</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addBlackRect</title> +<section><title>dimBitmap</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateBlackRect">createBlackRect</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthDimBitmap">dimBitmap</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addButton</title> +<section><title>displaceBitmap</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreatePushButton">createPushButton</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthDisplaceBitmap">displaceBitmap</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addButtonGroup</title> +<section><title>drawBitmap</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreatePushButtonGroup">createPushButtonGroup</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthDrawBitmap">drawBitmap</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addCheckBox</title> +<section><title>getBitmapPosition</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateCheckBox">createCheckBox</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthGetBitmapPosition">getBitmapPosition</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addCheckBoxStem</title> +<section><title>getBitmapSizeX</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateCheckBoxStem">createCheckBoxStem</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthGetBitmapSizeX"></link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addCheckGroup</title> +<section><title>getBitmapSizeY</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateCheckBoxGroup">createCheckBoxGroup</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthGetBitmapSizeY">getBitmapSizeY</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addComboBox</title> +<section><title>getBitmapSizeY</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateComboBox">createComboBox</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthGetBitmapSizeY">getBitmapSizeY</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addComboInput</title> +<section><title>scroll</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateComboBoxInput">createComboBoxInput</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthScrollbutton">scrollButton</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addEntryLine</title> +<section><title>scrollBitmapFromTo</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateEdit">createEdit</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthScrollBitmapFromTo">scrollBitmapFromTo</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addEtchedFrame</title> +<section><title>scrollText</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateEtchedFrame">createEtchedFrame</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthScrollText">scrollText</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addEtchedHorizontal</title> +<section><title>setBitmapPosition</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateEtchedHorizontal">createEtchedHorizontal</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link + linkend="mthSetBitmapPosition">setBitmapPosition</link>() method of the the <link + linkend="chpDialogObject">dialog</link> object. </para> </section> -<section><title>addEtchedVertical</title> +</section> <!-- End Deprecated Buttons Methods Section --> + +<section id="deprecatedComboBox"><title>Deprecated ComboBox Methods</title> +<indexterm><primary>Deprecated</primary><secondary>combo box methods</secondary></indexterm> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateEtchedVertical">createEtchedVertical</link>() method. + The following lists the <link linkend="ovvDeprecated">deprecated</link> methods of the <emphasis + role="italic">ComboBox</emphasis> class and how to replace those methods in ooDialog programs. </para> -</section> -<section><title>addGrayFrame</title> +<section><title>editSelection</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateGrayFrame">createGrayFrame</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Use <link + linkend="mthSetEditSelection">setEditSelection</link>(). </para> </section> -<section><title>addGrayRect</title> +</section> <!-- End Deprecated ComboBox Methods Section --> + +<section id="deprecatedListView"><title>Deprecated ListView Methods</title> +<indexterm><primary>Deprecated</primary><secondary>list-view methods</secondary></indexterm> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateGrayRect">createGrayRect</link>() method. + The following lists the <link linkend="ovvDeprecated">deprecated</link> methods of the <emphasis + role="italic">ListView</emphasis> class and how to replace those methods in ooDialog programs. </para> -</section> -<section><title>addGroupBox</title> +<section><title>removeImages</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateGroupBox">createGroupBox</link>() method. + This method is deprecated. It is replaced by the functionally equivalent <link + linkend="mthSetImageListClsListView">setImageList()</link> 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>addIcon</title> +<section><title>removeSmallImages</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthAddIconResource">addIconResource</link>() method. + This method is deprecated. It is replaced by the functionally equivalent <link + linkend="mthSetImageListClsListView">setImageList()</link> 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>addImage</title> +<section><title>setImages</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateStaticImage">createStaticImage</link>() method. + This method is deprecated. It is replaced by the functionally equivalent <link + linkend="mthSetImageListClsListView">setImageList()</link> 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>addInput</title> +<section><title>setSmallImages</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateEditInput">createEditInput</link>() method. + This method is deprecated. It is replaced by the functionally equivalent <link + linkend="mthSetImageListClsListView">setImageList()</link> 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>addInputGroup</title> +</section> <!-- End Deprecated TreeView Methods Section --> + +<section id="deprecatedProgressBar"><title>Deprecated ProgressBar Methods</title> +<indexterm><primary>Deprecated</primary><secondary>progress bar methods</secondary></indexterm> + +<section><title>getRange</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateEditInputGroup">createEditInputGroup</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Use <link linkend="mthGetFullRangePBC">getFullRange</link>(). </para> </section> -<section><title>addInputStem</title> +<section id="mthSetRangePBC"><title>setRange</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateEditInputStem">createEditInputStem</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link> Use <link linkend="mthSetFullRangePBC">setFullRange</link>(). </para> </section> -<section><title>addListBox</title> +</section> <!-- End Deprecated ProgressBar Methods Section --> + + +<section id="deprecatedRadiobuttonMethods"><title>Deprecated Radio Button Methods</title> +<indexterm><primary>Deprecated</primary><secondary>radio button methods</secondary></indexterm> + +<section><title>isChecked</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateListBox">createListBox</link>() method. + linkend="mthGetCheckStateClsRadioButton">getCheckState</link>() method for radio buttons, and the over-ridden <link + linkend="mthGetCheckStateClsCheckBox">getCheckState</link>() method for check boxes. This method was poorly named and + in some circumstances produced inconsistent results. </para> </section> -<section><title>addListControl</title> +<section><title>indeterminate</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateListView">createListView</link>() method. + linkend="mthSetIndeterminate">setIndeterminate</link>() method of the <link linkend="clsCheckBox">CheckBox</link> + 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. </para> </section> -<section><title>addMenuItem</title> +</section> <!-- End Deprecated Radio Button Methods Section --> + + +<section id="deprecatedTab"><title>Deprecated Tab Methods</title> +<indexterm><primary>Deprecated</primary><secondary>tab methods</secondary></indexterm> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> - object methods directly. + The following lists the <link linkend="ovvDeprecated">deprecated</link> methods of the <emphasis + role="italic">Tab</emphasis> class and how to replace those methods in ooDialog programs. </para> -</section> -<section><title>addMenuSeparator</title> +<section><title>removeImages</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> - object methods directly. + This method is deprecated. It is replaced by the functionally equivalent <link + linkend="mthSetImageListClsTabControl">setImageList()</link> 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>addOkCancelLeftBottom</title> +<section><title>setImages</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateOkCancelLeftBottom">createOkCancelLeftBottom</link>() method. + This method is deprecated. It is replaced by the functionally equivalent <link + linkend="mthSetImageListClsTabControl">setImageList()</link> 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>addOkCancelLeftTop</title> +</section> <!-- End Deprecated Tab Methods Section --> + +<section id="deprecatedTreeView"><title>Deprecated TreeView Methods</title> +<indexterm><primary>Deprecated</primary><secondary>tree-view methods</secondary></indexterm> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateOkCancelLeftTop">createOkCancelLeftTop</link>() method. + The following lists the <link linkend="ovvDeprecated">deprecated</link> methods of the <emphasis + role="italic">TreeView</emphasis> class and how to replace those methods in ooDialog programs. </para> -</section> -<section><title>addOkCancelRightBottom</title> +<section><title>removeImages</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateOkCancelRightBottom">createOkCancelRightBottom</link>() method. + This method is deprecated. It is replaced by the functionally equivalent <link + linkend="mthSetImageListClsTreeView">setImageList()</link> 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>addOkCancelRightTop</title> +<section><title>setImages</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateOkCancelRightTop">createOkCancelRightTop</link>() method. + This method is deprecated. It is replaced by the functionally equivalent <link + linkend="mthSetImageListClsTreeView">setImageList()</link> 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>addPasswordLine</title> +</section> <!-- End Deprecated TreeView Methods Section --> + +</section> <!-- End Deprecated Dialog Control Methods Section --> + + +<section id="deprecatedDialogControl"><title>Deprecated DialogControl Methods</title> +<indexterm><primary>Deprecated</primary><secondary>dialog control object methods</secondary></indexterm> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreatePasswordEdit">createPasswordEdit</link>() method. + The following lists the <link linkend="ovvDeprecated">deprecated</link> methods of the <emphasis + role="italic">DialogControl</emphasis> class and how to replace those methods in ooDialog programs. </para> -</section> -<section><title>addPopupMenu</title> +<section><title>captureMouse</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="clsMouse">mouse</link> object methods directly. </para> </section> -<section><title>addProgressBar</title> +<section><title>getFocus</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateProgressBar">createProgressBar</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> + object's <link linkend="mthGetFocus">getFocus</link>() method instead. </para> </section> -<section><title>addRadioButton</title> +<section><title>getMouseCapture</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateRadioButton">createRadioButton</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="clsMouse">mouse</link> + object methods directly. </para> </section> -<section><title>addRadioGroup</title> +<section><title>getTextSize</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateRadioButtonGroup">createRadioButtonGroup</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthGetTextSizeDu">getTextSizeDu</link>() method. The <link + linkend="mthGetTextSizeDlgClsDialogControl">getTextSizeDlg</link>() method could also be used, if absolutely + necessary. However, that is not recommended. </para> -</section> - -<section><title>addRadioStem</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateRadioButtonStem">createRadioButtonStem</link>() method. + This method never worked correctly, the previous documentation for this method was incorrect and / + or misleading. That has been fixed in the <emphasis role="italic">getTextSizeDlgDu</emphasis>() method. </para> </section> -<section><title>addScrollBar</title> +<section><title>isMouseButtonDown</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateScrollBar">createScrollBar</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="clsMouse">mouse</link> + object methods directly. </para> </section> -<section><title>addSliderControl</title> +<section><title>processMessage</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateTrackbar">createTrackbar</link>() method. + linkend="wbdcoSendMessage">sendMessage</link>() method. </para> </section> -<section><title>addStatic</title> +<section><title>releaseMouseCapture</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateStatic">createStatic</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="clsMouse">mouse</link> + object methods directly. </para> </section> -<section><title>addTabControl</title> +<section><title>setFocus</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateTab">createTab</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> + object's <link linkend="mthSetFocus">setFocus</link>() method instead. </para> </section> -<section><title>addText</title> +<section><title>tabToNext</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateStaticText">createStaticTest</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> + object's <link linkend="mthTabToNext">tabToNext</link>() method instead. </para> </section> -<section><title>addTreeControl</title> +<section><title>tabToPrevious</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateTreeView">createTreeView</link>() method. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> + object's <link linkend="mthTabToPrevious">tabToPrevious</link>() method instead. </para> </section> -<section><title>addWhiteFrame</title> +<section><title>value</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateWhiteFrame">createWhiteFrame</link>() method. + linkend="mthData">data</link>() method. </para> </section> -<section><title>addWhiteRect</title> +<section><title>value=</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthCreateWhiteRect">createWhiteRect</link>() method. + linkend="mthDataEquals">data=</link>() method. </para> </section> -<section><title>createMenu</title> -<para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> - object methods directly. -</para> -</section> +</section> <!-- End Deprecated DialogControl Methods Section --> -<section><title>loadMenu</title> -<para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> - object methods directly. -</para> -</section> -<section><title>setMenu</title> -<para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> - object methods directly. -</para> -</section> - -</section> <!-- End Deprecated UserDialog Methods Section --> - - <section id="deprecatedEventNotification"><title>Deprecated Event Notification Methods</title> <indexterm><primary>Deprecated</primary><secondary>MessageExtensions methods</secondary></indexterm> <indexterm><primary>Deprecated</primary><secondary>EventNotification methods</secondary></indexterm> @@ -1098,6 +1122,13 @@ </para> </section> +<section><title>connectMouseCapture</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="clsMouse">mouse</link> object + methods directly. +</para> +</section> + <section><title>connectScrollBar</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link @@ -1143,535 +1174,616 @@ </section> -<section id="deprecatedDialogControl"><title>Deprecated DialogControl Methods</title> -<indexterm><primary>Deprecated</primary><secondary>dialog control object methods</secondary></indexterm> +<section id="deprecatedExternalFunctions"><title>Deprecated External Functions</title> +<indexterm><primary>Deprecated</primary><secondary>external functions</secondary></indexterm> + <para> - The following lists the <link linkend="ovvDeprecated">deprecated</link> methods of the <emphasis - role="italic">DialogControl</emphasis> class and how to replace those methods in ooDialog programs. + <emphasis role="bold">Do not directly use any of the ooDialog external functions.</emphasis> </para> +<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 <link linkend="sctPublicRoutines">Public 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 + functions, noting that it would be difficult for ooDialog programmers to use these other functions + unless they were experienced C programmers. In hindsight that was a mistake. Each of the external + functions has a matching public routine. No mention of the external functions should have been made. + Instead, only the public routines should have been documented. +</para> +<para> + The reason for this is simple, the external functions have been removed. Prior to 4.0.0, ooDialog was + implemented using the original external naitve API. This API was useful, but somewhat limiting. + Particularly when used with the object-orientated paradigm. ooRexx 4.0.0 introduces a new native API + that is much more robust and flexible. Using this new API makes writing exernal packages like ooDialog + much easier. +</para> +<para> + ooDialog has been completely converted to use this new API. <emphasis role="italic"><emphasis + role="bold">All</emphasis> of the external functions have been removed.</emphasis> If your programs directly uses any + of the <emphasis role="bold">undocumented</emphasis> external functions, they will not work with the 4.2.0 release of + ooDialog. +</para> +<para> + The documented external functions will be available as <emphasis role="bold">deprecated</emphasis> + functions, with the possibility of their removal in the future. However, they will simply map to the + corresponding public routine. The programmer can remove this extra level of indirection by calling the + public routine directly. It would be nice if ooDialog did not have to drag along this baggage forever + into the future. +</para> +<para> + It is no longer necessary to use RxFuncAdd(). Doing so is a nop. Likewise, registering InstMMFuncs() + and calling it does nothing. The ooDialog programmer should remove any references to RxFuncAdd (when + used to register any ooDialog external function,) and InstMMFuncs in their code as the opportunity + arises. +</para> -<section><title>assignWindow</title> +<section><title>errorMessage</title> <para> - This method is deprecated and always returns 0, <emphasis role="italic">the assignment failed</emphasis>. To work with - a dialog or dialog control object, construct the proper ooDialog object. This ensures that the object has the correct - methods. To control a window not owned by your program use the <emphasis role="italic">find</emphasis>() method of the - <emphasis role="italic">WindowsManger</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 <link linkend="defHandle">handle</link> is known. For these cases - use a <link linkend="clsWindow">Window</link> object. + This function is <link linkend="ovvDeprecated">deprecated</link>. Use the public routine <link + linkend="rtnErrorDialog">errorDialog</link>. </para> </section> -<section><title>captureMous</title> +<section><title>getFileNameWindow</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> - object's <link linkend="mthCaptureMouse">captureMouse</link>() method instead. + This function is deprecated. See this <link linkend="deprecatedExternalFunctions">explanation</link>. Use the public routine + <link linkend="rtnFileNameDialog">FileNameDialog</link>. 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 <link linkend="deprecatedExternalFunctions">explanation</link>. Use the + public routine <link linkend="rtnScreenSize">screenSize</link>. 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>getFocus</title> +<section><title>getSysMetrics</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> - object's <link linkend="mthGetFocus">getFocus</link>() method instead. + This function is deprecated. It is replaced by the functionally equivalent <link + linkend="mthGetSystemMetricsClsDlgUtil">getSystemMetrics()</link> 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>getMouseCapture</title> +<section><title>infoMessage</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> - object's <link linkend="mthGetMouseCapture">getMouseCapture</link>() method instead. + This function is <link linkend="ovvDeprecated">deprecated</link>. Use the public routine <link + linkend="rtnInfoDialog">infoDialog</link>. </para> </section> -<section><title>getTextSize</title> +<section><title>playSoundFile</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthGetTextSizeDu">getTextSizeDu</link>() method. The <link - linkend="mthGetTextSizeDlgClsDialogControl">getTextSizeDlg</link>() method could also be used, if absolutely - necessary. However, that is not recommended. + This function is deprecated. See this <link linkend="deprecatedExternalFunctions">explanation</link>. Use the public routine + <link linkend="rtnPlay">Play</link>. 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 method never worked correctly, the previous documentation for this method was incorrect and / - or misleading. That has been fixed in the <emphasis role="italic">getTextSizeDlgDu</emphasis>() method. + This function is deprecated. See this <link linkend="deprecatedExternalFunctions">explanation</link>. Use the public routine + <link linkend="rtnPlay">play</link>. 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>isMouseButtonDown</title> +<section><title>sleepMS</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> - object's <link linkend="mthIsMouseButtonDown">isMouseButtonDown</link>() method instead. + This fucntion is <link linkend="ovvDeprecated">deprecated</link>. Use the public routine <link + linkend="rtnMSSleep">msSleep</link>. </para> </section> -<section><title>processMessage</title> +<section><title>stopSoundFile</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="wbdcoSendMessage">sendMessage</link>() method. + This function is deprecated. See this <link linkend="deprecatedExternalFunctions">explanation</link>. Use the public routine + <link linkend="rtnPlay">play</link>. 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 <link + linkend="mthGetSystemMetricsClsDlgUtil">getSystemMetrics()</link> 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> </section> -<section><title>releaseMouseCapture</title> +<section><title>winTimer</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> - object's <link linkend="mthReleaseMouseCapture">releaseMouseCapture</link>() method instead. + This function is <link linkend="ovvDeprecated">deprecated</link>. There is no replacement for this function. </para> +<para> + The implementation of this function is poor. It uses 100% of the CPU while waiting. It should be possible to provide + this functionality without consuming all the CPU. A future version of ooDialog may provide a proper implementation for + the functionality of waiting on a repeating timer. +</para> </section> -<section><title>setFocus</title> +<section><title>yesNoMessage</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> - object's <link linkend="mthSetFocus">setFocus</link>() method instead. + This function is <link linkend="ovvDeprecated">deprecated</link>. Use the public routine <link + linkend="rtnAskDialog">askDialog</link>. </para> </section> -<section><title>tabToNext</title> +</section> <!-- End Deprecated External Functions Section --> + + +<section id="deprecatedUserDialogMethods"><title>Deprecated UserDialog Methods</title> +<indexterm><primary>Deprecated</primary><secondary>UserDialog methods</secondary></indexterm> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> - object's <link linkend="mthTabToNext">tabToNext</link>() method instead. + <link linkend="ovvDeprecated">Deprecated</link> <computeroutput>UserDialog</computeroutput> methods and their + replacement methods are listed in this section. </para> + +<section><title>addBitmapButton</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateBitmapButton">createBitmapButton</link>() method. +</para> </section> -<section><title>tabToPrevious</title> +<section><title>addBlackFrame</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpDialogObject">dialog</link> - object's <link linkend="mthTabToPrevious">tabToPrevious</link>() method instead. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateBlackFrame">createBlackFrame</link>() method. </para> </section> -<section><title>value</title> +<section><title>addBlackRect</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthData">data</link>() method. + linkend="mthCreateBlackRect">createBlackRect</link>() method. </para> </section> -<section><title>value=</title> +<section><title>addButton</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthDataEquals">data=</link>() method. + linkend="mthCreatePushButton">createPushButton</link>() method. </para> </section> -</section> <!-- End Deprecated DialogControl Methods Section --> +<section><title>addButtonGroup</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreatePushButtonGroup">createPushButtonGroup</link>() method. +</para> +</section> +<section><title>addCheckBox</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateCheckBox">createCheckBox</link>() method. +</para> +</section> -<section id="deprecatedDialogControls"><title>Deprecated Methods of Dialog Controls</title> -<indexterm><primary>Deprecated</primary><secondary>dialog control methods</secondary></indexterm> +<section><title>addCheckBoxStem</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateCheckBoxStem">createCheckBoxStem</link>() method. +</para> +</section> -<section id="deprecatedButton"><title>Deprecated Button Methods</title> -<indexterm><primary>Deprecated</primary><secondary>button methods</secondary></indexterm> +<section><title>addCheckGroup</title> <para> - The following lists the <link linkend="ovvDeprecated">deprecated</link> 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 <link - linkend="chpDialogObject">dialog</link> object. The methods are methods of the dialog, not the button. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateCheckBoxGroup">createCheckBoxGroup</link>() method. </para> +</section> -<section><title>changeBitmap</title> +<section><title>addComboBox</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthChangeBitmapButton">changeBitmapButton</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateComboBox">createComboBox</link>() method. </para> </section> -<section><title>dimBitmap</title> +<section><title>addComboInput</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthDimBitmap">dimBitmap</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateComboBoxInput">createComboBoxInput</link>() method. </para> </section> -<section><title>displaceBitmap</title> +<section><title>addEntryLine</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthDisplaceBitmap">displaceBitmap</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateEdit">createEdit</link>() method. </para> </section> -<section><title>drawBitmap</title> +<section><title>addEtchedFrame</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthDrawBitmap">drawBitmap</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateEtchedFrame">createEtchedFrame</link>() method. </para> </section> -<section><title>getBitmapPosition</title> +<section><title>addEtchedHorizontal</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthGetBitmapPosition">getBitmapPosition</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateEtchedHorizontal">createEtchedHorizontal</link>() method. </para> </section> -<section><title>getBitmapSizeX</title> +<section><title>addEtchedVertical</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthGetBitmapSizeX"></link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateEtchedVertical">createEtchedVertical</link>() method. </para> </section> -<section><title>getBitmapSizeY</title> +<section><title>addGrayFrame</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthGetBitmapSizeY">getBitmapSizeY</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateGrayFrame">createGrayFrame</link>() method. </para> </section> -<section><title>getBitmapSizeY</title> +<section><title>addGrayRect</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthGetBitmapSizeY">getBitmapSizeY</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateGrayRect">createGrayRect</link>() method. </para> </section> -<section><title>scroll</title> +<section><title>addGroupBox</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthScrollbutton">scrollButton</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateGroupBox">createGroupBox</link>() method. </para> </section> -<section><title>scrollBitmapFromTo</title> +<section><title>addIcon</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthScrollBitmapFromTo">scrollBitmapFromTo</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthAddIconResource">addIconResource</link>() method. </para> </section> -<section><title>scrollText</title> +<section><title>addImage</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthScrollText">scrollText</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateStaticImage">createStaticImage</link>() method. </para> </section> -<section><title>setBitmapPosition</title> +<section><title>addInput</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Replace this method with the <link - linkend="mthSetBitmapPosition">setBitmapPosition</link>() method of the the <link - linkend="chpDialogObject">dialog</link> object. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateEditInput">createEditInput</link>() method. </para> </section> -</section> <!-- End Deprecated Buttons Methods Section --> +<section><title>addInputGroup</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateEditInputGroup">createEditInputGroup</link>() method. +</para> +</section> -<section id="deprecatedComboBox"><title>Deprecated ComboBox Methods</title> -<indexterm><primary>Deprecated</primary><secondary>combo box methods</secondary></indexterm> +<section><title>addInputStem</title> <para> - The following lists the <link linkend="ovvDeprecated">deprecated</link> methods of the <emphasis - role="italic">ComboBox</emphasis> class and how to replace those methods in ooDialog programs. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateEditInputStem">createEditInputStem</link>() method. </para> +</section> -<section><title>editSelection</title> +<section><title>addListBox</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Use <link - linkend="mthSetEditSelection">setEditSelection</link>(). + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateListBox">createListBox</link>() method. </para> </section> -</section> <!-- End Deprecated ComboBox Methods Section --> +<section><title>addListControl</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateListView">createListView</link>() method. +</para> +</section> -<section id="deprecatedListView"><title>Deprecated ListView Methods</title> -<indexterm><primary>Deprecated</primary><secondary>list-view methods</secondary></indexterm> +<section><title>addMenuItem</title> <para> - The following lists the <link linkend="ovvDeprecated">deprecated</link> methods of the <emphasis - role="italic">ListView</emphasis> class and how to replace those methods in ooDialog programs. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> + object methods directly. </para> +</section> -<section><title>removeImages</title> +<section><title>addMenuSeparator</title> <para> - This method is deprecated. It is replaced by the functionally equivalent <link - linkend="mthSetImageListClsListView">setImageList()</link> 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. + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> + object methods directly. </para> </section> -<section><title>removeSmallImages</title> +<section><title>addOkCancelLeftBottom</title> <para> - This method is deprecated. It is replaced by the functionally equivalent <link - linkend="mthSetImageListClsListView">setImageList()</link> 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. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateOkCancelLeftBottom">createOkCancelLeftBottom</link>() method. </para> </section> -<section><title>setImages</title> +<section><title>addOkCancelLeftTop</title> <para> - This method is deprecated. It is replaced by the functionally equivalent <link - linkend="mthSetImageListClsListView">setImageList()</link> 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. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateOkCancelLeftTop">createOkCancelLeftTop</link>() method. </para> </section> -<section><title>setSmallImages</title> +<section><title>addOkCancelRightBottom</title> <para> - This method is deprecated. It is replaced by the functionally equivalent <link - linkend="mthSetImageListClsListView">setImageList()</link> 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. + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateOkCancelRightBottom">createOkCancelRightBottom</link>() method. </para> </section> -</section> <!-- End Deprecated TreeView Methods Section --> +<section><title>addOkCancelRightTop</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateOkCancelRightTop">createOkCancelRightTop</link>() method. +</para> +</section> -<section id="deprecatedProgressBar"><title>Deprecated ProgressBar Methods</title> -<indexterm><primary>Deprecated</primary><secondary>progress bar methods</secondary></indexterm> +<section><title>addPasswordLine</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreatePasswordEdit">createPasswordEdit</link>() method. +</para> +</section> -<section><title>getRange</title> +<section><title>addPopupMenu</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Use <link linkend="mthGetFullRangePBC">getFullRange</link>(). + This method is <link linkend="ovvDeprecated">deprecated</link>. Use the <link linkend="chpMenus">menu</link> + object methods directly. </para> </section> -<section id="mthSetRangePBC"><title>setRange</title> +<section><title>addProgressBar</title> <para> - This method is <link linkend="ovvDeprecated">deprecated</link> Use <link linkend="mthSetFullRangePBC">setFullRange</link>(). + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateProgressBar">createProgressBar</link>() method. </para> </section> -</section> <!-- End Deprecated ProgressBar Methods Section --> +<section><title>addRadioButton</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateRadioButton">createRadioButton</link>() method. +</para> +</section> +<section><title>addRadioGroup</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateRadioButtonGroup">createRadioButtonGroup</link>() method. +</para> +</section> -<section id="deprecatedRadiobuttonMethods"><title>Deprecated Radio Button Methods</title> -<indexterm><primary>Deprecated</primary><secondary>radio button methods</secondary></indexterm> +<section><title>addRadioStem</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateRadioButtonStem">createRadioButtonStem</link>() method. +</para> +</section> -<section><title>isChecked</title> +<section><title>addScrollBar</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthGetCheckStateClsRadioButton">getCheckState</link>() method for radio buttons, and the over-ridden <link - linkend="mthGetCheckStateClsCheckBox">getCheckState</link>() method for check boxes. This method was poorly named and - in some circumstances produced inconsistent results. + linkend="mthCreateScrollBar">createScrollBar</link>() method. </para> </section> -<section><title>indeterminate</title> +<section><title>addSliderControl</title> <para> This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link - linkend="mthSetIndeterminate">setIndeterminate</link>() method of the <link linkend="clsCheckBox">CheckBox</link> - 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. + linkend="mthCreateTrackbar">createTrackbar</link>() method. </para> </section> -</section> <!-- End Deprecated Radio Button Methods Section --> +<section><title>addStatic</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateStatic">createStatic</link>() method. +</para> +</section> +<section><title>addTabControl</title> +<para> + This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link + linkend="mthCreateTab">createTab</link>() method. +</para> +</section> -<section id="deprecatedTab"><title>Deprecated Tab Methods</title> -<indexterm><primary>Deprecated</primary><secondary>tab me... [truncated message content] |