Produced by IDL 7.1.1
Developer Documentation

./plotter
gbtcursor.pro

Last modification date:
Wed Sep 28 13:27:13 2016

gbtcursor

function gbtcursor([/noshow], [/nocrosshair], [label=string])

Get a mouse event when the user presses any mouse button.

This returns a mouse event structure when the user presses any mouse button. The default behavior is to bring the plotter window to the foreground (show) and to switch to the crosshair cursor. Both of these features can be turned off. If the crosshair state is changed during this function, it always returns to the previous crosshair state on exit. Additionally, the "Left Click:" label is changed to the "Click a Mouse Button". Alternatively labels can be supplied through the optional label keyword.

See the IDL documentation for the events available from a DRAW_WIDGET. Users should use click in most cases.

Returns
mouse event structure.
Uses
gbtcursormoved
Version
$Id$
Common blocks
gbtplot_common

Keywords
noshow
in, optional
boolean
If set, then the plotter will not be brought to the foreground (shown).
nocrosshair
in, optional
boolean
If set, the the whatever the current crosshair state is, it will not be changed during this function. Normally, this function ensures that the crosshairs are on.
label
in, optional
string
A label to use in the "Left Click:" field of the plotter. Defaults to "Click a Mouse Button".


Produced by IDLdoc 1.6 on Wed Sep 28 13:27:21 2016