Message/DOM/DOMMouseEvents.dis

Namespace:
  @DOMCore:
    http://suika.fam.cx/~wakaba/archive/2004/8/18/dom-core#
  @DOMEvents:
    http://suika.fam.cx/~wakaba/archive/2004/dom/events#
  @DOMViews:
    http://suika.fam.cx/~wakaba/archive/2004/dom/views#
  @ev:
    http://www.w3.org/2001/xml-events
  @lang:
     http://suika.fam.cx/~wakaba/archive/2004/8/18/lang#
  @license:
     http://suika.fam.cx/~wakaba/archive/2004/8/18/license#
  @ManakaiDOMEvents:
    http://suika.fam.cx/~wakaba/archive/2004/mdom-ev#
  @TreeCore:\
Module:
  @Name:  DOMMouseEvents
  @Namespace:
     http://suika.fam.cx/~wakaba/archive/2004/dom/events#
  @BindingName:
     @@@:  events
     @@Type:
        lang:IDL-DOM
     @@prefix:  dom.w3c.org
  @FullName:
    @@lang:en
    @@@: DOM Mouse Events Module
  @Description:
    @@lang:en
    @@@:
      This event module is specifically designed for use with 
      pointing input devices, such as a mouse or a track ball. 
      \
      The mouse event module is composed of events listed in 
      HTML 4.0 and additional events that are supported in 
      DOM Level 0 browsers.

  @Author:
     @@FullName:  Wakaba
     @@Mail:  w@suika.fam.cx
  @License:
     license:Perl+MPL
  @Date.RCS:
     $Date: 2004/10/16 13:34:17 $

  @ConditionDef:
    @@Name:DOM2
  @ConditionDef:
    @@Name:DOM3
    @@ISA:DOM2
  @NormalCondition:DOM3

  @Feature:
    @@Name:MouseEvents
    @@Version:2.0
    @@FullName: DOM Level 2 Mouse Events
    @@ImplNote:
      @@@lang:en
      @@@@:
        The support for <Feature:UIEvents>/<FeatureVer:2.0> is required.
    @@Condition[list]:
      DOM2
      DOM3
    @@Contrib:
      DOMCore:DOMImplementation::
  @Feature:
    @@Name:MouseEvents
    @@Version:3.0
    @@FullName: DOM Level 3 Mouse Events
    @@ImplNote:
      @@@lang:en
      @@@@:
        The support for <Feature:UIEvents>/<FeatureVer:3.0> is required.
    @@Condition[list]:
      DOM3
    @@Contrib:
      DOMCore:DOMImplementation::

  @Require:
     @@Module:
        @@@Name:  DOMUIEvents
        @@@FileName:
           @@@@@:  events.idl
           @@@@For:
              lang:IDL-DOM
        @@@Namespace:
           http://suika.fam.cx/~wakaba/archive/2004/dom/events#

