Changeset 799

Timestamp:

04/27/06 15:17:59 (2 years ago)

Author:

bob@redivi.com

Message:

merge beau's doc tweaks to 1.3.1 branch

Files:

• mochikit/branches/MochiKit-1.3.1/doc/html/MochiKit/Signal.html (modified) (3 diffs)
• mochikit/branches/MochiKit-1.3.1/doc/rst/MochiKit/Signal.rst (modified) (3 diffs)

mochikit/branches/MochiKit-1.3.1/doc/html/MochiKit/Signal.html

@@ -181 +181 @@
-works.</blockquote>
-<p>
+<a name="fn-disconnectall"></a>
+<a class="mochidef reference" href="#fn-disconnectall">disconnectAll(src[, signal, ...])</a>:</p>
+<blockquote>
+<p><tt class="docutils literal"><span class="pre">disconnectAll(src)</span></tt> removes all signals from src.</p>
+<p><tt class="docutils literal"><span class="pre">disconnectAll(src,</span> <span class="pre">'onmousedown',</span> <span class="pre">'mySignal')</span></tt> will remove all
+<tt class="docutils literal"><span class="pre">'onmousedown'</span></tt> and <tt class="docutils literal"><span class="pre">'mySignal'</span></tt> signals from src.</p>
+</blockquote>
+<p>
-<a name="fn-signal"></a>
-<a class="mochidef reference" href="#fn-signal">signal(src, signal, ...)</a>:</p>
@@ -238 +246 @@
-<a class="mochidef reference" href="#fn-key">key()</a>:</p>
-<blockquote>
-{code, string}
+<tt class="docutils literal"><span class="pre">{code,</span> <span class="pre">string}</span></tt>
-<p>Use <tt class="docutils literal"><span class="pre">'onkeydown'</span></tt> and <tt class="docutils literal"><span class="pre">'onkeyup'</span></tt> handlers to detect control
-characters such as <tt class="docutils literal"><span class="pre">'KEY_F1'</span></tt>. Use the <tt class="docutils literal"><span class="pre">'onkeypressed'</span></tt> handler to
@@ -273 +281 @@
-<blockquote>
-<ul class="simple">
-{left, right, middle}
+<tt class="docutils literal"><span class="pre">{left,</span> <span class="pre">right,</span> <span class="pre">middle}</span></tt>
-property is <tt class="docutils literal"><span class="pre">true</span></tt> if the mouse button was pressed, <tt class="docutils literal"><span class="pre">false</span></tt>
-otherwise.</li>

mochikit/branches/MochiKit-1.3.1/doc/rst/MochiKit/Signal.rst

@@ -203 +203 @@
-
-
+:mochidef:`disconnectAll(src[, signal, ...])`:
+
+    ``disconnectAll(src)`` removes all signals from src.
+    
+    ``disconnectAll(src, 'onmousedown', 'mySignal')`` will remove all
+    ``'onmousedown'`` and ``'mySignal'`` signals from src.
+
+
+
-:mochidef:`signal(src, signal, ...)`:
-
@@ -259 +268 @@
-:mochidef:`key()`:
-
-{code, string}
+``{code, string}``
-    
-    Use ``'onkeydown'`` and ``'onkeyup'`` handlers to detect control
@@ -295 +304 @@
-    ``'ondblclick'``:
-
-{left, right, middle}
+``{left, right, middle}``
-            property is ``true`` if the mouse button was pressed, ``false`` 
-            otherwise.
-
-    Known browser bugs:
-
+
-        -   Current versions of Safari won't signal ``'ondblclick'`` when
-            attached via ``connect()`` (`Safari Bug 7790`_).