Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx-code-0:[8608] docs/trunk/oodialog/en-US
|
From: <mie...@us...> - 2012-11-21 01:33:14
|
Revision: 8608
http://sourceforge.net/p/oorexx/code-0/8608
Author: miesfeld
Date: 2012-11-21 01:33:11 +0000 (Wed, 21 Nov 2012)
Log Message:
-----------
ooDialog doc, fix tags
Modified Paths:
--------------
docs/trunk/oodialog/en-US/dialogExtensions.xml
docs/trunk/oodialog/en-US/dialogObject.xml
docs/trunk/oodialog/en-US/monthcalendar.xml
docs/trunk/oodialog/en-US/propertySheetDialogs.xml
docs/trunk/oodialog/en-US/tooltip.xml
docs/trunk/oodialog/en-US/utilityclasses.xml
docs/trunk/oodialog/en-US/windowBase.xml
docs/trunk/oodialog/en-US/windowBaseDCO.xml
docs/trunk/oodialog/en-US/windowBaseDO.xml
Modified: docs/trunk/oodialog/en-US/dialogExtensions.xml
===================================================================
--- docs/trunk/oodialog/en-US/dialogExtensions.xml 2012-11-21 01:14:33 UTC (rev 8607)
+++ docs/trunk/oodialog/en-US/dialogExtensions.xml 2012-11-21 01:33:11 UTC (rev 8608)
@@ -2515,7 +2515,7 @@
<listitem><para>Shows the dialog
</para></listitem></varlistentry>
<varlistentry><term>NOREDRAW</term>
-<listitem><para>Moves the dialog control without updating the display. Use the <xref linkend="mthUpdate"/>
+<listitem><para>Moves the dialog control without updating the display. Use the <xref linkend="mthUpdateClsWindowBase"/>
method to manually update the display.
</para></listitem></varlistentry>
</variablelist>
@@ -3192,7 +3192,7 @@
<listitem><para>Shows the control.
</para></listitem></varlistentry>
<varlistentry><term>NOREDRAW</term>
-<listitem><para>Resizes the control without updating the display. Use the <xref linkend="mthUpdate"/> method
+<listitem><para>Resizes the control without updating the display. Use the <xref linkend="mthUpdateClsWindowBase"/> method
to manually update the display.
</para></listitem></varlistentry>
</variablelist>
Modified: docs/trunk/oodialog/en-US/dialogObject.xml
===================================================================
--- docs/trunk/oodialog/en-US/dialogObject.xml 2012-11-21 01:14:33 UTC (rev 8607)
+++ docs/trunk/oodialog/en-US/dialogObject.xml 2012-11-21 01:33:11 UTC (rev 8608)
@@ -5118,7 +5118,7 @@
<listitem><para>Shows the dialog
</para></listitem></varlistentry>
<varlistentry><term>NOREDRAW</term>
-<listitem><para>Center the dialog without updating the display. Use the <xref linkend="mthUpdate"/> method
+<listitem><para>Center the dialog without updating the display. Use the <xref linkend="mthUpdateClsWindowBase"/> method
to manually update the display.
</para></listitem></varlistentry>
</variablelist>
@@ -5812,7 +5812,7 @@
<para>The hideWindowFast method is similar to the <xref linkend="mthHideWindow"/> method, but it is faster because the window's
or item's area is not redrawn. The hideWindowFast method
is used when more than one state is modified. After the operations, you can
-manually redraw the dialog window, using the <xref linkend="mthUpdate"/> method. </para>
+manually redraw the dialog window, using the <xref linkend="mthUpdateClsWindowBase"/> method. </para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
Modified: docs/trunk/oodialog/en-US/monthcalendar.xml
===================================================================
--- docs/trunk/oodialog/en-US/monthcalendar.xml 2012-11-21 01:14:33 UTC (rev 8607)
+++ docs/trunk/oodialog/en-US/monthcalendar.xml 2012-11-21 01:33:11 UTC (rev 8608)
@@ -223,7 +223,7 @@
<entry>Retrieves the date information for the date specified as <emphasis role="italic">today</emphasis> for the month calendar control.</entry>
</row>
<row>
-<entry><xref linkend="mthHitTest"/></entry>
+<entry><xref linkend="mthHitTestClsMonthCalendar"/></entry>
<entry>Determines which portion of a month calendar control is at a given point on the screen.</entry>
</row>
<row>
@@ -1846,8 +1846,8 @@
</section> <!-- End MonthCalendar::getToday() -->
-<section id="mthHitTest" xreflabel="hitTest"><title>hitTest</title>
-<indexterm><primary>hitTest</primary></indexterm>
+<section id="mthHitTestClsMonthCalendar" xreflabel="hitTest"><title>hitTest</title>
+<indexterm><primary>hitTest</primary><secondary>MonthCalendary class</secondary></indexterm>
<indexterm><primary>MonthCalendar class</primary><secondary>hitTest</secondary></indexterm>
<programlisting>
<![CDATA[
Modified: docs/trunk/oodialog/en-US/propertySheetDialogs.xml
===================================================================
--- docs/trunk/oodialog/en-US/propertySheetDialogs.xml 2012-11-21 01:14:33 UTC (rev 8607)
+++ docs/trunk/oodialog/en-US/propertySheetDialogs.xml 2012-11-21 01:33:11 UTC (rev 8608)
@@ -1587,7 +1587,7 @@
<listitem>
<para>
This is not a <emphasis role="italic">dynamic</emphasis> attribute. I.e., if the underlying property sheet has its
- title bar caption changed, say through the <xref linkend="mthSetTitle"/> method, the value of the
+ title bar caption changed, say through the <xref linkend="mthSetTitleClsWindowBase"/> method, the value of the
<emphasis role="italic">caption</emphasis> attribute will not change. Likewise, if the programmer were to change the
value of this attribute after the underlying dialog was created, it would not change the title bar of the dialog. At
the time the underlying dialog is created, this attribute is used to set the dialog's title bar. Other than that,
Modified: docs/trunk/oodialog/en-US/tooltip.xml
===================================================================
--- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 01:14:33 UTC (rev 8607)
+++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 01:33:11 UTC (rev 8608)
@@ -257,7 +257,7 @@
<entry>x</entry>
</row>
<row>
-<entry><xref linkend="mthCurrentToolInfo"/></entry>
+<entry><xref linkend="mthGetCurrentToolInfo"/></entry>
<entry>x</entry>
</row>
<row>
@@ -273,7 +273,7 @@
<entry>x</entry>
</row>
<row>
-<entry><xref linkend="mthGetText"/></entry>
+<entry><xref linkend="mthGetTextClsToolTip"/></entry>
<entry>x</entry>
</row>
<row>
@@ -301,7 +301,7 @@
<entry>x</entry>
</row>
<row>
-<entry><xref linkend="mthHitTest"/></entry>
+<entry><xref linkend="mthHitTestClsToolTip"/></entry>
<entry>x</entry>
</row>
<row>
@@ -333,7 +333,7 @@
<entry>x</entry>
</row>
<row>
-<entry><xref linkend="mthTipBkColor"/></entry>
+<entry><xref linkend="mthSetTipBkColor"/></entry>
<entry>x</entry>
</row>
<row>
@@ -341,7 +341,7 @@
<entry>x</entry>
</row>
<row>
-<entry><xref linkend="mthSetTitle"/></entry>
+<entry><xref linkend="mthSetTitleClsToolTip"/></entry>
<entry>x</entry>
</row>
<row>
@@ -361,7 +361,7 @@
<entry>x</entry>
</row>
<row>
-<entry><xref linkend="mthUpdate"/></entry>
+<entry><xref linkend="mthUpdateClsToolTip"/></entry>
<entry>x</entry>
</row>
<row>
@@ -1173,8 +1173,8 @@
</section> <!-- End ToolTip::getMaxTipWidth() -->
-<section id="mthGetText" xreflabel="getText"><title>getText</title>
-<indexterm><primary>getText</primary></indexterm>
+<section id="mthGetTextClsToolTip" xreflabel="getText"><title>getText</title>
+<indexterm><primary>getText</primary><secondary>ToolTip class</secondary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>getText</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -1621,8 +1621,8 @@
</section> <!-- End ToolTip::hasCurrentTool() -->
-<section id="mthHitTest" xreflabel="hitTest"><title>hitTest</title>
-<indexterm><primary>hitTest</primary></indexterm>
+<section id="mthHitTestClsToolTip" xreflabel="hitTest"><title>hitTest</title>
+<indexterm><primary>hitTest</primary><secondary>ToolTip class</secondary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>hitTest</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -2261,8 +2261,8 @@
</section> <!-- End ToolTip::setTipTextColor() -->
-<section id="mthSetTitle" xreflabel="setTitle"><title>setTitle</title>
-<indexterm><primary>setTitle</primary></indexterm>
+<section id="mthSetTitleClsToolTip" xreflabel="setTitle"><title>setTitle</title>
+<indexterm><primary>setTitle</primary><secondary>ToolTip class</secondary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>setTitle</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -2581,8 +2581,8 @@
</section> <!-- End ToolTip::trackPosition() -->
-<section id="mthUpdate" xreflabel="update"><title>update</title>
-<indexterm><primary>update</primary></indexterm>
+<section id="mthUpdateClsToolTip" xreflabel="update"><title>update</title>
+<indexterm><primary>update</primary><secondary>ToolTip class</secondary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>update</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -2709,7 +2709,7 @@
</section> <!-- End ToolTip::updateTipText() -->
-<section id="clsToolInf" xreflabel="ToolInf"><title>ToolInfo Class</title>
+<section id="clsToolInfo" xreflabel="ToolInf"><title>ToolInfo Class</title>
<indexterm><primary>ToolInfo class</primary></indexterm>
<para>
A <emphasis role="italic">ToolInfo</emphasis> object contains information about a tool in a <xref linkend="clsToolTip"/>
Modified: docs/trunk/oodialog/en-US/utilityclasses.xml
===================================================================
--- docs/trunk/oodialog/en-US/utilityclasses.xml 2012-11-21 01:14:33 UTC (rev 8607)
+++ docs/trunk/oodialog/en-US/utilityclasses.xml 2012-11-21 01:33:11 UTC (rev 8608)
@@ -10911,7 +10911,7 @@
<section id="wbwSetTitle" xreflabel="setTitle"><title>setTitle</title>
<programlisting>
-WindowBase::<xref linkend="mthSetTitle"/>
+WindowBase::<xref linkend="mthSetTitleClsWindowBase"/>
<![CDATA[
>>--setTitle(--newText--)------------------------><
@@ -10955,7 +10955,7 @@
<section id="wbwUpdate" xreflabel="update"><title>update</title>
<programlisting>
-WindowBase::<xref linkend="mthUpdate"/>
+WindowBase::<xref linkend="mthUpdateClsWindowBase"/>
<![CDATA[
]]>
Modified: docs/trunk/oodialog/en-US/windowBase.xml
===================================================================
--- docs/trunk/oodialog/en-US/windowBase.xml 2012-11-21 01:14:33 UTC (rev 8607)
+++ docs/trunk/oodialog/en-US/windowBase.xml 2012-11-21 01:33:11 UTC (rev 8608)
@@ -265,7 +265,7 @@
<entry>Sets the text, the caption, of the dialog.</entry>
</row>
<row>
-<entry><xref linkend="mthSetTitle"/></entry>
+<entry><xref linkend="mthSetTitleClsWindowBase"/></entry>
<entry>Sets the text of the dialog.</entry>
</row>
<row>
@@ -289,7 +289,7 @@
<entry>Sets the text of the dialog.</entry>
</row>
<row>
-<entry><xref linkend="mthUpdate"/></entry>
+<entry><xref linkend="mthUpdateClsWindowBase"/></entry>
<entry>Invalidates the entire client area of the dialog.</entry>
</row>
<row>
@@ -1294,7 +1294,7 @@
</programlisting>
This is usually done when there are a number of controls to make visible at one time. The programmer would make
- them all visible without redrawing. Then use the <xref linkend="mthUpdate"/> method to schedule
+ them all visible without redrawing. Then use the <xref linkend="mthUpdateClsWindowBase"/> method to schedule
repainting everything at once.
</para>
</listitem></varlistentry>
@@ -1961,8 +1961,8 @@
</section>
<section id="mthGetText" xreflabel="getText"><title>getText</title>
-<indexterm><primary>getText</primary></indexterm>
-<indexterm><primary>WindowBase</primary><secondary>getText</secondary></indexterm>
+<indexterm><primary>getText</primary><secondary>WindowBase class</secondary></indexterm>
+<indexterm><primary>WindowBase class</primary><secondary>getText</secondary></indexterm>
<indexterm><primary>dialog object</primary><secondary>getText</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>getText</secondary></indexterm>
<programlisting>
@@ -2311,8 +2311,8 @@
When a window is marked invisible, the operating system will not draw or redraw the window. It will only draw or
redraw the area the window covered. For example if the window is part of another window's client area, and the
client area is redrawn, then the window marked as invisible is not drawn. There are several methods that
- the programmer can use to cause a window to be redrawn, <xref linkend="mthUpdate"/>),
- <xref linkend="mthDraw"/>, etc..
+ the programmer can use to cause a window to be redrawn, <xref linkend="mthUpdateClsWindowBase"/>,
+ <xref linkend="mthDraw"/>, etc..
</para>
<para>
To restate this for clarity, when the window is marked invisible, having the window update or redraw itself will do
@@ -3916,8 +3916,8 @@
the user has entered, etc..
</para>
<para>
- The <emphasis role="italic">setText</emphasis>, <xref linkend="mthSetTitle"/>, and <xref linkend="mthTitleEquals"/>
- methods do exactly the same thing. The methods are interchangeable.
+ The <emphasis role="italic">setText</emphasis>, <xref linkend="mthSetTitleClsWindowBase"/>, and <xref
+ linkend="mthTitleEquals"/> methods do exactly the same thing. The methods are interchangeable.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
@@ -3936,9 +3936,9 @@
</variablelist>
</section> <!-- End WindowBase::setText() -->
-<section id="mthSetTitle" xreflabel="setTitle"><title>setTitle</title>
-<indexterm><primary>title=</primary></indexterm>
-<indexterm><primary>WindowBase</primary><secondary>setTitle</secondary></indexterm>
+<section id="mthSetTitleClsWindowBase" xreflabel="setTitle"><title>setTitle</title>
+<indexterm><primary>setTitle</primary><secondary>WindowBase class</secondary></indexterm>
+<indexterm><primary>WindowBase class</primary><secondary>setTitle</secondary></indexterm>
<indexterm><primary>dialog object</primary><secondary>setTitle</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>setTitle</secondary></indexterm>
<programlisting>
@@ -4364,7 +4364,7 @@
<para>
When a window is marked visible, the operating system does not redraw the window until necessary. For example if the
window is covered by another window and then uncovered. There are several methods that the programmer can use to
- cause a window to be redrawn, <xref linkend="mthUpdate"/>), <xref linkend="mthDraw"/>, etc..
+ cause a window to be redrawn, <xref linkend="mthUpdateClsWindowBase"/>), <xref linkend="mthDraw"/>, etc..
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
@@ -4694,9 +4694,9 @@
</para>
</section>
-<section id="mthUpdate" xreflabel="update"><title>update</title>
-<indexterm><primary>update</primary></indexterm>
-<indexterm><primary>WindowBase</primary><secondary>update</secondary></indexterm>
+<section id="mthUpdateClsWindowBase" xreflabel="update"><title>update</title>
+<indexterm><primary>update</primary><secondary>WindowBase class</secondary></indexterm>
+<indexterm><primary>WindowBase class</primary><secondary>update</secondary></indexterm>
<indexterm><primary>dialog object</primary><secondary>update</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>update</secondary></indexterm>
<programlisting>
Modified: docs/trunk/oodialog/en-US/windowBaseDCO.xml
===================================================================
--- docs/trunk/oodialog/en-US/windowBaseDCO.xml 2012-11-21 01:14:33 UTC (rev 8607)
+++ docs/trunk/oodialog/en-US/windowBaseDCO.xml 2012-11-21 01:33:11 UTC (rev 8608)
@@ -507,7 +507,7 @@
<section id="wbdcoSetTitle" xreflabel="setTitle"><title>setTitle</title>
<programlisting>
-WindowBase::<xref linkend="mthSetTitle"/>
+WindowBase::<xref linkend="mthSetTitleClsWindowBase"/>
<![CDATA[
>>--setTitle(--newText--)------------------------><
@@ -610,7 +610,7 @@
<section id="wbdcoUpdate" xreflabel="update"><title>update</title>
<programlisting>
-WindowBase::<xref linkend="mthUpdate"/>
+WindowBase::<xref linkend="mthUpdateClsWindowBase"/>
<![CDATA[
>>--update---------------------------------------><
Modified: docs/trunk/oodialog/en-US/windowBaseDO.xml
===================================================================
--- docs/trunk/oodialog/en-US/windowBaseDO.xml 2012-11-21 01:14:33 UTC (rev 8607)
+++ docs/trunk/oodialog/en-US/windowBaseDO.xml 2012-11-21 01:33:11 UTC (rev 8608)
@@ -508,7 +508,7 @@
<section id="wbdoSetTitle" xreflabel="setTitle"><title>setTitle</title>
<programlisting>
-WindowBase::<xref linkend="mthSetTitle"/>
+WindowBase::<xref linkend="mthSetTitleClsWindowBase"/>
<![CDATA[
>>--setTitle(--newText--)------------------------><
@@ -600,7 +600,7 @@
<section id="wbdoUpdate" xreflabel="update"><title>update</title>
<programlisting>
-WindowBase::<xref linkend="mthUpdate"/>
+WindowBase::<xref linkend="mthUpdateClsWindowBase"/>
<![CDATA[
>>--update---------------------------------------><
|