added deltaMode attribute to WheelEvent interface, fixed some accidental omissions
authorschepers
Thu, 27 Aug 2009 14:52:52 +0900
changeset 145 b9ade31ad0b2
parent 144 55c253dd97a0
child 146 afaec6bb0c16
added deltaMode attribute to WheelEvent interface, fixed some accidental omissions
html/DOM3-Events.html
--- a/html/DOM3-Events.html	Thu Aug 27 13:23:23 2009 +0900
+++ b/html/DOM3-Events.html	Thu Aug 27 14:52:52 2009 +0900
@@ -3342,12 +3342,62 @@
               <dd>
                 <dl>
                   <dt><code class="method-name">
-                      <a id="events-Events-Event-initMouseWheelEventNS">initMouseWheelEventNS</a>
-                    </code>
+                      <a id="events-Events-Event-initMouseWheelEvent">initMouseWheelEvent</a>
+                    </code> introduced in <strong class="since">DOM Level 3</strong>
                   </dt>
                   <dd>
                     <div class="method">Initializes attributes of a <code>MouseWheelEvent</code> object. This method has the same behavior as <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a>.
-    <div class="parameters">
+                      <div class="parameters">
+                        <strong>Parameters</strong>
+                        <div class="paramtable">
+                          <dl>
+                            <dt><code class="parameter-name">typeArg</code> of type <code>DOMString</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">canBubbleArg</code> of type <code>boolean</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">cancelableArg</code> of type <code>boolean</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">viewArg</code> of type <code>views::AbstractView</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">detailArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">screenXArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">screenYArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">clientXArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">clientYArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">buttonArg</code> of type <code>unsigned short</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">relatedTargetArg</code> of type <a href="#events-Events-EventTarget"><code>EventTarget</code></a></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">modifiersListArg</code> of type <code>DOMString</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">wheelDeltaArg</code> of type <code>long</code></dt>
+                            <dd>Specifies <a href="#events-Events-MouseWheelEvent-wheelDelta"><code>MouseWheelEvent.wheelDelta</code></a>.<br/></dd>
+                          </dl>
+                        </div>
+                      </div>
+                      <!-- parameters -->
+                      <div>
+                        <strong>No Return Value</strong>
+                      </div>
+                      <div>
+                        <strong>No Exceptions</strong>
+                      </div>
+                    </div>
+                    <!-- method -->
+                  </dd>
+                  
+                  <dt><code class="method-name">
+                      <a id="events-Events-Event-initMouseWheelEventNS">initMouseWheelEventNS</a>
+                    </code> introduced in <strong class="since">DOM Level 3</strong>
+                  </dt>
+                  <dd>
+                    <div class="method">Initializes attributes of a <code>MouseWheelEvent</code> object. This method has the same behavior as <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a>.
+                      <div class="parameters">
                         <strong>Parameters</strong>
                         <div class="paramtable">
                           <dl>
@@ -3465,9 +3515,6 @@
     movement along a flat surface, or pressure on a particular button.</dd>
         </dl>
 
-        <p class="issue">Should we include some additional attribute that denotes what units the roll is in, such as pixels or lines?  See <a href="http://www.w3.org/2008/webapps/track/issues/9"
-            title="ISSUE-9 - Web Applications Working Group Tracker">ISSUE-9</a>.</p>
-
         <dl>
           <dt><strong>Interface <em>
                 <a id="events-Events-WheelEvent">WheelEvent</a>
