Message/DOM/DOMKeyboardEvents.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:  DOMKeyboardEvents
  @Namespace:
     http://suika.fam.cx/~wakaba/archive/2004/dom/events#
  @BindingName:
     @@@:  events
     @@Type:
        lang:IDL-DOM
     @@prefix:  dom.w3c.org
  @FullName:
    @@lang:en
    @@@: DOM Keyboard Events Module
  @Description:
    @@lang:en
    @@@:
      Keyboard events are device dependent, i.e. they rely on 
      the capabilities of the input devices and how they are 
      mapped in the operating systems.  Depending on the character 
      generation device, keyboard events may or may not be generated.
    \
      {NOTE:: It is highly recommended to rely on <Module:DOMTextEvents> 
              when dealing with character input.
    \
      }

  @Author:
     @@FullName:  Wakaba
     @@Mail:  w@suika.fam.cx
  @License:
     license:Perl+MPL
  @Date.RCS:
     $Date: 2004/10/11 10:37:25 $

  @ConditionDef:
    @@Name:DOM3
  @NormalCondition:DOM3

  @Feature:
    @@Name:KeyboardEvents
    @@Version:3.0
    @@FullName: DOM Level 3 Keyboard 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:
    @@QName:
      ev:keydown
    @@Description:
      @@@lang:en
      @@@@:
        A key is pressed down. 
      \
        This event type is device dependent and relies on the 
        capabilities of the input devices and how they are mapped 
        in the operating system.
      \
        This event type is generated after the keyboard mapping 
        but before the processing of an input method editor.
      \
        This event should logically happen before the event 
        <EV:ev:keyup> is produced.  Whether a keydown 
        contributes to the generation of a text event is 
        implementation dependent.
    @@Type:KeyboardEvent
    @@IsBubbling:1
    @@IsCancelable:1
    @@EventTarget:
      @@@Type:
        DOMCore:Element
    @@SpecLevel:3
    @@UIEvent.view:
      @@@Type:
        DOMViews:AbstractView
    @@KeyboardEvent.keyIdentifier:
      @@@Type:
        ManakaiDOM:ManakaiDOMKeyIdentifier
    @@KeyboardEvent.keyLocation:
      @@@Type:KeyLocationCode
      @@@ImplNote:
        @@@@lang:en
        @@@@@:
          <A:KeyboardEvent.location> in the DOM Level 3 Events Specification 
          is maybe an error.
    @@KeyboardEvent.altKey:
      @@@Type:
        DOMMain:boolean
    @@ImplNote:
      @@@lang:en
      @@@@:
        <A:KeyboardEvent.altGraphKey>: Maybe error of the DOM Level 3 Events 
        specification.
    @@KeyboardEvent.shiftKey:
      @@@Type:
        DOMMain:boolean
    @@KeyboardEvent.ctrlKey:
      @@@Type:
        DOMMain:boolean
    @@KeyboardEvent.metaKey:
      @@@Type:
        DOMMain:boolean
  @Event:
    @@QName:
      ev:keyup
    @@Description:
      @@@lang:en
      @@@@:
        A key is released.
       \
        This event type is device dependent and relies on the 
        capabilities of the input devices and how they are mapped in 
        the operating system.
       \
        This event type is generated after the keyboard mapping but 
        before the process of an input method editor.
       \
        This event should logically happen after the event 
        <EV:ev:keydown> is produced.
       \
        Whether a keyup contributes to the generation of a text 
        event is implementation dependent.
    @@Type:KeyboardEvent
    @@IsBubbling:1
    @@IsCancelable:1
    @@EventTarget:
      @@@Type:
        DOMCore:Element
    @@SpecLevel:3
    @@UIEvent.view:
      @@@Type:
        DOMViews:AbstractView
    @@KeyboardEvent.keyIdentifier:
      @@@Type:
        ManakaiDOM:ManakaiDOMKeyIdentifier
    @@KeyboardEvent.keyLocation:
      @@@Type:KeyLocationCode
      @@@ImplNote:
        @@@@lang:en
        @@@@@:
          <A:KeyboardEvent.location> in the DOM Level 3 Events Specification 
          is maybe an error.
    @@KeyboardEvent.altKey:
      @@@Type:
        DOMMain:boolean
      @@@Description:
        @@@@lang:en
        @@@@@:
          Set unless the <A:KeyboardEvent.keyIdentifier> corresponding 
          to the key modifier itself.
    @@ImplNote:
      @@@lang:en
      @@@@:
        <A:KeyboardEvent.altGraphKey>: Maybe error of the DOM Level 3 Events 
        specification.
        \
          Set unless the <A:KeyboardEvent.keyIdentifier> corresponding 
          to the key modifier itself.
    @@KeyboardEvent.shiftKey:
      @@@Type:
        DOMMain:boolean
      @@@Description:
        @@@@lang:en
        @@@@@:
          Set unless the <A:KeyboardEvent.keyIdentifier> corresponding 
          to the key modifier itself.
    @@KeyboardEvent.ctrlKey:
      @@@Type:
        DOMMain:boolean
      @@@Description:
        @@@@lang:en
        @@@@@:
          Set unless the <A:KeyboardEvent.keyIdentifier> corresponding 
          to the key modifier itself.
    @@KeyboardEvent.metaKey:
      @@@Type:
        DOMMain:boolean
      @@@Description:
        @@@@lang:en
        @@@@@:
          Set unless the <A:KeyboardEvent.keyIdentifier> corresponding 
          to the key modifier itself.
