<doc>
  <legacy_id>1594</legacy_id>
  <name>idleRate</name>
  <type>property</type>
  <syntax>
    <example>set the idleRate to <i>number</i></example>
  </syntax>
  <library></library>
  <objects>
    <global/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Objects &amp; Messages</category>
    <category>User Interaction</category>
  </classification>
  <references>
    <property tag="blinkRate">blinkRate Property</property>
    <message tag="idle">idle Message</message>
    <property tag="idleTicks">idleTicks Property</property>
    <property tag="effectRate">effectRate Property</property>
  </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>Specifies the number of <function tag="milliseconds">milliseconds</function> between <message tag="idle">idle</message>, <message tag="mouseStillDown">mouseStillDown</message>, and <message tag="mouseWithin">mouseWithin</message> <glossary tag="message">messages</glossary>.</summary>
  <examples>
    <example>set the idleRate to 500 <code><i>-- one idle message per half second</i></code></example>
  </examples>
  <description>
    <p>Adjust the <b>idleRate</b> <glossary tag="property">property</glossary> to change the interval between periodically-sent <glossary tag="message">messages</glossary>. Increasing the <b>idleRate</b> causes these <glossary tag="message">messages</glossary> to be sent less frequently, and decreases the amount of CPU time the <glossary tag="application">application</glossary> uses.</p><p/><p><b>Value:</b></p><p>The <b>idleRate</b> is an <keyword tag="integer">integer</keyword> between zero and 65535.</p><p/><p>By default, the <b>idleRate</b> <glossary tag="property">property</glossary> is set to 200 (one-fifth of a second).</p><p/><p><b>Comments:</b></p><p>The <b>idleRate</b> is the time in <function tag="milliseconds">milliseconds</function> between one <message tag="idle">idle</message> <keyword tag="message box">message</keyword> and the next, one <message tag="mouseStillDown">mouseStillDown</message> <keyword tag="message box">message</keyword> and the next, and one <message tag="mouseWithin">mouseWithin</message> <keyword tag="message box">message</keyword> and the next.</p><p/><p><code/><img src="202653"/> <b>Important!</b><code/> Some <glossary tag="Unix">Unix systems</glossary> cannot reliably time an interval less than 200 <function tag="milliseconds">milliseconds</function>. Setting a shorter <b>idleRate</b> on those systems may cause <message tag="idle">idle</message> messages to be sent at erratic times.</p><p/><p>This property is very similar to the <b>idleTicks</b> <glossary tag="property">property</glossary>, and changes when the <property tag="idleTicks">idleTicks</property> changes. The only difference is that the two <property tag="properties">properties</property> are given in different time units:  the <b>idleRate</b> is in <function tag="milliseconds">milliseconds</function> and the <property tag="idleTicks">idleTicks</property> is in <function tag="ticks">ticks</function>.</p>
  </description>
</doc>