Error getting tags :
error 404Error getting tags :
error 404 mouseChunk | revDocs | RunRev
Welcome Guest (Log in)
Product Edition
Version
mouseChunk
Basics
Expander triangle
Type
Function
Syntax
the mouseChunk mouseChunk()
Introduced
1.0
Environment
Desktop, Web and Server
Platform Support
MacOS,Mac OS X,Windows,Linux
Security
None required
Summary
Returns a chunk expression describing the location of the word or text group under the mouse pointer.
Examples

the mouseChunk
if the shiftKey is down then select the mouseChunk

Additional Comments
Expander triangle

Use the mouseChunk function within a handler to determine which word or text group the mouse is hovering over, in order to take some action based on the current character.

Value:

The mouseChunk function returns a chunk expression of the form char startChar to endChar of field fieldNumber.

Comments:

The mouseChunk function only returns locations in a field. If the mouse pointer is not over a field, the mouseChunk function returns empty.

The return value reports the word the mouse is over. The startChar is the first character of the word, and the endChar is the last character. If the textStyle of the text is "link", the return value specifies the entire text group.

To get the text of the word or text group, use the mouseText function.

Important! Words are defined a little differently by the mouseChunkfunction than the way they are used in chunk expressions. A word, for purposes of the mouseChunk, is any text delimited by spaces, tabs, returns, or punctuation. If the mouse pointer is over a punctuation character, only that character is returned.

User Comments
Expander triangle