EventSet:
  @Event:
    @@Name:click
    @@QName: 
      ev:click
    @@Description:
      @@@lang:en
      @@@@:
        A pointing device button is clicked over an element.  The 
        definition of a <QUOTE:click> depends on the environment 
        configuration.
       \
        In the case of nested elements, this event is always targeted 
        at the most deeply nested element.
       \
          Events <EV:ev:mousedown> and <EV:ev:mouseup> are 
          dispatched before the <EV:ev:click>.  The target node 
          must be the same betweeb these three events; otherwise, i.e. 
          <EV:ev:mousemove> and <EV:ev:mouseout> occur betweeb the 
          press and release of the button, <EV:ev:click> cannot occur.
    @@Type:MouseEvent
    @@IsBubbling:1
    @@IsCancelable:1
    @@EventTarget:
      @@@Type:
        DOMCore:Element
    @@SpecLevel:2
    @@ContextInfo:
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:altKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:ctrlKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:shiftKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:metaKey
      @@@ImplNote:
        @@@@lang:en
        @@@@@:
          <A:MouseEvent.altGraphKey>
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:button
      @@@Attr:
        @@@@IF:
          DOMUIEvents:UIEvent
        @@@@Name:view
      @@@Attr:
        @@@@IF:
          DOMUIEvents:UIEvent
        @@@@Name:detail
        @@@@Type:
          DOMMain:unsigned-long
        @@@@Description:
          @@@@@lang:en
          @@@@@@:
            The number of consecutive clicks of a pointing device button 
            during a user action.
          \
            {NOTE:: The notion of consecutive clicks depends on 
                    the environment configuration.
          \
            }
  @Event:
    @@Name:mousedown
    @@QName:
      ev:mousedown
    @@Description:
      @@@lang:en
      @@@@:
        A pointing device button is pressed over an element.
        \
        In the case of nested elements, this event is always targeted
        at the most deeply nested element.
    @@Type:MouseEvent
    @@IsBubbling:1
    @@IsCancelable:1
    @@EventTarget:
      @@@Type:
        DOMCore:Element
    @@SpecLevel:2
    @@ContextInfo:
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:altKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:ctrlKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:shiftKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:metaKey
      @@@ImplNote:
        @@@@lang:en
        @@@@@:
          <A:MouseEvent.altGraphKey>
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:button
      @@@Attr:
        @@@@IF:
          DOMUIEvents:UIEvent
        @@@@Name:view
      @@@Attr:
        @@@@IF:
          DOMUIEvents:UIEvent
        @@@@Name:detail
        @@@@Type:
          DOMMain:unsigned-long
        @@@@Description:
          @@@@@lang:en
          @@@@@@:
            The number of consecutive clicks of a pointing device button 
            during a user action.
          \
            {NOTE:: The notion of consecutive clicks depends on 
                    the environment configuration.
          \
            }
          \
            {eg:: 
              \
              If no click happend before the mousedown, 
              the value will be <DOM:1>.
              \
            }
  @Event:
    @@Name:mouseup
    @@QName:
      ev:mouseup
    @@Description:
      @@@lang:en
      @@@@:
        A pointing device button is released over an element.
        \
        In the case of nested elements, this event is always targeted
        at the most deeply nested element.
    @@Type:MouseEvent
    @@IsBubbling:1
    @@IsCancelable:1
    @@EventTarget:
      @@@Type:
        DOMCore:Element
    @@SpecLevel:2
    @@ContextInfo:
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:altKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:ctrlKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:shiftKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:metaKey
      @@@ImplNote:
        @@@@lang:en
        @@@@@:
          <A:MouseEvent.altGraphKey>
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:button
      @@@Attr:
        @@@@IF:
          DOMUIEvents:UIEvent
        @@@@Name:view
      @@@Attr:
        @@@@IF:
          DOMUIEvents:UIEvent
        @@@@Name:detail
        @@@@Type:
          DOMMain:unsigned-long
        @@@@Description:
          @@@@@lang:en
          @@@@@@:
            The number of consecutive clicks of a pointing device button 
            during a user action.
          \
            {NOTE:: The notion of consecutive clicks depends on 
                    the environment configuration.
          \
            }
  @Event:
    @@Name:mouseover
    @@QName:
      ev:mouseover
    @@Description:
      @@@lang:en
      @@@@:
        A pointing device is moved onto an element.
        \
        In the case of nested elements, this event is always targeted
        at the most deeply nested element.
    @@Type:MouseEvent
    @@IsBubbling:1
    @@IsCancelable:1
    @@EventTarget:
      @@@Type:
        DOMCore:Element
    @@SpecLevel:2
    @@ContextInfo:
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:altKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:ctrlKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:shiftKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:metaKey
      @@@ImplNote:
        @@@@lang:en
        @@@@@:
          <A:MouseEvent.altGraphKey>
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:button
      @@@Attr:
        @@@@IF:
          DOMUIEvents:UIEvent
        @@@@Name:view
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:relatedTarget
        @@@@Type:
          DOMEvents:EventTarget
        @@@@Description:
          @@@@@lang:en
          @@@@@@:
            The event target a pointing device is exiting.
  @Event:
    @@Name:mousemove
    @@QName:
      ev:mousemove
    @@Description:
      @@@lang:en
      @@@@:
        A pointing device is moved while it is over an element. 
        \
        In the case of nested elements, this event is always targeted
        at the most deeply nested element.
    @@Type:MouseEvent
    @@IsBubbling:1
    @@IsCancelable:1
    @@EventTarget:
      @@@Type:
        DOMCore:Element
    @@SpecLevel:2
    @@ContextInfo:
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:altKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:ctrlKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:shiftKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:metaKey
      @@@ImplNote:
        @@@@lang:en
        @@@@@:
          <A:MouseEvent.altGraphKey>
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:button
      @@@Attr:
        @@@@IF:
          DOMUIEvents:UIEvent
        @@@@Name:view
  @Event:
    @@Name:mouseout
    @@QName:
      ev:mouseout
    @@Description:
      @@@lang:en
      @@@@:
        A pointing device is moved away from an element.
        \
        In the case of nested elements, this event is always targeted
        at the most deeply nested element.
    @@Type:MouseEvent
    @@IsBubbling:1
    @@IsCancelable:1
    @@EventTarget:
      @@@Type:
        DOMCore:Element
    @@SpecLevel:2
    @@ContextInfo:
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:screenY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientX
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:clientY
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:altKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:ctrlKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:shiftKey
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:metaKey
      @@@ImplNote:
        @@@@lang:en
        @@@@@:
          <A:MouseEvent.altGraphKey>
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:button
      @@@Attr:
        @@@@IF:
          DOMUIEvents:UIEvent
        @@@@Name:view
      @@@Attr:
        @@@@IF:MouseEvent
        @@@@Name:relatedTarget
        @@@@Type:
          DOMEvents:EventTarget
        @@@@Description:
          @@@@@lang:en
          @@@@@@:
            The event target a pointing device is entering.
  @ImplNote:
    @@lang:en
    @@@:
      {P:: An <QUOTE:double click> will produce:
         \
         = <ev:mousedown> with <A:UIEvent.detail> that equals <DOM:1>.
         \
         = <ev:mouseup> with <A:UIEvent.detail> that equals <DOM:1>.
         \
         = <ev:mouseclick> with <A:UIEvent.detail> that equals <DOM:1>.
         \
         = <ev:mousedown> with <A:UIEvent.detail> that equals <DOM:2>.
         \
         = <ev:mouseup> with <A:UIEvent.detail> that equals <DOM:2>.
         \
         = <ev:mouseclick> with <A:UIEvent.detail> that equals <DOM:2>.
         \
      }
  @ImplNote:
    @@lang:en
    @@@:
      The <A:UIEvent.detail> will be <DOM:0> if the user moves 
      the mouse between the mousedown and mouseup. 
      <SRC:DOM Level 2 Events>
##EventSet

