<doc>
  <legacy_id>2217</legacy_id>
  <name>tool</name>
  <type>property</type>
  <syntax>
    <example>set the tool [of <i>stack</i>] to <i>toolName</i></example>
  </syntax>
  <library></library>
  <objects>
    <global/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Developing with LiveCode</category>
  </classification>
  <references>
    <command tag="choose">choose Command</command>
    <property tag="powerKeys">powerKeys Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary>Specifies which <function tag="tool">tool</function> is currently chosen.</summary>
  <examples>
    <example>set the tool to "button tool"</example>
    <example>set the tool to pointer</example>
  </examples>
  <description>
    <p>Use the <b>tool</b> <glossary tag="property">property</glossary> to check which <function tag="tool">tool</function> is in use before performing an action that depends on the <function tag="tool">tool</function>.</p><p/><p><b>Value:</b></p><p>The <b>tool</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> one of the following <function tag="tool">tool</function> names:</p><p/><p><code>browse</code>,<code> pointer</code>,<code> button</code>,<code> field</code>,<code> scrollbar</code>,<code> graphic</code>,<code> image</code>,<code> player</code>,<code> select</code>,<code> pencil</code>,<code> bucket</code>,<code> brush</code>,<code> eraser</code>,<code> spray can</code>,<code> rectangle</code>,<code> line</code>,<code> round rect</code>,<code> oval</code>,<code> polygon</code>,<code> curve</code>,<code> regular polygon</code>, <code>dropper</code></p><p/><p>followed by the word "<code>tool</code>".</p><p/><p>When setting the <b>tool</b> <glossary tag="property">property</glossary>, you can omit the word "<code>tool</code>".</p><p/><p><b>Comments:</b></p><p>The tool names are the same as the names used with the <b>choose</b> <glossary tag="command">command</glossary> to select a <function tag="tool">tool</function> for use.</p><p/><p>Setting the <b>tool</b> is equivalent to choosing the <function tag="tool">tool</function> with the <command tag="choose">choose</command> <glossary tag="command">command</glossary>.</p>
  </description>
</doc>