Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx:[3875] docs/trunk/oodialog
|
From: <mie...@us...> - 2009-01-05 23:21:25
|
Revision: 3875
http://oorexx.svn.sourceforge.net/oorexx/?rev=3875&view=rev
Author: miesfeld
Date: 2009-01-05 23:21:22 +0000 (Mon, 05 Jan 2009)
Log Message:
-----------
Incremental update to ooDialo doc
Modified Paths:
--------------
docs/trunk/oodialog/basedialog.sgml
docs/trunk/oodialog/dialogcontrolc.sgml
docs/trunk/oodialog/plainuserdialogc.sgml
docs/trunk/oodialog/staticcontrolc.sgml
docs/trunk/oodialog/windowBaseCommon.sgml
Modified: docs/trunk/oodialog/basedialog.sgml
===================================================================
--- docs/trunk/oodialog/basedialog.sgml 2009-01-05 19:15:04 UTC (rev 3874)
+++ docs/trunk/oodialog/basedialog.sgml 2009-01-05 23:21:22 UTC (rev 3875)
@@ -810,6 +810,10 @@
<entry><link linkend="h000721">IsDialogActive</link></entry>
</row>
<row>
+<entry>isEnabled</entry>
+<entry><link linkend="mthIsEnabled">isEnabled</link></entry>
+</row>
+<row>
<entry>IsMaximized</entry>
<entry><link linkend="mthIsMaximized">IsMaximized</link></entry>
</row>
@@ -818,8 +822,8 @@
<entry><link linkend="mthIsMinimized">IsMinimized</link></entry>
</row>
<row>
-<entry>IsDialogActive</entry>
-<entry><link linkend="h000721">IsDialogActive</link></entry>
+<entry>isVisible</entry>
+<entry><link linkend="mthIsVisible">isVisible</link></entry>
</row>
<row>
<entry>ItemTitle</entry>
@@ -1155,7 +1159,7 @@
</row>
<row>
<entry>Title=</entry>
-<entry><link linkend="titlenew">Title=</link></entry>
+<entry><link linkend="mthTitleEquals">Title=</link></entry>
</row>
<row>
<entry>TransparentText</entry>
Modified: docs/trunk/oodialog/dialogcontrolc.sgml
===================================================================
--- docs/trunk/oodialog/dialogcontrolc.sgml 2009-01-05 19:15:04 UTC (rev 3874)
+++ docs/trunk/oodialog/dialogcontrolc.sgml 2009-01-05 23:21:22 UTC (rev 3875)
@@ -333,10 +333,18 @@
<entry><link linkend="hscrollpos">HScrollPos</link></entry>
</row>
<row>
-<entry>IsMouseButtonDown</entry>
-<entry><link linkend="ismousebuttondown">IsMouseButtonDown</link></entry>
+<entry>isEnabled</entry>
+<entry><link linkend="mthIsEnabled">isEnabled</link></entry>
</row>
<row>
+<entry>isMouseButtonDown</entry>
+<entry><link linkend="ismousebuttondown">isMouseButtonDown</link></entry>
+</row>
+<row>
+<entry>isVisible</entry>
+<entry><link linkend="mthIsVisible">isVisible</link></entry>
+</row>
+<row>
<entry>LoadBitmap</entry>
<entry><link linkend="h000667">LoadBitmap</link></entry>
</row>
@@ -470,7 +478,7 @@
</row>
<row>
<entry>Title=</entry>
-<entry><link linkend="titlenew">Title=</link></entry>
+<entry><link linkend="mthTitleEquals">Title=</link></entry>
</row>
<row>
<entry>TransparentText</entry>
@@ -701,6 +709,41 @@
</variablelist>
</section>
+<section id="mthIsVisible"><title>isVisible</title>
+<indexterm><primary>isVisible</primary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isVisible--------------------------------------------------><
+]]>
+</programlisting>
+
+<para>
+ Tests if the window (dialog or dialog control) is visible.
+</para>
+<variablelist>
+<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+<listitem>
+<para>
+ There are no arguments.
+</para>
+</listitem></varlistentry>
+<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+<listitem>
+<para>
+ Returns .true if the window is visible, otherwise .false
+</para>
+</listitem></varlistentry>
+<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+<listitem><para>
+<programlisting>
+<![CDATA[
+if \ self~isVisible then self~show
+]]>
+</programlisting>
+</para></listitem></varlistentry>
+</variablelist>
+</section>
+
<section id="enable"><title>Enable</title>
<indexterm><primary>Enable</primary></indexterm>
<programlisting>
@@ -752,6 +795,46 @@
</variablelist>
</section>
+<section id="mthIsEnabled"><title>isEnabled</title>
+<indexterm><primary>isEnabled</primary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isEnabled--------------------------------------------------><
+]]>
+</programlisting>
+
+<para>
+ Tests if the window (dialog or dialog control) is enabled
+</para>
+<variablelist>
+<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+<listitem>
+<para>
+ There are no arguments.
+</para>
+</listitem></varlistentry>
+<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+<listitem>
+<para>
+ Returns .true if the window is enabled, otherwise .false
+</para>
+</listitem></varlistentry>
+<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+<listitem><para>
+<programlisting>
+<![CDATA[
+::method toggleState private
+listView = self~getListControl(IDC_LV_NAMES)
+if listView~isEnabled then
+ listView~disable
+else
+ listView~enable
+]]>
+</programlisting>
+</para></listitem></varlistentry>
+</variablelist>
+</section>
+
<section id="mthGroup"><title>Group</title>
<indexterm><primary>SetGroup</primary></indexterm>
<programlisting>
@@ -1554,7 +1637,7 @@
</variablelist>
</section>
-<section id="titlenew"><title>Title=</title>
+<section id="mthTitleEquals"><title>Title=</title>
<indexterm><primary>Title=</primary></indexterm>
<programlisting>
<![CDATA[
@@ -1611,7 +1694,7 @@
</programlisting>
<para>The SetTitle method sets the title of the dialog
-or dialog control. It is equal to <link linkend="titlenew">Title=</link>.</para>
+or dialog control. It is equal to <link linkend="mthTitleEquals">Title=</link>.</para>
</section>
</section>
Modified: docs/trunk/oodialog/plainuserdialogc.sgml
===================================================================
--- docs/trunk/oodialog/plainuserdialogc.sgml 2009-01-05 19:15:04 UTC (rev 3874)
+++ docs/trunk/oodialog/plainuserdialogc.sgml 2009-01-05 23:21:22 UTC (rev 3875)
@@ -753,7 +753,7 @@
</row>
<row>
<entry>Title=</entry>
-<entry><link linkend="titlenew">Title=</link></entry>
+<entry><link linkend="mthTitleEquals">Title=</link></entry>
</row>
<row>
<entry>Update</entry>
@@ -776,11 +776,15 @@
dialog and dialog control classes.
</para>
<para>
- The WindowBase instance methods are listed here as a cross reference. This allows the programmer to
- know exactly which methods are implemented by this class. The methods are fully documented in other
- sections of this book. Each method listed has a link to the full documentation for that method and an
- accurate syntax diagram.
+ The instance methods implemented by the WindowBase class are listed here as a cross reference. The
+ methods are fully documented in other sections of this book. Each method listed has a link to the full
+ documentation for that method and an accurate syntax diagram.
</para>
+<para>
+ Both the PlainBaseDialog and the DialogControl classes inherit the WindowBase class. Since the
+ PlainBaseDialog is the base class for all dialogs and the DialogControl class is the base class for all
+ controls, every dialog object and every dialog control object have the instance methods listed here.
+</para>
&windowBaseCommon;
@@ -794,11 +798,15 @@
It is inherited by both dialog and dialog control classes.
</para>
<para>
- The WindowExtensions instance methods are listed here as a cross reference. This allows the programmer
- to know exactly which methods are implemented by this class. The methods are fully documented in other
- sections of this book. Each method listed has a link to the full documentation for that method and an
- accurate syntax diagram.
+ The instance methods implemented by the WindowExtensions class are listed here as a cross reference.
+ The methods are fully documented in other sections of this book. Each method listed has a link to the
+ full documentation for that method and an accurate syntax diagram.
</para>
+<para>
+ Both the BaseDialog and the DialogControl classes inherit the WindowBase class. The DialogControl
+ class is the base class for all controls. Therefore, every dialog control object and every dialog
+ object that is a descendent class of the BaseDialog have the instance methods listed here.
+</para>
&windowExtensionsCommon;
Modified: docs/trunk/oodialog/staticcontrolc.sgml
===================================================================
--- docs/trunk/oodialog/staticcontrolc.sgml 2009-01-05 19:15:04 UTC (rev 3874)
+++ docs/trunk/oodialog/staticcontrolc.sgml 2009-01-05 23:21:22 UTC (rev 3875)
@@ -78,10 +78,10 @@
DialogControl class.)
</para>
<para>
- The <emphasis role="bold">WindowBase</emphasis>
+ The <link linkend="clsWindowBase">WindowBase</link>
</para>
<para>
- The <emphasis role="bold"> WindowExtensions</emphasis>
+ The <link linkend="clsWindowExtensions">WindowExtensions</link>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Instantiating:</emphasis></term>
@@ -131,19 +131,6 @@
</variablelist>
-<section><title>Inherited Methods - WindowBase</title>
-&windowBaseCommon;
-</section>
-
-<section><title>Inherited Methods - WindowExtensions</title>
-&windowExtensionsCommon;
-</section>
-
-<section><title>Inherited Methods - DialogControl</title>
-&dialogcontrolCommon;
-</section>
-
-
<section id="mthNewClsStaticControl"><title>new (Class method)</title>
<indexterm><primary>new</primary>
<secondary>StaticControl class</secondary></indexterm>
@@ -293,4 +280,18 @@
</variablelist>
</section> <!-- End StaticControl::setImage() -->
+
+<section><title>Inherited Methods - WindowBase</title>
+&windowBaseCommon;
+</section>
+
+<section><title>Inherited Methods - WindowExtensions</title>
+&windowExtensionsCommon;
+</section>
+
+<section><title>Inherited Methods - DialogControl</title>
+&dialogcontrolCommon;
+</section>
+
+
</chapter> <!-- End StaticControl class -->
Modified: docs/trunk/oodialog/windowBaseCommon.sgml
===================================================================
--- docs/trunk/oodialog/windowBaseCommon.sgml 2009-01-05 19:15:04 UTC (rev 3874)
+++ docs/trunk/oodialog/windowBaseCommon.sgml 2009-01-05 23:21:22 UTC (rev 3875)
@@ -60,15 +60,6 @@
<para><link linkend="enable">WindowBase::enable</link></para>
</section>
-<section><title>hide</title>
-<programlisting>
-<![CDATA[
->>--hide-------------------------------------------------------><
-]]>
-</programlisting>
-<para><link linkend="hide">WindowBase::hide</link></para>
-</section>
-
<section><title>getID</title>
<programlisting>
<![CDATA[
@@ -96,11 +87,107 @@
<para><link linkend="getsize">WindowBase::getSize</link></para>
</section>
+<section><title>getTextSize</title>
+<programlisting>
+<![CDATA[
+>>--gGetTextSize(--text--+---------------+---------------+-----------+---------><
+ +--,--fontname--+--,--fontsize--+--,--hwnd--+
+]]>
+</programlisting>
+<para><link linkend="gettextsize">WindowBase::getTextSize()</link></para>
+</section>
+
+<section><title>hide</title>
+<programlisting>
+<![CDATA[
+>>--hide-------------------------------------------------------><
+]]>
+</programlisting>
+<para><link linkend="hide">WindowBase::hide</link></para>
+</section>
+
+<section><title>isEnabled</title>
+<programlisting>
+<![CDATA[
+>>--isEnabled--------------------------------------------------><
+]]>
+</programlisting>
+<para><link linkend="mthIsEnabled">WindowBase::isEnabled</link></para>
+</section>
+
+<section><title>isVisible</title>
+<programlisting>
+<![CDATA[
+>>--isVisible------------------------------------------------------------------><
+]]>
+</programlisting>
+<para><link linkend="mthIsVisible">WindowBase::isVisible</link></para>
+</section>
+
+<section><title>move</title>
+<programlisting>
+<![CDATA[
+>>---move(--xPos--,--yPos--+----------------------+--)-------------------------><
+ +-,-"--showOptions--"--+
+]]>
+</programlisting>
+<para><link linkend="move">WindowBase::move()</link></para>
+</section>
+
+<section><title>resize</title>
+<programlisting>
+<![CDATA[
+>>---resize(--width--,--height--+----------------------+--)--------------------><
+ +-,-"--showOptions--"--+
+]]>
+</programlisting>
+<para><link linkend="resize">WindowBase::resize()</link></para>
+</section>
+
+<section<title>setTitle</title>
+<programlisting>
+<![CDATA[
+>>--setTitle(--new_title--)------------------------------------><
+]]>
+</programlisting>
+<para><link linkend="settitle">WindowBase::setTitle()</link></para>
+</section>
+
<section><title>show</title>
+<note><title>Note</title><para>
+ The PlainBaseDialog overrides the show() method to take an optional argument.
+</para></note>
<programlisting>
<![CDATA[
>>--show-------------------------------------------------------><
]]>
</programlisting>
-<para><link linkend="showdc">WindowBase::show</link></para>
+<para><link linkend="showdc">DialogControl::show</link></para>
+
+<programlisting>
+<![CDATA[
+>>-show(--"--+--------+--"--)---------------------------------><
+ +--mode--+
+]]>
+</programlisting>
+<para><link linkend="show">PlainBaseDialog::show</link></para>
</section>
+
+<section><title>title</title>
+<programlisting>
+<![CDATA[
+>>--title------------------------------------------------------><
+]]>
+</programlisting>
+<para><link linkend="title">WindowBase::title</link></para>
+</section>
+
+<section><title>title=</title>
+<programlisting>
+<![CDATA[
+>>--title=--newTitle-------------------------------------------><
+]]>
+</programlisting>
+<para><link linkend="mthTitleEquals">WindowBase::title=</link></para>
+</section>
+
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|