<doc>
  <legacy_id>1440</legacy_id>
  <name>mouseChunk</name>
  <type>function</type>
  <syntax>
    <example>the mouseChunk</example>
    <example>mouseChunk()</example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <function tag="mouseCharChunk">mouseCharChunk Function</function>
    <function tag="selectedChunk">selectedChunk Function</function>
    <function tag="dropChunk">dropChunk Function</function>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary><glossary tag="return">Returns</glossary> a <glossary tag="chunk expression">chunk expression</glossary> describing the location of the <keyword tag="word">word</keyword> or <glossary tag="grouped text">text group</glossary> under the <glossary tag="mouse pointer">mouse pointer</glossary>.</summary>
  <examples>
    <example>the mouseChunk</example>
    <example>if the shiftKey is down then select the mouseChunk</example>
  </examples>
  <description>
    <p>Use the <b>mouseChunk</b> <control_st tag="function">function</control_st> within a <glossary tag="handler">handler</glossary> to determine which <keyword tag="word">word</keyword> or <glossary tag="grouped text">text group</glossary>  the mouse is hovering over, in order to take some action based on the current <keyword tag="character">character</keyword>.</p><p/><p><b>Value:</b></p><p>The <b>mouseChunk</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> a <glossary tag="chunk expression">chunk expression</glossary> of the form<code> char <i>startChar</i> to <i>endChar</i> of field <i>fieldNumber</i></code>.</p><p/><p><b>Comments:</b></p><p>The <b>mouseChunk</b> <control_st tag="function">function</control_st> only <glossary tag="return">returns</glossary> locations in a <keyword tag="field">field</keyword>. If the <glossary tag="mouse pointer">mouse pointer</glossary> is not over a <keyword tag="field">field</keyword>, the <b>mouseChunk</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> empty.</p><p/><p>The return value reports the word the mouse is over. The <i>startChar</i> is the first <keyword tag="character">character</keyword> of the <keyword tag="word">word</keyword>, and the <i>endChar</i> is the last <keyword tag="character">character</keyword>. If the <property tag="textStyle">textStyle</property> of the text is "link", the <glossary tag="return value">return value</glossary> specifies the entire <glossary tag="grouped text">text group</glossary>.</p><p/><p>To get the text of the word or text group, use the <b>mouseText</b> <control_st tag="function">function</control_st>.</p><p/><p><code/><img src="202653"/> <b>Important!</b><code/> Words are defined a little differently by the <b>mouseChunk</b> <control_st tag="function">function</control_st> than the way they are used in <glossary tag="chunk expression">chunk expressions</glossary>. A word, for purposes of the <b>mouseChunk</b>, is any text delimited by spaces, tabs, returns, or punctuation. If the mouse pointer is over a punctuation <keyword tag="character">character</keyword>, only that <keyword tag="character">character</keyword> is returned.</p>
  </description>
</doc>