##ErrorSet

IF:
  @Name:  KeyboardEvent
  @Description:
    @@lang:en
    @@@:
      Provide specific contextual information associated with 
      keyboard devices.  Each keyboard event refers a key using 
      an identifier.  
      \
      {NOTE:: Keyboard events are commonly directed at 
      the element that has the focus.
      \
      }
  @Example:
    @@For:
      lang:Perl
    @@FullName:
      @@@lang:en
      @@@@:
        Create an instance of the <IF:KeyboardEvent> interface
    @@Code:
      @@@Type:
        lang:Perl
      @@@@:
        my $keyev = $DocumentEvent->createEvent ('KeyboardEvent');

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

  @Level[list]:  3
  @SpecLevel[list]:  3

  @ConstGroup:
     @@Name:  KeyLocationCode
     @@Type:
        DOMMain:unsigned-long
     @@Description:
       @@@lang:en
       @@@@:
         The location of a key on the device.
     @@Const:
        @@@Name:  DOM_KEY_LOCATION_STANDARD
        @@@Type:
           DOMMain:unsigned-long
        @@@Value:  0x00
        @@@Description:
          @@@@lang:en
          @@@@@:
            The key is not distinguished as the left or right version and 
            did not originate from the numeric keyboard.
     @@Const:
        @@@Name:  DOM_KEY_LOCATION_LEFT
        @@@Type:
           DOMMain:unsigned-long
        @@@Value:  0x01
        @@@Description:
          @@@@lang:en
          @@@@@:
            In the left location. 
          \
            {eg:: 
              \
              - The left <KEY:Shift> key on a PC 101 Key US keyboard.
              \
            }
     @@Const:
        @@@Name:  DOM_KEY_LOCATION_RIGHT
        @@@Type:
           DOMMain:unsigned-long
        @@@Value:  0x02
        @@@Description:
          @@@@lang:en
          @@@@@:
            In the right location. 
          \
            {eg:: 
              \
              - The right <KEY:Shift> key on a PC 101 Key US keyboard.
              \
            }
     @@Const:
        @@@Name:  DOM_KEY_LOCATION_NUMPAD
        @@@Type:
           DOMMain:unsigned-long
        @@@Value:  0x03
        @@@Description:
          @@@@lang:en
          @@@@@:
            On the numeric keypad or with a virtual key corresponding 
            to the numeric keyboard.
     @@ImplNote:
       @@@lang:en
       @@@@:
         If the DOM implementation wishes to provide a new location 
         information, a value different from the constant values 
         defined in the specification must be used.

  @Attr:
     @@Name:  keyIdentifier
     @@Description:
       @@@lang:en
       @@@@:
         The identifier of the key.
     @@Get:
        @@@Type:
          ManakaiDOM:ManakaiDOMKeyIdentifier
        @@@InCase:
          @@@@Value:Unidentified
          @@@@Description:
            @@@@@lang:en
            @@@@@@:
              The DOM implementation is unable to identify the key.
        @@@Def:
          @@@@Type:
            lang:dis
          @@@@GetProp:
            DOMKeyboardEvents:keyIdentifier
  @Attr:
     @@Name:  keyLocation
     @@Description:
       @@@lang:en
       @@@@:
         The location of the key on the device.
     @@Get:
        @@@Type:KeyLocationCode
        @@@Def:
          @@@@Type:
            lang:dis
          @@@@GetProp:
            DOMKeyboardEvents:keyLocation
  @Attr:
     @@Name:  ctrlKey
     @@Description:
       @@@lang:en
       @@@@:
         Whether the <KEY:Control> (<CODE:Ctrl>) key modifier is activated 
         or not.
     @@Get:
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
  @Attr:
     @@Name:  shiftKey
     @@Description:
       @@@lang:en
       @@@@:
         Whether the shift (<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 alternative (<KEY:Alt>) key modifier is activated.
       \
         {eg:: 
         \
           {P:: Examples of the alternative key include:
           \
           - The <KEY:Alt> key.
           \
           - The <CODE:Option> key on Macinrosh systems.
           \
           - The <CODE:Menu> key.
           \
           }
         \
         }
     @@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.
         \
         {eg:: 
         \
           {P:: Examples of the <KEY:Meta> key include:
           \
           - The <KEY:Meta> key.
           \
           - The <CODE:Command> key on Macintosh systems.
           \
           }
         \
         }
     @@Get:
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
        @@@InCase:
           @@@@Value:  false
  @Method:
     @@Name:  getModifierState
     @@Description:
       @@@lang:en
       @@@@:
         Return the state of a modifier using a key identifier.
         \
         {NOTE:: To distinguish between right and left modifiers, 
                 use the <A:KeyboardEvent.KeyLocation> attribute.
         \
         }
     @@ImplNote:
       @@@lang:en
       @@@@:
         Can DOM applications know left <KEY:Control> and right <KEY:Shift> 
         are activated in the same time?
     @@Param:
        @@@Name:  keyIdentifierArg
        @@@Type:  
          ManakaiDOM:ManakaiDOMKeyIdentifier
        @@@Description:
          @@@@lang:en
          @@@@@:
             An modifier key identifier.
           \
             {NOTE:: 
             \
               {P:: Common modifier keys include:
             \
               - <KEY:Alt>
             \
               - <KEY:AltGraph>
             \
               - <KEY:CapsLock>
             \
               - <KEY:Control>
             \
               - <KEY:Meta>
             \
               - <KEY:NumLock>
             \
               - <KEY:Shift>
             \
               }
             \
             }
     @@Return:
        @@@Type:
           DOMMain:boolean
        @@@InCase:
           @@@@Value:  true
           @@@@Description:
             @@@@@lang:en
             @@@@@@:
               The <P:keyIdentifierArg> key is a modifier key and 
               the modifier is activated.
        @@@InCase:
           @@@@Value:  false
  @Method:
     @@Name:  initKeyboardEvent
     @@Description:
       @@@lang:en
       @@@@:
         Initialize the value of <IF:KeyboardEvent> object.  It has 
         the same behavior as <M:UIEvent.initUIEvent>.
     @@NSVersion:initKeyboardEvent
     @@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:  keyIdentifierArg
        @@@Type:  
          ManakaiDOM:ManakaiDOMKeyIdentifier
     @@Param:
        @@@Name:  keyLocationArg
        @@@Type:
           DOMMain:unsigned-long
     @@Param:
        @@@Name:  modifiersList
        @@@Type:  
          ManakaiDOM:ManakaiDOMKeyIdentifiers
        @@@Description:
          @@@@lang:en
          @@@@@:
            A white space (XML 1.0 <CODE:S>) separated list 
            of modifier key identifiers to be activated.
     @@Return: 
       @@@Def:
         @@@@Type:
           lang:Perl
         @@@@@:
           __DEEP{
                    ## Conditional
             $self->__SUPER{UIEvent}__::initEvent
                       ($typeArg, $canBubbleArg, $cancelableArg,
                        $viewArg, null);
           }__;    ## NOTE: $detailArg not used
           for ($self->{<Q:TreeCore:node>}) {
             $_->{<Q:DOMKeyboardEvents:keyIdentifier>} = $keyIdentifierArg;
             $_->{<Q:DOMKeyboardEvents:keyLocation>} = $keyLocationArg;
             $_->{<Q:DOMKeyboardEvents:modifiersList>} = $modifiersList;
           }
    @@SpecLevel:3
    @@Level[list]:
      3

  @Method:
     @@Name:  initKeyboardEventNS
     @@Description:
       @@@lang:en
       @@@@:
         Initialize the value of a <IF:KeyboardEvent> object.  It has 
         the same behavior as <M:UIEvent.initUIEventNS>.
     @@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:  keyIdentifierArg
        @@@Type:  
          ManakaiDOM:ManakaiDOMKeyIdentifier
     @@Param:
        @@@Name:  keyLocationArg
        @@@Type:
           DOMMain:unsigned-long
     @@Param:
        @@@Name:  modifiersList
        @@@Type:  
          ManakaiDOM:ManakaiDOMKeyIdentifiers
     @@Return:  
       @@@Def:
         @@@@Type:
           lang:Perl
         @@@@@:
           __DEEP{
                    ## Conditional
             $self->__SUPER{UIEvent}__::initEventNS
                       ($namespaceURI, $typeArg, $canBubbleArg, $cancelableArg,
                        $viewArg, null);
           }__;    ## NOTE: $detailArg not used
           for ($self->{<Q:TreeCore:node>}) {
             $_->{<Q:DOMKeyboardEvents:keyIdentifier>} = $keyIdentifierArg;
             $_->{<Q:DOMKeyboardEvents:keyLocation>} = $keyLocationArg;
             $_->{<Q:DOMKeyboardEvents:modifiersList>} = $modifiersList;
           }
##IF:KeyboardEvent


## DOMUIEvents.dis ends here
1	wakaba	1.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: DOMKeyboardEvents
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 Keyboard Events Module
29			@Description:
30			@@lang:en
31			@@@:
32			Keyboard events are device dependent, i.e. they rely on
33			the capabilities of the input devices and how they are
34			mapped in the operating systems. Depending on the character
35			generation device, keyboard events may or may not be generated.
36			\
37			{NOTE:: It is highly recommended to rely on <Module:DOMTextEvents>
38			when dealing with character input.
39			\
40			}
41
42			@Author:
43			@@FullName: Wakaba
44			@@Mail: w@suika.fam.cx
45			@License:
46			license:Perl+MPL
47			@Date.RCS:
48			$Date: 2004/10/11 10:37:25 $
49
50			@ConditionDef:
51			@@Name:DOM3
52			@NormalCondition:DOM3
53
54			@Feature:
55			@@Name:KeyboardEvents
56			@@Version:3.0
57			@@FullName: DOM Level 3 Keyboard Events
58			@@ImplNote:
59			@@@lang:en
60			@@@@:
61			The support for <Feature:UIEvents>/<FeatureVer:3.0> is required.
62			@@Condition[list]:
63			DOM3
64			@@Contrib:
65			DOMCore:DOMImplementation::
66
67			@Require:
68			@@Module:
69			@@@Name: DOMUIEvents
70			@@@FileName:
71			@@@@@: events.idl
72			@@@@For:
73			lang:IDL-DOM
74			@@@Namespace:
75			http://suika.fam.cx/~wakaba/archive/2004/dom/events#
76
77			EventSet:
78			@Event:
79			@@QName:
80			ev:keydown
81			@@Description:
82			@@@lang:en
83			@@@@:
84			A key is pressed down.
85			\
86			This event type is device dependent and relies on the
87			capabilities of the input devices and how they are mapped
88			in the operating system.
89			\
90			This event type is generated after the keyboard mapping
91			but before the processing of an input method editor.
92			\
93			This event should logically happen before the event
94			<EV:ev:keyup> is produced. Whether a keydown
95			contributes to the generation of a text event is
96			implementation dependent.
97			@@Type:KeyboardEvent
98			@@IsBubbling:1
99			@@IsCancelable:1
100			@@EventTarget:
101			@@@Type:
102			DOMCore:Element
103			@@SpecLevel:3
104			@@UIEvent.view:
105			@@@Type:
106			DOMViews:AbstractView
107			@@KeyboardEvent.keyIdentifier:
108			@@@Type:
109			ManakaiDOM:ManakaiDOMKeyIdentifier
110			@@KeyboardEvent.keyLocation:
111			@@@Type:KeyLocationCode
112			@@@ImplNote:
113			@@@@lang:en
114			@@@@@:
115			<A:KeyboardEvent.location> in the DOM Level 3 Events Specification
116			is maybe an error.
117			@@KeyboardEvent.altKey:
118			@@@Type:
119			DOMMain:boolean
120			@@ImplNote:
121			@@@lang:en
122			@@@@:
123			<A:KeyboardEvent.altGraphKey>: Maybe error of the DOM Level 3 Events
124			specification.
125			@@KeyboardEvent.shiftKey:
126			@@@Type:
127			DOMMain:boolean
128			@@KeyboardEvent.ctrlKey:
129			@@@Type:
130			DOMMain:boolean
131			@@KeyboardEvent.metaKey:
132			@@@Type:
133			DOMMain:boolean
134			@Event:
135			@@QName:
136			ev:keyup
137			@@Description:
138			@@@lang:en
139			@@@@:
140			A key is released.
141			\
142			This event type is device dependent and relies on the
143			capabilities of the input devices and how they are mapped in
144			the operating system.
145			\
146			This event type is generated after the keyboard mapping but
147			before the process of an input method editor.
148			\
149			This event should logically happen after the event
150			<EV:ev:keydown> is produced.
151			\
152			Whether a keyup contributes to the generation of a text
153			event is implementation dependent.
154			@@Type:KeyboardEvent
155			@@IsBubbling:1
156			@@IsCancelable:1
157			@@EventTarget:
158			@@@Type:
159			DOMCore:Element
160			@@SpecLevel:3
161			@@UIEvent.view:
162			@@@Type:
163			DOMViews:AbstractView
164			@@KeyboardEvent.keyIdentifier:
165			@@@Type:
166			ManakaiDOM:ManakaiDOMKeyIdentifier
167			@@KeyboardEvent.keyLocation:
168			@@@Type:KeyLocationCode
169			@@@ImplNote:
170			@@@@lang:en
171			@@@@@:
172			<A:KeyboardEvent.location> in the DOM Level 3 Events Specification
173			is maybe an error.
174			@@KeyboardEvent.altKey:
175			@@@Type:
176			DOMMain:boolean
177			@@@Description:
178			@@@@lang:en
179			@@@@@:
180			Set unless the <A:KeyboardEvent.keyIdentifier> corresponding
181			to the key modifier itself.
182			@@ImplNote:
183			@@@lang:en
184			@@@@:
185			<A:KeyboardEvent.altGraphKey>: Maybe error of the DOM Level 3 Events
186			specification.
187			\
188			Set unless the <A:KeyboardEvent.keyIdentifier> corresponding
189			to the key modifier itself.
190			@@KeyboardEvent.shiftKey:
191			@@@Type:
192			DOMMain:boolean
193			@@@Description:
194			@@@@lang:en
195			@@@@@:
196			Set unless the <A:KeyboardEvent.keyIdentifier> corresponding
197			to the key modifier itself.
198			@@KeyboardEvent.ctrlKey:
199			@@@Type:
200			DOMMain:boolean
201			@@@Description:
202			@@@@lang:en
203			@@@@@:
204			Set unless the <A:KeyboardEvent.keyIdentifier> corresponding
205			to the key modifier itself.
206			@@KeyboardEvent.metaKey:
207			@@@Type:
208			DOMMain:boolean
209			@@@Description:
210			@@@@lang:en
211			@@@@@:
212			Set unless the <A:KeyboardEvent.keyIdentifier> corresponding
213			to the key modifier itself.
214			##ErrorSet
215
216			IF:
217			@Name: KeyboardEvent
218			@Description:
219			@@lang:en
220			@@@:
221			Provide specific contextual information associated with
222			keyboard devices. Each keyboard event refers a key using
223			an identifier.
224			\
225			{NOTE:: Keyboard events are commonly directed at
226			the element that has the focus.
227			\
228			}
229			@Example:
230			@@For:
231			lang:Perl
232			@@FullName:
233			@@@lang:en
234			@@@@:
235			Create an instance of the <IF:KeyboardEvent> interface
236			@@Code:
237			@@@Type:
238			lang:Perl
239			@@@@:
240			my $keyev = $DocumentEvent->createEvent ('KeyboardEvent');
241
242			@ISA:
243			DOMUIEvents:UIEvent
244			@Role:
245			@@@:
246			DOMEvents:Event
247			@@compat:
248			ManakaiDOMEvents:Events
249
250			@Level[list]: 3
251			@SpecLevel[list]: 3
252
253			@ConstGroup:
254			@@Name: KeyLocationCode
255			@@Type:
256			DOMMain:unsigned-long
257			@@Description:
258			@@@lang:en
259			@@@@:
260			The location of a key on the device.
261			@@Const:
262			@@@Name: DOM_KEY_LOCATION_STANDARD
263			@@@Type:
264			DOMMain:unsigned-long
265			@@@Value: 0x00
266			@@@Description:
267			@@@@lang:en
268			@@@@@:
269			The key is not distinguished as the left or right version and
270			did not originate from the numeric keyboard.
271			@@Const:
272			@@@Name: DOM_KEY_LOCATION_LEFT
273			@@@Type:
274			DOMMain:unsigned-long
275			@@@Value: 0x01
276			@@@Description:
277			@@@@lang:en
278			@@@@@:
279			In the left location.
280			\
281			{eg::
282			\
283			- The left <KEY:Shift> key on a PC 101 Key US keyboard.
284			\
285			}
286			@@Const:
287			@@@Name: DOM_KEY_LOCATION_RIGHT
288			@@@Type:
289			DOMMain:unsigned-long
290			@@@Value: 0x02
291			@@@Description:
292			@@@@lang:en
293			@@@@@:
294			In the right location.
295			\
296			{eg::
297			\
298			- The right <KEY:Shift> key on a PC 101 Key US keyboard.
299			\
300			}
301			@@Const:
302			@@@Name: DOM_KEY_LOCATION_NUMPAD
303			@@@Type:
304			DOMMain:unsigned-long
305			@@@Value: 0x03
306			@@@Description:
307			@@@@lang:en
308			@@@@@:
309			On the numeric keypad or with a virtual key corresponding
310			to the numeric keyboard.
311			@@ImplNote:
312			@@@lang:en
313			@@@@:
314			If the DOM implementation wishes to provide a new location
315			information, a value different from the constant values
316			defined in the specification must be used.
317
318			@Attr:
319			@@Name: keyIdentifier
320			@@Description:
321			@@@lang:en
322			@@@@:
323			The identifier of the key.
324			@@Get:
325			@@@Type:
326			ManakaiDOM:ManakaiDOMKeyIdentifier
327			@@@InCase:
328			@@@@Value:Unidentified
329			@@@@Description:
330			@@@@@lang:en
331			@@@@@@:
332			The DOM implementation is unable to identify the key.
333			@@@Def:
334			@@@@Type:
335			lang:dis
336			@@@@GetProp:
337			DOMKeyboardEvents:keyIdentifier
338			@Attr:
339			@@Name: keyLocation
340			@@Description:
341			@@@lang:en
342			@@@@:
343			The location of the key on the device.
344			@@Get:
345			@@@Type:KeyLocationCode
346			@@@Def:
347			@@@@Type:
348			lang:dis
349			@@@@GetProp:
350			DOMKeyboardEvents:keyLocation
351			@Attr:
352			@@Name: ctrlKey
353			@@Description:
354			@@@lang:en
355			@@@@:
356			Whether the <KEY:Control> (<CODE:Ctrl>) key modifier is activated
357			or not.
358			@@Get:
359			@@@Type:
360			DOMMain:boolean
361			@@@InCase:
362			@@@@Value: true
363			@@@InCase:
364			@@@@Value: false
365			@Attr:
366			@@Name: shiftKey
367			@@Description:
368			@@@lang:en
369			@@@@:
370			Whether the shift (<KEY:Shift>) key modifier is activated or not.
371			@@Get:
372			@@@Type:
373			DOMMain:boolean
374			@@@InCase:
375			@@@@Value: true
376			@@@InCase:
377			@@@@Value: false
378			@Attr:
379			@@Name: altKey
380			@@Description:
381			@@@lang:en
382			@@@@:
383			Whether the alternative (<KEY:Alt>) key modifier is activated.
384			\
385			{eg::
386			\
387			{P:: Examples of the alternative key include:
388			\
389			- The <KEY:Alt> key.
390			\
391			- The <CODE:Option> key on Macinrosh systems.
392			\
393			- The <CODE:Menu> key.
394			\
395			}
396			\
397			}
398			@@Get:
399			@@@Type:
400			DOMMain:boolean
401			@@@InCase:
402			@@@@Value: true
403			@@@InCase:
404			@@@@Value: false
405			@Attr:
406			@@Name: metaKey
407			@@Description:
408			@@@lang:en
409			@@@@:
410			Whether the <KEY:Meta> key modifier is activated or not.
411			\
412			{eg::
413			\
414			{P:: Examples of the <KEY:Meta> key include:
415			\
416			- The <KEY:Meta> key.
417			\
418			- The <CODE:Command> key on Macintosh systems.
419			\
420			}
421			\
422			}
423			@@Get:
424			@@@Type:
425			DOMMain:boolean
426			@@@InCase:
427			@@@@Value: true
428			@@@InCase:
429			@@@@Value: false
430			@Method:
431			@@Name: getModifierState
432			@@Description:
433			@@@lang:en
434			@@@@:
435			Return the state of a modifier using a key identifier.
436			\
437			{NOTE:: To distinguish between right and left modifiers,
438			use the <A:KeyboardEvent.KeyLocation> attribute.
439			\
440			}
441			@@ImplNote:
442			@@@lang:en
443			@@@@:
444			Can DOM applications know left <KEY:Control> and right <KEY:Shift>
445			are activated in the same time?
446			@@Param:
447			@@@Name: keyIdentifierArg
448			@@@Type:
449			ManakaiDOM:ManakaiDOMKeyIdentifier
450			@@@Description:
451			@@@@lang:en
452			@@@@@:
453			An modifier key identifier.
454			\
455			{NOTE::
456			\
457			{P:: Common modifier keys include:
458			\
459			- <KEY:Alt>
460			\
461			- <KEY:AltGraph>
462			\
463			- <KEY:CapsLock>
464			\
465			- <KEY:Control>
466			\
467			- <KEY:Meta>
468			\
469			- <KEY:NumLock>
470			\
471			- <KEY:Shift>
472			\
473			}
474			\
475			}
476			@@Return:
477			@@@Type:
478			DOMMain:boolean
479			@@@InCase:
480			@@@@Value: true
481			@@@@Description:
482			@@@@@lang:en
483			@@@@@@:
484			The <P:keyIdentifierArg> key is a modifier key and
485			the modifier is activated.
486			@@@InCase:
487			@@@@Value: false
488			@Method:
489			@@Name: initKeyboardEvent
490			@@Description:
491			@@@lang:en
492			@@@@:
493			Initialize the value of <IF:KeyboardEvent> object. It has
494			the same behavior as <M:UIEvent.initUIEvent>.
495			@@NSVersion:initKeyboardEvent
496			@@Param:
497			@@@Name: typeArg
498			@@@Type:
499			DOMMain:DOMString
500			@@Param:
501			@@@Name: canBubbleArg
502			@@@Type:
503			DOMMain:boolean
504			@@@InCase:
505			@@@@Value: true
506			@@@InCase:
507			@@@@Value: false
508			@@Param:
509			@@@Name: cancelableArg
510			@@@Type:
511			DOMMain:boolean
512			@@@InCase:
513			@@@@Value: true
514			@@@InCase:
515			@@@@Value: false
516			@@Param:
517			@@@Name: viewArg
518			@@@Type:
519			DOMViews:AbstractView
520			@@Param:
521			@@@Name: keyIdentifierArg
522			@@@Type:
523			ManakaiDOM:ManakaiDOMKeyIdentifier
524			@@Param:
525			@@@Name: keyLocationArg
526			@@@Type:
527			DOMMain:unsigned-long
528			@@Param:
529			@@@Name: modifiersList
530			@@@Type:
531			ManakaiDOM:ManakaiDOMKeyIdentifiers
532			@@@Description:
533			@@@@lang:en
534			@@@@@:
535			A white space (XML 1.0 <CODE:S>) separated list
536			of modifier key identifiers to be activated.
537			@@Return:
538			@@@Def:
539			@@@@Type:
540			lang:Perl
541			@@@@@:
542			__DEEP{
543			## Conditional
544			$self->__SUPER{UIEvent}__::initEvent
545			($typeArg, $canBubbleArg, $cancelableArg,
546			$viewArg, null);
547			}__; ## NOTE: $detailArg not used
548			for ($self->{<Q:TreeCore:node>}) {
549			$_->{<Q:DOMKeyboardEvents:keyIdentifier>} = $keyIdentifierArg;
550			$_->{<Q:DOMKeyboardEvents:keyLocation>} = $keyLocationArg;
551			$_->{<Q:DOMKeyboardEvents:modifiersList>} = $modifiersList;
552			}
553			@@SpecLevel:3
554			@@Level[list]:
555			3
556
557			@Method:
558			@@Name: initKeyboardEventNS
559			@@Description:
560			@@@lang:en
561			@@@@:
562			Initialize the value of a <IF:KeyboardEvent> object. It has
563			the same behavior as <M:UIEvent.initUIEventNS>.
564			@@Param:
565			@@@Name: namespaceURI
566			@@@Type:
567			ManakaiDOM:ManakaiDOMNamespaceURI
568			@@Param:
569			@@@Name: typeArg
570			@@@Type:
571			DOMMain:DOMString
572			@@Param:
573			@@@Name: canBubbleArg
574			@@@Type:
575			DOMMain:boolean
576			@@@InCase:
577			@@@@Value: true
578			@@@InCase:
579			@@@@Value: false
580			@@Param:
581			@@@Name: cancelableArg
582			@@@Type:
583			DOMMain:boolean
584			@@@InCase:
585			@@@@Value: true
586			@@@InCase:
587			@@@@Value: false
588			@@Param:
589			@@@Name: viewArg
590			@@@Type:
591			DOMViews:AbstractView
592			@@Param:
593			@@@Name: keyIdentifierArg
594			@@@Type:
595			ManakaiDOM:ManakaiDOMKeyIdentifier
596			@@Param:
597			@@@Name: keyLocationArg
598			@@@Type:
599			DOMMain:unsigned-long
600			@@Param:
601			@@@Name: modifiersList
602			@@@Type:
603			ManakaiDOM:ManakaiDOMKeyIdentifiers
604			@@Return:
605			@@@Def:
606			@@@@Type:
607			lang:Perl
608			@@@@@:
609			__DEEP{
610			## Conditional
611			$self->__SUPER{UIEvent}__::initEventNS
612			($namespaceURI, $typeArg, $canBubbleArg, $cancelableArg,
613			$viewArg, null);
614			}__; ## NOTE: $detailArg not used
615			for ($self->{<Q:TreeCore:node>}) {
616			$_->{<Q:DOMKeyboardEvents:keyIdentifier>} = $keyIdentifierArg;
617			$_->{<Q:DOMKeyboardEvents:keyLocation>} = $keyLocationArg;
618			$_->{<Q:DOMKeyboardEvents:modifiersList>} = $modifiersList;
619			}
620			##IF:KeyboardEvent
621
622
623			## DOMUIEvents.dis ends here