CUE Mnemonic - Set Cue Text
Syntax
'CUE'(id,short_cue,long_cue)
Description
The 'CUE' mnemonic sets short cue and long cue text. 'CUE' is issued in the context of the parent window, using the ID of the control and associated cue text. For example, if a dialog has a push button with id 101 marked "Restore," a possible 'CUE' command (issued in the dialog's context) would be:
'CUE'(101,"Restore Text","Restores the original text in the edit field")
The cue is activated and a small yellow window appears with the short
cue text displayed when the user moves the mouse slowly over the object
and comes to a brief stop. If a status bar is available in the current
window or one of its parents, the long cue text appears. If a mouse button
is pressed or the mouse is moved off the cued object, the window with
the short cue text is removed and the text in the status bar is returned
to its previous appearance.
Either the short cue or the long cue may be specified as an empty string,
if that aspect of cueing is not desired. For example, 'CUE'(101,"","long text") would not create
a yellow window but would display "long
text" in the status bar when activated, while 'CUE'(101,"short","")
would produce only the yellow window . A cue may be reset at any time
or removed by using two empty strings.
If any 'CUE' mnemonics have ever been used in a given context, that window
cannot pass mouse-move events to the event queue. Mouse clicks and other
types of events are passed normally. Other side effects may exist on some
platforms.
Parameter |
Description |
id |
Control ID number. It must be an integer between 1 and 32767. |
short_cue |
Text string to be displayed in the small yellow window when the mouse pointer is positioned over the id-specified control. |
long_cue |
Text string to be displayed on the status bar when the mouse pointer is positioned over the id-specified control. |