BBjControl::getToolTipText

Description

Returns the tooltip text for the BBjControl (also known as short cue in BBx).

Syntax

Return Value Method
String getToolTipText()

Parameters

None.

Return Value

Returns the tool tip text when the mouse is positioned over the control.

Remarks

Same as BBjControl::getShortCue.

Example

rem 'Get the tooltip text of a control

rem 'Obtain the instance of the BBjAPI object
let myAPI! = BBjAPI()

rem 'Open the SysGui device
SYSGUI = UNT
OPEN (SYSGUI) "X0"

rem 'Obtain the instance of the BBjSysGui object
let mySysGui! = myAPI!.getSysGui()

rem 'Set common addWindow param values
X = 10
Y = 10
WIDTH = 200
HEIGHT = 200

rem 'Create a window with a title in the current context
TITLE$="BBj Window"

rem 'Set the current context
mySysGui!.setContext(0)
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

rem 'Add a button on the window
myButton! = myWindow!.addButton(101,50,100,90,30,"Button")

rem 'Set the tooltip text for the button
myButton!.setToolTipText("This is a tooltip")

rem 'Get the tooltip text for the button
TOOLTIP_TEXT$ = myButton!.getToolTipText()

rem 'Register the CALLBACK routines
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

rem 'Process Events
process_events

rem 'Callback routine called when the user closes the application window
APP_CLOSE:
release

See Also

BBjAPI

BBjSysGui

BBjWindow

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.