From: <mie...@us...> - 2012-11-20 23:58:56
|
Revision: 8604 http://sourceforge.net/p/oorexx/code-0/8604 Author: miesfeld Date: 2012-11-20 23:58:52 +0000 (Tue, 20 Nov 2012) Log Message: ----------- #419 Add Tooltip control See ticket [Feature-Requests:#419] Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-20 23:52:31 UTC (rev 8603) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-20 23:58:52 UTC (rev 8604) @@ -5,7 +5,7 @@ ]> <!--######################################################################### # - # Description: Open Object Rexx: ooDialog Reference SGML file. + # Description: Open Object Rexx: ooDialog Reference XML file. # # Copyright (c) 2012-2012, Rexx Language Association. All rights reserved. # @@ -40,18 +40,16 @@ # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # - # Author(s): - # W. David Ashley <da...@us...> - # ######################################################################### --> <chapter id="clsToolTip"><title>ToolTip Controls</title> <indexterm><primary>ToolTip class</primary></indexterm> <para> Tooltip controls are pop-up windows that display text. Typically the text describes a <emphasis - role="italic">tool</emphasis>. A <emphasis role="italic">tool</emphasis> is either a window or an application define area - within a window. Conceptually, a ToolTip is a dialog control that contains tools. A ToolTip with no added tool will never - display text. In ooDialog, the tools added to a ToolTip are usually other dialog controls. + role="italic">tool</emphasis>. A <emphasis role="italic">tool</emphasis> is either a window or an application defined area + within a window. Conceptually, a ToolTip is a dialog control that contains tools. Each ToolTip can contain any number of + <emphasis role="italic">tools</emphasis>. A ToolTip with no added tool will never display text. In ooDialog, the tools + added to a ToolTip are usually other dialog controls. </para> <para> ToolTips are hidden most of the time. They appear automatically, or pop up, when the user pauses the mouse pointer over a @@ -61,9 +59,9 @@ <para> ToolTip controls can display single or multiple lines of text. They can have square or rounded corners. They might or might not have a stem that points to the tools like a cartoon balloon. ToolTip text can be stationary or can move with the mouse - pointer, called tracking. Stationary text can be displayed adjacent to a tool or it can be displayed over a tool, which is - referred to as in-place. Standard ToolTips are stationary, display a single line of text, have square corners, and have no - stem pointing to the tool. + pointer, called tracking ToolTips. Stationary text can be displayed adjacent to a tool or it can be displayed over a tool, + which is referred to as in-place ToolTips. Standard ToolTips are stationary, display a single line of text, have square + corners, and have no stem pointing to the tool. </para> <para> The <computeroutput>ToolTip</computeroutput> class provides methods to work with and manipulate the underlying Windows @@ -71,9 +69,20 @@ linkend="chpDialogControlObject">object</link> and therefore has all methods of the of the dialog control object. </para> <para> - In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are - needed, or are useful, when working with ToolTip controls: + The following concepts, classes, and methods from other classes are needed, or are useful, when working with ToolTip + controls: +</para> <variablelist> + <varlistentry><term><emphasis role="bold">ToolInfo Class</emphasis></term> + <listitem> + <para> + The <link linkend="clsToolInfo">ToolInfo</link> class represents the information a ToolTip control uses to manage the + <emphasis role="italic">tools</emphasis> it contains. The attributes of a <computeroutput>ToolInfo</computeroutput> + object represent the information specific to a single tool within a ToolTip. Many of the methods of the + <computeroutput>ToolTip</computeroutput> class require a <computeroutput>ToolInfo</computeroutput> object as an argument, + or return information using a <computeroutput>ToolInfo</computeroutput> object. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term> <listitem> <para> @@ -97,8 +106,55 @@ the Rexx dialog object use the <link linkend="mthConnectToolTipEvent">connectToolTipEvent</link> method. </para> </listitem></varlistentry> -</variablelist> </para> +</variablelist> + +<section id="sctToolIdentification"><title>Tool Identification</title> +<indexterm><primary>ToolTip tool identification</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>tool identification</secondary></indexterm> + +<para> + Each ToolTip can contain more than one <emphasis role="italic">tool</emphasis>. Becuase of this, the ToolTip control + needs a way of uniquely identifying each individual tool. In the operating system, each tool is identified using a + combination of a window <link linkend="defHandle">handle</link> and an ID. The ID however, can be either another window + handle or a unique number. The number is similar to a resource ID. +</para> +<para> + The ooDialog framework allows the Rexx programmer to identify an unique tool in several different ways. This + documentation refers to a tool identifier as a <emphasis role="italic">Rexx object combination</emphasis>. This can be a + combination of two Rexx objects, however quite often only one object is needed to indentify a tool. + <computeroutput>ToolTip</computeroutput> methods that require a tool to be identifed, have as their first required + argument a <emphasis role="italic">toolHwnd</emphasis> and as a second optional argument a <emphasis + role="italic">toolId</emphasis>. +</para> +<para> + The combination of the two arguments, <emphasis role="italic">toolHwnd</emphasis> and <emphasis + role="italic">toolID</emphasis>, is always handled in the same way, which is as follows: +</para> + +<variablelist> + <varlistentry><term><emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is omitted</term> + <listitem> + <para> + It is very common that a ToolTip tool is a dialog control. For example quite often ToolTips are used for push buttons, + so that some label can be displayed when the user hovers the mouser over the button. ooDialog makes it easy for the + Rexx programmer to identify this type of tool by using just the dialog control object. When the <emphasis + role="italic">toolHwnd</emphasis> argument is not a <computeroutput>ToolInfo</computeroutput> object, and the <emphasis + role="italic">toolID</emphasis> is omitted, then the <emphasis role="italic">toolHwnd</emphasis> argument must be a + dialog control object. This dialog control object is the tool identifier. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is not omitted</term> + <listitem> + <para> + In this case, <emphasis role="italic">hwndTool</emphasis> can be either a dialog object, or a dialog control object. + When <emphasis role="italic">hwndTool</emphasis> is a dialog object, then <emphasis role="italic">toolID</emphasis> + must be either a dialog control object or an unique whole number. If <emphasis role="italic">hwndTool</emphasis> + </para> + </listitem></varlistentry> +</variablelist> +</section> + <section id="sctMethodsToolTip"><title>Method Table</title> <para> The following table provides links to the documentation for the primary methods and attributes used in working @@ -121,7 +177,7 @@ </row> <row> <entry><link linkend="tmthNewToolTip">newToolTip</link></entry> -<entry>Returns an <computeroutput>ToolTip</computeroutput> object for the control with the specified ID.</entry> +<entry>Returns a <computeroutput>ToolTip</computeroutput> object for the control with the specified ID.</entry> </row> <row> <entry><link linkend="tmthConnectToolTipEvent">connectToolTipEvent</link></entry> @@ -132,17 +188,29 @@ <entry align="center"><emphasis role="bold">Class Methods</emphasis></entry> </row> <row> -<entry>PROVIDE LINK</entry> -<entry>PROVIDE DESCRIPTION</entry> +<entry><xref linkend="mthActivate"/></entry> +<entry>x</entry> </row> <row> <entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry> <entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry> </row> <row> -<entry>PROVIDE LINK</entry> -<entry>xx</entry> +<entry><xref linkend="mthActivate"/></entry> +<entry>x</entry> </row> +<row> +<entry><xref linkend="mthAddTool"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthAddToolEx"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthAddToolRect"/></entry> +<entry>x</entry> +</row> </tbody></tgroup> </table> </section> @@ -244,4 +312,2908 @@ </section> <!-- End ToolTip::activate() --> +<section id="mthAddTool" xreflabel="addTool"><title>addTool</title> +<indexterm><primary>addTool</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>addTool</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--addTool(--+--------+--)--------------------------------------------->< + +--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 ToolTip::addTool() --> + + +<section id="mthAddToolEx" xreflabel="addToolEx"><title>addToolEx</title> +<indexterm><primary>addToolEx</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>addToolEx</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--addToolEx(--+--------+--)--------------------------------------------->< + +--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 ToolTip::addToolEx() --> + + +<section id="mthAddToolRect" xreflabel="addToolRect"><title>addToolRect</title> +<indexterm><primary>addToolRect</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>addToolRect</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--addToolRect(--+--------+--)--------------------------------------------->< + +--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 ToolTip::addToolRect() --> + + +<section id="mthAdjustRect" xreflabel="adjustRect"><title>adjustRect</title> +<indexterm><primary>adjustRect</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>adjustRect</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--adjustRect(--+--------+--)--------------------------------------------->< + +--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 ToolTip::adjustRect() --> + + +<section id="mthDelTool" xreflabel="delTool"><title>delTool</title> +<indexterm><primary>delTool</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>delTool</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--delTool(--+--------+--)--------------------------------------------->< + +--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 ToolTip::delTool() --> + + +<section id="mthEnumTools" xreflabel="enumTools"><title>enumTools</title> +<indexterm><primary>enumTools</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>enumTools</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--enumTools(--+--------+--)--------------------------------------------->< + +--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 ToolTip::enumTools() --> + + +<section id="mthGetBubbleSize" xreflabel="getBubbleSize"><title>getBubbleSize</title> +<indexterm><primary>getBubbleSize</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getBubbleSize</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getBubbleSize(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getBubbleSize() --> + + +<section id="mthGetCurrentToolInfo" xreflabel="getCurrentToolInfo"><title>getCurrentToolInfo</title> +<indexterm><primary>getCurrentToolInfo</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getCurrentToolInfo</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getCurrentToolInfo(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getCurrentToolInfo() --> + + +<section id="mthGetDelayTime" xreflabel="getDelayTime"><title>getDelayTime</title> +<indexterm><primary>getDelayTime</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getDelayTime</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getDelayTime(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getDelayTime() --> + + +<section id="mthGetMargin" xreflabel="getMargin"><title>getMargin</title> +<indexterm><primary>getMargin</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getMargin</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getMargin(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getMargin() --> + + +<section id="mthGetMaxTipWidth" xreflabel="getMaxTipWidth"><title>getMaxTipWidth</title> +<indexterm><primary>getMaxTipWidth</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getMaxTipWidth</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getMaxTipWidth(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getMaxTipWidth() --> + + +<section id="mthGetText" xreflabel="getText"><title>getText</title> +<indexterm><primary>getText</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getText</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getText(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getText() --> + + +<section id="mthGetTipBkColor" xreflabel="getTipBkColor"><title>getTipBkColor</title> +<indexterm><primary>getTipBkColor</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getTipBkColor</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getTipBkColor(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getTipBkColor() --> + + +<section id="mthGetTipTextColor" xreflabel="getTipTextColor"><title>getTipTextColor</title> +<indexterm><primary>getTipTextColor</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getTipTextColor</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getTipTextColor(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getTipTextColor() --> + + +<section id="mthGetTitle" xreflabel="getTitle"><title>getTitle</title> +<indexterm><primary>getTitle</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getTitle</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getTitle(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getTitle() --> + + +<section id="mthGetToolCount" xreflabel="getToolCount"><title>getToolCount</title> +<indexterm><primary>getToolCount</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getToolCount</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getToolCount(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getToolCount() --> + + +<section id="mthGetToolInfo" xreflabel="getToolInfo"><title>getToolInfo</title> +<indexterm><primary>getToolInfo</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>getToolInfo</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getToolInfo(--+--------+--)--------------------------------------------->< + +--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 ToolTip::getToolInfo() --> + + +<section id="mthHasCurrentTool" xreflabel="hasCurrentTool"><title>hasCurrentTool</title> +<indexterm><primary>hasCurrentTool</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>hasCurrentTool</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--hasCurrentTool(--+--------+--)--------------------------------------------->< + +--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 ToolTip::hasCurrentTool() --> + + +<section id="mthHitTest" xreflabel="hitTest"><title>hitTest</title> +<indexterm><primary>hitTest</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>hitTest</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--hitTest(--+--------+--)--------------------------------------------->< + +--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 ToolTip::hitTest() --> + + +<section id="mthManageAtypicalTool" xreflabel="manageAtypicalTool"><title>manageAtypicalTool</title> +<indexterm><primary>manageAtypicalTool</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>manageAtypicalTool</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--manageAtypicalTool(--+--------+--)--------------------------------------------->< + +--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 ToolTip::manageAtypicalTool() --> + + +<section id="mthNewToolRect" xreflabel="newToolRect"><title>newToolRect</title> +<indexterm><primary>newToolRect</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>newToolRect</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--newToolRect(--+--------+--)--------------------------------------------->< + +--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 ToolTip::newToolRect() --> + + +<section id="mthPop" xreflabel="pop"><title>pop</title> +<indexterm><primary>pop</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>pop</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--pop(--+--------+--)--------------------------------------------->< + +--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 ToolTip::pop() --> + + +<section id="mthPopUp" xreflabel="popUp"><title>popUp</title> +<indexterm><primary>popUp</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>popUp</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--popUp(--+--------+--)--------------------------------------------->< + +--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 ToolTip::popUp() --> + + +<section id="mthSetDelayTime" xreflabel="setDelayTime"><title>setDelayTime</title> +<indexterm><primary>setDelayTime</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>setDelayTime</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setDelayTime(--+--------+--)--------------------------------------------->< + +--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 ToolTip::setDelayTime() --> + + +<section id="mthSetMargin" xreflabel="setMargin"><title>setMargin</title> +<indexterm><primary>setMargin</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>setMargin</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setMargin(--+--------+--)--------------------------------------------->< + +--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 ToolTip::setMargin() --> + + +<section id="mthSetMaxTipWidth" xreflabel="setMaxTipWidth"><title>setMaxTipWidth</title> +<indexterm><primary>setMaxTipWidth</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>setMaxTipWidth</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setMaxTipWidth(--+--------+--)--------------------------------------------->< + +--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 ToolTip::setMaxTipWidth() --> + + +<section id="mthSetTipBkColor" xreflabel="setTipBkColor"><title>setTipBkColor</title> +<indexterm><primary>setTipBkColor</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>setTipBkColor</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setTipBkColor(--+--------+--)--------------------------------------------->< + +--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 ToolTip::setTipBkColor() --> + + +<section id="mthSetTipTextColor" xreflabel="setTipTextColor"><title>setTipTextColor</title> +<indexterm><primary>setTipTextColor</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>setTipTextColor</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setTipTextColor(--+--------+--)--------------------------------------------->< + +--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 ToolTip::setTipTextColor() --> + + +<section id="mthSetTitle" xreflabel="setTitle"><title>setTitle</title> +<indexterm><primary>setTitle</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>setTitle</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setTitle(--+--------+--)--------------------------------------------->< + +--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 ToolTip::setTitle() --> + + +<section id="mthSetToolInfo" xreflabel="setToolInfo"><title>setToolInfo</title> +<indexterm><primary>setToolInfo</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>setToolInfo</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setToolInfo(--+--------+--)--------------------------------------------->< + +--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 ToolTip::setToolInfo() --> + + +<section id="mthSetWindowTheme" xreflabel="setWindowTheme"><title>setWindowTheme</title> +<indexterm><primary>setWindowTheme</primary></indexterm> +<indexterm><primary>ToolTip class</primary><secondary>setWindowTheme</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setWindowTheme(--+--------+--)--------------------------------------------->< + +--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="dotSyste... [truncated message content] |
From: <mie...@us...> - 2012-11-21 01:08:32
|
Revision: 8606 http://sourceforge.net/p/oorexx/code-0/8606 Author: miesfeld Date: 2012-11-21 01:08:29 +0000 (Wed, 21 Nov 2012) Log Message: ----------- #419 Add Tooltip control See ticket [Feature-Requests:#419] Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 00:00:59 UTC (rev 8605) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 01:08:29 UTC (rev 8606) @@ -69,8 +69,7 @@ linkend="chpDialogControlObject">object</link> and therefore has all methods of the of the dialog control object. </para> <para> - The following concepts, classes, and methods from other classes are needed, or are useful, when working with ToolTip - controls: + The following classes, and methods from other classes, are needed, or are useful, when working with ToolTip controls: </para> <variablelist> <varlistentry><term><emphasis role="bold">ToolInfo Class</emphasis></term> @@ -117,22 +116,38 @@ Each ToolTip can contain more than one <emphasis role="italic">tool</emphasis>. Becuase of this, the ToolTip control needs a way of uniquely identifying each individual tool. In the operating system, each tool is identified using a combination of a window <link linkend="defHandle">handle</link> and an ID. The ID however, can be either another window - handle or a unique number. The number is similar to a resource ID. + handle or a unique number. When the ID is a number, the number is similar to a <xref linkend="defResourceId"/>. </para> <para> - The ooDialog framework allows the Rexx programmer to identify an unique tool in several different ways. This - documentation refers to a tool identifier as a <emphasis role="italic">Rexx object combination</emphasis>. This can be a - combination of two Rexx objects, however quite often only one object is needed to indentify a tool. - <computeroutput>ToolTip</computeroutput> methods that require a tool to be identifed, have as their first required - argument a <emphasis role="italic">toolHwnd</emphasis> and as a second optional argument a <emphasis - role="italic">toolId</emphasis>. + For the operating systm, the first part of the 2-part identifier is the handle of the window that the ToolTip will send + notifications to. The second part of the identifier can be a second window handle, if the ToolTip is going to subclass that + window, or an unique number if the ToolTip is not going to subclass the tool. This may seem somewhat complicated to the + Rexx programmer, especially if the programer has little experience with the underlying details of programming dialog + controls. </para> <para> - The combination of the two arguments, <emphasis role="italic">toolHwnd</emphasis> and <emphasis - role="italic">toolID</emphasis>, is always handled in the same way, which is as follows: + The ooDialog framework attempts to simplify this somewhat by allowing the Rexx programmer to identify an unique tool in + several different ways. For the most common use of ToolTips, identifying a tool is simple and can be done with one Rexx + object. However, ooDialog also supplies the necessary means to identify a tool for more advanced use of ToolTips. </para> +<para> + This documentation refers to a tool identifier as a <emphasis role="italic">Rexx object combination</emphasis>. This can be + a combination of two Rexx objects, but quite often only one object is needed to indentify a tool. + <computeroutput>ToolTip</computeroutput> methods that require a tool to be identifed, have as their first required argument + a <emphasis role="italic">toolHwnd</emphasis> argument and as a second optional argument a <emphasis + role="italic">toolId</emphasis> argument. The combination of the two arguments, <emphasis role="italic">toolHwnd</emphasis> + and <emphasis role="italic">toolID</emphasis>, is always handled in the same way, which is as follows: +</para> <variablelist> + <varlistentry><term><emphasis role="italic">hwndTool</emphasis> == a <computeroutput>ToolInfo</computeroutput> object</term> + <listitem> + <para> + A <computeroutput>ToolInfo</computeroutput> object always uniquely identifies a tool. When the <emphasis + role="italic">toolHwnd</emphasis> argument is a <computeroutput>ToolInfo</computeroutput> object that is sufficient and + the second <emphasis role="italic">toolID</emphasis> argument is ignored. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is omitted</term> <listitem> <para> @@ -141,20 +156,33 @@ Rexx programmer to identify this type of tool by using just the dialog control object. When the <emphasis role="italic">toolHwnd</emphasis> argument is not a <computeroutput>ToolInfo</computeroutput> object, and the <emphasis role="italic">toolID</emphasis> is omitted, then the <emphasis role="italic">toolHwnd</emphasis> argument must be a - dialog control object. This dialog control object is the tool identifier. + dialog control object. This dialog control object is the tool identifier. The ooDialog framework deduces the proper + values to identify the tool to the operating system. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is not omitted</term> <listitem> <para> - In this case, <emphasis role="italic">hwndTool</emphasis> can be either a dialog object, or a dialog control object. - When <emphasis role="italic">hwndTool</emphasis> is a dialog object, then <emphasis role="italic">toolID</emphasis> - must be either a dialog control object or an unique whole number. If <emphasis role="italic">hwndTool</emphasis> + This combination of identifying objects is needed when some more advanced uses of ToolTips are desired. It allows the + programmer to specify the exact values that should be passed on to the operarting system to identify the tool. For this + combination, <emphasis role="italic">hwndTool</emphasis> can be either a dialog object, or a dialog control object. When + <emphasis role="italic">hwndTool</emphasis> is a dialog object, then <emphasis role="italic">toolID</emphasis> must be + either a dialog control object or an unique whole number. The first part of the 2-part operating system ID for the tool + is set the the window handle of the Rexx object, the dialog window handle or the dialog control window handle. + <para> + The <emphasis role="italic">toolID</emphasis> argument can be either a dialog control, or an unique non-negative whole + number. If the <emphasis role="italic">toolHwnd</emphasis> argument is a dialog, then <emphasis + role="italic">toolID</emphasis> can be a dialog control or a number. However, if <emphasis + role="italic">toolHwnd</emphasis> is a dialog control, the <emphasis role="italic">toolID</emphasis> must be a number. + The second part of the 2-part operating system identifier is set to the window handle of the dialog control, if <emphasis + role="italic">toolID</emphasis> is a dialoog control. Otherwise the second part is set to the number specified. Note that + numbers can be specified using <link linkend="defSymbolicId">symbolic</link> IDs just as other types of resource IDs are. </para> </listitem></varlistentry> </variablelist> -</section> +</section> <!-- End Tool Identification Section --> + <section id="sctMethodsToolTip"><title>Method Table</title> <para> The following table provides links to the documentation for the primary methods and attributes used in working @@ -173,9 +201,17 @@ <tbody> <row> <entry align="center"><emphasis role="bold">Useful</emphasis></entry> -<entry align="center"><emphasis role="bold"> External Methods</emphasis></entry> +<entry align="center"><emphasis role="bold">Classes</emphasis></entry> </row> <row> +<entry><link linkend="clsToolInfo">ToolInf</link></entry> +<entry>A <computeroutput>ToolInfo</computeroutput> object is used to supply tool information to, or recieve tool information from, the ToolTip control.</entry> +</row> +<row> +<entry align="center"><emphasis role="bold">Useful</emphasis></entry> +<entry align="center"><emphasis role="bold">External Methods</emphasis></entry> +</row> +<row> <entry><link linkend="tmthNewToolTip">newToolTip</link></entry> <entry>Returns a <computeroutput>ToolTip</computeroutput> object for the control with the specified ID.</entry> </row> @@ -184,14 +220,6 @@ <entry>Connects tool tip event notifications to a method in the Rexx dialog object</entry> </row> <row> -<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry> -<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry> -</row> -<row> -<entry><xref linkend="mthActivate"/></entry> -<entry>x</entry> -</row> -<row> <entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry> <entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry> </row> @@ -211,6 +239,134 @@ <entry><xref linkend="mthAddToolRect"/></entry> <entry>x</entry> </row> +<row> +<entry><xref linkend="mthAdjustRect"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthDelTool"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthEnumTools"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthGetBubbleSize"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthCurrentToolInfo"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthGetDelayTime"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthGetMargin"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthGetMaxTipWidth"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthGetText"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthGetTipBkColor"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthGetTipTextColor"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthTitle"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthGetToolCount"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthGetToolInfo"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthHasCurrentTool"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthHitTest"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthMangeAtypicalTool"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthNewToolRect"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthPop"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthPopup"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthSetDelayTime"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthSetMargin"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthSetMaxTipWidth"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthTipBkColor"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthSetTipTextColor"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthSetTitle"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthSetToolInfo"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthSetWindowTheme"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthTrackActivate"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthTrackPosition"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthUpdate"/></entry> +<entry>x</entry> +</row> +<row> +<entry><xref linkend="mthUpdateTipText"/></entry> +<entry>x</entry> +</row> </tbody></tgroup> </table> </section> |
From: <mie...@us...> - 2012-11-21 01:14:36
|
Revision: 8607 http://sourceforge.net/p/oorexx/code-0/8607 Author: miesfeld Date: 2012-11-21 01:14:33 +0000 (Wed, 21 Nov 2012) Log Message: ----------- ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 01:08:29 UTC (rev 8606) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 01:14:33 UTC (rev 8607) @@ -169,6 +169,7 @@ <emphasis role="italic">hwndTool</emphasis> is a dialog object, then <emphasis role="italic">toolID</emphasis> must be either a dialog control object or an unique whole number. The first part of the 2-part operating system ID for the tool is set the the window handle of the Rexx object, the dialog window handle or the dialog control window handle. + </para> <para> The <emphasis role="italic">toolID</emphasis> argument can be either a dialog control, or an unique non-negative whole number. If the <emphasis role="italic">toolHwnd</emphasis> argument is a dialog, then <emphasis |
From: <mie...@us...> - 2012-11-21 01:42:13
|
Revision: 8609 http://sourceforge.net/p/oorexx/code-0/8609 Author: miesfeld Date: 2012-11-21 01:42:11 +0000 (Wed, 21 Nov 2012) Log Message: ----------- ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 01:33:11 UTC (rev 8608) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 01:42:11 UTC (rev 8609) @@ -305,7 +305,7 @@ <entry>x</entry> </row> <row> -<entry><xref linkend="mthMangeAtypicalTool"/></entry> +<entry><xref linkend="mthManageAtypicalTool"/></entry> <entry>x</entry> </row> <row> |
From: <mie...@us...> - 2012-11-21 04:06:48
|
Revision: 8610 http://sourceforge.net/p/oorexx/code-0/8610 Author: miesfeld Date: 2012-11-21 04:06:46 +0000 (Wed, 21 Nov 2012) Log Message: ----------- ooDialog doc - a few proof reading edits Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 01:42:11 UTC (rev 8609) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-21 04:06:46 UTC (rev 8610) @@ -66,7 +66,7 @@ <para> The <computeroutput>ToolTip</computeroutput> class provides methods to work with and manipulate the underlying Windows ToolTip dialog control which it represents. It is a concrete subclass of the dialog control <link - linkend="chpDialogControlObject">object</link> and therefore has all methods of the of the dialog control object. + linkend="chpDialogControlObject">object</link> and therefore has all methods of the dialog control object. </para> <para> The following classes, and methods from other classes, are needed, or are useful, when working with ToolTip controls: @@ -135,7 +135,7 @@ a combination of two Rexx objects, but quite often only one object is needed to indentify a tool. <computeroutput>ToolTip</computeroutput> methods that require a tool to be identifed, have as their first required argument a <emphasis role="italic">toolHwnd</emphasis> argument and as a second optional argument a <emphasis - role="italic">toolId</emphasis> argument. The combination of the two arguments, <emphasis role="italic">toolHwnd</emphasis> + role="italic">toolID</emphasis> argument. The combination of the two arguments, <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis>, is always handled in the same way, which is as follows: </para> @@ -143,7 +143,7 @@ <varlistentry><term><emphasis role="italic">hwndTool</emphasis> == a <computeroutput>ToolInfo</computeroutput> object</term> <listitem> <para> - A <computeroutput>ToolInfo</computeroutput> object always uniquely identifies a tool. When the <emphasis + A <xref linkend="clsToolInfo"/> object always uniquely identifies a tool. When the <emphasis role="italic">toolHwnd</emphasis> argument is a <computeroutput>ToolInfo</computeroutput> object that is sufficient and the second <emphasis role="italic">toolID</emphasis> argument is ignored. </para> @@ -168,7 +168,7 @@ combination, <emphasis role="italic">hwndTool</emphasis> can be either a dialog object, or a dialog control object. When <emphasis role="italic">hwndTool</emphasis> is a dialog object, then <emphasis role="italic">toolID</emphasis> must be either a dialog control object or an unique whole number. The first part of the 2-part operating system ID for the tool - is set the the window handle of the Rexx object, the dialog window handle or the dialog control window handle. + is set to the window handle of the Rexx object, the dialog window handle or the dialog control window handle. </para> <para> The <emphasis role="italic">toolID</emphasis> argument can be either a dialog control, or an unique non-negative whole @@ -205,7 +205,7 @@ <entry align="center"><emphasis role="bold">Classes</emphasis></entry> </row> <row> -<entry><link linkend="clsToolInfo">ToolInf</link></entry> +<entry><link linkend="clsToolInfo">ToolInfo</link></entry> <entry>A <computeroutput>ToolInfo</computeroutput> object is used to supply tool information to, or recieve tool information from, the ToolTip control.</entry> </row> <row> |
From: <mie...@us...> - 2012-11-23 04:07:53
|
Revision: 8621 http://sourceforge.net/p/oorexx/code-0/8621 Author: miesfeld Date: 2012-11-23 04:07:49 +0000 (Fri, 23 Nov 2012) Log Message: ----------- ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-23 04:01:36 UTC (rev 8620) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-23 04:07:49 UTC (rev 8621) @@ -817,7 +817,7 @@ it is present, the ooDialog framework removes it. </para> </listitem></varlistentry> - <varlistentry id="kywToolTipPARSELINKS" xreflabel="PARSELINKS"><term>PARSELINKS</term> + <varlistentry><term>PARSELINKS</term> <listitem> <para> Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later. |
From: <mie...@us...> - 2012-11-23 04:10:36
|
Revision: 8622 http://sourceforge.net/p/oorexx/code-0/8622 Author: miesfeld Date: 2012-11-23 04:10:34 +0000 (Fri, 23 Nov 2012) Log Message: ----------- ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-23 04:07:49 UTC (rev 8621) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-23 04:10:34 UTC (rev 8622) @@ -756,7 +756,7 @@ <listitem> <para> An unique, non-negative, whole number that identifies the tool being added. May be numeric or <xref - linkend="defSymbolic"/>. + linkend="defSymbolicId"/>. </para> </listitem></varlistentry> <varlistentry><term>rect [required]</term> |
From: <mie...@us...> - 2012-11-23 05:14:24
|
Revision: 8623 http://sourceforge.net/p/oorexx/code-0/8623 Author: miesfeld Date: 2012-11-23 05:14:22 +0000 (Fri, 23 Nov 2012) Log Message: ----------- #419 Add Tooltip control See ticket [Feature-Requests:#419] Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-23 04:10:34 UTC (rev 8622) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-23 05:14:22 UTC (rev 8623) @@ -246,11 +246,11 @@ </row> <row> <entry><xref linkend="mthAdjustRect"/></entry> -<entry>x</entry> +<entry>Calculates a ToolTip control's text display rectangle from its window rectangle, or the ToolTip window rectangle needed to display a specified text display rectangle.</entry> </row> <row> <entry><xref linkend="mthDelTool"/></entry> -<entry>x</entry> +<entry>Removes the specified tool from this ToolTip.</entry> </row> <row> <entry><xref linkend="mthEnumTools"/></entry> @@ -924,13 +924,14 @@ <indexterm><primary>ToolTip class</primary><secondary>adjustRect</secondary></indexterm> <programlisting> <![CDATA[ ->>--adjustRect(--+--------+--)--------------------------------------------->< - +--type--+ +>>--adjustRect(--rect--+-----------+--)---------->< + +-,-larger--+ ]]> </programlisting> <para> - xx + Calculates a ToolTip control's text display rectangle from its window rectangle, or the ToolTip window rectangle needed to + display a specified text display rectangle. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -939,44 +940,59 @@ The arguments are: </para> <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>rect [required]</term> <listitem> <para> - xx + A <xref linkend="clsRect"/> object used to specify the rectangle to adjust. On a successful return, the coordinates + in the rectangle will be adjusted as specified by the <emphasis role="italic">larger</emphasis> arguent. </para> </listitem></varlistentry> + <varlistentry><term>larger [optional]</term> + <listitem> + <para> + True or false to specify how the rectangle is adjusted. If omitted, the default is false. + </para> + <para> + If true, <emphasis role="italic">rect</emphasis> is used to specify a text-display rectangle and it is updated to + contain the corresponding window rectangle. On return the rectangle is <emphasis role="italic">larger</emphasis> in + this case. If false, <emphasis role="italic">rect</emphasis> is used to specify a window rectangle and it is updated + to the corresponding text display rectangle. On return, the rectangle is <emphasis role="italic">not</emphasis> + larger, (it is smaller,) in this case. + </para> + </listitem></varlistentry> </variablelist> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + Returns true if the rectangle was adjusted correctly, and returns false if an error occurred. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + This method is particularly useful when a ToolTip control is used to display the full text of a string that is truncated. + It is commonly used with list-view and tree-view controls. Typically send this method would be used in response to a + <xref linkend="kywToolTipSHOW"/> SHOW event notification so that the ToolTip control properly can be positioned properly. </para> - </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Details</emphasis></term> - <listitem> <para> - Raises syntax errors when incorrect usage is detected. + The ToolTip's window rectangle is somewhat larger than the text display rectangle that bounds the ToolTip string. The + window origin is also offset up and to the left from the origin of the text display rectangle. To position the text + display rectangle, the programmer must calculate the corresponding window rectangle and use that rectangle to position + the ToolTip. The <emphasis role="italic">adjustRect</emphasis> method handles this calculation for the programmer. </para> <para> - Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + If <emphasis role="italic">larger</emphasis> is set to true, <emphasis role="italic">adjustRect</emphasis> takes the size + and position of the desired ToolTip text display rectangle, and passes back the size and position of the ToolTip window + needed to display the text in the specified position. If <emphasis role="italic">larger</emphasis> is set to false, the + programmer can specify a ToolTip window rectangle and the <emphasis role="italic">adjustRect</emphasis> method will + return the size and position of its text rectangle. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> <para> - This example ... -<programlisting> -<![CDATA[ - -]]> -</programlisting> + Raises syntax errors when incorrect usage is detected. </para> </listitem></varlistentry> </variablelist> @@ -988,13 +1004,13 @@ <indexterm><primary>ToolTip class</primary><secondary>delTool</secondary></indexterm> <programlisting> <![CDATA[ ->>--delTool(--+--------+--)--------------------------------------------->< - +--type--+ +>>--delTool(--toolHwnd--+----------+--)---------->< + +-,-toolID-+ ]]> </programlisting> <para> - xx + Removes the specified tool from this ToolTip. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1003,24 +1019,33 @@ The arguments are: </para> <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>toolHwnd [required]</term> <listitem> <para> - xx + The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx + object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted. </para> </listitem></varlistentry> + <varlistentry><term>toolID [optional]</term> + <listitem> + <para> + The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx + object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted. + </para> + </listitem></varlistentry> </variablelist> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + Returns 0, always. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The <link linkend="sctToolIdentification">Tool Identification</link> section explains exactly how the Rexx object + combination is used to specify the tool to be deleted. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -1028,17 +1053,26 @@ <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 ... + This example shows a tool being added to a ToolTip and then at some later point in the application being deleted. <programlisting> <![CDATA[ + pbTest = self~newPushButton(IDC_PB_TEST) + count = 0 + ... + + ttTest = self~createToolTip(IDC_TT_TEST) + ttTest~addTool(pbTest, "Push the Test button to start the regression testing.") + + ... + + ttTest~delTool(pbTest) + + ]]> </programlisting> </para> @@ -2971,11 +3005,13 @@ <indexterm><primary>ToolInfo class</primary></indexterm> <para> A <emphasis role="italic">ToolInfo</emphasis> object contains information about a tool in a <xref linkend="clsToolTip"/> - control. The attributes of the <computeroutput>ToolInfo</computeroutput> object reflect the information that defines a tool - in the ToolTip control. + control. The attributes of the <computeroutput>ToolInfo</computeroutput> object reflect the information that defines a + specific tool in the ToolTip control. </para> <para> - xx + <emphasis role="italic">ToolInfo</emphasis> objects are used in some of the methods of the + <computeroutput>ToolTip</computeroutput> class to provide information to the ToolTip control, and / or, to receive + information from the ToolTip control. </para> <section id="sctMethodsToolInfo"><title>Method Table</title> |
From: <mie...@us...> - 2012-11-23 05:35:52
|
Revision: 8624 http://sourceforge.net/p/oorexx/code-0/8624 Author: miesfeld Date: 2012-11-23 05:35:51 +0000 (Fri, 23 Nov 2012) Log Message: ----------- ooDialog doc, some proof-reading edits Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-23 05:14:22 UTC (rev 8623) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-23 05:35:51 UTC (rev 8624) @@ -119,7 +119,7 @@ handle or a unique number. When the ID is a number, the number is similar to a <xref linkend="defResourceId"/>. </para> <para> - For the operating systm, the first part of the 2-part identifier is the handle of the window that the ToolTip will send + For the operating system, the first part of the 2-part identifier is the handle of the window that the ToolTip will send notifications to. The second part of the identifier can be a second window handle, if the ToolTip is going to subclass that window, or an unique number if the ToolTip is not going to subclass the tool. This may seem somewhat complicated to the Rexx programmer, especially if the programer has little experience with the underlying details of programming dialog @@ -128,7 +128,7 @@ <para> The ooDialog framework attempts to simplify this somewhat by allowing the Rexx programmer to identify an unique tool in several different ways. For the most common use of ToolTips, identifying a tool is simple and can be done with one Rexx - object. However, ooDialog also supplies the necessary means to identify a tool for more advanced use of ToolTips. + object. However, ooDialog also supplies the means needed to identify a tool when more advanced use of ToolTips is desired. </para> <para> This documentation refers to a tool identifier as a <emphasis role="italic">Rexx object combination</emphasis>. This can be @@ -140,7 +140,7 @@ </para> <variablelist> - <varlistentry><term><emphasis role="italic">hwndTool</emphasis> == a <computeroutput>ToolInfo</computeroutput> object</term> + <varlistentry><term>if <emphasis role="italic">hwndTool</emphasis> == a <computeroutput>ToolInfo</computeroutput> object</term> <listitem> <para> A <xref linkend="clsToolInfo"/> object always uniquely identifies a tool. When the <emphasis @@ -148,7 +148,7 @@ the second <emphasis role="italic">toolID</emphasis> argument is ignored. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is omitted</term> + <varlistentry><term>if <emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is omitted</term> <listitem> <para> It is very common that a ToolTip tool is a dialog control. For example quite often ToolTips are used for push buttons, @@ -160,7 +160,7 @@ values to identify the tool to the operating system. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is not omitted</term> + <varlistentry><term>if <emphasis role="italic">hwndTool</emphasis> \== a <computeroutput>ToolInfo</computeroutput> object and <emphasis role="italic">toolID</emphasis> is not omitted</term> <listitem> <para> This combination of identifying objects is needed when some more advanced uses of ToolTips are desired. It allows the @@ -749,7 +749,8 @@ <varlistentry><term>dlg [required]</term> <listitem> <para> - xx + The dialog <link linkend="chpDialogObject">object</link> that contains the rectangular area specified by the + <emphasis role="italic">rect</emphasis> argument. </para> </listitem></varlistentry> <varlistentry><term>id [required]</term> @@ -763,7 +764,7 @@ <listitem> <para> A <xref linkend="clsRect"/> object that specifies the bounding rectangle coordinates of the tool. The coordinates are - in client <link linkend="defScreenCoordinates"></link> of the dialog identified by the <emphasis + in client <link linkend="defScreenCoordinates">coordinates</link> of the dialog identified by the <emphasis role="italic">dlg</emphasis> argument. </para> </listitem></varlistentry> |
From: <mie...@us...> - 2012-11-25 17:13:04
|
Revision: 8626 http://sourceforge.net/p/oorexx/code-0/8626 Author: miesfeld Date: 2012-11-25 17:09:50 +0000 (Sun, 25 Nov 2012) Log Message: ----------- #419 Add Tooltip control See ticket [Feature-Requests:#419] Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-25 16:46:34 UTC (rev 8625) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-25 17:09:50 UTC (rev 8626) @@ -254,19 +254,19 @@ </row> <row> <entry><xref linkend="mthEnumTools"/></entry> -<entry>x</entry> +<entry>Retrieves a <xref linkend="clsToolInfo"/> object for the tool at the specified index.</entry> </row> <row> <entry><xref linkend="mthGetBubbleSize"/></entry> -<entry>x</entry> +<entry>Returns the width and height, as a <xref linkend="clsSize"/> object, of this ToolTip control.</entry> </row> <row> <entry><xref linkend="mthGetCurrentToolInfo"/></entry> -<entry>x</entry> +<entry>Retrieves a <xref linkend="clsToolInfo"/> object whose attributes represent the current tool in this tool tip.</entry> </row> <row> <entry><xref linkend="mthGetDelayTime"/></entry> -<entry>x</entry> +<entry>Retrieves one of the 3 delay times currently set for this ToolTip.</entry> </row> <row> <entry><xref linkend="mthGetMargin"/></entry> @@ -1087,25 +1087,25 @@ <indexterm><primary>ToolTip class</primary><secondary>enumTools</secondary></indexterm> <programlisting> <![CDATA[ ->>--enumTools(--+--------+--)--------------------------------------------->< - +--type--+ +>>--enumTools(--+---------+--)------------------->< + +--index--+ ]]> </programlisting> <para> - xx + Retrieves a <xref linkend="clsToolInfo"/> object for the tool at the specified index. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - The arguments are: + The single argument is: </para> <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>index</term> <listitem> <para> - xx + The one-based index of the tool to retrieve. If omitted, <emphasis role="italic">index</emphasis> defaults to 1. </para> </listitem></varlistentry> </variablelist> @@ -1113,13 +1113,14 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + Returns the tool, as a <computeroutput>ToolInfo</computeroutput> object, at the index specified, or the + <computeroutput>.nil</computeroutput> object if there is no tool at the index. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The Microsoft documentation says nothing about what, if any, order the tools contained in a ToolTip are in. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -1127,17 +1128,25 @@ <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 ... + This example <emphasis role="italic">enumerates</emphasis> the tools in a ToolTip: <programlisting> <![CDATA[ + do i = 1 to toolTip~getToolCount + toolInfo = toolTip~enumTools(i) + say 'Tool info hwnd: ' toolInfo~rexxHwnd + say 'Tool info id: ' toolInfo~rexxID + say 'Tool info text: ' toolInfo~text + say 'Tool info flags: ' toolInfo~flags + say 'Tool info rect: ' toolInfo~rect + say 'Tool info userData:' toolInfo~userData + say 'Tool info resource:' toolInfo~resource + say + end ]]> </programlisting> </para> @@ -1151,13 +1160,13 @@ <indexterm><primary>ToolTip class</primary><secondary>getBubbleSize</secondary></indexterm> <programlisting> <![CDATA[ ->>--getBubbleSize(--+--------+--)--------------------------------------------->< - +--type--+ +>>--getBubbleSize(--toolHwnd--+----------+--)---->< + +-,-toolID-+ ]]> </programlisting> <para> - xx + Returns the width and height, as a <xref linkend="clsSize"/> object, of this ToolTip control. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1166,24 +1175,33 @@ The arguments are: </para> <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>toolHwnd [required]</term> <listitem> <para> - xx + The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx + object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted. </para> </listitem></varlistentry> + <varlistentry><term>toolID [optional]</term> + <listitem> + <para> + The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx + object combination that <link linkend="sctToolIdentification">identify</link> the tool to be deleted. + </para> + </listitem></varlistentry> </variablelist> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + A <computeroutput>Size</computeroutput> object specifying the width and height of this tool tip control. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The <link linkend="sctToolIdentification">Tool Identification</link> section explains exactly how the Rexx object + combination is used to specify the tool to be deleted. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -1191,21 +1209,7 @@ <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 ToolTip::getBubbleSize() --> @@ -1215,41 +1219,27 @@ <indexterm><primary>ToolTip class</primary><secondary>getCurrentToolInfo</secondary></indexterm> <programlisting> <![CDATA[ ->>--getCurrentToolInfo(--+--------+--)--------------------------------------------->< - +--type--+ +>>--getCurrentToolInfo--------------------------->< ]]> </programlisting> <para> - xx + Retrieves a <xref linkend="clsToolInfo"/> object whose attributes represent the current tool in this tool tip. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - The arguments are: + There are no arguments for this method. </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 + Returns the current tool as a <xref linkend="clsToolInfo"/> object, if one exists, or + the <computeroutput>.nil</computeroutput> object if there is not a current tool. </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> @@ -1259,17 +1249,6 @@ 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 ToolTip::getCurrentToolInfo() --> @@ -1279,61 +1258,72 @@ <indexterm><primary>ToolTip class</primary><secondary>getDelayTime</secondary></indexterm> <programlisting> <![CDATA[ ->>--getDelayTime(--+--------+--)--------------------------------------------->< - +--type--+ +>>--getDelayTime(--+---------+--)---------------->< + +--which--+ ]]> </programlisting> <para> - xx + Retrieves one of the 3 delay times currently set for this ToolTip. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - The arguments are: + The single argument is: </para> <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>which [optional]</term> <listitem> <para> - xx + Exactly one of the following keywords, case is not significant. This specifies which of the 3 possible delay times to + retrieve. The default if omitted is AUTOPOP: </para> + <para> + <simplelist type='vert' columns='3'> + <member>AUTOPOP </member> + <member>INITIAL </member> + <member>RESHOW </member> + </simplelist> + <variablelist> + <varlistentry><term>AUTOPOP</term> + <listitem> + <para> + The amount of time the ToolTip window remains visible if the pointer is stationary within a tool's bounding + rectangle. + </para> + </listitem></varlistentry> + <varlistentry><term>INITIAL</term> + <listitem> + <para> + The amount of time the pointer must remain stationary within a tool's bounding rectangle before the ToolTip + window appears. + </para> + </listitem></varlistentry> + <varlistentry><term>RESHOW</term> + <listitem> + <para> + The amount of time it takes for subsequent ToolTip windows to appear as the pointer moves from one tool to + another. + </para> + </listitem></varlistentry> + </variablelist> + </para> </listitem></varlistentry> </variablelist> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + The specified delay time in milliseconds. </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 ToolTip::getDelayTime() --> |
From: <mie...@us...> - 2012-11-25 23:57:18
|
Revision: 8627 http://sourceforge.net/p/oorexx/code-0/8627 Author: miesfeld Date: 2012-11-25 23:57:16 +0000 (Sun, 25 Nov 2012) Log Message: ----------- #419 Add Tooltip control See ticket [Feature-Requests:#419] Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-25 17:09:50 UTC (rev 8626) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-25 23:57:16 UTC (rev 8627) @@ -113,7 +113,7 @@ <indexterm><primary>ToolTip class</primary><secondary>tool identification</secondary></indexterm> <para> - Each ToolTip can contain more than one <emphasis role="italic">tool</emphasis>. Becuase of this, the ToolTip control + Each ToolTip can contain more than one <emphasis role="italic">tool</emphasis>. Because of this, the ToolTip control needs a way of uniquely identifying each individual tool. In the operating system, each tool is identified using a combination of a window <link linkend="defHandle">handle</link> and an ID. The ID however, can be either another window handle or a unique number. When the ID is a number, the number is similar to a <xref linkend="defResourceId"/>. @@ -3026,15 +3026,15 @@ </row> <row> <entry><link linkend="mthForHitTest">forHitTest</link></entry> -<entry>x</entry> +<entry>Returns a new <computeroutput>ToolInfo</computeroutput> object to be used in the <xref linkend="mthHitTestClsToolTip"/> method.</entry> </row> <row> <entry><link linkend="mthForID">forID</link></entry> -<entry>x</entry> +<entry>Returns a new <computeroutput>ToolInfo</computeroutput> object to be used for tool <link linkend="sctToolIdentification">indentification.</link></entry> </row> <row> <entry><link linkend="mthNewClsToolInfo">new</link></entry> -<entry>x</entry> +<entry>Instantiates a new <computeroutput>ToolInfo</computeroutput> object.</entry> </row> <row> <entry align="center"><emphasis role="bold">Attribute Methods</emphasis></entry> @@ -3042,31 +3042,31 @@ </row> <row> <entry><link linkend="atrFlags">flags</link></entry> -<entry>x</entry> +<entry>Reflects the flags that define the style and options of the tool.</entry> </row> <row> <entry><link linkend="atrRect">rect</link></entry> -<entry>x</entry> +<entry>Reflects the bounding rectangle coordinates of the tool when the tool is an application-defined rectangular area within a window's client area.</entry> </row> <row> <entry><link linkend="atrResource">resource</link></entry> -<entry>x</entry> +<entry>Reserved for future enhancement.</entry> </row> <row> <entry><link linkend="atrRexxHwnd">rexxHwnd</link></entry> -<entry>x</entry> +<entry>Reflects the Rexx object from which the first part of the 2-part system <link linkend="sctToolIdentification">identification</link> for a tool is derived from.</entry> </row> <row> <entry><link linkend="atrRexxID">rexxID</link></entry> -<entry>x</entry> +<entry>Reflects the Rexx object from which the second part of the 2-part system <link linkend="sctToolIdentification">identification</link> for a tool is derived from.</entry> </row> <row> <entry><link linkend="atrText">text</link></entry> -<entry>x</entry> +<entry>Reflects the text set for the tool.</entry> </row> <row> <entry><link linkend="atrUserData">userData</link></entry> -<entry>x</entry> +<entry>Reflects the application-defined user data value for the tool.</entry> </row> </tbody></tgroup> </table> @@ -3079,25 +3079,28 @@ <indexterm><primary>ToolInfo class</primary><secondary>forHitTest</secondary></indexterm> <programlisting> <![CDATA[ ->>--forHitTest(--+--------+--)--------------------------------------------->< - +--type--+ +>>--forHitTest(--hwndObj--)---------------------->< ]]> </programlisting> <para> - xx + Returns a new <computeroutput>ToolInfo</computeroutput> object to be used in the <xref linkend="mthHitTestClsToolTip"/> + method. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - The arguments are: + The single argument is: </para> <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>hwndObj [required]</term> <listitem> <para> - xx + The Rexx tool or Rexx object that contains a tool that is going to be hit tested. For example, if the tool to be + tested is a rectangular area, <emphasis role="italic">hwndObj</emphasis> should be the Rexx object that represents + the window containing the rectangle. If the tool is a dialog control, then <emphasis role="italic">hwndObj</emphasis> + should be the Rexx object that represents the dialog control. </para> </listitem></varlistentry> </variablelist> @@ -3105,13 +3108,18 @@ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + Returns a newly instantiated <computeroutput>ToolInfo</computeroutput> object designed to be used as the argument to the + <emphasis role="italic">hitTest</emphasis> method. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The new <computeroutput>ToolInfo</computeroutput> object is especially constructed to be of use in the <xref + linkend="mthHitTestClsToolTip"/> method. To be explicit, the <computeroutput>ToolInfo</computeroutput> object returned is + initialized to an empty state and the normal tool indentifiers are not set. The returned + <computeroutput>ToolInfo</computeroutput> object is not suitable to be used in any other methods that required a + <computeroutput>ToolInfo</computeroutput> object, except the <emphasis role="italic">hitTest</emphasis> method. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -3119,17 +3127,55 @@ <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 ... + This example comes from an application that has a number of rectangular tools in a dialog. An arbitrary point is hit + tested and if the hit succeeds, the filled in tool information is printed to the screen: <programlisting> <![CDATA[ + hitTool = .ToolInfo~forHitTest(self) + + say 'Using' pos + + if tt~hitTest(hitTool, pos) then do + say 'Got hit' + say 'Tool info hwnd: ' hitTool~rexxHwnd + say 'Tool info id: ' hitTool~rexxID + say 'Tool info text: ' hitTool~text + say 'Tool info flags: ' hitTool~flags + say 'Tool info rect: ' hitTool~rect + say 'Tool info userData:' hitTool~userData + say 'Tool info resource:' hitTool~resource + say + end + else do + say 'NO hit' + end + +/* Output might be for instance: + +Using a Point (220, 101) +Got hit +Tool info hwnd: a SimpleDialog +Tool info id: 777 +Tool info text: Over main dialog, bottom right quadrant +Tool info flags: SUBCLASS TRANSPARENT +Tool info rect: a Rect (194, 101, 386, 200) +Tool info userData: The NIL object +Tool info resource: The NIL object + +*/ + +/* Output from a miss: + +Using a Point (220, 301) +NO hit + +*/ + ]]> </programlisting> </para> @@ -3143,13 +3189,14 @@ <indexterm><primary>ToolInfo class</primary><secondary>forID</secondary></indexterm> <programlisting> <![CDATA[ ->>--forID(--+--------+--)--------------------------------------------->< - +--type--+ +>>--forID(--toolHwnd--+----------+--)------------>< + +-,-toolID-+ ]]> </programlisting> <para> - xx + Returns a new <computeroutput>ToolInfo</computeroutput> object to be used for tool <link + linkend="sctToolIdentification">indentification.</link> </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -3158,24 +3205,37 @@ The arguments are: </para> <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>toolHwnd [required]</term> <listitem> <para> - xx + The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx + object combination that <link linkend="sctToolIdentification">identify</link> a tool to the operating system. </para> </listitem></varlistentry> + <varlistentry><term>toolID [optional]</term> + <listitem> + <para> + The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx + object combination that <link linkend="sctToolIdentification">identify</link> the tool to the operaring system. + </para> + </listitem></varlistentry> </variablelist> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + Returns a newly instantiated <computeroutput>ToolInfo</computeroutput> object that can be used to identify a specific + tool contained within a ToolTip. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + Many of the <computeroutput>ToolTip</computeroutput> methods require that the tool the method pertains to be identified. + The <computeroutput>ToolInfo</computeroutput> object returned from <emphasis role="italic">forID</emphasis> is useful for + those method. In addition, some methods return information by filling in the attributes of a + <computeroutput>ToolInfo</computeroutput> object that specifies a tool. This is another good use of the <emphasis + role="italic">forID</emphasis> method. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -3183,17 +3243,20 @@ <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 ... + This example instantiates a new <computeroutput>ToolInfo</computeroutput> object using the <emphasis + role="italic">forID</emphasis> method and then uses the object to change the ToolTip text for a push button tool: <programlisting> <![CDATA[ + toolInfo = .ToolInfo~forID(self~newPushButton(IDC_PB_TEST)) + toolInfo~text = "Push the 'Test' button when you are ready to begin the test suite for the final release." + + toolTip~setMaxTipWidth(140) + toolTip~updateTipText(toolInfo) ]]> </programlisting> </para> @@ -3206,39 +3269,163 @@ <indexterm><primary>ToolInfo class</primary><secondary>new</secondary></indexterm> <programlisting> <![CDATA[ ->>--new(--+--------+--)--------------------------------------------->< - +--type--+ +>>--new(-toolHwnd-+----------+-+-------+-+--------+-+-----+-+---------+-+-------+-)-->< + +-,-toolID-+ +-,-txt-+ +-,-flgs-+ +-,-r-+ +-,-uData-+ +-,-rsv-+ ]]> </programlisting> <para> - xx + Instantiates a new <computeroutput>ToolInfo</computeroutput> object. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - xx + The arguments are: <variablelist> - <varlistentry><term>TERM</term> + <varlistentry><term>toolHwnd [required]</term> <listitem> <para> - xx + The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx + object combination that <link linkend="sctToolIdentification">identify</link> a tool to the operating system. </para> </listitem></varlistentry> + <varlistentry><term>toolID [optional]</term> + <listitem> + <para> + The <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> arguments are the Rexx + object combination that <link linkend="sctToolIdentification">identify</link> the tool to the operaring system. + </para> + </listitem></varlistentry> + <varlistentry><term>txt [optional]</term> + <listitem> + <para> + Text for the tool. If omitted, or the empty string, or the string: TEXTCALLBACK, then the ToolTip sends the <xref + linkend="kywToolTipNEEDTEXT"/> notification and the program supplies the text. + </para> + <para> + The length of the text must be less than 1024 characters, which includes any possible end of line (0x0D0A) sequences. + </para> + </listitem></varlistentry> + <varlistentry><term>flags [optional]</term> + <listitem> + <para> + A list of 0 or more of the following keywords separated by spaces, case is not significant. + </para> + <para> + <simplelist type='vert' columns='3'> + <member>ABSOLUTE </member> + <member>CENTERTIP </member> + <member>IDISHWND </member> + <member>PARSELINKS </member> + <member>RTLREADING </member> + <member>SUBCLASS </member> + <member>TRACK </member> + <member>TRANSPARENT</member> + </simplelist> + <variablelist> + <varlistentry><term>ABSOLUTE</term> + <listitem> + <para> + Positions the ToolTip window at the exact same coordinates specified by the <xref linkend="mthTrackPosition"/> + method. Without this flag the ToolTip control chooses where to display the ToolTip window based on the + coordinates specified, which places the ToolTip close to the tool. This flag must be used with the TRACK flag. + </para> + </listitem></varlistentry> + <varlistentry><term>CENTERTIP</term> + <listitem> + <para> + Centers the ToolTip window below the tool. + </para> + </listitem></varlistentry> + <varlistentry><term>IDISHWND</term> + <listitem> + <para> + Indicates that the ID part of the tool <link linkend="sctToolIdentification">identification</link> is the window + handle to the tool. In general, the ooDialog framework will set this flag correctly by using knowledge it gains + from parsing the <emphasis role="italic">toolHwnd</emphasis> and <emphasis role="italic">toolID</emphasis> + arguments. If the flag is required, the framework will set it, if the flag should not be used, the framework will + remove it if it is set. + </para> + </listitem></varlistentry> + <varlistentry><term>PARSELINKS</term> + <listitem> + <para> + Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later. + </para> + <para> + Indicates that links in the ToolTip text should be parsed. + </para> + </listitem></varlistentry> + <varlistentry><term>RTLREADING</term> + <listitem> + <para> + Indicates that the ToolTip text will be displayed in the opposite direction to the text in the parent window. + </para> + </listitem></varlistentry> + <varlistentry><term>SUBCLASS</term> + <listitem> + <para> + Indicates that the ToolTip control should subclass the tool's window to intercept messages, such as WM_MOUSEMOVE. + If this flag is not set, some means must be used so that the mouse messages are forwarded to the ToolTip control, + for instance by using the <xref linkend="mthManageAtypicalTool"/> method. + </para> + </listitem></varlistentry> + <varlistentry><term>TRACK</term> + <listitem> + <para> + Positions the ToolTip window next to the tool to which it corresponds and moves the window according to + coordinates supplied by the <xref linkend="mthTrackPosition"/> method. The programmer must activate this + type of tool using the <xref linkend="mthTrackActivate"/> method. + </para> + </listitem></varlistentry> + <varlistentry><term>TRANSPARENT</term> + <listitem> + <para> + Causes the ToolTip control to forward mouse event messages to the parent window. This is limited to mouse events + that occur within the bounds of the ToolTip window. + </para> + </listitem></varlistentry> + </variablelist> + </para> + </listitem></varlistentry> + <varlistentry><term>r [optional]</term> + <listitem> + <para> + A <xref linkend="clsRect"/> object that specifies the bounding rectangle coordinates of the tool. The coordinates are + in client <link linkend="defScreenCoordinates">coordinates</link> of the tool. + </para> + </listitem></varlistentry> + <varlistentry><term>uData [optional]</term> + <listitem> + <para> + A user data value to be associated with the tool. This can be any Rexx object the programmer wants. Note that the + value is associated with the tool, not the tool tip. + </para> + </listitem></varlistentry> + <varlistentry><term>rsv [optional]</term> + <listitem> + <para> + Reserved for future enhancement. This argument is completely ignrored in the current implmentation of ooDialog. Future + versions may be enhance to use this argument to specify a <xref linkend="clsResourceImage"/> object containing binary + resources for the tool. + </para> + </listitem></varlistentry> </variablelist> </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> <para> - xx + Returns a newly instantiated <computeroutput>ToolInfo</computeroutput> object. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + Except for the IDISHWND flag, the returned <computeroutput>ToolInfo</computeroutput> object is constructed exactly as the + programmer specifies. This makes the object ideal for use in the <xref linkend="mthAddToolEx"/> method for those cases + where the convenience <xref linkend="mthAddTool"/> and <xref linkend="mthAddToolRect"/> are not suitable. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -3246,17 +3433,31 @@ <para> Raises syntax errors when incorrect arguments are detected. </para> - <para> - Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. - </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example ... + This example uses the <emphasis role="italic">new</emphasis> method to instantiate a + <computeroutput>ToolInfo</computeroutput> object for an implementation of custom ToolTips for a <xref + linkend="clsTreeView"/>: + <programlisting> <![CDATA[ + tv = self~newTreeView(IDC_TREE) + ret = tv~setItemHeight(20) + tt = self~createToolTip(IDC_TT) + + rect = tv~clientRect + + toolInfo = .ToolInfo~new(tv, ID_TOOL_TV, '', 'TRANSPARENT', rect, helperObj) + tt~addToolEx(toolInfo) + + tt~setMaxTipWidth(250) + + self~populateTree(tv) + tt~manageAtypicalTool(tv, .array~of('RELAY', 'NEEDTEXT', 'SHOW')) + ]]> </programlisting> </para> @@ -3277,26 +3478,103 @@ </programlisting> <para> - xx + Reflects the flags that define the style and options of the tool. </para> <variablelist> <varlistentry><term><emphasis role="bold">flags get:</emphasis></term> <listitem> <para> - details about get + Returns a string of 0 or more keywords separated by a single space that specify the flags set for this tool. If no flags + are set, the empty string is returned. See the remarks for the keyword values and meanings. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">flags set:</emphasis></term> <listitem> <para> - details about set + Sets the flags for this tool to those specified by a string of 0 or more space separated keywords. Case is not + significant. See the remarks for the possible keywords and their meaning. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The following keywords specify the individual flags that define the style and options for a ToolTip tool. The keywords + are case insensitive. </para> + <para> + <simplelist type='vert' columns='3'> + <member>ABSOLUTE </member> + <member>CENTERTIP </member> + <member>IDISHWND </member> + <member>PARSELINKS </member> + <member>RTLREADING </member> + <member>SUBCLASS </member> + <member>TRACK </member> + <member>TRANSPARENT</member> + </simplelist> + <variablelist> + <varlistentry><term>ABSOLUTE</term> + <listitem> + <para> + Indicates that the ToolTip should position its window at the exact same coordinates specified by the <xref + linkend="mthTrackPosition"/> method. Without this flag the ToolTip control chooses where to display the ToolTip + window based on the coordinates specified, which places the ToolTip close to the tool. This flag must be used with + the TRACK flag. + </para> + </listitem></varlistentry> + <varlistentry><term>CENTERTIP</term> + <listitem> + <para> + Indicates that the ToolTip should centers its window below the tool. + </para> + </listitem></varlistentry> + <varlistentry><term>IDISHWND</term> + <listitem> + <para> + Indicates that the ID part of the tool <link linkend="sctToolIdentification">identification</link> is the window + handle if the tool. If the programmer sets the <emphasis role="italic">flags</emphasis> attribute, it becomes the + programmer's responsibility to set this flag correctly. Failure to do so will result in unpredictable behaviour. + </para> + </listitem></varlistentry> + <varlistentry><term>PARSELINKS</term> + <listitem> + <para> + Requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later. + </para> + <para> + Indicates that links in the ToolTip text should be parsed. + </para> + </listitem></varlistentry> + <varlistentry><term>RTLREADING</term> + <listitem> + <para> + Indicates that the ToolTip text will be displayed in the opposite direction to the text in the parent window. + </para> + </listitem></varlistentry> + <varlistentry><term>SUBCLASS</term> + <listitem> + <para> + Indicates that the ToolTip control should subclass the tool's window to intercept messages, such as WM_MOUSEMOVE. + If this flag is not set, some means must be used so that the mouse messages are forwarded to the ToolTip control. + </para> + </listitem></varlistentry> + <varlistentry><term>TRACK</term> + <listitem> + <para> + Indicates that the ToolTip should position its window next to the tool to which it corresponds and move the window + according to coordinates supplied by the <xref linkend="mthTrackPosition"/> method. The programmer must activate this + type of tool using the <xref linkend="mthTrackActivate"/> method. + </para> + </listitem></varlistentry> + <varlistentry><term>TRANSPARENT</term> + <listitem> + <para> + Causes the ToolTip control to forward mouse event messages to the parent window. This is limited to mouse events + that occur within the bounds of the ToolTip window. + </para> + </listitem></varlistentry> + </variablelist> + </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> @@ -3304,18 +3582,6 @@ Raises syntax errors when incorrect usage is detected. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End ToolInfo::flags() [attribute] --> @@ -3333,25 +3599,30 @@ </programlisting> <para> - xx + Reflects the bounding rectangle coordinates of the tool when the tool is an application-defined rectangular area within a + window's client area. </para> <variablelist> <varlistentry><term><emphasis role="bold">rect get:</emphasis></term> <listitem> <para> - details about get + Returns the bounding rectangle as a <xref linkend="clsRect"/> object. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">rect set:</emphasis></term> <listitem> <para> - details about set + Assign a <computeroutput>Rect</computeroutput> object to the <emphasis role="italic">rect</emphasis> attribute to define + the tool as a rectangular area within a window. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + When the tool is not an application-defined rectangular area, the value of the <emphasis role="italic">rect</emphasis> + attribute is a <computeroutput>rect</computeroutput> object whose coordinates are all 0. When the <emphasis + role="italic">flags</emphasis> attribute includes the IDIHWND keyword, the <emphasis role="italic">rect</emphasis> + attriubte is ignored by the ToolTip. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -3360,18 +3631,6 @@ Raises syntax errors when incorrect usage is detected. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End ToolInfo::rect() [attribute] --> @@ -3389,25 +3648,27 @@ </programlisting> <para> - xx + Reserved for future enhancement. </para> <variablelist> <varlistentry><term><emphasis role="bold">resource get:</emphasis></term> <listitem> <para> - details about get + Returns the <computeroutput>.nil</computeroutput> object, always. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">resource set:</emphasis></term> <listitem> <para> - details about set + This attribute can not be set. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + If the <xref linkend="clsResourceImage"/> class is enhanced to work with string resources (a good possibility) then this + attribute will the <computeroutput>ResourceImage</computeroutput> that contains the string resource to use for the text + of the tool. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -3416,18 +3677,6 @@ Raises syntax errors when incorrect usage is detected. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End ToolInfo::resource() [attribute] --> @@ -3445,45 +3694,30 @@ </programlisting> <para> - xx + Reflects the Rexx object from which the first part of the 2-part system <link + linkend="sctToolIdentification">identification</link> for a tool is derived from. </para> <variablelist> <varlistentry><term><emphasis role="bold">rexxHwnd get:</emphasis></term> <listitem> <para> - details about get + Returns the Rexx object that is used as part of the basis for the tool identification. This will always be either a + dialog object or a dialog control object. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">rexxHwnd set:</emphasis></term> <listitem> <para> - details about set + The Rexx programmer can not set this attribute. It is set by the ooDialog framework when the + <computeroutput>ToolInfo</computeroutput> object is instantiated and can not be changed after that. </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> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End ToolInfo::rexxHwnd() [attribute] --> @@ -3501,45 +3735,30 @@ </programlisting> <para> - xx + Reflects the Rexx object from which the second part of the 2-part system <link + linkend="sctToolIdentification">identification</link> for a tool is derived from. </para> <variablelist> <varlistentry><term><emphasis role="bold">rexxID get:</emphasis></term> <listitem> <para> - details about get + Returns the Rexx object used as the ID portion of the tool identifier. This will always be either a dialog control object + or a non-negative whole number. (Recall that in ooRexx all numbers are objects.) </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">rexxID set:</emphasis></term> <listitem> <para> - details about set + The Rexx programmer can not set this attribute. It is set by the ooDialog framework when the + <computeroutput>ToolInfo</computeroutput> object is instantiated and can not be changed after that </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> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End ToolInfo::rexxID() [attribute] --> @@ -3557,26 +3776,38 @@ </programlisting> <para> - xx + Reflects the text set for the tool. </para> <variablelist> <varlistentry><term><emphasis role="bold">text get:</emphasis></term> <listitem> <para> - details about get + Returns the text for the tool, the empty string if the text is not set, or the string <emphasis + role="italic">TextCallBack</emphasis> if the tool is set to use the call back feature. See the remarks for details on the + call back feature. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">text set:</emphasis></term> <listitem> <para> - details about set + Assign this attribute the text string the ToolTip should display in its window for this tool. To set the ToolTip to use + its call back feature, either assign the string <emphasis role="italic">TEXTCALLBACK</emphasis>, case is not significant, + or assign the empty string. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The ToolTip provides a call back feature that can be used rather than setting a static text string for the tool. With this + feature, the ToolTip sends the <xref linkend="kywToolTipNEEDTEXT"/> notification and the program supplies the text + supplies the text for the tool by responding to the notification. To use this feature, the programmer should set the + <emphasis role="italic">text</emphasis> attribute to either the string, <emphasis role="italic">TextCallBack</emphasis> ro + the empty string. </para> + <para> + The length of the text must be less than 1024 characters, which includes any possible end of line (0x0D0A) sequences. Do + not set the <emphasis role="italic">text</emphasis> attriubte to a string longer than 1023 characters. + </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> @@ -3584,18 +3815,6 @@ Raises syntax errors when incorrect usage is detected. </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End ToolInfo::text() [attribute] --> @@ -3613,45 +3832,28 @@ </programlisting> <para> - xx + Reflects the application-defined user data value for the tool. </para> <variablelist> <varlistentry><term><emphasis role="bold">userData get:</emphasis></term> <listitem> <para> - details about get + Returns the user data set for the tool, or the <computeroutput>.nil</computeroutput> object is no user data has been + assiged. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">userData set:</emphasis></term> <listitem> <para> - details about set + The programmer can assign a user data value to the tool. This can be any Rexx object desired. </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> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> - <para> - This example ... -<programlisting> -<![CDATA[ - - -]]> -</programlisting> - </para> - </listitem></varlistentry> </variablelist> </section> <!-- End ToolInfo::userData() [attribute] --> |
From: <mie...@us...> - 2012-11-26 04:12:27
|
Revision: 8628 http://sourceforge.net/p/oorexx/code-0/8628 Author: miesfeld Date: 2012-11-26 04:12:24 +0000 (Mon, 26 Nov 2012) Log Message: ----------- #419 Add Tooltip control See ticket [Feature-Requests:#419] Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-25 23:57:16 UTC (rev 8627) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-26 04:12:24 UTC (rev 8628) @@ -270,7 +270,7 @@ </row> <row> <entry><xref linkend="mthGetMargin"/></entry> -<entry>x</entry> +<entry>Returns a rectangle that describes the margins of the ToolTip.</entry> </row> <row> <entry><xref linkend="mthGetMaxTipWidth"/></entry> @@ -1333,60 +1333,59 @@ <indexterm><primary>ToolTip class</primary><secondary>getMargin</secondary></indexterm> <programlisting> <![CDATA[ ->>--getMargin(--+--------+--)--------------------------------------------->< - +--type--+ +>>--getMargin------------------------------------>< ]]> </programlisting> <para> - xx + Returns a rectangle that describes the margins of the ToolTip </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem> <para> - The arguments are: + This method has no arguments. </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 + A <xref linkend="clsRect"/> object whose attributes specify the margins of the ToolTip. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> <listitem> <para> - Additional comments. + The attributes of the returned rectangle do not define a bounding rectangle. For the purpose of this method, the + attributes are interpreted as follows: </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> + <variablelist> + <varlistentry><term><emphasis role="bold">top:</emphasis></term> + <listitem> + <para> + Distance between top border and top of ToolTip text, in pixels. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">left:</emphasis></term> + <listitem> + <para> + Distance between left border and left end of ToolTip text, in pixels. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">bottom:</emphasis></term> + <listitem> + <para> + Distance between bottom border and bottom of ToolTip text, in pixels. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">right:</emphasis></term> + <listitem> + <para> + Distance between right border and right end of ToolTip text, in pixels. + </para> + </listitem></varlistentry> + </variablelist> </listitem></varlistentry> </variablelist> </section> <!-- End ToolTip::getMargin() --> @@ -3425,7 +3424,7 @@ <para> Except for the IDISHWND flag, the returned <computeroutput>ToolInfo</computeroutput> object is constructed exactly as the programmer specifies. This makes the object ideal for use in the <xref linkend="mthAddToolEx"/> method for those cases - where the convenience <xref linkend="mthAddTool"/> and <xref linkend="mthAddToolRect"/> are not suitable. + where the convenience <xref linkend="mthAddTool"/> and <xref linkend="mthAddToolRect"/> methods are not suitable. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> |
From: <mie...@us...> - 2012-11-28 04:10:35
|
Revision: 8636 http://sourceforge.net/p/oorexx/code-0/8636 Author: miesfeld Date: 2012-11-28 04:10:32 +0000 (Wed, 28 Nov 2012) Log Message: ----------- ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-28 03:57:57 UTC (rev 8635) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-28 04:10:32 UTC (rev 8636) @@ -289,7 +289,7 @@ <entry>Retrieves the text color fot this ToolTip's window.</entry> </row> <row> -<entry><xref linkend="mthTitle"/></entry> +<entry><xref linkend="mthGetTitle"/></entry> <entry>Retrieves information concerning the title and icon of this ToolTip control.</entry> </row> <row> |
From: <mie...@us...> - 2012-11-29 23:31:32
|
Revision: 8643 http://sourceforge.net/p/oorexx/code-0/8643 Author: miesfeld Date: 2012-11-29 23:31:29 +0000 (Thu, 29 Nov 2012) Log Message: ----------- ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-29 22:36:06 UTC (rev 8642) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-29 23:31:29 UTC (rev 8643) @@ -2391,6 +2391,7 @@ The amount of time it takes for subsequent ToolTip windows to appear as the pointer moves from one tool to another. </para> + </listitem></varlistentry> <varlistentry><term>AUTOMATIC</term> <listitem> <para> |
From: <mie...@us...> - 2012-11-30 00:15:00
|
Revision: 8644 http://sourceforge.net/p/oorexx/code-0/8644 Author: miesfeld Date: 2012-11-30 00:14:57 +0000 (Fri, 30 Nov 2012) Log Message: ----------- ooDialog doc, fix tags Modified Paths: -------------- docs/trunk/oodialog/en-US/tooltip.xml Modified: docs/trunk/oodialog/en-US/tooltip.xml =================================================================== --- docs/trunk/oodialog/en-US/tooltip.xml 2012-11-29 23:31:29 UTC (rev 8643) +++ docs/trunk/oodialog/en-US/tooltip.xml 2012-11-30 00:14:57 UTC (rev 8644) @@ -2790,6 +2790,9 @@ </para> </listitem></varlistentry> </variablelist> + </para> + </listitem></varlistentry> + </variablelist> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> <listitem> @@ -3090,7 +3093,7 @@ role="italic">trackPosition</emphasis> method. This causes the ToolTip window to appear beside the tool to which it corresponds. To have ToolTip windows displayed at specific coordinates, include the ABSOLUTE keyword in the <emphasis role="italic">flags</emphasis> argument when adding the tool through the <xref linkend="mthAddTool"/>, <xref - linkend="addToolEx"/>, or <xref linkend="mthAddToolRect"/> methods. + linkend="mthAddToolEx"/>, or <xref linkend="mthAddToolRect"/> methods. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> @@ -3169,8 +3172,8 @@ <listitem> <para> The best way to use this method is to instantiate a new <computeroutput>ToolInfo</computeroutput> object through the - <xref linkend="forID"/> method and then set the <emphasis role="italic">text</emphasis> attribute of the object to the - new text desired. + <xref linkend="mthForID"/> method and then set the <emphasis role="italic">text</emphasis> attribute of the object + to the new text desired. </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> |