aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJohn Resig <jeresig@gmail.com>2006-09-16 22:48:53 +0000
committerJohn Resig <jeresig@gmail.com>2006-09-16 22:48:53 +0000
commit394334671cd4a0b22c01f724b30933fc83df863d (patch)
tree966944812b0a67e7284fcd8b0891c34b12dd8fbe
parent060c55bf043922401cb033117a3091ad24dbf047 (diff)
downloadjquery-394334671cd4a0b22c01f724b30933fc83df863d.tar.gz
jquery-394334671cd4a0b22c01f724b30933fc83df863d.zip
Weird, I never committed the docs for mouseover.
-rw-r--r--src/event/event.js68
1 files changed, 68 insertions, 0 deletions
diff --git a/src/event/event.js b/src/event/event.js
index 583f8f5eb..ff1d936fd 100644
--- a/src/event/event.js
+++ b/src/event/event.js
@@ -1451,6 +1451,74 @@ new function(){
* @cat Events/Mouse
*/
+ /**
+ * Bind a function to the mouseover event of each matched element.
+ *
+ * @example $("p").mouseover( function() { alert("Hello"); } );
+ * @before <p>Hello</p>
+ * @result <p onmouseover="alert('Hello');">Hello</p>
+ *
+ * @name mouseover
+ * @type jQuery
+ * @param Function fn A function to bind to the mousedown event on each of the matched elements.
+ * @cat Events/Mouse
+ */
+
+ /**
+ * Trigger the mouseover event of each matched element. This causes all of the functions
+ * that have been bound to thet mousedown event to be executed.
+ *
+ * @example $("p").mouseover();
+ * @before <p onmouseover="alert('Hello');">Hello</p>
+ * @result alert('Hello');
+ *
+ * @name mouseover
+ * @type jQuery
+ * @cat Events/Mouse
+ */
+
+ /**
+ * Bind a function to the mouseover event of each matched element, which will only be executed once.
+ * Unlike a call to the normal .mouseover() method, calling .onemouseover() causes the bound function to be
+ * only executed the first time it is triggered, and never again (unless it is re-bound).
+ *
+ * @example $("p").onemouseover( function() { alert("Hello"); } );
+ * @before <p onmouseover="alert('Hello');">Hello</p>
+ * @result alert('Hello'); // Only executed for the first mouseover
+ *
+ * @name onemouseover
+ * @type jQuery
+ * @param Function fn A function to bind to the mouseover event on each of the matched elements.
+ * @cat Events/Mouse
+ */
+
+ /**
+ * Removes a bound mouseover event from each of the matched
+ * elements. You must pass the identical function that was used in the original
+ * bind method.
+ *
+ * @example $("p").unmouseover( myFunction );
+ * @before <p onmouseover="myFunction">Hello</p>
+ * @result <p>Hello</p>
+ *
+ * @name unmouseover
+ * @type jQuery
+ * @param Function fn A function to unbind from the mouseover event on each of the matched elements.
+ * @cat Events/Mouse
+ */
+
+ /**
+ * Removes all bound mouseover events from each of the matched elements.
+ *
+ * @example $("p").unmouseover();
+ * @before <p onmouseover="alert('Hello');">Hello</p>
+ * @result <p>Hello</p>
+ *
+ * @name unmouseover
+ * @type jQuery
+ * @cat Events/Mouse
+ */
+
/**
* @test var count;
* var e = ("blur,focus,load,resize,scroll,unload,click,dblclick," +