[r8516]: docs / trunk / oodialog / en-US / tooltip.xml  Maximize  Restore  History

Download this file

239 lines (223 with data), 8.6 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "oodialog.ent">
%BOOK_ENTITIES;
]>
<!--#########################################################################
#
# Description: Open Object Rexx: ooDialog Reference SGML file.
#
# Copyright (c) 2012-2012, Rexx Language Association. All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Common Public License v1.0 which accompanies this
# distribution. A copy is also available at the following address:
# http://www.oorexx.org/license.html
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the distribution.
#
# Neither the name of Rexx Language Association nor the names
# of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# 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 <dashley@us.ibm.com>
#
#########################################################################
-->
<chapter id="clsToolTip"><title>ToolTip Controls</title>
<indexterm><primary>ToolTip class</primary></indexterm>
<para>
xx
</para>
<para>
xx
</para>
<para>
xx
</para>
<para>
The <computeroutput>ToolTip</computeroutput> class provides methods to work with and manipulate the underlying
Windows tool tip 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.
</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 tool tip controls:
<variablelist>
<varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term>
<listitem>
<para>
Use the <link linkend="tmthNewToolTip">newToolTip</link> method of the <link linkend="chpDialogObject">dialog</link>
object to retrieve a new ToolTip object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Dynamic Definition:</emphasis></term>
<listitem>
<para>
Unlike most other types of dialog controls, a tool tip can not be added to a dialog <link
linkend="ovvDialogTemplate">template</link>. Tool tips are created dynamically during the <link
linkend="tmthNewToolTip">newToolTip</link> method. Therefore there is no equivalent <emphasis
role="italic">createToolTip</emphasis> method in the <link linkend="clsUserDialog">UserDialog</link> class.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Event Notification</emphasis></term>
<listitem>
<para>
To connect the <link linkend="ovvEvents">event</link> notifications sent by the underlying tool tip control to a method
in the Rexx dialog object use the <link linkend="mthConnectToolTipEvent">connectToolTipEvent</link> method.
</para>
</listitem></varlistentry>
</variablelist> </para>
<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
with ToolTip objects, including the pertinent methods from other classes:
</para>
<table id="tblToolTipMethods" frame="all">
<title>Important ToolTip Methods</title>
<tgroup cols="2">
<colspec colwidth="3*" /><colspec colwidth="8*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<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 an <computeroutput>ToolTip</computeroutput> object for the control with the specified ID.</entry>
</row>
<row>
<entry><link linkend="tmthConnectToolTipEvent">connectToolTipEvent</link></entry>
<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>PROVIDE LINK</entry>
<entry>PROVIDE DESCRIPTION</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>
</row>
</tbody></tgroup>
</table>
</section>
<section id="tmthNewToolTip"><title>newToolTip (dialog object method)</title>
<para>
ToolTip objects can not be instantiated by the programmer from Rexx code. Rather an ToolTip object is obtained
by using the <link linkend="mthNewToolTip">newToolTip</link>() method of the dialog <link
linkend="chpDialogObject">object</link>. The syntax is:
<programlisting>
<![CDATA[
>>-newToolTip(--id--)---------------------><
]]>
</programlisting>
</para>
</section> <!-- End newToolTip() [PlainBaseDialog method] -->
<section id="tmthConnectToolTipEvent"><title>connectToolTipEvent (dialog object method)</title>
<para>
To connect event notifications from an tool tip control use the <link
linkend="mthConnectToolTipEvent">connectToolTipEvent</link>() method of the <link
linkend="chpDialogObject">dialog</link> object. The basic syntax is:
<programlisting> <![CDATA[
>>-connectToolTipEvent(--id--,--event--+----------------+--)------------><
+--,-methodName--+
]]>
</programlisting>
</para>
</section> <!-- End connectToolTipEvent() [EventNotification method] -->
<section id="mthActivate"><title>activate</title>
<indexterm><primary>activate</primary></indexterm>
<indexterm><primary>ToolTip class</primary><secondary>activate</secondary></indexterm>
<programlisting>
<![CDATA[
>>--activate(--+------------+--)-----------------><
+--activate--+
]]>
</programlisting>
<para>
xx
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
xx
</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 arguments are detected.
</para>
<para>
xx
</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::activate() -->
</chapter> <!-- End ToolTip class -->

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

JavaScript is required for this form.





No, thanks