Diff of /docs/trunk/oodialog/en-US/treeview.xml [r8596] .. [r8597]  Maximize  Restore

Switch to side-by-side view

--- a/docs/trunk/oodialog/en-US/treeview.xml
+++ b/docs/trunk/oodialog/en-US/treeview.xml
@@ -124,56 +124,56 @@
 <entry>Adds a new item to the tree-view.</entry>
 </row>
 <row>
+<entry><xref linkend="child"/></entry>
 <entry>Child</entry>
-<entry><xref linkend="child"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="collapse"/></entry>
 <entry>Collapse</entry>
-<entry><xref linkend="collapse"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="collapseandreset"/></entry>
 <entry>CollapseAndReset</entry>
-<entry><xref linkend="collapseandreset"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="deletetrc"/></entry>
 <entry>delete</entry>
-<entry><xref linkend="deletetrc"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="deletealltrc"/></entry>
 <entry>deleteAll</entry>
-<entry><xref linkend="deletealltrc"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="drophighlight"/></entry>
 <entry>DropHighlight</entry>
-<entry><xref linkend="drophighlight"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="drophighlightedtrc"/></entry>
 <entry>dropHighlighted</entry>
-<entry><xref linkend="drophighlightedtrc"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="edittrc"/></entry>
 <entry>Edit</entry>
-<entry><xref linkend="edittrc"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="mthEndEditClsTreeView"/></entry>
 <entry>endEdit</entry>
-<entry><xref linkend="mthEndEditClsTreeView"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="mthEnsureVisibleClsTreeView"/></entry>
 <entry>ensureVisible</entry>
-<entry><xref linkend="mthEnsureVisibleClsTreeView"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="expand"/></entry>
 <entry>Expand</entry>
-<entry><xref linkend="expand"/></entry>
 </row>
 <row>
 <entry><xref linkend="mthFind"/></entry>
 <entry>Finds the first tree-view item whose label matches the text specified. The search is case insensitive.</entry>
 </row>
 <row>
+<entry><xref linkend="firstvisibletrc"/></entry>
 <entry>firstVisible</entry>
-<entry><xref linkend="firstvisibletrc"/></entry>
 </row>
 <row>
 <entry><xref linkend="mthGetImageListClsTreeView"/></entry>
@@ -192,88 +192,92 @@
 <entry>Retrieves the bounding rectangle for a tree-view item and indicates whether the item is visible.</entry>
 </row>
 <row>
+<entry><xref linkend="mthGetToolTipsClsTreeView"/></entry>
+<entry>Retrieves the child <link linkend="clsToolTip">ToolTip</link> control used by this tree-view.</entry>
+</row>
+<row>
 <entry><xref linkend="mthItemTextClsTreeView"/></entry>
 <entry>Gets the text, the label, of the specified tree-view item.</entry>
 </row>
 <row>
-<entry>HitTest</entry>
-<entry><xref linkend="hittest"/></entry>
+<entry><xref linkend="mthHitTestClsTreeView"/></entry>
+<entry>hitTest</entry>
 </row>
 <row>
 <entry><xref linkend="mthHitTestInfoClsTreeView"/></entry>
 <entry>Determines the location of a point relative to the tree-view control.</entry>
 </row>
 <row>
+<entry><xref linkend="indent"/></entry>
 <entry>Indent</entry>
-<entry><xref linkend="indent"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="indentnew"/></entry>
 <entry>Indent=</entry>
-<entry><xref linkend="indentnew"/></entry>
 </row>
 <row>
 <entry><xref linkend="mthInsertClsTreeView"/></entry>
 <entry>Inserts a new item into the tree-view control.</entry>
 </row>
 <row>
+<entry><xref linkend="isancestor"/></entry>
 <entry>IsAncestor</entry>
-<entry><xref linkend="isancestor"/></entry>
 </row>
 <row>
 <entry><xref linkend="mthItemInfoClsTreeView"/></entry>
 <entry>The <emphasis role="italic">itemInfo</emphasis> method returnes the attributes of the specified item as a stem.</entry>
 </row>
 <row>
+<entry><xref linkend="itemstrc"/></entry>
 <entry>items</entry>
-<entry><xref linkend="itemstrc"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="makefirstvisibletrc"/></entry>
 <entry>MakeFirstVisible</entry>
-<entry><xref linkend="makefirstvisibletrc"/></entry>
 </row>
 <row>
 <entry><xref linkend="mthModifyClsTreeView"/></entry>
 <entry>Modifies some or all of an item's attributes.</entry>
 </row>
 <row>
