mouseover()

Function groupExecute on clientPlatform(s)
MouseNOAll

Syntax

mouseover(constant[,tablefield])

Description

Returns information about the mouse position defined by a mouseover constant (e.g. kMLine) when mouseover is called. If using kMItemref and 'tablefield' is kTrue enterable table rows fields are checked

The function only works in an "open" user-defined window (not reports or searches). Moreover, it returns references only for fields and not background objects (text and graphic objects).

The mouse position is returned in a variety of ways depending on the constant you use. You can use the following constants:

kMCharpos returns the character position where the mouse is located in an edit field under the mouse.
kMComplexGridRow returns the complex grid row.
kMHorz returns the horizontal position of the mouse relative to the topmost open user-defined window; if no user-defined window is open, returns the horizontal position of the mouse relative to the Omnis application window.
kMHorzCell returns the horizontal column number of a headed list,tree control,string grid, or data grid.
kMItemref returns an item reference to the object under the mouse. A window instance can be returned if the mouse is not over a window object.
kMLine returns the line number for a list. For a complex grid, use kMComplexGridRow.
kMPLine returns the line of the parent list the mouse is over.
kMScreenPos returns a row with 2 columns (h and v) which are the horizontal and vertical mouse position in screen coordinates.
kMVert returns the vertical position of the mouse relative to the topmost open user-defined window; if no user-defined window is open, returns the relative position to the Omnis application window.