<doc>

<legacy_id>1093</legacy_id>

<name>clickStack</name>

<type>function</type>

<syntax>

<example>the clickStack</example>

<example>clickStack()</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

<property tag="backdrop">backdrop Property</property>

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

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

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

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

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

<property tag="defaultStack">defaultStack Property</property>

<property tag="name">name Property</property>

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

</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 name of the <object tag="stack">stack</object> in which the user most recently clicked the mouse.</summary>

<examples>

<example>the clickStack</example>

<example>repeat until (the short name of the clickStack is "Icon Palette")</example>

<example>if the name of the clickStack is not the defaultStack then beep</example>

</examples>

<description>

<p>Use the <b>clickStack</b> <control_st tag="function">function</control_st> to determine which window the user clicked, or, in conjunction with the <function tag="clickField">clickField</function>, <function tag="clickLine">clickLine</function>, or <function tag="clickChunk">clickChunk</function>, to determine which <keyword tag="field">field</keyword> was clicked.</p><p/><p><b>Value:</b></p><p>The <b>clickStack</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> the long <property tag="name">name</property> <glossary tag="property">property</glossary> of the <object tag="stack">stack</object> that was last clicked.</p><p/><p><b>Comments:</b></p><p>If the user clicks a stack's title bar or border to bring it to the front, the value returned by the <b>clickStack</b> does not change. Only clicking in the <glossary tag="stack window">stack window's</glossary> content area changes the <b>clickStack</b> <function tag="value">value</function>.</p><p/><p>If the user clicks the backdrop, the <b>clickStack</b> <glossary tag="return">returns</glossary> empty.</p>

</description>

</doc>