Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx-code-0:[8943] docs/trunk/oodialog/en-US
|
From: <mie...@us...> - 2013-02-06 00:44:43
|
Revision: 8943
http://sourceforge.net/p/oorexx/code-0/8943
Author: miesfeld
Date: 2013-02-06 00:44:41 +0000 (Wed, 06 Feb 2013)
Log Message:
-----------
Feature Requests:
#530 Want to be be able to calculate the rectangle occupied by a combo box item
See ticket [Feature-requests:#530]
#531 Combo box methods to set the minimum number of items shown in list
See ticket [Feature-requests:#531]
#532 Set the cue banner text for a combo box
See ticket [Feature-requests:#532]
Modified Paths:
--------------
docs/trunk/oodialog/en-US/combobox.xml
docs/trunk/oodialog/en-US/edit.xml
docs/trunk/oodialog/en-US/treeview.xml
docs/trunk/oodialog/en-US/utilityclasses.xml
Modified: docs/trunk/oodialog/en-US/combobox.xml
===================================================================
--- docs/trunk/oodialog/en-US/combobox.xml 2013-02-06 00:41:20 UTC (rev 8942)
+++ docs/trunk/oodialog/en-US/combobox.xml 2013-02-06 00:44:41 UTC (rev 8943)
@@ -156,6 +156,10 @@
<entry>Searches this combo box for a list item containing the specified text or prefix.</entry>
</row>
<row>
+<entry><xref linkend="mthGetCueClsComboBox"/></entry>
+<entry>Retrieves the cue banner text for this combo box, or the empty string if there is no cue set.</entry>
+</row>
+<row>
<entry><xref linkend="mthGetComboBoxInfo"/></entry>
<entry>Returns a <computeroutput>Directory</computeroutput> object containinng information about this combo box.</entry>
</row>
@@ -700,7 +704,72 @@
</variablelist>
</section> <!-- End ComboBox::find() -->
+<section id="mthGetCueClsComboBox" xreflabel="getCue"><title>getCue</title>
+<indexterm><primary>getCue</primary><secondary>ComboBox class</secondary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>getCue</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--getCue---------------------------------------><
+]]>
+</programlisting>
+<para>
+ Retrieves the cue banner text for this combo box, or the empty string if there is no cue set.
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ There are no arguments for this method.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ Returns the cue for this combo box, or the empty string if no cue is set.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ The cue banner is text that is displayed in the edit control, or selection field, of a combo box when there is no item
+ currently selected.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ <emphasis role="bold">Requires Windows Vista or later</emphasis>.
+ </para>
+ <para>
+ Raises syntax errors if incorrect usage is detected.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example sets a simple cue for a combo box and then reads it back:
+<programlisting>
+<![CDATA[
+
+ comboBox = self~newComboBox(IDC_COMBOBOX)
+
+ comboBox~setCue("Select a city")
+
+ say 'Cue set:' comboBox~getCue
+
+/* Output would be:
+
+ Cue set: Select a city
+
+*/
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End ComboBox::getCue() -->
+
<section id="mthGetComboBoxInfo" xreflabel="getCombBoxInfo"><title>getCombBoxInfo</title>
<indexterm><primary>getCombBoxInfo</primary></indexterm>
<indexterm><primary>ComboBox class</primary><secondary>getCombBoxInfo</secondary></indexterm>
@@ -903,7 +972,69 @@
</variablelist>
</section> <!-- End ComboBox::getEditControl() -->
+<section id="mthGetFirstVisibleClsComboBox" xreflabel="getFirstVisible"><title>getFirstVisible</title>
+<indexterm><primary>getFirstVisible</primary><secondary>ComboBox class</secondary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>getFirstVisible</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--getFirstVisible(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+<para>
+ xx
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ </para>
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ Additional comments.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ Raises syntax errors when incorrect usage is detected.
+ </para>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End ComboBox::getFirstVisible() -->
+
<section id="mthGetHorizontalExtentClsComboBox" xreflabel="getHorizontalExtent"><title>getHorizontalExtent</title>
<indexterm><primary>getHorizontalExtent</primary><secondary>ComboBox class</secondary></indexterm>
<indexterm><primary>ComboBox class</primary><secondary>getHorizontalExtent</secondary></indexterm>
@@ -951,6 +1082,133 @@
</variablelist>
</section> <!-- End ComboBox::getHorizontalExtent() -->
+<section id="mthGetItemHeightClsComboBox" xreflabel="getItemHeight"><title>getItemHeight</title>
+<indexterm><primary>getItemHeight</primary><secondary>ComboBox class</secondary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>getItemHeight</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--getItemHeight(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ </para>
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ Additional comments.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ Raises syntax errors when incorrect usage is detected.
+ </para>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End ComboBox::getItemHeight() -->
+
+<section id="mthGetMinVisible" xreflabel="getMinVisible"><title>getMinVisible</title>
+<indexterm><primary>getMinVisible</primary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>getMinVisible</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--getMinVisible(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ </para>
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ Additional comments.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ Raises syntax errors when incorrect usage is detected.
+ </para>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End ComboBox::getMinVisible() -->
+
+
<section id="mthGetTextClsComboBox" xreflabel="getText"><title>getText</title>
<indexterm><primary>getText</primary><secondary>ComboBox class</secondary></indexterm>
<indexterm><primary>ComboBox class</primary><secondary>getText</secondary></indexterm>
@@ -995,6 +1253,197 @@
</variablelist>
</section>
+
+<section id="mthInsertClsComboBox" xreflabel="insert"><title>insert</title>
+<indexterm><primary>insert</primary><secondary>ComboBox class</secondary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>insert</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--insert(--+-------+--,--item--)---------------><
+ +-index-+
+
+]]>
+</programlisting>
+
+<para>
+ Inserts a new item into the list of the combo box.
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ <variablelist>
+ <varlistentry><term>index [optional]</term>
+ <listitem>
+ <para>
+ The one-based index of the position to add the new item. If this <emphasis role="italic">index</emphasis> is
+ omitted, the item is added after the currently selected item. If there is no currently selected item, the new
+ item is inserted as the last item. If <emphasis role="italic">index</emphasis> is 0 the item is inserted as the
+ first item. If <emphasis role="italic">index</emphasis> is less than 0 then the new item is inserted as the last
+ item
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term>item [required]</term>
+ <listitem>
+ <para>
+ The item to add to the list.
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ Unlike the <xref linkend="mthAddClsComboBox"/> method, if the combo box has the SORT style, the <emphasis
+ role="italic">insert</emphasis> method does not cause the combo box to sort the list items.
+ </para>
+ <para>
+ If the combo box has a horizontal scroll bar and the width of the new item is wider than the combo box, or wider
+ than the current horizontal extent, the programmer should use the <xref linkend="mthSetHorizontalExtentClsComboBox"/>
+ method to ensure the scroll bar is shown and will scroll far enough to show the whole item.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ On success, the one-based index of the position at which the item was been added. A number less than 1 indicates an
+ error.
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section>
+
+
+<section id="mthIsDropDown" xreflabel="isDropDown"><title>isDropDown</title>
+<indexterm><primary>isDropDown</primary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>isDropDown</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isDropDown(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ </para>
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ Additional comments.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ Raises syntax errors when incorrect usage is detected.
+ </para>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End ComboBox::isDropDown() -->
+
+
+<section id="mthIsDropDownList" xreflabel="isDropDownList"><title>isDropDownList</title>
+<indexterm><primary>isDropDownList</primary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>isDropDownList</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isDropDownList(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ </para>
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ Additional comments.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ Raises syntax errors when incorrect usage is detected.
+ </para>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End ComboBox::isDropDownList() -->
+
+
<section id="mthIsDropDownOpen" xreflabel="isDropDownOpen"><title>isDropDownOpen</title>
<indexterm><primary>isDropDownOpen</primary></indexterm>
<indexterm><primary>ComboBox class</primary><secondary>isDropDownOpen</secondary></indexterm>
@@ -1137,68 +1586,70 @@
</variablelist>
</section> <!-- End ComboBox::isGrandchild() -->
-
-<section id="mthInsertClsComboBox" xreflabel="insert"><title>insert</title>
-<indexterm><primary>insert</primary><secondary>ComboBox class</secondary></indexterm>
-<indexterm><primary>ComboBox class</primary><secondary>insert</secondary></indexterm>
+<section id="mthIsSimple" xreflabel="isSimple"><title>isSimple</title>
+<indexterm><primary>isSimple</primary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>isSimple</secondary></indexterm>
<programlisting>
<![CDATA[
->>--insert(--+-------+--,--item--)---------------><
- +-index-+
-
+>>--isSimple(--+--------+--)---------------------------------------------><
+ +--type--+
]]>
</programlisting>
<para>
- Inserts a new item into the list of the combo box.
+ xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
- <variablelist>
- <varlistentry><term>index [optional]</term>
- <listitem>
- <para>
- The one-based index of the position to add the new item. If this <emphasis role="italic">index</emphasis> is
- omitted, the item is added after the currently selected item. If there is no currently selected item, the new
- item is inserted as the last item. If <emphasis role="italic">index</emphasis> is 0 the item is inserted as the
- first item. If <emphasis role="italic">index</emphasis> is less than 0 then the new item is inserted as the last
- item
- </para>
- </listitem></varlistentry>
- <varlistentry><term>item [required]</term>
- <listitem>
- <para>
- The item to add to the list.
- </para>
- </listitem></varlistentry>
- </variablelist>
</para>
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
</listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
- Unlike the <xref linkend="mthAddClsComboBox"/> method, if the combo box has the SORT style, the <emphasis
- role="italic">insert</emphasis> method does not cause the combo box to sort the list items.
+ Additional comments.
</para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
<para>
- If the combo box has a horizontal scroll bar and the width of the new item is wider than the combo box, or wider
- than the current horizontal extent, the programmer should use the <xref linkend="mthSetHorizontalExtentClsComboBox"/>
- method to ensure the scroll bar is shown and will scroll far enough to show the whole item.
+ Raises syntax errors when incorrect usage is detected.
</para>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
</listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
- On success, the one-based index of the position at which the item was been added. A number less than 1 indicates an
- error.
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
-</section>
+</section> <!-- End ComboBox::isSimple() -->
+
<section id="mthItemsClsComboBox" xreflabel="items"><title>items</title>
<indexterm><primary>items</primary><secondary>ComboBox class</secondary></indexterm>
<indexterm><primary>ComboBox class</primary><secondary>items</secondary></indexterm>
@@ -1516,6 +1967,70 @@
</variablelist>
</section> <!-- End ComboBox::selectIndex() -->
+<section id="mthSetCueClsComboBox" xreflabel="setCue"><title>setCue</title>
+<indexterm><primary>setCue</primary><secondary>ComboBox class</secondary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>setCue</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--setCue(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ </para>
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ Additional comments.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ Raises syntax errors when incorrect usage is detected.
+ </para>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End ComboBox::setCue() -->
+
+
<section id="mthSetEditSelection" xreflabel="setEditSelection"><title>setEditSelection</title>
<indexterm><primary>setEditSelection</primary></indexterm>
<indexterm><primary>ComboBox class</primary><secondary>setEditSelection</secondary></indexterm>
@@ -1697,4 +2212,131 @@
</variablelist>
</section> <!-- End ComboBox::setHorizontalExtent() -->
+<section id="mthSetItemHeight" xreflabel="setItemHeight"><title>setItemHeight</title>
+<indexterm><primary>setItemHeight</primary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>setItemHeight</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--setItemHeight(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ </para>
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ Additional comments.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ Raises syntax errors when incorrect usage is detected.
+ </para>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End ComboBox::setItemHeight() -->
+
+<section id="mthSetMinVisible" xreflabel="setMinVisible"><title>setMinVisible</title>
+<indexterm><primary>setMinVisible</primary></indexterm>
+<indexterm><primary>ComboBox class</primary><secondary>setMinVisible</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--setMinVisible(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ </para>
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ Additional comments.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ Raises syntax errors when incorrect usage is detected.
+ </para>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End ComboBox::setMinVisible() -->
+
+
</chapter>
Modified: docs/trunk/oodialog/en-US/edit.xml
===================================================================
--- docs/trunk/oodialog/en-US/edit.xml 2013-02-06 00:41:20 UTC (rev 8942)
+++ docs/trunk/oodialog/en-US/edit.xml 2013-02-06 00:44:41 UTC (rev 8943)
@@ -163,7 +163,7 @@
<entry>Retrieves the index of the first visible line, or the first visible character, in an edit control.</entry>
</row>
<row>
-<entry><xref linkend="mthGetCue"/></entry>
+<entry><xref linkend="mthGetCueClsEdit"/></entry>
<entry>Retrieves the cue text, or the empty string if there is no cue set.</entry>
</row>
<row>
@@ -259,7 +259,7 @@
<entry>Returns a <computeroutput>Directory</computeroutput> object containing the start and end of the text selection.</entry>
</row>
<row>
-<entry><xref linkend="mthSetCue"/></entry>
+<entry><xref linkend="mthSetCueClsEdit"/></entry>
<entry>Sets the text for the <emphasis role="italic">cue</emphasis> banner.</entry>
</row>
<row>
@@ -876,8 +876,8 @@
</section> <!-- End Edit::firstVisibleLine() -->
-<section id="mthGetCue" xreflabel="getCue"><title>getCue</title>
-<indexterm><primary>getCue</primary></indexterm>
+<section id="mthGetCueClsEdit" xreflabel="getCue"><title>getCue</title>
+<indexterm><primary>getCue</primary><secondary>Edit class</secondary></indexterm>
<indexterm><primary>Edit class</primary><secondary>getCue</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -888,7 +888,7 @@
<para>
Retrieves the cue text, or the empty string if there is no cue set. The cue text is set with the
- <xref linkend="mthSetCue"/> method.
+ <xref linkend="mthSetCueClsEdit"/> method.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
@@ -2696,8 +2696,8 @@
</section> <!-- End Edit::selection() -->
-<section id="mthSetCue" xreflabel="setCue"><title>setCue</title>
-<indexterm><primary>setCue</primary></indexterm>
+<section id="mthSetCueClsEdit" xreflabel="setCue"><title>setCue</title>
+<indexterm><primary>setCue</primary><secondary>Edit class</secondary></indexterm>
<indexterm><primary>Edit class</primary><secondary>setCue</secondary></indexterm>
<programlisting>
<![CDATA[
Modified: docs/trunk/oodialog/en-US/treeview.xml
===================================================================
--- docs/trunk/oodialog/en-US/treeview.xml 2013-02-06 00:41:20 UTC (rev 8942)
+++ docs/trunk/oodialog/en-US/treeview.xml 2013-02-06 00:44:41 UTC (rev 8943)
@@ -184,7 +184,7 @@
<entry>Gets the item data associated with the specified tree-view item.</entry>
</row>
<row>
-<entry><xref linkend="mthGetItemHeight"/></entry>
+<entry><xref linkend="mthGetItemItemClsTreeView"/></entry>
<entry>Gets the height the tree-view control used for each of items items.</entry>
</row>
<row>
@@ -1235,8 +1235,8 @@
</variablelist>
</section> <!-- End TreeView::getItemData() -->
-<section id="mthGetItemHeight" xreflabel="getItemHeight"><title>getItemHeight</title>
-<indexterm><primary>getItemHeight</primary></indexterm>
+<section id="mthGetItemItemClsTreeView" xreflabel="getItemHeight"><title>getItemHeight</title>
+<indexterm><primary>getItemHeight</primary><secondary>TreeViewClass</secondary></indexterm>
<indexterm><primary>TreeView class</primary><secondary>getItemHeight</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -2933,7 +2933,7 @@
<listitem>
<para>
The tree-view uses the value for the height of all items. The value itself is the height of a single item. See the <link
- linkend="mthGetItemHeight">getItemHeight</link> method. By default, the tree-view only allows even heights. However, if
+ linkend="mthGetItemItemClsTreeView">getItemHeight</link> method. By default, the tree-view only allows even heights. However, if
the <link linkend="styTreeViewNONEVENHEIGHT">NONEVENHEIGHT</link> style is give to the tree-view, both odd and even
values can be assigned.
</para>
Modified: docs/trunk/oodialog/en-US/utilityclasses.xml
===================================================================
--- docs/trunk/oodialog/en-US/utilityclasses.xml 2013-02-06 00:41:20 UTC (rev 8942)
+++ docs/trunk/oodialog/en-US/utilityclasses.xml 2013-02-06 00:44:41 UTC (rev 8943)
@@ -3807,7 +3807,7 @@
<entry>Subtracts two <computeroutput>Point</computeroutput>objects</entry>
</row>
<row>
-<entry><xref linkend="mthCopy"/></entry>
+<entry><xref linkend="mthCopyClsPoint"/></entry>
<entry>Returns a new <computeroutput>Point</computeroutput> object that represents the same coordinates as this point.</entry>
</row>
<row>
@@ -4149,8 +4149,8 @@
</variablelist>
</section> <!-- End Point::-() -->
-<section id="mthCopy" xreflabel="copy"><title>copy</title>
-<indexterm><primary>copy</primary></indexterm>
+<section id="mthCopyClsPoint" xreflabel="copy"><title>copy</title>
+<indexterm><primary>copy</primary><secondary>PointClass</secondary></indexterm>
<indexterm><primary>Point class</primary><secondary>copy</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -4554,6 +4554,10 @@
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
</row>
<row>
+<entry><xref linkend="mthCopyClsRect"/></entry>
+<entry>Returns a new <computeroutput>Rect</computeroutput> object with the same coordinates as this rectangle.</entry>
+</row>
+<row>
<entry><xref linkend="mthStringRect"/></entry>
<entry>Provides an informative string representation of the <computeroutput>Rect</computeroutput> object.</entry>
</row>
@@ -4855,6 +4859,64 @@
</variablelist>
</section> <!-- End Rect::top() [attribute] -->
+<section id="mthCopyClsRect" xreflabel="copy"><title>copy</title>
+<indexterm><primary>copy</primary><secondary>RectClass</secondary></indexterm>
+<indexterm><primary>Rect class</primary><secondary>copy</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--copy-----------------------------------------><
+]]>
+</programlisting>
+
+<para>
+ Returns a new <computeroutput>Rect</computeroutput> object with the same coordinates as this rectangle.
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ This method has no arguments.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ Returns a newly instantiated <computeroutput>Rect</computeroutput> object with the same coordinates as this object.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
+ <listitem>
+ <para>
+ The copied rectangle initially has the same coordinates as this rectangle. Changing the coordinates in one rectangle
+ after the copy does not effect the coordinates of the other rectangle.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example makes a copy of the client rectangle of an edit control:
+<programlisting>
+<![CDATA[
+
+ editOffsetRect = editRect~copy
+ editOffsetRect~top -= height
+ editOffSetRect~bottom -= height
+
+ say 'text rect: ' editRect
+ say 'text offset rect' editOffsetRect
+
+ /* Output might be */
+
+ text rect: a Rect (0, 0, 104, 21)
+ text offset rect a Rect (0, -21, 104, 0)
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End Rect::copy() -->
+
+
<section id="mthStringRect" xreflabel="string"><title>string</title>
<indexterm><primary>string</primary><secondary>Rect class</secondary></indexterm>
<indexterm><primary>Rect class</primary><secondary>string</secondary></indexterm>
|