+<entry><xref linkend="moveitem"/></entry>
 <entry>moveItem</entry>
-<entry><xref linkend="moveitem"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="nexttrc"/></entry>
 <entry>next</entry>
-<entry><xref linkend="nexttrc"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="nextvisible"/></entry>
 <entry>NextVisible</entry>
-<entry><xref linkend="nextvisible"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="parent"/></entry>
 <entry>Parent</entry>
-<entry><xref linkend="parent"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="previoustrc"/></entry>
 <entry>previous</entry>
-<entry><xref linkend="previoustrc"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="previousvisible"/></entry>
 <entry>PreviousVisible</entry>
-<entry><xref linkend="previousvisible"/></entry>
 </row>
 <row>
 <entry><xref linkend="mthRemoveItemDataClsTreeView"/></entry>
 <entry>Removes and returns the user data associated with the specified tree-view item.</entry>
 </row>
 <row>
+<entry><xref linkend="mthRoot"/></entry>
 <entry>Root</entry>
-<entry><xref linkend="mthRoot"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="selecttrc"/></entry>
 <entry>select</entry>
-<entry><xref linkend="selecttrc"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="selectedtrc"/></entry>
 <entry>selected</entry>
-<entry><xref linkend="selectedtrc"/></entry>
 </row>
 <row>
 <entry><xref linkend="mthSetImageListClsTreeView"/></entry>
@@ -288,20 +292,24 @@
 <entry>Sets the height of the tree-view items.</entry>
 </row>
 <row>
+<entry><xref linkend="mthSetToolTipsClsTreeView"/></entry>
+<entry>Sets the child <link linkend="clsToolTip">ToolTip</link> control used by this tree-view.</entry>
+</row>
+<row>
+<entry><xref linkend="sortchildren"/></entry>
 <entry>SortChildren</entry>
-<entry><xref linkend="sortchildren"/></entry>
 </row>
 <row>
 <entry><xref linkend="mthSortChildrenCB"/></entry>
 <entry>Has the tree-view sort the children of the specified item by invoking a custom comparsion method in the Rexx dialog.</entry>
 </row>
 <row>
+<entry><xref linkend="toggle"/></entry>
 <entry>Toggle</entry>
-<entry><xref linkend="toggle"/></entry>
-</row>
-<row>
+</row>
+<row>
+<entry><xref linkend="visibleitems"/></entry>
 <entry>VisibleItems</entry>
-<entry><xref linkend="visibleitems"/></entry>
 </row>
 </tbody></tgroup>
 </table>
@@ -1344,17 +1352,44 @@
 </section>  <!-- End TreeView::getItemRect() -->
 
 
-<section id="hittest"><title>HitTest</title>
-<indexterm><primary>HitTest</primary></indexterm>
+<section id="mthGetToolTipsClsTreeView" xreflabel="getToolTips"><title>getToolTips</title>
+<indexterm><primary>getToolTips</primary><secondary>TreeView class</secondary></indexterm>
+<indexterm><primary>TreeView class</primary><secondary>getToolTips</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--getToolTips----------------------------------><
+]]>
+</programlisting>
+
+<para>
+  Retrieves the child <link linkend="clsToolTip">ToolTip</link> control used by this tree-view.
+</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 Rexx <link linkend="clsToolTip">ToolTip</link> object that represents the ToolTip control of the tree-view,
+    or the <computeroutput>.nil</computeroutput> object if the tree-view does not currently have a ToolTip.
+  </para>
+  </listitem></varlistentry>
+</variablelist>
+</section>  <!-- End TreeView::getToolTips() -->
+
+<section id="mthHitTestClsTreeView"><title>hitTest</title>
+<indexterm><primary>hitTest</primary></indexterm>
 <programlisting>
 <![CDATA[
 >>--hitTest(--x--,--y--)-------------------------><
-
-
-]]>
-</programlisting>
-
-<para>The HitTest method determines the location of the
+]]>
+</programlisting>
+
+<para>The hitTest method determines the location of the
 specified point relative to the <xref linkend="defClientArea"/> of a tree-view control.</para>
 <variablelist>
 <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
@@ -2403,45 +2438,6 @@
 </variablelist>
 </section>
 