IF:
  @Name:  MouseEvent
  @Description:
    @@lang:en
    @@@:
      Provide specific contextual information associated 
      with Mouse Events.
    \
      {NOTE:: In the case of nested elements, mouse events are 
              always targeted at the most deeply nested element.  
    \
      }
  @Example:
    @@FullName:
      @@@lang:en
      @@@@:
        Create an instance of the <IF:MouseEvent> interface
    @@Code:
      @@@Type:
         lang:Perl
      @@@@:
        my $me = $DocumentEvents->createEvent ('MouseEvent');

  @ISA:  
    DOMUIEvents:UIEvent
  @Role:
    @@@:
      DOMEvents:Event
    @@compat:
      ManakaiDOMEvents:Events

  @Level[list]:  2
  @SpecLevel[list]:  
    2
    3
  @Attr:
     @@Name:  screenX
     @@Description:
       @@@lang:en
       @@@@:
         The horizontal coordinate at which the event occurred 
         relative to the origin of the screen coordinate system.
     @@Get:
        @@@Type:
           DOMMain:long
        @@@Def:
          @@@@Type:
            lang:dis
          @@@@GetProp:
            DOMMouseEvents:screenX
  @Attr:
     @@Name:  screenY
     @@Description:
       @@@lang:en
       @@@@:
         The vertical coordinate at which the event occurred 
         relative to the origin of the screen coordinate system.
     @@Get:
        @@@Type:
           DOMMain:long
        @@@Def:
          @@@@Type:
            lang:dis
          @@@@GetProp:
            DOMMouseEvents:screenY
  @Attr:
     @@Name:  clientX
     @@Description:
       @@@lang:en
       @@@@:
         The horizontal coordinate at which the event 
         occurred relative to the client area of the DOM 
         implementation.
     @@Get:
        @@@Type:
           DOMMain:long
        @@@Def:
          @@@@Type:
            lang:dis
          @@@@GetProp:
            DOMMouseEvents:clientX
  @Attr:
     @@Name:  clientY
     @@Description:
       @@@lang:en
       @@@@:
         The vertical coordinate at which the event occurred 
         relative to the client area of the DOM implementation.
     @@Get:
        @@@Type:
           DOMMain:long
        @@@Def:
          @@@@Type:
            lang:dis
          @@@@GetProp:
            DOMMouseEvents:clientY
  @Attr:
     @@Name:  ctrlKey
     @@Description:
       @@@lang:en
       @@@@:
         Whether the Ctrl (<KEY:Control>) key modifier 
         is activated or not.
     @@Get:
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
  @Attr:
     @@Name:  shiftKey
     @@Description:
       @@@lang:en
       @@@@:
         Whether the <KEY:Shift> key modifier is activated or not.
     @@Get:
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
  @Attr:
     @@Name:  altKey
     @@Description:
       @@@lang:en
       @@@@:
         Whether the <KEY:Alt> (alternative) key modifier is 
         activated or not. 
      \
         {NOTE:: The Macintosh <CODE:Option> key modifier must be 
                 represented using this key modifier.
      \
         }
     @@Get:
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
  @Attr:
     @@Name:  metaKey
     @@Description:
       @@@lang:en
       @@@@:
         Whether the <KEY:Meta> key modifier is activated or not.
       \
         {NOTE:: The Macintosh <CODE:Command> key modifier must 
                 be represented using this key.
       \
         }
     @@Get:
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
  @Attr:
     @@Name:  button
     @@Description:
       @@@lang:en
       @@@@:
         Mouse button that changed the state. 
     @@Get:
        @@@Type:
           DOMMain:unsigned-short
        @@@Description:
          @@@@lang:en
          @@@@@:
            A number that indicates which mouse button changed 
            the state.
        @@@InCase:
          @@@@Value:0
          @@@@Description:
            @@@@@lang:en
            @@@@@@:
              The normal button of the mouse. 
            \
              {NOTE:: In general, it is the left button or the one button 
                      on the Macintosh mouse. 
            \
              }
          @@@@SpecLevel:2
        @@@InCase:
          @@@@Value:1
          @@@@Description:
            @@@@@lang:en
            @@@@@@:
              The extra button. 
            \
              {NOTE:: In general, it is the middle button and often 
                      combined with the mouse wheel.
            \
              }
          @@@@SpecLevel:2
        @@@InCase:
          @@@@Value:2
          @@@@Description:
            @@@@@lang:en
            @@@@@@:
              The contextual property button.
            \
              {NOTE:: In general, it is the right button.
            \
              }
          @@@@SpecLevel:2
        @@@InCase:
          @@@@Label:
            @@@@@lang:en
            @@@@@@:
              Values higher than <DOM:2>
          @@@@Description:
            @@@@@lang:en
            @@@@@@:
              Other button.
          @@@@SpecLevel:3
        @@@Def:
          @@@@Type:
            lang:dis
          @@@@GetProp:
            DOMMouseEvents:button
  @Attr:
     @@Name:  relatedTarget
     @@Description:
       @@@lang:en
       @@@@:
         The secondary <IF:EventTarget> related to a UI event.
     @@Get:
        @@@Type:  
          DOMEvents:EventTarget
        @@@Def:
          @@@@Type:
            lang:dis
          @@@@GetProp:
            DOMMouseEvents:relatedTarget

  @ImplNote:
    @@lang:en
    @@@:
      When initializing using <M:initMouseEvent> or 
      <M:initMouseEventNS>, the DOM implementation should 
      use the client coordinates <A:clientX> and <A:clientY> 
      for calculation of other coordinates such as 
      target coordinates exposed by the DOM implementation.

  @Method:
     @@Name:  initMouseEvent
     @@Description:
       @@@lang:en
       @@@@:
         Initialize the value of a <IF:MouseEvent> object.  It has 
         the same behavior as <M:UIEvent.initUIEvent>.
     @@NSVersion:initMouseEventNS
     @@Param:
        @@@Name:  typeArg
        @@@Type:  
          DOMMain:DOMString
     @@Param:
        @@@Name:  canBubbleArg
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
     @@Param:
        @@@Name:  cancelableArg
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
     @@Param:
        @@@Name:  viewArg
        @@@Type:
           DOMViews:AbstractView
     @@Param:
        @@@Name:  detailArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  screenXArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  screenYArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  clientXArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  clientYArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  ctrlKeyArg
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
     @@Param:
        @@@Name:  altKeyArg
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
     @@Param:
        @@@Name:  shiftKeyArg
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
     @@Param:
        @@@Name:  metaKeyArg
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
     @@Param:
        @@@Name:  buttonArg
        @@@Type:
           DOMMain:unsigned-short
     @@Param:
        @@@Name:  relatedTargetArg
        @@@Type:  
          DOMEvents:EventTarget
     @@Return:  
       @@@Def:
         @@@@Type:
           lang:Perl
         @@@@@:
           __DEEP{
                    ## Conditional
             $self->__SUPER{UIEvent}__::initUIEvent
                       ($typeArg, $canBubbleArg, $cancelableArg,
                        $viewArg, $detailArg);
           }__;
           for ($self->{<Q:TreeCore:node>}) {
             $_->{<Q:DOMMouseEvents:screenX>} = $screenXArg;
             $_->{<Q:DOMMouseEvents:screenY>} = $screenYArg;
             $_->{<Q:DOMMouseEvents:clientX>} = $clientXArg;
             $_->{<Q:DOMMouseEvents:clientY>} = $clientYArg;
             $_->{<Q:DOMMouseEvents:modifiersList>} = '';
             $_->{<Q:DOMMouseEvents:modifiersList>} .= ' Control'
                                            if $ctrlKeyArg;
             $_->{<Q:DOMMouseEvents:modifiersList>} .= ' Alt'
                                            if $altKeyArg;
             $_->{<Q:DOMMouseEvents:modifiersList>} .= ' Shift'
                                            if $shiftKeyArg;
             $_->{<Q:DOMMouseEvents:modifiersList>} .= ' Meta'
                                            if $metaKeyArg;
             $_->{<Q:DOMMouseEvents:button>} = $buttonArg;
             $_->{<Q:DOMMouseEvents:relatedTarget>} = $relatedTargetArg;
           }
    @@SpecLevel:2
    @@Level[list]:
      2
      3
  @Method:
     @@Name:  getModifierState
     @@Description:
       @@@lang:en
       @@@@:
         Return the state of a modifier.
     @@Param:
        @@@Name:  keyIdentifierArg
        @@@Type: 
          ManakaiDOM:ManakaiDOMKeyIdentifier
        @@@Description:
          @@@@lang:en
          @@@@@:
            The modifier key of which the state is queries. 
        @@@ImplNote:
          @@@@lang:en
          @@@@@:
            If a DOM application wishes to distinguish between 
            left and right key modifiers, use keyboard events.
     @@Return:
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
           @@@@Description:
             @@@@@lang:en
             @@@@@@:
               The <P:keyIdentifierArg> is a modifier key and 
               the modifier is activated.
        @@@InCase:
           @@@@Value:  false
     @@Level[list]:  3
     @@SpecLevel[list]:  3
  @Method:
     @@Name:  initMouseEventNS
     @@Description:
       @@@lang:en
       @@@@:
         Initialize the value of a <IF:MouseEvent> object.  It has 
         the same behavior as <M:UIEvent.initUIEventNS>.
     @@NoNSVersion:initMouseEvent
     @@Param:
        @@@Name:  namespaceURI
        @@@Type:  
          ManakaiDOM:ManakaiDOMNamespaceURI
     @@Param:
        @@@Name:  typeArg
        @@@Type:  
          DOMMain:DOMString
     @@Param:
        @@@Name:  canBubbleArg
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
     @@Param:
        @@@Name:  cancelableArg
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
     @@Param:
        @@@Name:  viewArg
        @@@Type:
           DOMViews:AbstractView
     @@Param:
        @@@Name:  detailArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  screenXArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  screenYArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  clientXArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  clientYArg
        @@@Type:
           DOMMain:long
     @@Param:
        @@@Name:  buttonArg
        @@@Type:
           DOMMain:unsigned-short
     @@Param:
        @@@Name:  relatedTargetArg
        @@@Type:  
          DOMEvents:EventTarget
     @@Param:
        @@@Name:  modifiersList
        @@@Type: 
          ManakaiDOM:ManakaiDOMKeyIdentifiers
        @@@Description:
          @@@@lang:en
          @@@@@:
            Modifier key identifiers to be activated.
     @@Return: 
       @@@Def:
         @@@@Type:
           lang:Perl
         @@@@@:
           __DEEP{
                    ## Conditional
             $self->__SUPER{UIEvent}__::initUIEventNS
                       ($namespaceURI, $typeArg, $canBubbleArg, $cancelableArg,
                        $viewArg, $detailArg);
           }__;
           for ($self->{<Q:TreeCore:node>}) {
             $_->{<Q:DOMMouseEvents:screenX>} = $screenXArg;
             $_->{<Q:DOMMouseEvents:screenY>} = $screenYArg;
             $_->{<Q:DOMMouseEvents:clientX>} = $clientXArg;
             $_->{<Q:DOMMouseEvents:clientY>} = $clientYArg;
             $_->{<Q:DOMMouseEvents:button>} = $buttonArg;
             $_->{<Q:DOMMouseEvents:relatedTarget>} = $relatedTargetArg;
             $_->{<Q:DOMMouseEvents:modifiersList>} = $modifiersList;
           }
     @@Level[list]:  3
     @@SpecLevel[list]:  3
