<doc>
  <legacy_id>1164</legacy_id>
  <name>mouseCharChunk</name>
  <type>function</type>
  <syntax>
    <example>the mouseCharChunk</example>
    <example>mouseCharChunk()</example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <function tag="charToNum">charToNum Function</function>
    <function tag="clickCharChunk">clickCharChunk Function</function>
    <property tag="lockText">lockText Property</property>
    <function tag="mouseChar">mouseChar Function</function>
    <function tag="mouseChunk">mouseChunk Function</function>
    <function tag="mouseControl">mouseControl Function</function>
    <function tag="mouseLoc">mouseLoc Function</function>
    <message tag="mouseMove">mouseMove Message</message>
    <function tag="mouseStack">mouseStack Function</function>
    <function tag="mouseText">mouseText Function</function>
    <function tag="mouseLine">mouseLine 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="character">character</keyword> under the <glossary tag="mouse pointer">mouse pointer</glossary>.</summary>
  <examples>
    <example>the mouseCharChunk</example>
    <example>if the mouseChar is empty then select the mouseCharChunk</example>
  </examples>
  <description>
    <p>Use the <b>mouseChar</b> <control_st tag="function">function</control_st> within a <glossary tag="handler">handler</glossary> to determine which <keyword tag="character">character</keyword> 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>mouseCharChunk</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> charNumbe</i>r to<i> charNumbe</i>r of field<i> fieldNumbe</i></code>r.</p><p/><p><b>Comments:</b></p><p>The <b>mouseCharChunk</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>mouseCharChunk</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> empty.</p><p/><p>The first and second character numbers in the return value are always identical, unless the mouse is over a field but there is no text under it. In this case, the <b>mouseCharChunk</b> <glossary tag="return">returns</glossary> a <glossary tag="chunk expression">chunk expression</glossary> of the form<code> char <i>charNumber</i> to <i>charNumber - 1</i> of field <i>fieldNumber</i></code>, indicating the start of the <function tag="mouseLine">mouseLine</function>. For example, if the mouse is over an empty <keyword tag="field">field</keyword>, the <b>mouseCharChunk</b> <glossary tag="return">returns</glossary> <code>char 1 to 0 of field <i>fieldNumber</i></code>.</p><p/><p>To get the actual character clicked, use the <b>mouseChar</b> <control_st tag="function">function</control_st>.</p>
  </description>
</doc>