-<section id="parent"><title>Parent</title>
-<indexterm><primary>Parent</primary></indexterm>
-<programlisting>
-<![CDATA[
->>--parent(--hItem--)----------------------------><
-
-
-]]>
-</programlisting>
-
-<para>The Parent method retrieves the parent of the specified
-item.</para>
-<variablelist>
-<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
-<listitem><para>The only argument is:
-<variablelist>
-<varlistentry><term>hItem</term>
-<listitem><para>The handle to the item for which the parent is to be retrieved.
-</para></listitem></varlistentry>
-</variablelist>
-</para></listitem></varlistentry>
-<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
-<listitem><para>The handle to the parent item, or -1 if
-<emphasis role="italic">hItem</emphasis> is not
-specified or is 0, or 0 in all other cases.
-</para></listitem></varlistentry>
-<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
-<listitem><para>The following example displays the name of the selected item's parent:
-<programlisting>
-<![CDATA[
-::method Parent
-  curTree = self~newTreeView("IDC_TREE")
-  itemInfo. = curTree~itemInfo(curTree~Parent(curTree~selected))
-  say ItemInfo.!Text
-]]>
-</programlisting>
-</para></listitem></varlistentry>
-</variablelist>
-</section>
 
 <section id="nexttrc"><title>next</title>
 <indexterm><primary>next</primary>
@@ -2513,6 +2509,47 @@
 <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
 <listitem><para>The handle to the next visible item, or -1 if you omitted
 <emphasis role="italic">hItem</emphasis>, or 0 in all other cases.
+</para></listitem></varlistentry>
+</variablelist>
+</section>
+
+
+<section id="parent"><title>Parent</title>
+<indexterm><primary>Parent</primary></indexterm>
+<programlisting>
+<![CDATA[
+>>--parent(--hItem--)----------------------------><
+
+
+]]>
+</programlisting>
+
+<para>The Parent method retrieves the parent of the specified
+item.</para>
+<variablelist>
+<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+<listitem><para>The only argument is:
+<variablelist>
+<varlistentry><term>hItem</term>
+<listitem><para>The handle to the item for which the parent is to be retrieved.
+</para></listitem></varlistentry>
+</variablelist>
+</para></listitem></varlistentry>
+<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+<listitem><para>The handle to the parent item, or -1 if
+<emphasis role="italic">hItem</emphasis> is not
+specified or is 0, or 0 in all other cases.
+</para></listitem></varlistentry>
+<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+<listitem><para>The following example displays the name of the selected item's parent:
+<programlisting>
+<![CDATA[
+::method Parent
+  curTree = self~newTreeView("IDC_TREE")
+  itemInfo. = curTree~itemInfo(curTree~Parent(curTree~selected))
+  say ItemInfo.!Text
+]]>
+</programlisting>
 </para></listitem></varlistentry>
 </variablelist>
 </section>
@@ -2979,6 +3016,50 @@
   </listitem></varlistentry>
 </variablelist>
 </section>  <!-- End TreeView::setItemHeight() -->
+
+<section id="mthSetToolTipsClsTreeView" xreflabel="setToolTips"><title>setToolTips</title>
+<indexterm><primary>setToolTips</primary><secondary>TreeView class</secondary></indexterm>
+<indexterm><primary>TreeView class</primary><secondary>setToolTips</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--setToolTips(--toolTip--)---------------------><
+]]>
+</programlisting>
+
+<para>
+  Sets the child <link linkend="clsToolTip">ToolTip</link> control used by this tree-view.
+</para>
+<variablelist>
+  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+  <listitem>
+  <para>
+    The arguments are:
+  </para>
+    <variablelist>
+      <varlistentry><term>toolTip [required]</term>
+      <listitem>
+      <para>
+        The Rexx <computeroutput>ToolTip</computeroutput> object that represents the tool tip control the tree-view should
+        use.
+      </para>
+      </listitem></varlistentry>
+    </variablelist>
+  </listitem></varlistentry>
+  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+  <listitem>
+  <para>
+    Returns the previous tool tip, as a Rexx <computeroutput>ToolTip</computeroutput> object, or the
+    <computeroutput>.nil</computeroutput> object if there is no previous tool tip.
+  </para>
+  </listitem></varlistentry>
+  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+  <listitem>
+  <para>
+    Raises syntax errors when incorrect usage is detected.
+  </para>
+  </listitem></varlistentry>
+</variablelist>
+</section>  <!-- End TreeView::setToolTips() -->
 
 
 <section id="sortchildren"><title>SortChildren</title>