callbacks.empty.xml

<?xml version="1.0"?>
<entry name="callbacks.empty" type="method" return="Callbacks">
  <title>callbacks.empty()</title>
  <signature>
    <added>1.7</added>
  </signature>
  <desc>Remove all of the callbacks from a list.</desc>
  <longdesc>
    <p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
    <h2 id="example-1">Example</h2>
    <p>Use <code>callbacks.empty()</code> to empty a list of callbacks:</p>
    <pre><code><![CDATA[// a sample logging function to be added to a callbacks list
var foo = function( value1, value2 ) {
  console.log( "foo: " + value1 + "," + value2 );
}

// another function to also be added to the list
var bar = function( value1, value2 ){
    console.log( "bar: " + value1 + "," + value2 );
}

var callbacks = $.Callbacks();

// add the two functions
callbacks.add( foo );
callbacks.add( bar );

// empty the callbacks list
callbacks.empty();

// check to ensure all callbacks have been removed
console.log( callbacks.has( foo ) );
// false
console.log( callbacks.has( bar ) );
// false
]]></code></pre>
  </longdesc>
  <category slug="callbacks-object"/>
  <category slug="version/1.7"/>
</entry>