From: <mie...@us...> - 2010-10-11 01:36:28
|
Revision: 6269 http://oorexx.svn.sourceforge.net/oorexx/?rev=6269&view=rev Author: miesfeld Date: 2010-10-11 01:36:21 +0000 (Mon, 11 Oct 2010) Log Message: ----------- Small fix up for 4.1.0 docs Modified Paths: -------------- docs/branches/4.1.0/trunk/oodialog/Makefile docs/branches/4.1.0/trunk/shared/legalstuff.xml Modified: docs/branches/4.1.0/trunk/oodialog/Makefile =================================================================== --- docs/branches/4.1.0/trunk/oodialog/Makefile 2010-10-10 22:26:19 UTC (rev 6268) +++ docs/branches/4.1.0/trunk/oodialog/Makefile 2010-10-11 01:36:21 UTC (rev 6269) @@ -47,7 +47,7 @@ ../shared/oorexx.html.dsl -xml_FILES = baseClasses.xml \ +xml_FILES = advcntlc.xml \ basedialog.xml \ windowBaseCommon.xml \ windowExtensionsCommon.xml \ Modified: docs/branches/4.1.0/trunk/shared/legalstuff.xml =================================================================== --- docs/branches/4.1.0/trunk/shared/legalstuff.xml 2010-10-10 22:26:19 UTC (rev 6268) +++ docs/branches/4.1.0/trunk/shared/legalstuff.xml 2010-10-11 01:36:21 UTC (rev 6269) @@ -70,7 +70,7 @@ # The following need to be modified for each release! #######################################################################--> <edition>Version 4.1.0</edition> -<pubdate>June 2010</pubdate> +<pubdate>November 2010</pubdate> <!--####################################################################### # The releaseinfo tag is used to show the release status of a document. # This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <jfa...@us...> - 2010-10-24 21:34:58
|
Revision: 6320 http://oorexx.svn.sourceforge.net/oorexx/?rev=6320&view=rev Author: jfaucher Date: 2010-10-24 21:34:49 +0000 (Sun, 24 Oct 2010) Log Message: ----------- Retrofit from trunk : Fix bug 3028787 (shrinked HTML tables) oodialog : section 6.10.11 (createFontEx) section 6.10.11.1 (outputPrecision, clipPrecision, quality, pitchAndFamily but not weight and charset) section 14.2.3 section 14.3.2 rexxpg : section 3.9 section 9.1.1 section 9.2.1 section 9.2.2 section 9.13 section 9.14.1 etc... (plenty of tables for API) section 10.4.2.1.2 section 10.4.2.2.2 section 10.4.2.3.2 etc... (return codes) rexxref : section 3.5 section 5.1.3.3 section 5.1.3.4 section 5.1.3.5 section 5.1.3.6 section 1.11.2.1 section 1.11.2.2 section 1.11.2.3 section 1.11.2.4 section 1.11.3 section 5.4.1.18 section 5.4.3.12 section 5.4.5.2 section 5.4.15 section 5.4.21.3 table 8.1 (to check !) winextensions : table 4.2 table 4.3 Modified Paths: -------------- docs/branches/4.1.0/trunk/oodialog/buttoncontrols.xml docs/branches/4.1.0/trunk/oodialog/dialogcontrolc.xml docs/branches/4.1.0/trunk/rexxpg/api.xml docs/branches/4.1.0/trunk/rexxpg/classicapi.xml docs/branches/4.1.0/trunk/rexxpg/tour.xml docs/branches/4.1.0/trunk/rexxref/dire.xml docs/branches/4.1.0/trunk/rexxref/fundclasses.xml docs/branches/4.1.0/trunk/rexxref/intro.xml docs/branches/4.1.0/trunk/rexxref/rexutil.xml docs/branches/4.1.0/trunk/rexxref/utilityclasses.xml docs/branches/4.1.0/trunk/winextensions/wineventlog.xml Modified: docs/branches/4.1.0/trunk/oodialog/buttoncontrols.xml =================================================================== --- docs/branches/4.1.0/trunk/oodialog/buttoncontrols.xml 2010-10-24 20:55:07 UTC (rev 6319) +++ docs/branches/4.1.0/trunk/oodialog/buttoncontrols.xml 2010-10-24 21:34:49 UTC (rev 6320) @@ -2035,7 +2035,7 @@ <para> The return value is a keyword indicating the checked state of the radio button and will be exactly one of the following: - <informaltable frame='none' colsep='0' rowsep='0'> + <informaltable frame='none' colsep='0' rowsep='0' pgwide='1'> <tgroup cols='2'> <colspec align='left' colwidth='1*'> <colspec align='left' colwidth='4*'> @@ -2317,7 +2317,7 @@ <para> The return value is a keyword indicating the checked state of the check box and will exactly one of the following: - <informaltable frame='none' colsep='0' rowsep='0'> + <informaltable frame='none' colsep='0' rowsep='0' pgwide='1'> <tgroup cols='2'> <colspec align='left' colwidth='1*'> <colspec align='left' colwidth='3*'> Modified: docs/branches/4.1.0/trunk/oodialog/dialogcontrolc.xml =================================================================== --- docs/branches/4.1.0/trunk/oodialog/dialogcontrolc.xml 2010-10-24 20:55:07 UTC (rev 6319) +++ docs/branches/4.1.0/trunk/oodialog/dialogcontrolc.xml 2010-10-24 21:34:49 UTC (rev 6320) @@ -4159,7 +4159,7 @@ <computeroutput>CreateFont()</computeroutput> from <emphasis role="italic">nWidth</emphasis> to <emphasis role="italic">fdwPitchAndFamily</emphasis>. Where an index has a link, the link provides some more information on the possible values for index. The valid indexes are: - <informaltable frame='none' colsep='0' rowsep='0'> + <informaltable frame='none' colsep='0' rowsep='0' pgwide='1'> <tgroup cols='3'> <colspec align='left' colwidth='1*'> <colspec align='left' colwidth='1*'> @@ -4405,7 +4405,7 @@ </tbody></tgroup> </informaltable> </listitem></varlistentry> - <varlistentry id="cfxOutputPrecision"><term><emphasis role="bold">outputPrecsion</emphasis> Must be an integer.</term> + <varlistentry id="cfxOutputPrecision"><term><emphasis role="bold">outputPrecision</emphasis> Must be an integer.</term> <listitem> <para> The output precision defines how closely the output must match the requested font's height, width, @@ -4422,7 +4422,7 @@ <para> It can be one of the following values: </para> - <informaltable id="tblCfxOutputPrecision" frame="all"> + <informaltable id="tblCfxOutputPrecision" frame="all" pgwide="1"> <tgroup cols="3"> <colspec align='left' colwidth='3*'> <colspec align='left' colwidth='4*'> @@ -4497,7 +4497,7 @@ region. It can be one or more of the following values. Use <link linkend="mthOrClsDlgUtil">.DlgUtil~or</link> to combine values. </para> - <informaltable id="tblCfxClipPrecision" frame="all"> + <informaltable id="tblCfxClipPrecision" frame="all" pgwide="1"> <tgroup cols="3"> <colspec align='left' colwidth='2*'> <colspec align='left' colwidth='3*'> @@ -4570,7 +4570,7 @@ NONANTIALIASED_QUALITY is selected, the font is antialiased only if the user chooses "smooth screen fonts" in Control Panel. Quality can be one of the following values: </para> - <informaltable id="tblCfxQuality" frame="all"> + <informaltable id="tblCfxQuality" frame="all" pgwide="1"> <tgroup cols="3"> <colspec align='left' colwidth='3*'> <colspec align='left' colwidth='4*'> @@ -4640,7 +4640,7 @@ this case they could simply be added. The programmer can also use <link linkend="mthOrClsDlgUtil">.DlgUtil~or</link> to combine values. </para> - <informaltable id="tblCfxPitchAndFamily" frame="all"> + <informaltable id="tblCfxPitchAndFamily" frame="all" pgwide="1"> <tgroup cols="3"> <colspec align='left' colwidth='2*'> <colspec align='left' colwidth='4*'> Modified: docs/branches/4.1.0/trunk/rexxpg/api.xml =================================================================== --- docs/branches/4.1.0/trunk/rexxpg/api.xml 2010-10-24 20:55:07 UTC (rev 6319) +++ docs/branches/4.1.0/trunk/rexxpg/api.xml 2010-10-24 21:34:49 UTC (rev 6320) @@ -176,7 +176,7 @@ } </programlisting> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">instance</emphasis></entry> <entry><para>The returned RexxInstance interface vector. The interface vector provides access to APIs that apply to the global interpreter environment.</para></entry> @@ -414,7 +414,7 @@ The ooRexx APIs use a number of opaque types that represent instances of Rexx built-in objects. The defined object types are: </para> -<informaltable frame="none" colsep="0" rowsep="0"> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"> <tgroup cols="2"> <colspec colnum="1" colwidth="1*"> <colspec colnum="2" colwidth="3*"> @@ -485,7 +485,7 @@ <para>In addition to a full set of standard numeric types, there are two special types provided that implement the standard Rexx rules for numbers used internally by Rexx. These types are:</para> -<informaltable frame="none" colsep="0" rowsep="0"> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"> <tgroup cols="2"> <colspec colnum="1" colwidth="1*"> <colspec colnum="2" colwidth="4*"> @@ -516,7 +516,7 @@ <para>A subset of the integer numeric types are of differing sizes depending on the addressing mode of the system you are compiling on. These types will be either 32-bits or 64-bits. The variable size types are: </para> -<informaltable frame="none" colsep="0" rowsep="0"> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"> <tgroup cols="2"> <colspec colnum="1" colwidth="1*"> <colspec colnum="2" colwidth="4*"> @@ -538,7 +538,7 @@ </tgroup> </informaltable> <para>The remainder of the numeric types have fixed sizes regardless of the addressing mode.</para> -<informaltable frame="none" colsep="0" rowsep="0"> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"> <tgroup cols="2"> <colspec colnum="1" colwidth="1*"> <colspec colnum="2" colwidth="4*"> @@ -2823,7 +2823,7 @@ RexxStringObject address, RexxStringObject command) </programlisting> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">context</emphasis></entry> <entry><para>A <link linkend="exitcontext">RexxExitContext</link> interface vector for the handler call. The RexxExitContext provides access to runtime services appropriate to a command handler. For example, the @@ -2922,7 +2922,7 @@ It create a new one-dimension Array with the specified objects. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj1</emphasis></entry> <entry><para>The first object to be added.</para></entry> </row> @@ -2979,7 +2979,7 @@ <para>Append an Object to the end of an Array. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">arr</emphasis></entry> <entry><para>The target Array object.</para></entry> </row> @@ -3031,7 +3031,7 @@ a String object created from a pointer and length. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">arr</emphasis></entry> <entry><para>The target Array object.</para></entry> </row> @@ -3085,7 +3085,7 @@ <para>Retrieve an object from a specified Array index. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">arr</emphasis></entry> <entry><para>The source Array object.</para></entry> </row> @@ -3136,7 +3136,7 @@ <para>Returns number of dimensions of an Array. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">arr</emphasis></entry> <entry><para>The target Array object.</para></entry> </row> @@ -3183,7 +3183,7 @@ <para>Returns number of elements in an Array. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">arr</emphasis></entry> <entry><para>The source Array object.</para></entry> </row> @@ -3230,7 +3230,7 @@ <para>Create a new one-dimension Array with the specified objects. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj1</emphasis></entry> <entry><para>The first object to be added.</para></entry> </row> @@ -3286,7 +3286,7 @@ <para>Create a new one-dimension Array with the specified objects. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj1</emphasis></entry> <entry><para>The first object to be added.</para></entry> </row> @@ -3339,7 +3339,7 @@ <para>Create a new one-dimension Array with the specified objects.. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj1</emphasis></entry> <entry><para>The first object to be added.</para></entry> </row> @@ -3389,7 +3389,7 @@ <para>Create a new one-dimension Array with the specified object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be added.</para></entry> </row> @@ -3437,7 +3437,7 @@ <para>Replace/add an Object to an Array. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">arr</emphasis></entry> <entry><para>The target Array object.</para></entry> </row> @@ -3490,7 +3490,7 @@ <para>Returns the size of an Array. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">arr</emphasis></entry> <entry><para>The source Array object.</para></entry> </row> @@ -3531,7 +3531,7 @@ <emphasis role="italic">context</emphasis> pointer. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">tc</emphasis></entry> <entry><para>Pointer to a RexxThreadContext pointer used to return a RexxThreadContext for the attached thread.</para></entry> </row> @@ -3581,7 +3581,7 @@ <para>Returns a pointer to a Buffer object's data area. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The source Buffer object.</para></entry> </row> @@ -3628,7 +3628,7 @@ <para>Return the length of a Buffer object's data area. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The source Buffer object.</para></entry> </row> @@ -3675,7 +3675,7 @@ <para>Returns a pointer to a RexxBufferString object's data area. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The source object.</para></entry> </row> @@ -3726,7 +3726,7 @@ <para>Return the length of a RexxBufferStringObject instance. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The source RexxBufferStringObject.</para></entry> </row> @@ -3774,7 +3774,7 @@ <para>Returns the result object of the routine. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>The ASCII-Z path/name of the Rexx program to call.</para></entry> </row> @@ -3830,7 +3830,7 @@ <para>Returns the result object of the routine. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The routine object to call.</para></entry> </row> @@ -3975,7 +3975,7 @@ The second converts C ASCII-Z string into a String object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The source object for the conversion.</para></entry> </row> @@ -4026,7 +4026,7 @@ <para>Decodes the condition information into a RexxCondition structure. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">dir</emphasis></entry> <entry><para>The source Directory object containing the condition information.</para></entry> </row> @@ -4115,7 +4115,7 @@ <para>Return the object at the specified index. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">dirobj</emphasis></entry> <entry><para>The source Directory object.</para></entry> </row> @@ -4167,7 +4167,7 @@ <para>Replace/add an Object at the specified Directory index. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">dirobj</emphasis></entry> <entry><para>The source Directory object.</para></entry> </row> @@ -4221,7 +4221,7 @@ <para>Removes and returns the object at the specified Directory index. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">dirobj</emphasis></entry> <entry><para>The source Directory object.</para></entry> </row> @@ -4278,7 +4278,7 @@ The second form converts an Object to a C double value. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>For the first method form, the double value to be converted. For the second method form, the target of the conversion.</para></entry> @@ -4332,7 +4332,7 @@ <para>Converts C double value to an Object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>The double value to be converted.</para></entry> </row> @@ -4380,7 +4380,7 @@ <para>Converts C double value to an Object with a specific precision. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>The double value to be converted.</para></entry> </row> @@ -4425,7 +4425,7 @@ <para>Drops a Rexx variable in the current routine's caller variable context. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>The name of the Rexx variable.</para></entry> </row> @@ -4465,7 +4465,7 @@ <para>Drops an instance variable in the current method's scope. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">str</emphasis></entry> <entry><para>The name of the object variable.</para></entry> </row> @@ -4512,7 +4512,7 @@ <para>Drops an element of the Stem object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">sobj</emphasis></entry> <entry><para>The target Stem object.</para></entry> </row> @@ -4562,7 +4562,7 @@ <para>Drops an element of the Stem object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">sobj</emphasis></entry> <entry><para>The target Stem object.</para></entry> </row> @@ -4654,7 +4654,7 @@ <para>Locates a Class object in the current thread context. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>An ASCII-Z string containing the name of the class.</para></entry> </row> @@ -4695,7 +4695,7 @@ <para>Locate a Class object in the current Method or Routine Package context. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>The class name to be located.</para></entry> </row> @@ -4743,7 +4743,7 @@ <para>Locate a class object in a given Package object's context. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">pkg</emphasis></entry> <entry><para>The Package object used to resolve the class.</para></entry> </row> @@ -4795,7 +4795,7 @@ given length and returns a reference to the completed String object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The working RexxBufferStringObject.</para></entry> </row> @@ -4842,7 +4842,7 @@ equivalent to using a FORWARD CONTINUE instruction from Rexx code. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to receive the message. If NULL, the object that is the target of the current method call is used. @@ -4949,7 +4949,7 @@ Each assigned Stem tail element will be an entry in the Directory. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">sobj</emphasis></entry> <entry><para>The source Stem object.</para></entry> </row> @@ -5034,7 +5034,7 @@ is equivalent to calling Arg(n) from within Rexx code. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>The argument number (1-based).</para></entry> </row> @@ -5313,7 +5313,7 @@ Compound variable values can be retrieved from the corresponding Stem values. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>The name of the Rexx variable.</para></entry> </row> @@ -5517,7 +5517,7 @@ <para>Returns the Package object associated with the specified Method instance. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The source Method object..</para></entry> </row> @@ -5561,7 +5561,7 @@ Compound variable values can be retrieved from the corresponding Stem values. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">str</emphasis></entry> <entry><para>The name of the object variable.</para></entry> </row> @@ -5609,7 +5609,7 @@ <para>Returns a Directory object containing the Package public and private classes, indexed by class name. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The package object to query.</para></entry> </row> @@ -5658,7 +5658,7 @@ using the .methods environment symbol from Rexx code. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The package routine object to query.</para></entry> </row> @@ -5705,7 +5705,7 @@ <para>Returns a Directory object containing the Package public classes, indexed by class name. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The package object to query.</para></entry> </row> @@ -5752,7 +5752,7 @@ <para>Returns a Directory object containing the Package public routines, indexed by routine name. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The package object to query.</para></entry> </row> @@ -5799,7 +5799,7 @@ <para>Returns a Directory object containing the Package public and private routines, indexed by routine name. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The package routine object to query.</para></entry> </row> @@ -5918,7 +5918,7 @@ <para>Returns Routine object's associated Package object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The routine object to query.</para></entry> </row> @@ -6040,7 +6040,7 @@ <para>Retrieves an element of a Stem object using a numeric index. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">sobj</emphasis></entry> <entry><para>The source Stem object.</para></entry> </row> @@ -6092,7 +6092,7 @@ <para>Retrieves an element of a Stem object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">sobj</emphasis></entry> <entry><para>The source Stem object.</para></entry> </row> @@ -6147,7 +6147,7 @@ <para>Retrieves the base name value of a Stem object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">sobj</emphasis></entry> <entry><para>The source Stem object.</para></entry> </row> @@ -6302,7 +6302,7 @@ <para>Tests if an object supports the specified method name. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The target object.</para></entry> </row> @@ -6395,7 +6395,7 @@ The second form converts an Object to a C 32-bit integer, returning it in <emphasis role="italic">n</emphasis>. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>For the first form, the value to be converted. For the second form, the converted result.</para></entry> </row> @@ -6448,7 +6448,7 @@ <para>Convert a C 32-bit integer <emphasis role="italic">n</emphasis> to an Object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>The integer to be converted.</para></entry> </row> @@ -6500,7 +6500,7 @@ The second form converts an Object to a C 64-bit integer and returns in <emphasis role="italic">n</emphasis>. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>For the first form, the integer to be converted. For the second form, the converted integer.</para></entry> </row> @@ -6553,7 +6553,7 @@ <para>Convert the C 64-bit integer <emphasis role="italic">n</emphasis> to an Object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>The integer to be converted.</para></entry> </row> @@ -6657,7 +6657,7 @@ <emphasis role="italic">n</emphasis>. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>For the first form, the value to be converted. For the second form, the conversion result.</para></entry> @@ -6711,7 +6711,7 @@ <para>Convert the C signed integer <emphasis role="italic">n</emphasis> to an Object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>The signed integer to be converted.</para></entry> </row> @@ -6760,7 +6760,7 @@ the RexxObjectPtr value may be safely cast to a RexxArrayObject. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be tested.</para></entry> </row> @@ -6809,7 +6809,7 @@ the RexxObjectPtr value may be safely cast to a RexxBufferObject. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be tested.</para></entry> </row> @@ -6858,7 +6858,7 @@ the RexxObjectPtr value may be safely cast to a RexxDirectoryObject. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be tested.</para></entry> </row> @@ -6906,7 +6906,7 @@ <para>Tests if an Object is an instance of the specified class. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The Object to be tested.</para></entry> </row> @@ -6958,7 +6958,7 @@ the RexxObjectPtr value may be safely cast to a RexxMethodObject. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be tested.</para></entry> </row> @@ -7007,7 +7007,7 @@ This method combines the operations of the FindClass() and IsInstanceOf() methods in a single call. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be tested.</para></entry> </row> @@ -7061,7 +7061,7 @@ the RexxObjectPtr value may be safely cast to a RexxPointerObject. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be tested.</para></entry> </row> @@ -7110,7 +7110,7 @@ the RexxObjectPtr value may be safely cast to a RexxPointerObject. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be tested.</para></entry> </row> @@ -7159,7 +7159,7 @@ the RexxObjectPtr value may be safely cast to a RexxStemObject. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be tested.</para></entry> </row> @@ -7208,7 +7208,7 @@ the RexxObjectPtr value may be safely cast to a RexxStringObject. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be tested.</para></entry> </row> @@ -7307,7 +7307,7 @@ <para>Loads an external library with the given name and adds it to the global Rexx environment. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>The ASCII-Z path/name of the library package, in format required by the ::REQUIRES LIBRARY directive.</para></entry> @@ -7357,7 +7357,7 @@ <para>Returns the Package object loaded from the specified file path/name. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>The ASCII-Z path/name of the Rexx package source file.</para></entry> </row> @@ -7409,7 +7409,7 @@ <para>Returns the loaded package object from the specified file path/name. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>The ASCII-Z name assigned to the package.</para></entry> </row> @@ -7470,7 +7470,7 @@ The second form converts a C logical value to an Object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be converted.</para></entry> </row> @@ -7524,7 +7524,7 @@ <para>Converts a C logical value to an Object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">n</emphasis></entry> <entry><para>The logical_t value to be converted..</para></entry> </row> @@ -7571,7 +7571,7 @@ <para>Create an Array object of the specified size. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">d</emphasis></entry> <entry><para>The size of the Array.</para></entry> </row> @@ -7618,7 +7618,7 @@ <para>Create a Buffer object with a specific data size. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">len</emphasis></entry> <entry><para>The maximum length of the buffer.</para></entry> </row> @@ -7668,7 +7668,7 @@ transform this into a completed String object. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">len</emphasis></entry> <entry><para>The maximum length of the final String object.</para></entry> </row> @@ -7758,7 +7758,7 @@ <para>Create a new Method object from an in-memory buffer. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>ASCII-Z name of the method.</para></entry> </row> @@ -7815,7 +7815,7 @@ <para>Create a new Pointer object from a C pointer. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">p</emphasis></entry> <entry><para>The source C pointer.</para></entry> </row> @@ -7863,7 +7863,7 @@ <para>Create a new Routine object from an in-memory buffer. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">name</emphasis></entry> <entry><para>ASCII-Z name of the routine.</para></entry> </row> @@ -7920,7 +7920,7 @@ <para>Create an new Stem object with the specified base name. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">str</emphasis></entry> <entry><para>The base name for the new Stem object.</para></entry> </row> @@ -7970,7 +7970,7 @@ <para>There are two forms of this method. Both create a new String object from program data. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">str</emphasis></entry> <entry><para>For the first form, a pointer to a null-terminated ASCII-Z string. For the second form, a pointer to a data buffer containing the string data. @@ -8022,7 +8022,7 @@ <para>This method returns a Supplier object based on the supplied argument Arrays. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">arr1</emphasis></entry> <entry><para>The Array of supplier items.</para></entry> </row> @@ -8161,7 +8161,7 @@ Objects that rely on CSELF values typically set the variable CSELF inside an INIT method for the class. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The source object.</para></entry> </row> @@ -8209,7 +8209,7 @@ <para>Converts an Object to a C double value. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The source object for the conversion.</para></entry> </row> @@ -8262,7 +8262,7 @@ <para>Convert an Object into a 32-bit integer. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to convert.</para></entry> </row> @@ -8315,7 +8315,7 @@ <para>Convert an Object into a 64-bit integer. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to be converted.</para></entry> </row> @@ -8368,7 +8368,7 @@ <para>Convert an Object to an intptr_t value. </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> +<informaltable frame="none" colsep="0" rowsep="0" pgwide="1"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*"><tbody> <row><entry><emphasis role="italic">obj</emphasis></entry> <entry><para>The object to convert.</para></entry> </row> @@ -8420,7 +8420,7 @@ <para>Converts an Object to a C logical value (0 or 1). </para> <para><emphasis role="bold">Arguments</emphasis></para> -<informaltable frame="none" colsep="0" rowsep="0"><tgroup cols="2"><colspec colnum="1" colwidth="1*"><colspec colnum="2" colwidth="5*... [truncated message content] |
From: <wda...@us...> - 2010-11-05 13:41:05
|
Revision: 6361 http://oorexx.svn.sourceforge.net/oorexx/?rev=6361&view=rev Author: wdashley Date: 2010-11-05 13:40:57 +0000 (Fri, 05 Nov 2010) Log Message: ----------- Merge File class changes into the branch. Modified Paths: -------------- docs/branches/4.1.0/trunk/rexxref/utilityclasses.xml docs/branches/4.1.0/trunk/shared/legalstuff.xml Modified: docs/branches/4.1.0/trunk/rexxref/utilityclasses.xml =================================================================== --- docs/branches/4.1.0/trunk/rexxref/utilityclasses.xml 2010-11-04 20:59:24 UTC (rev 6360) +++ docs/branches/4.1.0/trunk/rexxref/utilityclasses.xml 2010-11-05 13:40:57 UTC (rev 6361) @@ -5856,5 +5856,838 @@ </section> </section> +<section id="clsFile"><title>The File Class</title> +<indexterm><primary>File class</primary></indexterm> +<indexterm><primary>class</primary> +<secondary>File class</secondary></indexterm> + +<para>The File class provides services which are common to all the filesystems supported by ooRexx. A File object represents a path to a file or directory. The path can be relative or absolute. +</para> +<para> +If you create a File object with a relative path, the absolute path will be calculated using the current default directory. +This absolute path is memorized on the File object, and will not change if you change of default directory. +</para> +<figure><title>The File class and methods</title> +<mediaobject> +<imageobject> +<!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> +<imagedata fileref="ooRexxFileClass"> +</imageobject> +</mediaobject> +</figure> +<note><title>Note</title> +<para>The File class also has available class methods that its +metaclass, the <link linkend="clsClass">Class class</link>, defines.</para></note> + +<section><title>Inherited Methods</title> + +&objclsmthods; + +<para>Methods inherited from the +<link linkend="clsComparable">Comparable class</link>.</para> +<itemizedlist> +<listitem><para><link linkend="mthComparableCompareTo">compareTo</link></para></listitem> +</itemizedlist> + +&orderclsmthods; </section> +<section id="clsmthFileIsCaseSensitive"><title>isCaseSensitive (Class Method)</title> +<indexterm><primary>isCaseSensitive method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>isCaseSensitive method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-isCaseSensitive--------------------------------------------->< +]]> +</programlisting> + +<para>Returns .true ("1") if the file system is case-sensitive. Otherwise returns .false ("0"). +</para> +<para>This query method is available as both instance and class method. +</para> +</section> + +<section id="clsmthFileListRoots"><title>listRoots (Class Method)</title> +<indexterm><primary>listRoots method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>listRoots method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-listRoots--------------------------------------------------->< +]]> +</programlisting> + +<para>Returns the file system root elements, as an array of string. +On Windows, each of the drives is a root element (Ex : "C:\"). +On Unix, there is just one root ("/"). +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +say .File~listRoots~toString +/* Possible output on Windows : /* +C:\ +D:\ +E:\ +R:\ +]]> +</programlisting> +</section> + +<section id="clsmthFilePathSeparator"><title>pathSeparator (Class Method)</title> +<indexterm><primary>pathSeparator method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>pathSeparator method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-pathSeparator----------------------------------------------->< +]]> +</programlisting> + +<para>Returns the separator used for file search paths (";" on Windows, ":" on Unix). +</para> +<para>This query method is available as both instance and class method. +</para> +</section> + +<section id="clsmthFileSeparator"><title>separator (Class Method)</title> +<indexterm><primary>separator method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>separator method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-separator--------------------------------------------------->< +]]> +</programlisting> + +<para>Returns the file name separator used by the file system ("\" on Windows, "/" on Unix). +</para> +<para>This query method is available as both instance and class method. +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +file = .File~new("dir1" || .File~separator || "dir2" || .File~separator || "file") +-- "dir1/dir2/file" on Unix, "dir1\dir2\file" on Windows +]]> +</programlisting> +</section> + +<section id="mthFileAbsoluteFile"><title>absoluteFile</title> +<indexterm><primary>absoluteFile method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>absoluteFile method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-absoluteFile------------------------------------------------>< +]]> +</programlisting> + +<para>Returns the fully qualified path as a new instance of File. +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +/* On Windows */ +'cd c:\program files\oorexx' +say .File~new("my file")~absoluteFile~class -- The File class +say .File~new("my file")~absoluteFile -- c:\program files\oorexx\my file +say .File~new("..\my file")~absoluteFile -- c:\program files\my file +say .File~new("..\..\my file")~absoluteFile -- c:\my file +say .File~new("..\..\my dir\my file")~absoluteFile -- c:\my dir\my file + +/* On Linux */ +'cd /opt/ooRexx' +say .File~new("my file")~absoluteFile -- /opt/ooRexx/my file +say .File~new("../my file")~absoluteFile -- /opt/my file +]]> +</programlisting> +</section> + +<section id="mthFileAbsolutePath"><title>absolutePath</title> +<indexterm><primary>absolutePath method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>absolutePath method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-absolutePath------------------------------------------------>< +]]> +</programlisting> + +<para>Returns the fully qualified path as a string. +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +/* On Windows */ +'cd c:\program files\oorexx' +say .File~new("my file")~absolutePath~class -- The String class +say .File~new("my file")~absolutePath -- c:\program files\oorexx\my file +say .File~new("..\my file")~absolutePath -- c:\program files\my file +say .File~new("..\..\my file")~absolutePath -- c:\my file +say .File~new("..\..\my dir\my file")~absolutePath -- c:\my dir\my file + +/* On Linux */ +'cd /opt/ooRexx' +say .File~new("my file")~absolutePath -- /opt/ooRexx/my file +say .File~new("../my file")~absolutePath -- /opt/my file +]]> +</programlisting> +</section> + +<section id="mthFileCanRead"><title>canRead</title> +<indexterm><primary>canRead method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>canRead method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-canRead----------------------------------------------------->< +]]> +</programlisting> + +<para>Returns .true ("1") if the file exists and is readable. Otherwise returns .false ("0"). +</para> +</section> + +<section id="mthFileCanWrite"><title>canWrite</title> +<indexterm><primary>canWrite method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>canWrite method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-canWrite---------------------------------------------------->< +]]> +</programlisting> + +<para>Returns .true ("1") if the file exists and is writable. Otherwise returns .false ("0"). +</para> +</section> + +<section id="mthFileCompareTo"><title>compareTo</title> +<indexterm><primary>compareTo method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>compareTo method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-compareTo(other)-------------------------------------------->< +]]> +</programlisting> + +<para>Performs a sorting comparison of the target File object to the <emphasis role="italic">other</emphasis> File object. +The comparison is made on the absolute paths (strings) of both File objects. +If the filesystem is case-sensitive then the paths comparison is case-sensitive, otherwise the comparison is caseless. +If the two paths are equal , 0 is returned. If the target path is larger, 1 is returned. -1 if the +<emphasis role="italic">other</emphasis> argument is the larger path. +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +file1 = .File~new("file", "dir") +file2 = .File~new("FILE", "DIR") +'cd' .File~listRoots[1] +file1~compareTo(file2) -- 0 on Windows (both Files denote the same path) +file1~compareTo(file2) -- 1 on Unix ("/dir/file" is greater than "/DIR/FILE") +]]> +</programlisting> +</section> + +<section id="mthFileDelete"><title>delete</title> +<indexterm><primary>delete method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>delete method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-delete------------------------------------------------------>< +]]> +</programlisting> + +<para>Deletes the file or directory denoted by the absolute path of the target File object. +Only empty directories can be deleted. +</para> +<para>Returns .true ("1") if the deletion was successful, otherwise returns .false ("0"). +</para> +</section> + +<section id="mthFileExists"><title>exists</title> +<indexterm><primary>exists method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>exists method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-exists------------------------------------------------------>< +]]> +</programlisting> + +<para>Returns .true ("1") if the file or directory (denoted by the absolute path of the target File object) exists. +Otherwise returns .false ("0"). +</para> +</section> + +<section id="mthFileHashCode"><title>hashCode</title> +<indexterm><primary>hashCode method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>hashCode method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-hashCode---------------------------------------------------->< +]]> +</programlisting> + +<para>Returns a string value that is used as a hash value for MapCollection such as Table, Relation, Set, Bag, +and Directory. +</para> +</section> + +<section id="mthFileInit"><title>init</title> +<indexterm><primary>init method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>init method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-init(path-+------+-)---------------------------------------->< + +-,dir-+ +]]> +</programlisting> + +<para>Initializes a new File instance with the path <emphasis role="italic">path</emphasis> +(after normalization). +</para> +<para>If specified, <emphasis role="italic">dir</emphasis> is a parent path that is prepended +to <emphasis role="italic">path</emphasis>. If <emphasis role="italic">dir</emphasis> is a File +object then the absolute path of <emphasis role="italic">dir</emphasis> is prepended, otherwise +<emphasis role="italic">dir</emphasis> is prepended as-is (after normalization). +The normalization consists in adjusting the separators to the platform's convention and removing +the final separator (if any). +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +/* Windows */ +file = .File~new("file") -- file +file = .File~new("c:\program files\") -- c:\program files +file = .File~new("file", "c:/program files") -- c:\program files\file +'cd c:\program files\oorexx' +samples = .File~new("samples") -- samples +file = .File~new("file", "samples") -- samples\file +file = .File~new("file", samples) -- c:\program files\oorexx\samples\file + +/* Unix */ +file = .File~new("/opt/ooRexx/") -- /opt/ooRexx +'cd /opt/ooRexx' +samples = .File~new("samples") -- samples +file = .File~new("file", "samples") -- samples/file +file = .File~new("file", samples) -- /opt/ooRexx/samples/file +]]> +</programlisting> +</section> + +<section id="mthFileIsCaseSensitive"><title>isCaseSensitive</title> +<indexterm><primary>isCaseSensitive method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>isCaseSensitive method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-isCaseSensitive--------------------------------------------->< +]]> +</programlisting> + +<para>Returns .true ("1") if the file system is case-sensitive. Otherwise returns .false ("0"). +</para> +<para>This query method is available as both instance and class method. +</para> +</section> + +<section id="mthFileIsDirectory"><title>isDirectory</title> +<indexterm><primary>isDirectory method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>isDirectory method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-isDirectory--------------------------------------------->< +]]> +</programlisting> + +<para>Returns .true ("1") if the absolute path of the target File object references a directory. +Otherwise returns .false ("0"). +</para> +</section> + +<section id="mthFileIsFile"><title>isFile</title> +<indexterm><primary>isFile method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>isFile method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-isFile------------------------------------------------------>< +]]> +</programlisting> + +<para>Returns .true ("1") if the absolute path of the target File object references a file. +Otherwise returns .false ("0"). +</para> +</section> + +<section id="mthFileIsHidden"><title>isHidden</title> +<indexterm><primary>isHidden method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>isHidden method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-isHidden---------------------------------------------------->< +]]> +</programlisting> + +<para>Returns .true ("1") if the absolute path of the target File object references an existing file or +directory which is hidden. Otherwise returns .false ("0"). +</para> +<para>On Windows, a file or directory is hidden when its attribute FILE_ATTRIBUTE_HIDDEN is set. +</para> +<para>On Unix, a file or directory is hidden when its name starts with a period character (".") or when one of its parent +directories has a name starting with a period character. +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +/* Unix, when file exists */ +say .File~new("/tmp/file")~isHidden -- 0 +say .File~new("/tmp/.file")~isHidden -- 1 +say .File~new("/tmp/.dir/file")~isHidden -- 1 +]]> +</programlisting> +</section> + +<section id="mthFileLastModified"><title>lastModified (Attribute)</title> +<indexterm><primary>lastModified attribute</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>lastModified method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-lastModified------------------------------------------------>< + +>>-lastModified=date------------------------------------------->< +]]> +</programlisting> + +<variablelist> + <varlistentry><term><emphasis role="bold">lastModified get:</emphasis></term> + <listitem> + <para>Returns the last modified date of the file/directory denoted by the absolute + path of the receiver object. The result is a DateTime object, or .nil in case of error. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">lastModified set:</emphasis></term> + <listitem> + <para>Sets the last modified date of the file/directory denoted by the absolute path of the receiver object. + </para> + <para>The <emphasis role="italic">date</emphasis> parameter is a DateTime object. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Examples:</emphasis></term> + <listitem> + <programlisting> + <![CDATA[ + /* On Windows */ + say .File~new("C:\Program Files")~lastModified~class -- The DateTime class + say .File~new("C:\Program Files")~lastModified -- 2010-11-01T19:14:49.000000 + say .File~new("dummy")~lastModified -- The NIL object + + /* A possible implementation of : touch -c -m -r referenceFile file + -c, --no-create do not create any files + -m change only the modification time + -r, --reference=FILE use this file's time instead of current time + */ + parse arg referenceFilePath filePath . + file = .File~new(filePath) + if \ file~exists then return 0 -- OK, not an error + referenceFile = .File~new(referenceFilePath) + referenceDate = referenceFile~lastModified + if referenceDate == .nil then return 1 -- KO + file~lastModified = referenceDate + return 0 -- OK + ]]> + </programlisting> + </listitem></varlistentry> +</variablelist> +</section> + +<section id="mthFileLength"><title>length</title> +<indexterm><primary>length method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>length method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-length------------------------------------------------------>< +]]> +</programlisting> + +<para>Returns the size in bytes of the file/directory denoted by the absolute +path of the receiver object. +</para> +</section> + +<section id="mthFileList"><title>list</title> +<indexterm><primary>list method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>list method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-list-------------------------------------------------------->< +]]> +</programlisting> + +<para>Returns an array of files/directories names which are immediate childrens of the directory +denoted by the absolute path of the receiver object. +The order in which the names are returned is dependent on the file system (not necessarily alphabetic order). +The special names "." and ".." are not returned. +</para> +<para>The result is an array of strings. +If the receiver object is not a directory then the result is .nil. +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +names = .File~new("c:\program files\oorexx\samples")~list +say names -- an Array +say names~toString +/* Possible output */ +api +ccreply.rex +complex.rex +drives.rex +factor.rex +(etc...) +]]> +</programlisting> +</section> + +<section id="mthFileListFiles"><title>listFiles</title> +<indexterm><primary>listFiles method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>listFiles method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-listFiles--------------------------------------------------->< +]]> +</programlisting> + +<para>Returns an array of files/directories which are immediate childrens of the directory +denoted by the absolute path of the receiver object. +The order in which the names are returned is dependent on the file system (not necessarily alphabetic order). +The special names "." and ".." are not returned. +</para> +<para>The result is an array of File objects. +If the receiver object is not a directory then the result is .nil. +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +do file over deepListFiles("c:\program files\oorexx\samples") + say file +end + +-- Depth first iteration +::routine deepListFiles +use strict arg directory, accumulator=(.List~new) +files = .File~new(directory)~listFiles +if files == .nil then return accumulator +do file over files + accumulator~append(file) + if file~isDirectory then call deepListFiles file~absolutePath, accumulator +end +return accumulator + +/* Possible output */ +c:\program files\oorexx\samples\api +c:\program files\oorexx\samples\api\callrxnt +c:\program files\oorexx\samples\api\callrxnt\backward.fnc +c:\program files\oorexx\samples\api\callrxnt\callrxnt.c +c:\program files\oorexx\samples\api\callrxnt\callrxnt.exe +c:\program files\oorexx\samples\api\callrxnt\callrxnt.ico +c:\program files\oorexx\samples\api\callrxnt\callrxnt.mak +c:\program files\oorexx\samples\api\callrxwn +c:\program files\oorexx\samples\api\callrxwn\backward.fnc +(etc...) +]]> +</programlisting> +</section> + +<section id="mthFileMakeDir"><title>makeDir</title> +<indexterm><primary>makeDir method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>makeDir method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-makeDir----------------------------------------------------->< +]]> +</programlisting> + +<para>Makes just the directory represented by the last <link linkend="mthFileName">name</link> +portion of the receiver object's absolute path. Does not create any parent directories, +which must all exist for a successful creation of the leaf directory. +</para> +<para>Returns .true ("1") if the creation was successful, otherwise returns .false ("0"). +If the directory already exists then the result is .false. +</para> +</section> + +<section id="mthFileMakeDirs"><title>makeDirs</title> +<indexterm><primary>makeDirs method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>makeDirs method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-makeDirs---------------------------------------------------->< +]]> +</programlisting> + +<para>Creates the entire directory hierarchy represented by the absolute path +of the receiver object. +</para> +<para>Returns .true ("1") if the creation was successful, otherwise returns .false ("0"). +If the directory already exists then the result is .false. +</para> +</section> + +<section id="mthFileName"><title>name</title> +<indexterm><primary>name method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>name method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-name-------------------------------------------------------->< +]]> +</programlisting> + +<para>Returns the name portion of the receiver object's absolute path. +This is everything after the last path separator. On Windows, the file's +extension is part of the name. +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +/* On Windows */ +say .File~new("c:\program files\oorexx\rexx.exe")~name -- rexx.exe +say .File~new("c:\")~name -- empty string +say .File~new("c:")~name -- empty string + +/* On Unix */ +say .File~new("/opt/ooRexx/bin/rexx.img")~name -- rexx.img +say .File~new("/")~name -- empty string +]]> +</programlisting> +</section> + +<section id="mthFileParent"><title>parent</title> +<indexterm><primary>parent method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>parent method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-parent------------------------------------------------------>< +]]> +</programlisting> + +<para>Returns the parent directory portion of the receiver object's absolute path. +If no separator is found or the absolute path ends with a separator +(which means this is a root path) then returns .nil. +</para> +<para><emphasis role="bold">Examples:</emphasis></para> +<programlisting> +<![CDATA[ +/* On Windows */ +say .File~new("c:\program files\oorexx\rexx.exe")~parent -- c:\program files\oorexx +say .File~new("c:\")~parent -- The NIL object +say .File~new("c:")~parent -- The NIL object + +/* On Unix */ +say .File~new("/opt/ooRexx/bin/rexx.img")~parent -- /opt/ooRexx/bin +say .File~new("/")~parent -- The NIL object +]]> +</programlisting> +</section> + +<section id="mthFileParentFile"><title>parentFile</title> +<indexterm><primary>parentFile method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>parentFile method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-parentFile-------------------------------------------------->< +]]> +</programlisting> + +<para>Returns the <link linkend="mthFileParent">parent</link> directory +portion as a File object. +If no separator is found or the absolute path ends with a separator +(which means this is a root path) then returns .nil. +</para> +</section> + +<section id="mthFilePath"><title>path</title> +<indexterm><primary>path method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>path method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-path-------------------------------------------------------->< +]]> +</programlisting> + +<para>Returns the original path (after normalization) used to create the File object. +The normalization consists in adjusting the separators to the platform's convention and removing +the final separator (if any). +</para> +</section> + +<section id="mthFilePathSeparator"><title>pathSeparator</title> +<indexterm><primary>pathSeparator method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>pathSeparator method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-pathSeparator----------------------------------------------->< +]]> +</programlisting> + +<para>Returns the separator used for file search paths (";" on Windows, ":" on Unix). +</para> +<para>This query method is available as both instance and class method. +</para> +</section> + +<section id="mthFileRenameTo"><title>renameTo</title> +<indexterm><primary>renameTo method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>renameTo method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-renameTo(dest)---------------------------------------------->< +]]> +</programlisting> + +<para>Changes the name of the file/directory denoted by the absolute path of the target object. +The new name is <emphasis role="italic">dest</emphasis>. +</para> +<para>Returns .true ("1") if the renaming was successful, otherwise returns .false ("0"). +</para> +<para>On Windows, this method calls <function>MoveFile</function> to perform the action. +</para> +<para>On Unix, this method calls <function>rename</function> to perform the action. +</para> +</section> + +<section id="mthFileSeparator"><title>separator</title> +<indexterm><primary>separator method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>separator method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-separator--------------------------------------------------->< +]]> +</programlisting> + +<para>Returns the file name separator used by the file system ("\" on Windows, "/" on Unix). +</para> +<para>This query method is available as both instance and class method. +</para> +</section> + +<section id="mthFileSetReadOnly"><title>setReadOnly</title> +<indexterm><primary>setReadOnly method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>setReadOnly method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-setReadOnly------------------------------------------------->< +]]> +</programlisting> + +<para>Sets the read-only flag of the file/directory denoted by the absolute path of the target object. +</para> +<para>Returns .true ("1") if the attribute was set, otherwise returns .false ("0"). +</para> +</section> + +<section id="mthFileString"><title>string</title> +<indexterm><primary>string method</primary> +<secondary>of File class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>string method</secondary> +<tertiary>of File class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-string------------------------------------------------------>< +]]> +</programlisting> + +<para>Returns a string that indicates the path used to create the File object. +</para> +</section> + +</section> + +</section> + Modified: docs/branches/4.1.0/trunk/shared/legalstuff.xml =================================================================== --- docs/branches/4.1.0/trunk/shared/legalstuff.xml 2010-11-04 20:59:24 UTC (rev 6360) +++ docs/branches/4.1.0/trunk/shared/legalstuff.xml 2010-11-05 13:40:57 UTC (rev 6361) @@ -86,7 +86,7 @@ # Draft - SVN Rev &svnrev; # #########################################################################--> -<releaseinfo>Draft - SVN Rev &svnrev;</releaseinfo> +<releaseinfo>Draft 2</releaseinfo> <!--####################################################################### # End of modification area. #######################################################################--> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |