Class: KeyboardEvent (private in WindowEvent

• Inheritance
• Description
• Related information
• Instance protocol
  • accessing
  • testing

Inheritance:

   Object
   |
   +--Message
      |
      +--MessageSend
         |
         +--Event
            |
            +--WindowEvent
               |
               +--WindowEvent::InputEvent
                  |
                  +--WindowEvent::KeyboardEvent
                     |
                     +--WindowEvent::HotKeyEvent
                     |
                     +--WindowEvent::KeyPressEvent
                     |
                     +--WindowEvent::KeyReleaseEvent

Package:

stx:libview

Category:

Interface-Support-UI

Owner:

WindowEvent

Author:

exept MBP

Description:

documentation to be added.

class:
    <a short class summary here, describing what instances represent>

responsibilities:    
    <describing what my main role is>

collaborators:    
    <describing with whom and how I talk to>

API:
    <public api and main messages>
    
example:
    <a one-line examples on how to use - can also be in a separate example method>

implementation:
    <implementation points>


[instance variables:]

[class variables:]

Related information:

Instance protocol:

 isDeadKey: aBoolean

set (by the sensor) if this is an event for a deadKey.
Consumers may want to mark deadKeys specially
(eg. by highlighting it, as done in the editTextView)

 key

return the (translated) key of the key-event.
i.e. if the keyboardMap maps #Ctrlc to #Copy,
then key will be #Copy and untranslatedKey will be #Ctrlc
and rawKey will be $c.

 key: aCharacterOrSymbol

set the (translated) key of the key-event.
i.e. if the keyboardMap maps #Ctrlc to #Copy,
then key will be #Copy and untranslatedKey will be #Ctrlc
and rawKey will be $c.

 rawKey

return the (raw) key of the key-event.
i.e. if the keyboardMap maps #Ctrlc to #Copy,
then key will be #Copy and untranslatedKey will be #Ctrlc
and rawKey will be $c.

 rawKey: aKey

set the (raw) key of the key-event.
i.e. if the keyboardMap maps #Ctrlc to #Copy,
then key will be #Copy and untranslatedKey will be #Ctrlc
and rawKey will be $c.

 rawKey: rKey untranslatedKey: uKey

set the (raw) key of the key-event.
i.e. if the keyboardMap maps #Ctrlc to #Copy,
then key will be #Copy and untranslatedKey will be #Ctrlc
and rawKey will be $c.

 untranslatedKey

return the untranslated key of the key-event;
i.e. if the keyboardMap maps #Ctrlc to #Copy,
then key will be #Copy and untranslatedKey will be #Ctrlc
(and rawKey will be $c).

 untranslatedKey: aKey

set the untranslated key of the key-event.
i.e. if the keyboardMap maps #Ctrlc to #Copy,
then key will be #Copy and untranslatedKey will be #Ctrlc
and rawKey will be $c.

 x

return the x coordinate of the key-event
(mouse position at the time of the key-event).

 x: anInteger

change the x coordinate of the key-event

 y

return the y coordinate of the key-event
(mouse position at the time of the key-event).

 y: anInteger

change the y coordinate of the key-event

 isDeadKey

return true, if this event is for a deadKey

 isDelegatedToFocusView

return true, if this event will be forwarded to a focusView.

 isKeyEvent

return true, if this event is a keyboard event

 isUserEvent

return true, if this event from a user