From: <mie...@us...> - 2011-11-06 03:52:03
|
Revision: 7275 http://oorexx.svn.sourceforge.net/oorexx/?rev=7275&view=rev Author: miesfeld Date: 2011-11-06 03:51:57 +0000 (Sun, 06 Nov 2011) Log Message: ----------- Continue ooDialog doc update Modified Paths: -------------- docs/trunk/oodialog/progressbar.xml docs/trunk/oodialog/scrollbar.xml docs/trunk/oodialog/tab.xml Modified: docs/trunk/oodialog/progressbar.xml =================================================================== --- docs/trunk/oodialog/progressbar.xml 2011-11-04 19:15:51 UTC (rev 7274) +++ docs/trunk/oodialog/progressbar.xml 2011-11-06 03:51:57 UTC (rev 7275) @@ -134,14 +134,14 @@ <entry>Sets the color of the progress indicator bar in the progress bar control.</entry> </row> <row> +<entry><link linkend="mthGetFullRangePBC">getFullRange</link></entry> +<entry>Retrives the current high and low limits of the range of the progress bar.</entry> +</row> +<row> <entry><link linkend="mthGetPosPBC">getPos</link></entry> <entry>Returns the current position of the progress bar.</entry> </row> <row> -<entry><link linkend="mthGetFullRangePBC">getFullRange</link></entry> -<entry>Retrives the current high and low limits of the range of the progress bar.</entry> -</row> -<row> <entry><link linkend="mthSetFullRangePBC">setFullRange</link></entry> <entry>Sets the minimum and maximum values for the progress bar using the full allowable range and returns the previous range.</entry> </row> Modified: docs/trunk/oodialog/scrollbar.xml =================================================================== --- docs/trunk/oodialog/scrollbar.xml 2011-11-04 19:15:51 UTC (rev 7274) +++ docs/trunk/oodialog/scrollbar.xml 2011-11-06 03:51:57 UTC (rev 7275) @@ -329,7 +329,8 @@ <table id="tblScrollBarConstants" frame="all"> <title>ScrollBar Event Constants</title> <tgroup cols="3"> -<colspec colwidth="1.75in"> +<colspec colwidth="1.25in"> +<colspec colwidth="1.25in"> <thead> <row> <entry>Constant</entry> Modified: docs/trunk/oodialog/tab.xml =================================================================== --- docs/trunk/oodialog/tab.xml 2011-11-04 19:15:51 UTC (rev 7274) +++ docs/trunk/oodialog/tab.xml 2011-11-06 03:51:57 UTC (rev 7275) @@ -504,6 +504,13 @@ <listitem><para>Y-coordinate of the lower right corner of the rectangle</para></listitem> </itemizedlist> </para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> +<listitem> +<para> + This method is outmoded and retained solely for backwards compatibility. All new code should use the <link + linkend="mthCalcWindowRect">calcWindowRect</link> method. +</para> +</listitem></varlistentry> </variablelist> </section> @@ -512,24 +519,28 @@ <indexterm><primary>Tab class</primary><secondary>calcDisplayArea</secondary></indexterm> <programlisting> <![CDATA[ ->>--calcDisplayArea(--+--------+--)--------------------------------------------->< - +--type--+ +>>--calcDisplayArea(--rect--)-------------------->< + ]]> </programlisting> <para> - xx + Given a <link linkend="clsRect">rect</link> object that specifies the window rectangle of a tab control, calculates + the display area of the the tab control. This method should be used when the size of the tab control is fixed and the + size of the contents of a page in the tab control can be adjusted. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx + The single argument is: <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>rect [required] [in/out]</term> <listitem> <para> - xx + A <link linkend="clsRect">Rect</link> object that specifies the window rect of the tab conrol when the method is + invoked. On return, the <computeroutput>rect</computeroutput> object will contain the co-ordinates of the display + area of the tab control. </para> </listitem></varlistentry> </variablelist> @@ -538,35 +549,28 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + Returns 0, always. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + Two strategies can be used for placing the content of a page of a tab control. The position and size of the content + can be adjusted to the position and size of the display area of the tab control, or the tab control's position and + size can be adjusted so the content fits into the display area. This method is used to facilitate the first + strategy. Give the size and position of the tab control, it returns the position and size for the page content. </para> + <para> + This method is only for tab controls that have their tabs on the top. It does not apply for tab controls that have + their tabs on the sides or bottom. + </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> <para> Raises syntax errors when incorrect arguments are 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 Tab::calcDisplayArea() --> @@ -575,8 +579,8 @@ <indexterm><primary>Tab class</primary><secondary>calcWindowRect</secondary></indexterm> <programlisting> <![CDATA[ ->>--calcWindowRect(--+--------+--)--------------------------------------------->< - +--type--+ +>>--calcWindowRect(--rect--)--------------------->< + ]]> </programlisting> @@ -587,12 +591,14 @@ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx + The single argument is: <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>rect [required] [in/out]</term> <listitem> <para> - xx + A <link linkend="clsRect">Rect</link> object that specifies the display area of the tab conrol when the method is + invoked. On return, the <computeroutput>rect</computeroutput> object will contain the co-ordinates of the window + rectangle of the tab control. </para> </listitem></varlistentry> </variablelist> @@ -601,35 +607,29 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + This method always returns 0. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + Two strategies can be used for placing the content of a page of a tab control. The position and size of the content + can be adjusted to the position and size of the display area of the tab control, or the tab control's position and + size can be adjusted so the content fits into the display area. This method is used to facilitate the second + strategy. Give the position and size of the page content, it returns the position and size that the tab control + needs to be. </para> + <para> + This method is only for tab controls that have their tabs on the top. It does not apply for tab controls that have + their tabs on the sides or bottom. + </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> <para> Raises syntax errors when incorrect arguments are 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 Tab::calcWindowRect() --> @@ -811,7 +811,7 @@ </programlisting> <para> - xx + Gets the bounding rectangle for a tab in a tab control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1188,6 +1188,13 @@ <listitem><para>Y-coordinate of the lower right corner of the rectangle</para></listitem> </itemizedlist> </para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> +<listitem> +<para> + This method is outmoded and retained solely for backwards compatibility. All new code should use the <link + linkend="mthCalcDisplayRect">calcDispalyRect</link> method. +</para> +</listitem></varlistentry> </variablelist> </section> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |