BBjControl::getLongCue

Description

Returns the text that appears in the status bar for the BBjControl when the mouse is positioned over the control.

Syntax

Return Value Method
String getLongCue()

Parameters

None.

Return Value

Returns the text that appears in the status bar for the BBjControl when the mouse is positioned over the control.

Example

rem 'Get the long cue for 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 status bar to the window
myWindow!.addStatusBar(201)

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

rem 'Set the long cue text for the button
myButton!.setLongCue("This is a long cue")

rem 'Get the long cue text for the button
LONG_CUE_TEXT$ = myButton!.getLongCue()

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.