@@ -3485,9 +3532,16 @@
                   <pre>
     // Introduced in DOM Level 3:
     interface <a class="noxref" href="#events-Events-WheelEvent">WheelEvent</a> : <a class="noxref" href="#events-Events-MouseEvent">MouseEvent</a> {
+
+    // DeltaModeCode
+    const unsigned long       <a class="noxref" href="#events-DOM_DELTA_PIXEL">DOM_DELTA_PIXEL</a>       = 0x00;
+    const unsigned long       <a class="noxref" href="#events-DOM_DELTA_LINE">DOM_DELTA_LINE</a>        = 0x01;
+    const unsigned long       <a class="noxref" href="#events-DOM_DELTA_PAGE">DOM_DELTA_PAGE</a>        = 0x02;
+
     readonly attribute long            <a class="noxref" href="#events-Events-WheelEvent-deltaX">deltaX</a>;
     readonly attribute long            <a class="noxref" href="#events-Events-WheelEvent-deltaY">deltaY</a>;
     readonly attribute long            <a class="noxref" href="#events-Events-WheelEvent-deltaZ">deltaZ</a>;
+    readonly attribute unsigned long   <a class="noxref" href="#events-Events-WheelEvent-deltaMode">deltaMode</a>;    
     void               <a class="noxref" href="#events-Events-Event-initWheelEvent">initWheelEvent</a>(in DOMString typeArg, 
                                               in boolean canBubbleArg, 
                                               in boolean cancelableArg, 
@@ -3502,7 +3556,8 @@
                                               in DOMString modifiersListArg, 
                                               in long deltaXArg, 
                                               in long deltaYArg, 
-                                              in long deltaZArg);
+                                              in long deltaZArg, 
+                                              in unsigned long deltaMode);
     void               <a class="noxref" href="#events-Events-Event-initWheelEventNS">initWheelEventNS</a>(in DOMString namespaceURIArg, 
                                               in DOMString typeArg, 
                                               in boolean canBubbleArg, 
@@ -3518,13 +3573,39 @@
                                               in DOMString modifiersListArg, 
                                               in long deltaXArg, 
                                               in long deltaYArg, 
-                                              in long deltaZArg);
+                                              in long deltaZArg, 
+                                              in unsigned long deltaMode);
     };
     </pre>
                 </div>
                 <br/>
               </dd>
               <dt>
+                <strong>Definition group <em>
+                    <a id="events-ID-WheelEvent-DeltaModeCode">DeltaModeCode</a>
+                  </em></strong>
+              </dt>
+              <dd>
+                <p>This set of constants shall be used to indicate the units of measurement for the <a href="#events-Events-WheelEvent-delta"><code>delta</code></a> values.  The precise measurement is specific to device, operating system, and application configurations.</p>
+                <dl>
+                  <dt>
+                    <strong>Defined Constants</strong>
+                  </dt>
+                  <dd>
+                    <dl>
+                      <dt><a id="events-DOM_DELTA_PIXEL"><code class="constant-name">DOM_DELTA_PIXEL</code></a></dt>
+                      <dd>The units of measurement for the <a href="#events-Events-WheelEvent-delta"><code>delta</code></a> shall be pixels.  This is the most typical case in most operating system and implementation configurations.</dd>
+
+                      <dt><a id="events-DOM_DELTA_LINE"><code class="constant-name">DOM_DELTA_LINE</code></a></dt>
+                      <dd>The units of measurement for the <a href="#events-Events-WheelEvent-delta"><code>delta</code></a> shall be individual lines of text.  This is the case for many form controls.</dd>
+
+                      <dt><a id="events-DOM_DELTA_PAGE"><code class="constant-name">DOM_DELTA_PAGE</code></a></dt>
+                      <dd>The units of measurement for the <a href="#events-Events-WheelEvent-delta"><code>delta</code></a> shall be pages, either defined as a single screen or as a demarcated page.</dd>
+                    </dl>
+                  </dd>
+                </dl>
+              </dd>
+              <dt>
                 <strong>Attributes</strong>
               </dt>
               <dd>
@@ -3541,6 +3622,14 @@
                       <a id="events-Events-WheelEvent-deltaZ">deltaZ</a>
                     </code> of type <code>long</code>, readonly</dt>
                   <dd>The distance the wheel has rotated around the z-axis.<br/></dd>
+                  <dt><code class="attribute-name">
+                      <a id="events-Events-WheelEvent-deltaMode">deltaMode</a>
+                    </code> of type <code>unsigned long</code>, readonly</dt>
+                  <dd>The <code>deltaMode</code> attribute contains an indication of to indicate the units of measurement for the <a href="#events-Events-WheelEvent-delta"><code>delta</code></a> values.  The default value is <a href="#events-DOM_DELTA_PIXEL"><code class="constant-name">DOM_DELTA_PIXEL</code></a> (pixels).  The value of <code>deltaMode</code> may be different for each of <code class="attribute-name"><a href="#events-Events-WheelEvent-deltaX">deltaX</a></code>, <code class="attribute-name"><a href="#events-Events-WheelEvent-deltaY">deltaY</a></code>, and <code class="attribute-name"><a href="#events-Events-WheelEvent-deltaZ">deltaZ</a></code>, based on system configuration.<br/>
+
+                    <p class="issue">@@ deltaMode is the proposed solution for <a href="http://www.w3.org/2008/webapps/track/issues/9" title="ISSUE-9 - Web Applications Working Group Tracker">ISSUE-9</a>.</p>
+
+                  </dd>
                 </dl>
               </dd>
               <dt>