##IF:MouseEvent

## DOMMouseEvents.dis ends here
1	Namespace:
2	@DOMCore:
3	http://suika.fam.cx/~wakaba/archive/2004/8/18/dom-core#
4	@DOMEvents:
5	http://suika.fam.cx/~wakaba/archive/2004/dom/events#
6	@DOMViews:
7	http://suika.fam.cx/~wakaba/archive/2004/dom/views#
8	@ev:
9	http://www.w3.org/2001/xml-events
10	@lang:
11	http://suika.fam.cx/~wakaba/archive/2004/8/18/lang#
12	@license:
13	http://suika.fam.cx/~wakaba/archive/2004/8/18/license#
14	@ManakaiDOMEvents:
15	http://suika.fam.cx/~wakaba/archive/2004/mdom-ev#
16	@TreeCore:\
17	Module:
18	@Name: DOMMouseEvents
19	@Namespace:
20	http://suika.fam.cx/~wakaba/archive/2004/dom/events#
21	@BindingName:
22	@@@: events
23	@@Type:
24	lang:IDL-DOM
25	@@prefix: dom.w3c.org
26	@FullName:
27	@@lang:en
28	@@@: DOM Mouse Events Module
29	@Description:
30	@@lang:en
31	@@@:
32	This event module is specifically designed for use with
33	pointing input devices, such as a mouse or a track ball.
34	\
35	The mouse event module is composed of events listed in
36	HTML 4.0 and additional events that are supported in
37	DOM Level 0 browsers.
38
39	@Author:
40	@@FullName: Wakaba
41	@@Mail: w@suika.fam.cx
42	@License:
43	license:Perl+MPL
44	@Date.RCS:
45	$Date: 2004/10/16 13:34:17 $
46
47	@ConditionDef:
48	@@Name:DOM2
49	@ConditionDef:
50	@@Name:DOM3
51	@@ISA:DOM2
52	@NormalCondition:DOM3
53
54	@Feature:
55	@@Name:MouseEvents
56	@@Version:2.0
57	@@FullName: DOM Level 2 Mouse Events
58	@@ImplNote:
59	@@@lang:en
60	@@@@:
61	The support for <Feature:UIEvents>/<FeatureVer:2.0> is required.
62	@@Condition[list]:
63	DOM2
64	DOM3
65	@@Contrib:
66	DOMCore:DOMImplementation::
67	@Feature:
68	@@Name:MouseEvents
69	@@Version:3.0
70	@@FullName: DOM Level 3 Mouse Events
71	@@ImplNote:
72	@@@lang:en
73	@@@@:
74	The support for <Feature:UIEvents>/<FeatureVer:3.0> is required.
75	@@Condition[list]:
76	DOM3
77	@@Contrib:
78	DOMCore:DOMImplementation::
79
80	@Require:
81	@@Module:
82	@@@Name: DOMUIEvents
83	@@@FileName:
84	@@@@@: events.idl
85	@@@@For:
86	lang:IDL-DOM
87	@@@Namespace:
88	http://suika.fam.cx/~wakaba/archive/2004/dom/events#
89
90	EventSet:
91	@Event:
92	@@Name:click
93	@@QName:
94	ev:click
95	@@Description:
96	@@@lang:en
97	@@@@:
98	A pointing device button is clicked over an element. The
99	definition of a <QUOTE:click> depends on the environment
100	configuration.
101	\
102	In the case of nested elements, this event is always targeted
103	at the most deeply nested element.
104	\
105	Events <EV:ev:mousedown> and <EV:ev:mouseup> are
106	dispatched before the <EV:ev:click>. The target node
107	must be the same betweeb these three events; otherwise, i.e.
108	<EV:ev:mousemove> and <EV:ev:mouseout> occur betweeb the
109	press and release of the button, <EV:ev:click> cannot occur.
110	@@Type:MouseEvent
111	@@IsBubbling:1
112	@@IsCancelable:1
113	@@EventTarget:
114	@@@Type:
115	DOMCore:Element
116	@@SpecLevel:2
117	@@ContextInfo:
118	@@@Attr:
119	@@@@IF:MouseEvent
120	@@@@Name:screenX
121	@@@Attr:
122	@@@@IF:MouseEvent
123	@@@@Name:screenY
124	@@@Attr:
125	@@@@IF:MouseEvent
126	@@@@Name:clientX
127	@@@Attr:
128	@@@@IF:MouseEvent
129	@@@@Name:clientY
130	@@@Attr:
131	@@@@IF:MouseEvent
132	@@@@Name:altKey
133	@@@Attr:
134	@@@@IF:MouseEvent
135	@@@@Name:ctrlKey
136	@@@Attr:
137	@@@@IF:MouseEvent
138	@@@@Name:shiftKey
139	@@@Attr:
140	@@@@IF:MouseEvent
141	@@@@Name:metaKey
142	@@@ImplNote:
143	@@@@lang:en
144	@@@@@:
145	<A:MouseEvent.altGraphKey>
146	@@@Attr:
147	@@@@IF:MouseEvent
148	@@@@Name:button
149	@@@Attr:
150	@@@@IF:
151	DOMUIEvents:UIEvent
152	@@@@Name:view
153	@@@Attr:
154	@@@@IF:
155	DOMUIEvents:UIEvent
156	@@@@Name:detail
157	@@@@Type:
158	DOMMain:unsigned-long
159	@@@@Description:
160	@@@@@lang:en
161	@@@@@@:
162	The number of consecutive clicks of a pointing device button
163	during a user action.
164	\
165	{NOTE:: The notion of consecutive clicks depends on
166	the environment configuration.
167	\
168	}
169	@Event:
170	@@Name:mousedown
171	@@QName:
172	ev:mousedown
173	@@Description:
174	@@@lang:en
175	@@@@:
176	A pointing device button is pressed over an element.
177	\
178	In the case of nested elements, this event is always targeted
179	at the most deeply nested element.
180	@@Type:MouseEvent
181	@@IsBubbling:1
182	@@IsCancelable:1
183	@@EventTarget:
184	@@@Type:
185	DOMCore:Element
186	@@SpecLevel:2
187	@@ContextInfo:
188	@@@Attr:
189	@@@@IF:MouseEvent
190	@@@@Name:screenX
191	@@@Attr:
192	@@@@IF:MouseEvent
193	@@@@Name:screenY
194	@@@Attr:
195	@@@@IF:MouseEvent
196	@@@@Name:clientX
197	@@@Attr:
198	@@@@IF:MouseEvent
199	@@@@Name:clientY
200	@@@Attr:
201	@@@@IF:MouseEvent
202	@@@@Name:altKey
203	@@@Attr:
204	@@@@IF:MouseEvent
205	@@@@Name:ctrlKey
206	@@@Attr:
207	@@@@IF:MouseEvent
208	@@@@Name:shiftKey
209	@@@Attr:
210	@@@@IF:MouseEvent
211	@@@@Name:metaKey
212	@@@ImplNote:
213	@@@@lang:en
214	@@@@@:
215	<A:MouseEvent.altGraphKey>
216	@@@Attr:
217	@@@@IF:MouseEvent
218	@@@@Name:button
219	@@@Attr:
220	@@@@IF:
221	DOMUIEvents:UIEvent
222	@@@@Name:view
223	@@@Attr:
224	@@@@IF:
225	DOMUIEvents:UIEvent
226	@@@@Name:detail
227	@@@@Type:
228	DOMMain:unsigned-long
229	@@@@Description:
230	@@@@@lang:en
231	@@@@@@:
232	The number of consecutive clicks of a pointing device button
233	during a user action.
234	\
235	{NOTE:: The notion of consecutive clicks depends on
236	the environment configuration.
237	\
238	}
239	\
240	{eg::
241	\
242	If no click happend before the mousedown,
243	the value will be <DOM:1>.
244	\
245	}
246	@Event:
247	@@Name:mouseup
248	@@QName:
249	ev:mouseup
250	@@Description:
251	@@@lang:en
252	@@@@:
253	A pointing device button is released over an element.
254	\
255	In the case of nested elements, this event is always targeted
256	at the most deeply nested element.
257	@@Type:MouseEvent
258	@@IsBubbling:1
259	@@IsCancelable:1
260	@@EventTarget:
261	@@@Type:
262	DOMCore:Element
263	@@SpecLevel:2
264	@@ContextInfo:
265	@@@Attr:
266	@@@@IF:MouseEvent
267	@@@@Name:screenX
268	@@@Attr:
269	@@@@IF:MouseEvent
270	@@@@Name:screenY
271	@@@Attr:
272	@@@@IF:MouseEvent
273	@@@@Name:clientX
274	@@@Attr:
275	@@@@IF:MouseEvent
276	@@@@Name:clientY
277	@@@Attr:
278	@@@@IF:MouseEvent
279	@@@@Name:altKey
280	@@@Attr:
281	@@@@IF:MouseEvent
282	@@@@Name:ctrlKey
283	@@@Attr:
284	@@@@IF:MouseEvent
285	@@@@Name:shiftKey
286	@@@Attr:
287	@@@@IF:MouseEvent
288	@@@@Name:metaKey
289	@@@ImplNote:
290	@@@@lang:en
291	@@@@@:
292	<A:MouseEvent.altGraphKey>
293	@@@Attr:
294	@@@@IF:MouseEvent
295	@@@@Name:button
296	@@@Attr:
297	@@@@IF:
298	DOMUIEvents:UIEvent
299	@@@@Name:view
300	@@@Attr:
301	@@@@IF:
302	DOMUIEvents:UIEvent
303	@@@@Name:detail
304	@@@@Type:
305	DOMMain:unsigned-long
306	@@@@Description:
307	@@@@@lang:en
308	@@@@@@:
309	The number of consecutive clicks of a pointing device button
310	during a user action.
311	\
312	{NOTE:: The notion of consecutive clicks depends on
313	the environment configuration.
314	\
315	}
316	@Event:
317	@@Name:mouseover
318	@@QName:
319	ev:mouseover
320	@@Description:
321	@@@lang:en
322	@@@@:
323	A pointing device is moved onto an element.
324	\
325	In the case of nested elements, this event is always targeted
326	at the most deeply nested element.
327	@@Type:MouseEvent
328	@@IsBubbling:1
329	@@IsCancelable:1
330	@@EventTarget:
331	@@@Type:
332	DOMCore:Element
333	@@SpecLevel:2
334	@@ContextInfo:
335	@@@Attr:
336	@@@@IF:MouseEvent
337	@@@@Name:screenX
338	@@@Attr:
339	@@@@IF:MouseEvent
340	@@@@Name:screenY
341	@@@Attr:
342	@@@@IF:MouseEvent
343	@@@@Name:clientX
344	@@@Attr:
345	@@@@IF:MouseEvent
346	@@@@Name:clientY
347	@@@Attr:
348	@@@@IF:MouseEvent
349	@@@@Name:altKey
350	@@@Attr:
351	@@@@IF:MouseEvent
352	@@@@Name:ctrlKey
353	@@@Attr:
354	@@@@IF:MouseEvent
355	@@@@Name:shiftKey
356	@@@Attr:
357	@@@@IF:MouseEvent
358	@@@@Name:metaKey
359	@@@ImplNote:
360	@@@@lang:en
361	@@@@@:
362	<A:MouseEvent.altGraphKey>
363	@@@Attr:
364	@@@@IF:MouseEvent
365	@@@@Name:button
366	@@@Attr:
367	@@@@IF:
368	DOMUIEvents:UIEvent
369	@@@@Name:view
370	@@@Attr:
371	@@@@IF:MouseEvent
372	@@@@Name:relatedTarget
373	@@@@Type:
374	DOMEvents:EventTarget
375	@@@@Description:
376	@@@@@lang:en
377	@@@@@@:
378	The event target a pointing device is exiting.
379	@Event:
380	@@Name:mousemove
381	@@QName:
382	ev:mousemove
383	@@Description:
384	@@@lang:en
385	@@@@:
386	A pointing device is moved while it is over an element.
387	\
388	In the case of nested elements, this event is always targeted
389	at the most deeply nested element.
390	@@Type:MouseEvent
391	@@IsBubbling:1
392	@@IsCancelable:1
393	@@EventTarget:
394	@@@Type:
395	DOMCore:Element
396	@@SpecLevel:2
397	@@ContextInfo:
398	@@@Attr:
399	@@@@IF:MouseEvent
400	@@@@Name:screenX
401	@@@Attr:
402	@@@@IF:MouseEvent
403	@@@@Name:screenY
404	@@@Attr:
405	@@@@IF:MouseEvent
406	@@@@Name:clientX
407	@@@Attr:
408	@@@@IF:MouseEvent
409	@@@@Name:clientY
410	@@@Attr:
411	@@@@IF:MouseEvent
412	@@@@Name:altKey
413	@@@Attr:
414	@@@@IF:MouseEvent
415	@@@@Name:ctrlKey
416	@@@Attr:
417	@@@@IF:MouseEvent
418	@@@@Name:shiftKey
419	@@@Attr:
420	@@@@IF:MouseEvent
421	@@@@Name:metaKey
422	@@@ImplNote:
423	@@@@lang:en
424	@@@@@:
425	<A:MouseEvent.altGraphKey>
426	@@@Attr:
427	@@@@IF:MouseEvent
428	@@@@Name:button
429	@@@Attr:
430	@@@@IF:
431	DOMUIEvents:UIEvent
432	@@@@Name:view
433	@Event:
434	@@Name:mouseout
435	@@QName:
436	ev:mouseout
437	@@Description:
438	@@@lang:en
439	@@@@:
440	A pointing device is moved away from an element.
441	\
442	In the case of nested elements, this event is always targeted
443	at the most deeply nested element.
444	@@Type:MouseEvent
445	@@IsBubbling:1
446	@@IsCancelable:1
447	@@EventTarget:
448	@@@Type:
449	DOMCore:Element
450	@@SpecLevel:2
451	@@ContextInfo:
452	@@@Attr:
453	@@@@IF:MouseEvent
454	@@@@Name:screenX
455	@@@Attr:
456	@@@@IF:MouseEvent
457	@@@@Name:screenY
458	@@@Attr:
459	@@@@IF:MouseEvent
460	@@@@Name:clientX
461	@@@Attr:
462	@@@@IF:MouseEvent
463	@@@@Name:clientY
464	@@@Attr:
465	@@@@IF:MouseEvent
466	@@@@Name:altKey
467	@@@Attr:
468	@@@@IF:MouseEvent
469	@@@@Name:ctrlKey
470	@@@Attr:
471	@@@@IF:MouseEvent
472	@@@@Name:shiftKey
473	@@@Attr:
474	@@@@IF:MouseEvent
475	@@@@Name:metaKey
476	@@@ImplNote:
477	@@@@lang:en
478	@@@@@:
479	<A:MouseEvent.altGraphKey>
480	@@@Attr:
481	@@@@IF:MouseEvent
482	@@@@Name:button
483	@@@Attr:
484	@@@@IF:
485	DOMUIEvents:UIEvent
486	@@@@Name:view
487	@@@Attr:
488	@@@@IF:MouseEvent
489	@@@@Name:relatedTarget
490	@@@@Type:
491	DOMEvents:EventTarget
492	@@@@Description:
493	@@@@@lang:en
494	@@@@@@:
495	The event target a pointing device is entering.
496	@ImplNote:
497	@@lang:en
498	@@@:
499	{P:: An <QUOTE:double click> will produce:
500	\
501	= <ev:mousedown> with <A:UIEvent.detail> that equals <DOM:1>.
502	\
503	= <ev:mouseup> with <A:UIEvent.detail> that equals <DOM:1>.
504	\
505	= <ev:mouseclick> with <A:UIEvent.detail> that equals <DOM:1>.
506	\
507	= <ev:mousedown> with <A:UIEvent.detail> that equals <DOM:2>.
508	\
509	= <ev:mouseup> with <A:UIEvent.detail> that equals <DOM:2>.
510	\
511	= <ev:mouseclick> with <A:UIEvent.detail> that equals <DOM:2>.
512	\
513	}
514	@ImplNote:
515	@@lang:en
516	@@@:
517	The <A:UIEvent.detail> will be <DOM:0> if the user moves
518	the mouse between the mousedown and mouseup.
519	<SRC:DOM Level 2 Events>
520	##EventSet
521
522	IF:
523	@Name: MouseEvent
524	@Description:
525	@@lang:en
526	@@@:
527	Provide specific contextual information associated
528	with Mouse Events.
529	\
530	{NOTE:: In the case of nested elements, mouse events are
531	always targeted at the most deeply nested element.
532	\
533	}
534	@Example:
535	@@FullName:
536	@@@lang:en
537	@@@@:
538	Create an instance of the <IF:MouseEvent> interface
539	@@Code:
540	@@@Type:
541	lang:Perl
542	@@@@:
543	my $me = $DocumentEvents->createEvent ('MouseEvent');
544
545	@ISA:
546	DOMUIEvents:UIEvent
547	@Role:
548	@@@:
549	DOMEvents:Event
550	@@compat:
551	ManakaiDOMEvents:Events
552
553	@Level[list]: 2
554	@SpecLevel[list]:
555	2
556	3
557	@Attr:
558	@@Name: screenX
559	@@Description:
560	@@@lang:en
561	@@@@:
562	The horizontal coordinate at which the event occurred
563	relative to the origin of the screen coordinate system.
564	@@Get:
565	@@@Type:
566	DOMMain:long
567	@@@Def:
568	@@@@Type:
569	lang:dis
570	@@@@GetProp:
571	DOMMouseEvents:screenX
572	@Attr:
573	@@Name: screenY
574	@@Description:
575	@@@lang:en
576	@@@@:
577	The vertical coordinate at which the event occurred
578	relative to the origin of the screen coordinate system.
579	@@Get:
580	@@@Type:
581	DOMMain:long
582	@@@Def:
583	@@@@Type:
584	lang:dis
585	@@@@GetProp:
586	DOMMouseEvents:screenY
587	@Attr:
588	@@Name: clientX
589	@@Description:
590	@@@lang:en
591	@@@@:
592	The horizontal coordinate at which the event
593	occurred relative to the client area of the DOM
594	implementation.
595	@@Get:
596	@@@Type:
597	DOMMain:long
598	@@@Def:
599	@@@@Type:
600	lang:dis
601	@@@@GetProp:
602	DOMMouseEvents:clientX
603	@Attr:
604	@@Name: clientY
605	@@Description:
606	@@@lang:en
607	@@@@:
608	The vertical coordinate at which the event occurred
609	relative to the client area of the DOM implementation.
610	@@Get:
611	@@@Type:
612	DOMMain:long
613	@@@Def:
614	@@@@Type:
615	lang:dis
616	@@@@GetProp:
617	DOMMouseEvents:clientY
618	@Attr:
619	@@Name: ctrlKey
620	@@Description:
621	@@@lang:en
622	@@@@:
623	Whether the Ctrl (<KEY:Control>) key modifier
624	is activated or not.
625	@@Get:
626	@@@Type:
627	DOMMain:boolean
628	@@@InCase:
629	@@@@Value: true
630	@@@InCase:
631	@@@@Value: false
632	@Attr:
633	@@Name: shiftKey
634	@@Description:
635	@@@lang:en
636	@@@@:
637	Whether the <KEY:Shift> key modifier is activated or not.
638	@@Get:
639	@@@Type:
640	DOMMain:boolean
641	@@@InCase:
642	@@@@Value: true
643	@@@InCase:
644	@@@@Value: false
645	@Attr:
646	@@Name: altKey
647	@@Description:
648	@@@lang:en
649	@@@@:
650	Whether the <KEY:Alt> (alternative) key modifier is
651	activated or not.
652	\
653	{NOTE:: The Macintosh <CODE:Option> key modifier must be
654	represented using this key modifier.
655	\
656	}
657	@@Get:
658	@@@Type:
659	DOMMain:boolean
660	@@@InCase:
661	@@@@Value: true
662	@@@InCase:
663	@@@@Value: false
664	@Attr:
665	@@Name: metaKey
666	@@Description:
667	@@@lang:en
668	@@@@:
669	Whether the <KEY:Meta> key modifier is activated or not.
670	\
671	{NOTE:: The Macintosh <CODE:Command> key modifier must
672	be represented using this key.
673	\
674	}
675	@@Get:
676	@@@Type:
677	DOMMain:boolean
678	@@@InCase:
679	@@@@Value: true
680	@@@InCase:
681	@@@@Value: false
682	@Attr:
683	@@Name: button
684	@@Description:
685	@@@lang:en
686	@@@@:
687	Mouse button that changed the state.
688	@@Get:
689	@@@Type:
690	DOMMain:unsigned-short
691	@@@Description:
692	@@@@lang:en
693	@@@@@:
694	A number that indicates which mouse button changed
695	the state.
696	@@@InCase:
697	@@@@Value:0
698	@@@@Description:
699	@@@@@lang:en
700	@@@@@@:
701	The normal button of the mouse.
702	\
703	{NOTE:: In general, it is the left button or the one button
704	on the Macintosh mouse.
705	\
706	}
707	@@@@SpecLevel:2
708	@@@InCase:
709	@@@@Value:1
710	@@@@Description:
711	@@@@@lang:en
712	@@@@@@:
713	The extra button.
714	\
715	{NOTE:: In general, it is the middle button and often
716	combined with the mouse wheel.
717	\
718	}
719	@@@@SpecLevel:2
720	@@@InCase:
721	@@@@Value:2
722	@@@@Description:
723	@@@@@lang:en
724	@@@@@@:
725	The contextual property button.
726	\
727	{NOTE:: In general, it is the right button.
728	\
729	}
730	@@@@SpecLevel:2
731	@@@InCase:
732	@@@@Label:
733	@@@@@lang:en
734	@@@@@@:
735	Values higher than <DOM:2>
736	@@@@Description:
737	@@@@@lang:en
738	@@@@@@:
739	Other button.
740	@@@@SpecLevel:3
741	@@@Def:
742	@@@@Type:
743	lang:dis
744	@@@@GetProp:
745	DOMMouseEvents:button
746	@Attr:
747	@@Name: relatedTarget
748	@@Description:
749	@@@lang:en
750	@@@@:
751	The secondary <IF:EventTarget> related to a UI event.
752	@@Get:
753	@@@Type:
754	DOMEvents:EventTarget
755	@@@Def:
756	@@@@Type:
757	lang:dis
758	@@@@GetProp:
759	DOMMouseEvents:relatedTarget
760
761	@ImplNote:
762	@@lang:en
763	@@@:
764	When initializing using <M:initMouseEvent> or
765	<M:initMouseEventNS>, the DOM implementation should
766	use the client coordinates <A:clientX> and <A:clientY>
767	for calculation of other coordinates such as
768	target coordinates exposed by the DOM implementation.
769
770	@Method:
771	@@Name: initMouseEvent
772	@@Description:
773	@@@lang:en
774	@@@@:
775	Initialize the value of a <IF:MouseEvent> object. It has
776	the same behavior as <M:UIEvent.initUIEvent>.
777	@@NSVersion:initMouseEventNS
778	@@Param:
779	@@@Name: typeArg
780	@@@Type:
781	DOMMain:DOMString
782	@@Param:
783	@@@Name: canBubbleArg
784	@@@Type:
785	DOMMain:boolean
786	@@@InCase:
787	@@@@Value: true
788	@@@InCase:
789	@@@@Value: false
790	@@Param:
791	@@@Name: cancelableArg
792	@@@Type:
793	DOMMain:boolean
794	@@@InCase:
795	@@@@Value: true
796	@@@InCase:
797	@@@@Value: false
798	@@Param:
799	@@@Name: viewArg
800	@@@Type:
801	DOMViews:AbstractView
802	@@Param:
803	@@@Name: detailArg
804	@@@Type:
805	DOMMain:long
806	@@Param:
807	@@@Name: screenXArg
808	@@@Type:
809	DOMMain:long
810	@@Param:
811	@@@Name: screenYArg
812	@@@Type:
813	DOMMain:long
814	@@Param:
815	@@@Name: clientXArg
816	@@@Type:
817	DOMMain:long
818	@@Param:
819	@@@Name: clientYArg
820	@@@Type:
821	DOMMain:long
822	@@Param:
823	@@@Name: ctrlKeyArg
824	@@@Type:
825	DOMMain:boolean
826	@@@InCase:
827	@@@@Value: true
828	@@@InCase:
829	@@@@Value: false
830	@@Param:
831	@@@Name: altKeyArg
832	@@@Type:
833	DOMMain:boolean
834	@@@InCase:
835	@@@@Value: true
836	@@@InCase:
837	@@@@Value: false
838	@@Param:
839	@@@Name: shiftKeyArg
840	@@@Type:
841	DOMMain:boolean
842	@@@InCase:
843	@@@@Value: true
844	@@@InCase:
845	@@@@Value: false
846	@@Param:
847	@@@Name: metaKeyArg
848	@@@Type:
849	DOMMain:boolean
850	@@@InCase:
851	@@@@Value: true
852	@@@InCase:
853	@@@@Value: false
854	@@Param:
855	@@@Name: buttonArg
856	@@@Type:
857	DOMMain:unsigned-short
858	@@Param:
859	@@@Name: relatedTargetArg
860	@@@Type:
861	DOMEvents:EventTarget
862	@@Return:
863	@@@Def:
864	@@@@Type:
865	lang:Perl
866	@@@@@:
867	__DEEP{
868	## Conditional
869	$self->__SUPER{UIEvent}__::initUIEvent
870	($typeArg, $canBubbleArg, $cancelableArg,
871	$viewArg, $detailArg);
872	}__;
873	for ($self->{<Q:TreeCore:node>}) {
874	$_->{<Q:DOMMouseEvents:screenX>} = $screenXArg;
875	$_->{<Q:DOMMouseEvents:screenY>} = $screenYArg;
876	$_->{<Q:DOMMouseEvents:clientX>} = $clientXArg;
877	$_->{<Q:DOMMouseEvents:clientY>} = $clientYArg;
878	$_->{<Q:DOMMouseEvents:modifiersList>} = '';
879	$_->{<Q:DOMMouseEvents:modifiersList>} .= ' Control'
880	if $ctrlKeyArg;
881	$_->{<Q:DOMMouseEvents:modifiersList>} .= ' Alt'
882	if $altKeyArg;
883	$_->{<Q:DOMMouseEvents:modifiersList>} .= ' Shift'
884	if $shiftKeyArg;
885	$_->{<Q:DOMMouseEvents:modifiersList>} .= ' Meta'
886	if $metaKeyArg;
887	$_->{<Q:DOMMouseEvents:button>} = $buttonArg;
888	$_->{<Q:DOMMouseEvents:relatedTarget>} = $relatedTargetArg;
889	}
890	@@SpecLevel:2
891	@@Level[list]:
892	2
893	3
894	@Method:
895	@@Name: getModifierState
896	@@Description:
897	@@@lang:en
898	@@@@:
899	Return the state of a modifier.
900	@@Param:
901	@@@Name: keyIdentifierArg
902	@@@Type:
903	ManakaiDOM:ManakaiDOMKeyIdentifier
904	@@@Description:
905	@@@@lang:en
906	@@@@@:
907	The modifier key of which the state is queries.
908	@@@ImplNote:
909	@@@@lang:en
910	@@@@@:
911	If a DOM application wishes to distinguish between
912	left and right key modifiers, use keyboard events.
913	@@Return:
914	@@@Type:
915	DOMMain:boolean
916	@@@InCase:
917	@@@@Value: true
918	@@@@Description:
919	@@@@@lang:en
920	@@@@@@:
921	The <P:keyIdentifierArg> is a modifier key and
922	the modifier is activated.
923	@@@InCase:
924	@@@@Value: false
925	@@Level[list]: 3
926	@@SpecLevel[list]: 3
927	@Method:
928	@@Name: initMouseEventNS
929	@@Description:
930	@@@lang:en
931	@@@@:
932	Initialize the value of a <IF:MouseEvent> object. It has
933	the same behavior as <M:UIEvent.initUIEventNS>.
934	@@NoNSVersion:initMouseEvent
935	@@Param:
936	@@@Name: namespaceURI
937	@@@Type:
938	ManakaiDOM:ManakaiDOMNamespaceURI
939	@@Param:
940	@@@Name: typeArg
941	@@@Type:
942	DOMMain:DOMString
943	@@Param:
944	@@@Name: canBubbleArg
945	@@@Type:
946	DOMMain:boolean
947	@@@InCase:
948	@@@@Value: true
949	@@@InCase:
950	@@@@Value: false
951	@@Param:
952	@@@Name: cancelableArg
953	@@@Type:
954	DOMMain:boolean
955	@@@InCase:
956	@@@@Value: true
957	@@@InCase:
958	@@@@Value: false
959	@@Param:
960	@@@Name: viewArg
961	@@@Type:
962	DOMViews:AbstractView
963	@@Param:
964	@@@Name: detailArg
965	@@@Type:
966	DOMMain:long
967	@@Param:
968	@@@Name: screenXArg
969	@@@Type:
970	DOMMain:long
971	@@Param:
972	@@@Name: screenYArg
973	@@@Type:
974	DOMMain:long
975	@@Param:
976	@@@Name: clientXArg
977	@@@Type:
978	DOMMain:long
979	@@Param:
980	@@@Name: clientYArg
981	@@@Type:
982	DOMMain:long
983	@@Param:
984	@@@Name: buttonArg
985	@@@Type:
986	DOMMain:unsigned-short
987	@@Param:
988	@@@Name: relatedTargetArg
989	@@@Type:
990	DOMEvents:EventTarget
991	@@Param:
992	@@@Name: modifiersList
993	@@@Type:
994	ManakaiDOM:ManakaiDOMKeyIdentifiers
995	@@@Description:
996	@@@@lang:en
997	@@@@@:
998	Modifier key identifiers to be activated.
999	@@Return:
1000	@@@Def:
1001	@@@@Type:
1002	lang:Perl
1003	@@@@@:
1004	__DEEP{
1005	## Conditional
1006	$self->__SUPER{UIEvent}__::initUIEventNS
1007	($namespaceURI, $typeArg, $canBubbleArg, $cancelableArg,
1008	$viewArg, $detailArg);
1009	}__;
1010	for ($self->{<Q:TreeCore:node>}) {
1011	$_->{<Q:DOMMouseEvents:screenX>} = $screenXArg;
1012	$_->{<Q:DOMMouseEvents:screenY>} = $screenYArg;
1013	$_->{<Q:DOMMouseEvents:clientX>} = $clientXArg;
1014	$_->{<Q:DOMMouseEvents:clientY>} = $clientYArg;
1015	$_->{<Q:DOMMouseEvents:button>} = $buttonArg;
1016	$_->{<Q:DOMMouseEvents:relatedTarget>} = $relatedTargetArg;
1017	$_->{<Q:DOMMouseEvents:modifiersList>} = $modifiersList;
1018	}
1019	@@Level[list]: 3
1020	@@SpecLevel[list]: 3
1021	##IF:MouseEvent
1022
1023	## DOMMouseEvents.dis ends here