<doc>

<legacy_id>2139</legacy_id>

<name>clickLoc</name>

<type>function</type>

<syntax>

<example>the clickLoc</example>

<example>clickLoc()</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

<function tag="mouseClick">mouseClick Function</function>

<function tag="clickStack">clickStack Function</function>

<function tag="selectedLoc">selectedLoc Function</function>

<function tag="clickH">clickH Function</function>

<command tag="click">click Command</command>

<command tag="popup">popup Command</command>

<message tag="linkClicked">linkClicked Message</message>

<message tag="mouseStillDown">mouseStillDown Message</message>

<message tag="mouseDoubleUp">mouseDoubleUp Message</message>

</references>

<history>

<introduced version="1.0">Added.</introduced>

</history>

<platforms>

<mac/>

<windows/>

<linux/>

<ios/>

<android/>

</platforms>

<classes>

<desktop/>

<web/>

<mobile/>

</classes>

<security>

</security>

<summary><glossary tag="return">Returns</glossary> the position of the most recent mouse click.</summary>

<examples>

<example>the clickLoc</example>

<example>if the clickLoc is the mouseLoc then send mouseUp to me</example>

</examples>

<description>

<p>Use the <b>clickLoc</b> <control_st tag="function">function</control_st> to determine where a user clicked, or to determine whether the <glossary tag="mouse pointer">mouse pointer</glossary> has moved since the last click.</p><p/><p><b>Value:</b></p><p>The <b>clickLoc</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> two <glossary tag="integer">integers</glossary> separated by a comma.</p><p/><p><b>Comments:</b></p><p>The first item of the returned value is the horizontal distance in pixels from the left edge of the clicked stack to the location of the click. (Use the <b>clickStack</b> function to identify which <object tag="stack">stack</object> was clicked.) The second <keyword tag="item">item</keyword> of the <glossary tag="return value">returned value</glossary> is the vertical distance from the top edge of the clicked <object tag="stack">stack</object> to the location of the click.</p><p/><p>The click location is the position of the mouse pointer when the user pressed the mouse button, not when the user released the button. In particular, inside a mouseDown handler, the clickLoc returns the position of the mouse as it was when the mouse down action occured.</p><p/><p>The first item of the <b>clickLoc</b> is equal to the <function tag="clickH">clickH</function>. The second <keyword tag="item">item</keyword> is equal to the <function tag="clickV">clickV</function>.</p>

</description>

</doc>