@@ -3549,12 +3638,69 @@
               <dd>
                 <dl>
                   <dt><code class="method-name">
-                      <a id="events-Events-Event-initWheelEventNS">initWheelEventNS</a>
-                    </code>
+                      <a id="events-Events-Event-initWheelEvent">initWheelEvent</a>
+                    </code> introduced in <strong class="since">DOM Level 3</strong>
                   </dt>
                   <dd>
                     <div class="method">Initializes attributes of a <code>WheelEvent</code> object. This method has the same behavior as <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a>.
-    <div class="parameters">
+                      <div class="parameters">
+                        <strong>Parameters</strong>
+                        <div class="paramtable">
+                          <dl>
+                            <dt><code class="parameter-name">typeArg</code> of type <code>DOMString</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">canBubbleArg</code> of type <code>boolean</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">cancelableArg</code> of type <code>boolean</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">viewArg</code> of type <code>views::AbstractView</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">detailArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initUIEventNS"><code>UIEvent.initUIEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">screenXArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">screenYArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">clientXArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">clientYArg</code> of type <code>long</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">buttonArg</code> of type <code>unsigned short</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">relatedTargetArg</code> of type <a href="#events-Events-EventTarget"><code>EventTarget</code></a></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">modifiersListArg</code> of type <code>DOMString</code></dt>
+                            <dd>Refer to the <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a> method for a description of this parameter.<br/></dd>
+                            <dt><code class="parameter-name">deltaXArg</code> of type <code>long</code></dt>
+                            <dd>Specifies <a href="#events-Events-WheelEvent-deltaX"><code>WheelEvent.deltaX</code></a>.<br/></dd>
+                            <dt><code class="parameter-name">deltaYArg</code> of type <code>long</code></dt>
+                            <dd>Specifies <a href="#events-Events-WheelEvent-deltaY"><code>WheelEvent.deltaY</code></a>.<br/></dd>
+                            <dt><code class="parameter-name">deltaZArg</code> of type <code>long</code></dt>
+                            <dd>Specifies <a href="#events-Events-WheelEvent-deltaZ"><code>WheelEvent.deltaZ</code></a>.<br/></dd>
+                            <dt><code class="parameter-name">deltaModeArg</code> of type <code>unsigned long</code></dt>
+                            <dd>Specifies <a href="#events-Events-WheelEvent-deltaMode"><code>WheelEvent.deltaMode</code></a>.<br/></dd>
+                          </dl>
+                        </div>
+                      </div>
+                      <!-- parameters -->
+                      <div>
+                        <strong>No Return Value</strong>
+                      </div>
+                      <div>
+                        <strong>No Exceptions</strong>
+                      </div>
+                    </div>
+                    <!-- method -->
+                  </dd>
+
+
+                  <dt><code class="method-name">
+                      <a id="events-Events-Event-initWheelEventNS">initWheelEventNS</a>
+                    </code> introduced in <strong class="since">DOM Level 3</strong>
+                  </dt>
+                  <dd>
+                    <div class="method">Initializes attributes of a <code>WheelEvent</code> object. This method has the same behavior as <a href="#events-Events-Event-initMouseEventNS"><code>MouseEvent.initMouseEventNS()</code></a>.
+                      <div class="parameters">
                         <strong>Parameters</strong>
                         <div class="paramtable">
                           <dl>
@@ -3590,6 +3736,8 @@
                             <dd>Specifies <a href="#events-Events-WheelEvent-deltaY"><code>WheelEvent.deltaY</code></a>.<br/></dd>
                             <dt><code class="parameter-name">deltaZArg</code> of type <code>long</code></dt>
                             <dd>Specifies <a href="#events-Events-WheelEvent-deltaZ"><code>WheelEvent.deltaZ</code></a>.<br/></dd>
+                            <dt><code class="parameter-name">deltaModeArg</code> of type <code>unsigned long</code></dt>
+                            <dd>Specifies <a href="#events-Events-WheelEvent-deltaMode"><code>WheelEvent.deltaMode</code></a>.<br/></dd>
                           </dl>
                         </div>
                       </div>