From: <mie...@us...> - 2013-12-19 00:40:59
|
Revision: 9734 http://sourceforge.net/p/oorexx/code-0/9734 Author: miesfeld Date: 2013-12-19 00:40:53 +0000 (Thu, 19 Dec 2013) Log Message: ----------- [#553] Add the StatusBar control to ooDialog [#550] Add the ReBar dialog control to ooDialog [#552] Add the ToolBar control to ooDialog Modified Paths: -------------- docs/trunk/oodialog/en-US/dialogObject.xml docs/trunk/oodialog/en-US/eventNotification.xml docs/trunk/oodialog/en-US/oodialog.xml docs/trunk/oodialog/en-US/rebar.xml docs/trunk/oodialog/en-US/statusBar.xml docs/trunk/oodialog/en-US/userdialog.xml Modified: docs/trunk/oodialog/en-US/dialogObject.xml =================================================================== --- docs/trunk/oodialog/en-US/dialogObject.xml 2013-12-19 00:39:45 UTC (rev 9733) +++ docs/trunk/oodialog/en-US/dialogObject.xml 2013-12-19 00:40:53 UTC (rev 9734) @@ -1007,6 +1007,10 @@ <entry>Returns an object of the <computeroutput>RadioButton</computeroutput> class for the radio button control with the specified resource ID.</entry> </row> <row> +<entry><xref linkend="mthNewReBar"/></entry> +<entry>Returns an object of the <computeroutput>ReBar</computeroutput> class for the rebar control with the specified resource ID.</entry> +</row> +<row> <entry><xref linkend="mthNewScrollBar"/></entry> <entry>Returns an object of the <computeroutput>ScrollBar</computeroutput> class for the scroll bar control with the specified resource ID.</entry> </row> @@ -4122,6 +4126,65 @@ </section> +<section id="mthNewReBar" xreflabel="newReBar"><title>newReBar</title> +<indexterm><primary>newReBar</primary></indexterm> +<indexterm><primary>dialog object</primary><secondary>newReBar</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--newReBar(--id--)------------------------->< +]]> +</programlisting> + +<para> + The <emphasis role="italic">newReBar</emphasis> method returns an object of the <xref linkend="clsReBar"/> control + class. This object represents the rebar control in the underlying dialog with the specified resource ID. +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The single argument is: + <variablelist> + <varlistentry><term>id [required]</term> + <listitem> + <para> + The resource ID of the rebar dialog control. May be numeric or <xref linkend="defSymbolicId"/>. + </para> + </listitem></varlistentry> + </variablelist> + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + An object of the rebar control class or <emphasis role="italic">.nil</emphasis> on any error. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + The following example gets a new rebar control object that represents the rebar control in the underlying + dialog with the symbolic ID of IDC_RBAR. The application then begins populating the rebar with bands: + + <programlisting> + <![CDATA[ + rb = self~newReBar(IDC_RBAR) + + cb = self~newComboBox(IDC_CB) + r = cb~windowRect + + band = .ReBarBandInfo~new(cb, 'Combo Box', CHILDEDGE, 'Bogus', 50) + band~cxMinChild = 0 + band~cyMinChild = r~bottom - r~top + + ret = rb~insertBand(band) + ]]> + </programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> + <section id="mthNewScrollBar" xreflabel="newScrollBar"><title>newScrollBar</title> <indexterm><primary>newScrollBar</primary></indexterm> <indexterm><primary>dialog object</primary><secondary>newScrollBar</secondary></indexterm> Modified: docs/trunk/oodialog/en-US/eventNotification.xml =================================================================== --- docs/trunk/oodialog/en-US/eventNotification.xml 2013-12-19 00:39:45 UTC (rev 9733) +++ docs/trunk/oodialog/en-US/eventNotification.xml 2013-12-19 00:40:53 UTC (rev 9734) @@ -1872,8 +1872,8 @@ <listitem> <para> Sent by a date and time picker (DTP) control to request text to be displayed in a - <link linkend="sctDTPCallback">callback</link>/> field. The <emphasis role="italic">willReply</emphasis> argument - is ignored for this event, the event handler must <link linkend="sctCodingEventHandlers">return</link> a reply. + <link linkend="sctDTPCallback">callback</link> field. The <emphasis role="italic">willReply</emphasis> argument is + ignored for this event, the event handler must <link linkend="sctCodingEventHandlers">return</link> a reply. </para> </listitem></varlistentry> <varlistentry><term>FORMATQUERY</term> @@ -6529,6 +6529,149 @@ </variablelist> </section> +<section id="mthConnectReBarEvent" xreflabel="connectReBarEvent"><title>connectReBarEvent</title> +<indexterm><primary>connectReBarEvent</primary></indexterm> +<indexterm><primary>dialog object</primary><secondary>connectReBarEvent</secondary></indexterm> +<indexterm><primary>EventNotification class</primary><secondary>connectReBarEvent</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--connectReBarEvent(--id--,--event--+-----------+--+-------------+--)-------->< + +-,-mthName-+ +-,-willReply-+ +]]> +</programlisting> + +<para> + Connects an event notification message from a rebar control to a method in the Rexx dialog object. +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>id [required]</term> + <listitem> + <para> + The resource ID of the rebar control whose notification message is to be connected to a method in the Rexx dialog. + May be numeric or <xref linkend="defSymbolicId"/>. + </para> + </listitem></varlistentry> + <varlistentry><term>event [required]</term> + <listitem> + <para> + Exactly one of the following keywords. The keyword specifies the event to be connected. Case is not significant. + </para> + <para> + <simplelist type='vert' columns='3'> + <member>AUTOBREAK</member> + <member>?</member> + <member>?</member> + <member>?</member> + </simplelist> + </para> + <variablelist> + <varlistentry id="kywReBarAUTOBREAK" xreflabel="AUTOBREAK"><term>AUTOBREAK</term> + <listitem> + <para> + xxx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term>methodName [optional]</term> + <listitem> + <para> + The name of the method that is to be invoked whenever the specified event happens. The programmer defines this method. + If this argument is omitted, a method name is automatically generated that consists of the event keyword preceded by + <computeroutput>on</computeroutput>. For instance, <computeroutput>onAutoBreak</computeroutput>. The method name can + not be the empty string. The empty string is treated as an omitted argument. + </para> + </listitem></varlistentry> + <varlistentry><term>willReply [optional]</term> + <listitem> + <para> + The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreter <link + linkend="sctCodingEventHandlers">waits</link>, or does not wait, for the reply from the event handler. The value of + this argument can be <computeroutput>.true</computeroutput>, <computeroutput>.false</computeroutput>, or the keyword + <emphasis role="italic">sync</emphasis>, case insignificant. The default if the argument is omitted is + <computeroutput>.true</computeroutput> + </para> + <variablelist> + <varlistentry><term><emphasis role="bold">.true</emphasis></term> + <listitem> + <para> + The interpreter waits for the return from the event handler and the event handler <emphasis + role="italic">must</emphasis> return a value. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">.false</emphasis></term> + <listitem> + <para> + The interpreter does not wait for the return from the event handler. Because of this any return from the event + handler is discarded. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">sync</emphasis></term> + <listitem> + <para> + The interpreter waits until the event handler method returns, but ignores the return value. The event handler is not + required to return a value, but good practice would be to always return a value from an event handler. + </para> + </listitem></varlistentry> + </variablelist> + <para> + For those event notifications that the operating system expects a return value, the <emphasis + role="italic">willReply</emphasis> argument is ignored. For these events, the event handler must always return a value + of the correct type. I.e., if the operating system expects a reply of true or false, the event handler mus always + return true or false. The events in the following list fall into this category: + </para> + <para> + <simplelist type='vert' columns='3'> + <member>NCHITTEST </member> + <member>AUTOBREAK </member> + <member>BEGINDRAG </member> + <member>CHILDSIZE </member> + <member>GETOBJECT </member> + <member>MINMAX </member> + </simplelist> + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + Returns <computeroutput>.true</computeroutput> if the event was connected correctly, otherwise + <computeroutput>.false</computeroutput>. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link + linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> + <listitem> + <para> + Syntax errors are raised when incorrect usage is detected, including the use of an invalid symbolic ID or an + unrecognized event keyword. + </para> + <para> + If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if the + connected event happens. + </para> + <para> + The underlying dialog receives the RBN_* messages as the notifications for the rebar events. + </para> + </listitem></varlistentry> +</variablelist> + +</section> <!-- End EventNotification::connectReBarEvent() --> + + <section id="mthConnectResize" xreflabel="connectResize"><title>connectResize</title> <indexterm><primary>connectResize</primary></indexterm> <indexterm><primary>dialog object</primary><secondary>connectResize</secondary></indexterm> @@ -7483,6 +7626,183 @@ </variablelist> </section> + +<section id="mthConnectStatusBarEvent" xreflabel="connectStatusBarEvent"><title>connectStatusBarEvent</title> +<indexterm><primary>connectStatusBarEvent</primary></indexterm> +<indexterm><primary>dialog object</primary><secondary>connectStatusBarEvent</secondary></indexterm> +<indexterm><primary>EventNotification class</primary><secondary>connectStatusBarEvent</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--connectStatusBarEvent(--id--,--event--+-----------+--+-------------+--)---->< + +-,-mthName-+ +-,-willReply-+ +]]> +</programlisting> + +<para> + Connects an event notification message from a status bar control to a method in the Rexx dialog object. +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>id [required]</term> + <listitem> + <para> + The resource ID of the status bar control whose notification message is to be connected to a method in the Rexx dialog. + May be numeric or <xref linkend="defSymbolicId"/>. + </para> + </listitem></varlistentry> + <varlistentry><term>event [required]</term> + <listitem> + <para> + Exactly one of the following keywords. The keyword specifies the event to be connected. Case is not significant. + </para> + <para> + <simplelist type='vert' columns='3'> + <member>CLICK </member> + <member>DBLCLK </member> + <member>RCLICK </member> + <member>RDBLCLK </member> + <member>SIMPLEMODECHANGE</member> + </simplelist> + </para> + <variablelist> + <varlistentry id="kywStatusBarCLICK" xreflabel="CLICK"><term>CLICK</term> + <listitem> + <para> + Sent by a status bar control to notify the dialog that the user has clicked the left mouse button within the + control. The event handler returns true to indicate that the mouse click was handled and to suppress the default + processing by the operating system. Return false to allow default processing of the click. + </para> + </listitem></varlistentry> + <varlistentry id="kywStatusBarDBLCLK" xreflabel="DBLCLK"><term>DBLCLK</term> + <listitem> + <para> + Sent by a status bar control to notify the dialog that the user has double-clicked the left mouse button within the + control. The event handler returns true to indicate that the mouse click was handled and to suppress the default + processing by the operating system. Return false to allow default processing of the click. + </para> + </listitem></varlistentry> + <varlistentry id="kywStatusBarRCLICK" xreflabel="RCLICK"><term>RCLICK</term> + <listitem> + <para> + Sent by a status bar control to notify the dialog that the user has clicked the right mouse button within the + control. The event handler returns true to indicate that the mouse click was handled and to suppress the default + processing by the operating system. Return false to allow default processing of the click. + </para> + </listitem></varlistentry> + <varlistentry id="kywStatusBarRDBLCLK" xreflabel="RDBLCLK"><term>RDBLCLK</term> + <listitem> + <para> + Sent by a status bar control to notify the dialog that the user has double-clicked the right mouse button within the + control. The event handler returns true to indicate that the mouse click was handled and to suppress the default + processing by the operating system. Return false to allow default processing of the click. + </para> + </listitem></varlistentry> + <varlistentry id="kywStatusBarSIMPLEMODECHANGE" xreflabel="SIMPLEMODECHANGE"><term>SIMPLEMODECHANGE</term> + <listitem> + <para> + Sent by a status bar control when the simple mode changes due to the invocation of the <xref linkend="mthSimple"/> + method. The reply from the event handler is ignored by the operating system. + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term>methodName [optional]</term> + <listitem> + <para> + The name of the method that is to be invoked whenever the specified event happens. The programmer defines this method. + If this argument is omitted, a method name is automatically generated that consists of the event keyword preceded by + <computeroutput>on</computeroutput>. For instance, <computeroutput>onClick</computeroutput>. The method name can + not be the empty string. The empty string is treated as an omitted argument. + </para> + </listitem></varlistentry> + <varlistentry><term>willReply [optional]</term> + <listitem> + <para> + The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreter <link + linkend="sctCodingEventHandlers">waits</link>, or does not wait, for the reply from the event handler. The value of + this argument can be <computeroutput>.true</computeroutput>, <computeroutput>.false</computeroutput>, or the keyword + <emphasis role="italic">sync</emphasis>, case insignificant. The default if the argument is omitted is + <computeroutput>.true</computeroutput> + </para> + <variablelist> + <varlistentry><term><emphasis role="bold">.true</emphasis></term> + <listitem> + <para> + The interpreter waits for the return from the event handler and the event handler <emphasis + role="italic">must</emphasis> return a value. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">.false</emphasis></term> + <listitem> + <para> + The interpreter does not wait for the return from the event handler. Because of this any return from the event + handler is discarded. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">sync</emphasis></term> + <listitem> + <para> + The interpreter waits until the event handler method returns, but ignores the return value. The event handler is not + required to return a value, but good practice would be to always return a value from an event handler. + </para> + </listitem></varlistentry> + </variablelist> + <para> + For those event notifications that the operating system expects a return value, the <emphasis + role="italic">willReply</emphasis> argument is ignored. For these events, the event handler must always return a value + of the correct type. I.e., if the operating system expects a reply of true or false, the event handler mus always + return true or false. The events in the following list fall into this category: + </para> + <para> + <simplelist type='vert' columns='3'> + <member>CLICK </member> + <member>DBLCLK </member> + <member>RCLICK </member> + <member>RDBLCLK </member> + <member>SIMPLEMODECHANGE</member> + </simplelist> + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + Returns <computeroutput>.true</computeroutput> if the event was connected correctly, otherwise + <computeroutput>.false</computeroutput>. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link + linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> + <listitem> + <para> + Syntax errors are raised when incorrect usage is detected, including the use of an invalid symbolic ID or an + unrecognized event keyword. + </para> + <para> + If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if the + connected event happens. + </para> + <para> + The underlying dialog receives the SBN_* messages as the notifications for the status bar events. + </para> + </listitem></varlistentry> +</variablelist> + +</section> <!-- End EventNotification::connectStatusBarEvent() --> + + <section id="mthConnectTabEvent" xreflabel="connectTabEvent"><title>connectTabEvent</title> <indexterm><primary>connectTabEvent</primary></indexterm> <programlisting> @@ -7720,7 +8040,7 @@ </programlisting> <para> - xx + Connects an event notification message from a toolbar control to a method in the Rexx dialog object. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -7771,12 +8091,60 @@ <listitem> <para> The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreter <link - linkend="sctCodingEventHandlers">waits</link> for the reply from the event handler, for some of the toolbar events. - The default is ... + linkend="sctCodingEventHandlers">waits</link>, or does not wait, for the reply from the event handler. The value of + this argument can be <computeroutput>.true</computeroutput>, <computeroutput>.false</computeroutput>, or the keyword + <emphasis role="italic">sync</emphasis>, case insignificant. The default if the argument is omitted is + <computeroutput>.true</computeroutput> </para> + <variablelist> + <varlistentry><term><emphasis role="bold">.true</emphasis></term> + <listitem> + <para> + The interpreter waits for the return from the event handler and the event handler <emphasis + role="italic">must</emphasis> return a value. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">.false</emphasis></term> + <listitem> + <para> + The interpreter does not wait for the return from the event handler. Because of this any return from the event + handler is discarded. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">sync</emphasis></term> + <listitem> + <para> + The interpreter waits until the event handler method returns, but ignores the return value. The event handler is not + required to return a value, but good practice would be to always return a value from an event handler. + </para> + </listitem></varlistentry> + </variablelist> <para> - xxx + For those event notifications that the operating system expects a return value, the <emphasis + role="italic">willReply</emphasis> argument is ignored. For these events, the event handler must always return a value + of the correct type. I.e., if the operating system expects a reply of true or false, the event handler mus always + return true or false. The events in the following list fall into this category: </para> + <para> + <simplelist type='vert' columns='3'> + <member>CHAR </member> + <member>CLICK </member> + <member>KEYDOWN </member> + <member>RCLICK </member> + <member>RDBLCLK </member> + <member>DROPDOWN </member> + <member>GETBUTTONINFO </member> + <member>GETDISPINFO </member> + <member>GETINFOTIP </member> + <member>GETOBJECT </member> + <member>HOTITEMCHANGE </member> + <member>INITCUSTOMIZE </member> + <member>MAPACCELERATOR</member> + <member>QUERYDELETE </member> + <member>QUERYINSERT </member> + <member>RESTORE </member> + </simplelist> + </para> </listitem></varlistentry> </variablelist> </listitem></varlistentry> @@ -7805,20 +8173,9 @@ connected event happens. </para> <para> - The underlying dialog receives the TBN_* messages as the notifications for the tool tip events. + The underlying dialog receives the TBN_* messages as the notifications for the toolbar events. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End EventNotification::connectToolBarEvent() --> Modified: docs/trunk/oodialog/en-US/oodialog.xml =================================================================== --- docs/trunk/oodialog/en-US/oodialog.xml 2013-12-19 00:39:45 UTC (rev 9733) +++ docs/trunk/oodialog/en-US/oodialog.xml 2013-12-19 00:40:53 UTC (rev 9734) @@ -63,6 +63,7 @@ <xi:include href="listview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="monthcalendar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="progressbar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="rebar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="scrollbar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="static.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="statusBar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> Modified: docs/trunk/oodialog/en-US/rebar.xml =================================================================== --- docs/trunk/oodialog/en-US/rebar.xml 2013-12-19 00:39:45 UTC (rev 9733) +++ docs/trunk/oodialog/en-US/rebar.xml 2013-12-19 00:40:53 UTC (rev 9734) @@ -307,11 +307,2317 @@ </variablelist> </section> <!-- End ReBar::getBandBorders() --> + +<section id="mthGetBandCount" xreflabel="getBandCount"><title>getBandCount</title> +<indexterm><primary>getBandCount</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getBandCount</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getBandCount(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getBandCount() --> + + +<section id="mthGetBandInfo" xreflabel="getBandInfo"><title>getBandInfo</title> +<indexterm><primary>getBandInfo</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getBandInfo</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getBandInfo(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getBandInfo() --> + + +<section id="mthGetBandMargins" xreflabel="getBandMargins"><title>getBandMargins</title> +<indexterm><primary>getBandMargins</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getBandMargins</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getBandMargins(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getBandMargins() --> + + +<section id="mthGetBarHeight" xreflabel="getBarHeight"><title>getBarHeight</title> +<indexterm><primary>getBarHeight</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getBarHeight</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getBarHeight(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getBarHeight() --> + + +<section id="mthGetBarInfo" xreflabel="getBarInfo"><title>getBarInfo</title> +<indexterm><primary>getBarInfo</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getBarInfo</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getBarInfo(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getBarInfo() --> + + +<section id="mthGetBkColor" xreflabel="getBkColor"><title>getBkColor</title> +<indexterm><primary>getBkColor</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getBkColor</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getBkColor(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getBkColor() --> + + +<section id="mthGetColorScheme" xreflabel="getColorScheme"><title>getColorScheme</title> +<indexterm><primary>getColorScheme</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getColorScheme</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getColorScheme(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getColorScheme() --> + + +<section id="mthGetExtendedStyle" xreflabel="getExtendedStyle"><title>getExtendedStyle</title> +<indexterm><primary>getExtendedStyle</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getExtendedStyle</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getExtendedStyle(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getExtendedStyle() --> + + +<section id="mthGetImageList" xreflabel="getImageList"><title>getImageList</title> +<indexterm><primary>getImageList</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getImageList</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getImageList(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getImageList() --> + + +<section id="mthGetPalette" xreflabel="getPalette"><title>getPalette</title> +<indexterm><primary>getPalette</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getPalette</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getPalette(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getPalette() --> + + +<section id="mthGetRect" xreflabel="getRect"><title>getRect</title> +<indexterm><primary>getRect</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getRect</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getRect(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getRect() --> + + +<section id="mthGetRowCount" xreflabel="getRowCount"><title>getRowCount</title> +<indexterm><primary>getRowCount</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getRowCount</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getRowCount(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getRowCount() --> + + +<section id="mthGetRowHeight" xreflabel="getRowHeight"><title>getRowHeight</title> +<indexterm><primary>getRowHeight</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getRowHeight</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getRowHeight(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getRowHeight() --> + + +<section id="mthGetTextColor" xreflabel="getTextColor"><title>getTextColor</title> +<indexterm><primary>getTextColor</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getTextColor</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getTextColor(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getTextColor() --> + + +<section id="mthGetToolTips" xreflabel="getToolTips"><title>getToolTips</title> +<indexterm><primary>getToolTips</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>getToolTips</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getToolTips(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::getToolTips() --> + + +<section id="mthHitTestInfo" xreflabel="hitTestInfo"><title>hitTestInfo</title> +<indexterm><primary>hitTestInfo</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>hitTestInfo</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--hitTestInfo(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::hitTestInfo() --> + + +<section id="mthIdToIndex" xreflabel="idToIndex"><title>idToIndex</title> +<indexterm><primary>idToIndex</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>idToIndex</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--idToIndex(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::idToIndex() --> + + +<section id="mthInsertBand" xreflabel="insertBand"><title>insertBand</title> +<indexterm><primary>insertBand</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>insertBand</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--insertBand(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::insertBand() --> + + +<section id="mthMaximizeBand" xreflabel="maximizeBand"><title>maximizeBand</title> +<indexterm><primary>maximizeBand</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>maximizeBand</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--maximizeBand(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::maximizeBand() --> + + +<section id="mthMinimizeBand" xreflabel="minimizeBand"><title>minimizeBand</title> +<indexterm><primary>minimizeBand</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>minimizeBand</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--minimizeBand(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::minimizeBand() --> + + +<section id="mthMoveBand" xreflabel="moveBand"><title>moveBand</title> +<indexterm><primary>moveBand</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>moveBand</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--moveBand(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is 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 ReBar::moveBand() --> + + +<section id="mthPushChevron" xreflabel="pushChevron"><title>pushChevron</title> +<indexterm><primary>pushChevron</primary></indexterm> +<indexterm><primary>ReBar class</primary><secondary>pushChevron</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--pushChevron(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + <... [truncated message content] |