Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIDOMKeyEvent Interface Reference

import "nsIDOMKeyEvent.idl";

Inheritance diagram for nsIDOMKeyEvent:
Inheritance graph
[legend]
Collaboration diagram for nsIDOMKeyEvent:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void initKeyEvent (in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in nsIDOMAbstractView viewArg, in boolean ctrlKeyArg, in boolean altKeyArg, in boolean shiftKeyArg, in boolean metaKeyArg, in unsigned long keyCodeArg, in unsigned long charCodeArg)
void initUIEvent (in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in nsIDOMAbstractView viewArg, in long detailArg)
void stopPropagation ()
 The stopPropagation method is used prevent further propagation of an event during event flow.
void preventDefault ()
 If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur.
void initEvent (in DOMString eventTypeArg, in boolean canBubbleArg, in boolean cancelableArg)
 The initEvent method is used to initialize the value of an Event created through the DocumentEvent interface.

Public Attributes

const unsigned long DOM_VK_CANCEL = 0x03
const unsigned long DOM_VK_HELP = 0x06
const unsigned long DOM_VK_BACK_SPACE = 0x08
const unsigned long DOM_VK_TAB = 0x09
const unsigned long DOM_VK_CLEAR = 0x0C
const unsigned long DOM_VK_RETURN = 0x0D
const unsigned long DOM_VK_ENTER = 0x0E
const unsigned long DOM_VK_SHIFT = 0x10
const unsigned long DOM_VK_CONTROL = 0x11
const unsigned long DOM_VK_ALT = 0x12
const unsigned long DOM_VK_PAUSE = 0x13
const unsigned long DOM_VK_CAPS_LOCK = 0x14
const unsigned long DOM_VK_ESCAPE = 0x1B
const unsigned long DOM_VK_SPACE = 0x20
const unsigned long DOM_VK_PAGE_UP = 0x21
const unsigned long DOM_VK_PAGE_DOWN = 0x22
const unsigned long DOM_VK_END = 0x23
const unsigned long DOM_VK_HOME = 0x24
const unsigned long DOM_VK_LEFT = 0x25
const unsigned long DOM_VK_UP = 0x26
const unsigned long DOM_VK_RIGHT = 0x27
const unsigned long DOM_VK_DOWN = 0x28
const unsigned long DOM_VK_PRINTSCREEN = 0x2C
const unsigned long DOM_VK_INSERT = 0x2D
const unsigned long DOM_VK_DELETE = 0x2E
const unsigned long DOM_VK_0 = 0x30
const unsigned long DOM_VK_1 = 0x31
const unsigned long DOM_VK_2 = 0x32
const unsigned long DOM_VK_3 = 0x33
const unsigned long DOM_VK_4 = 0x34
const unsigned long DOM_VK_5 = 0x35
const unsigned long DOM_VK_6 = 0x36
const unsigned long DOM_VK_7 = 0x37
const unsigned long DOM_VK_8 = 0x38
const unsigned long DOM_VK_9 = 0x39
const unsigned long DOM_VK_SEMICOLON = 0x3B
const unsigned long DOM_VK_EQUALS = 0x3D
const unsigned long DOM_VK_A = 0x41
const unsigned long DOM_VK_B = 0x42
const unsigned long DOM_VK_C = 0x43
const unsigned long DOM_VK_D = 0x44
const unsigned long DOM_VK_E = 0x45
const unsigned long DOM_VK_F = 0x46
const unsigned long DOM_VK_G = 0x47
const unsigned long DOM_VK_H = 0x48
const unsigned long DOM_VK_I = 0x49
const unsigned long DOM_VK_J = 0x4A
const unsigned long DOM_VK_K = 0x4B
const unsigned long DOM_VK_L = 0x4C
const unsigned long DOM_VK_M = 0x4D
const unsigned long DOM_VK_N = 0x4E
const unsigned long DOM_VK_O = 0x4F
const unsigned long DOM_VK_P = 0x50
const unsigned long DOM_VK_Q = 0x51
const unsigned long DOM_VK_R = 0x52
const unsigned long DOM_VK_S = 0x53
const unsigned long DOM_VK_T = 0x54
const unsigned long DOM_VK_U = 0x55
const unsigned long DOM_VK_V = 0x56
const unsigned long DOM_VK_W = 0x57
const unsigned long DOM_VK_X = 0x58
const unsigned long DOM_VK_Y = 0x59
const unsigned long DOM_VK_Z = 0x5A
const unsigned long DOM_VK_CONTEXT_MENU = 0x5D
const unsigned long DOM_VK_NUMPAD0 = 0x60
const unsigned long DOM_VK_NUMPAD1 = 0x61
const unsigned long DOM_VK_NUMPAD2 = 0x62
const unsigned long DOM_VK_NUMPAD3 = 0x63
const unsigned long DOM_VK_NUMPAD4 = 0x64
const unsigned long DOM_VK_NUMPAD5 = 0x65
const unsigned long DOM_VK_NUMPAD6 = 0x66
const unsigned long DOM_VK_NUMPAD7 = 0x67
const unsigned long DOM_VK_NUMPAD8 = 0x68
const unsigned long DOM_VK_NUMPAD9 = 0x69
const unsigned long DOM_VK_MULTIPLY = 0x6A
const unsigned long DOM_VK_ADD = 0x6B
const unsigned long DOM_VK_SEPARATOR = 0x6C
const unsigned long DOM_VK_SUBTRACT = 0x6D
const unsigned long DOM_VK_DECIMAL = 0x6E
const unsigned long DOM_VK_DIVIDE = 0x6F
const unsigned long DOM_VK_F1 = 0x70
const unsigned long DOM_VK_F2 = 0x71
const unsigned long DOM_VK_F3 = 0x72
const unsigned long DOM_VK_F4 = 0x73
const unsigned long DOM_VK_F5 = 0x74
const unsigned long DOM_VK_F6 = 0x75
const unsigned long DOM_VK_F7 = 0x76
const unsigned long DOM_VK_F8 = 0x77
const unsigned long DOM_VK_F9 = 0x78
const unsigned long DOM_VK_F10 = 0x79
const unsigned long DOM_VK_F11 = 0x7A
const unsigned long DOM_VK_F12 = 0x7B
const unsigned long DOM_VK_F13 = 0x7C
const unsigned long DOM_VK_F14 = 0x7D
const unsigned long DOM_VK_F15 = 0x7E
const unsigned long DOM_VK_F16 = 0x7F
const unsigned long DOM_VK_F17 = 0x80
const unsigned long DOM_VK_F18 = 0x81
const unsigned long DOM_VK_F19 = 0x82
const unsigned long DOM_VK_F20 = 0x83
const unsigned long DOM_VK_F21 = 0x84
const unsigned long DOM_VK_F22 = 0x85
const unsigned long DOM_VK_F23 = 0x86
const unsigned long DOM_VK_F24 = 0x87
const unsigned long DOM_VK_NUM_LOCK = 0x90
const unsigned long DOM_VK_SCROLL_LOCK = 0x91
const unsigned long DOM_VK_COMMA = 0xBC
const unsigned long DOM_VK_PERIOD = 0xBE
const unsigned long DOM_VK_SLASH = 0xBF
const unsigned long DOM_VK_BACK_QUOTE = 0xC0
const unsigned long DOM_VK_OPEN_BRACKET = 0xDB
const unsigned long DOM_VK_BACK_SLASH = 0xDC
const unsigned long DOM_VK_CLOSE_BRACKET = 0xDD
const unsigned long DOM_VK_QUOTE = 0xDE
const unsigned long DOM_VK_META = 0xE0
readonly attribute unsigned long charCode
readonly attribute unsigned long keyCode
readonly attribute boolean altKey
readonly attribute boolean ctrlKey
readonly attribute boolean shiftKey
readonly attribute boolean metaKey
readonly attribute
nsIDOMAbstractView 
view
readonly attribute long detail
const unsigned short CAPTURING_PHASE = 1
 The current event phase is the capturing phase.
const unsigned short AT_TARGET = 2
 The event is currently being evaluated at the target EventTarget.
const unsigned short BUBBLING_PHASE = 3
 The current event phase is the bubbling phase.
readonly attribute DOMString type
 The name of the event (case-insensitive).
readonly attribute
nsIDOMEventTarget 
target
 Used to indicate the EventTarget to which the event was originally dispatched.
readonly attribute
nsIDOMEventTarget 
currentTarget
 Used to indicate the EventTarget whose EventListeners are currently being processed.
readonly attribute unsigned short eventPhase
 Used to indicate which phase of event flow is currently being evaluated.
readonly attribute boolean bubbles
 Used to indicate whether or not an event is a bubbling event.
readonly attribute boolean cancelable
 Used to indicate whether or not an event can have its default action prevented.
readonly attribute DOMTimeStamp timeStamp
 Used to specify the time (in milliseconds relative to the epoch) at which the event was created.

Detailed Description

Definition at line 43 of file nsIDOMKeyEvent.idl.


Member Function Documentation

void nsIDOMEvent::initEvent ( in DOMString  eventTypeArg,
in boolean  canBubbleArg,
in boolean  cancelableArg 
) [inherited]

The initEvent method is used to initialize the value of an Event created through the DocumentEvent interface.

This method may only be called before the Event has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times the final invocation takes precedence. If called from a subclass of Event interface only the values specified in the initEvent method are modified, all other attributes are left unchanged.

Parameters:
eventTypeArgSpecifies the event type. This type may be any event type currently defined in this specification or a new event type.. The string must be an XML name. Any new event type must not begin with any upper, lower, or mixed case version of the string "DOM". This prefix is reserved for future DOM event sets. It is also strongly recommended that third parties adding their own events use their own prefix to avoid confusion and lessen the probability of conflicts with other new events.
canBubbleArgSpecifies whether or not the event can bubble.
cancelableArgSpecifies whether or not the event's default action can be prevented.
void nsIDOMKeyEvent::initKeyEvent ( in DOMString  typeArg,
in boolean  canBubbleArg,
in boolean  cancelableArg,
in nsIDOMAbstractView  viewArg,
in boolean  ctrlKeyArg,
in boolean  altKeyArg,
in boolean  shiftKeyArg,
in boolean  metaKeyArg,
in unsigned long  keyCodeArg,
in unsigned long  charCodeArg 
)
void nsIDOMUIEvent::initUIEvent ( in DOMString  typeArg,
in boolean  canBubbleArg,
in boolean  cancelableArg,
in nsIDOMAbstractView  viewArg,
in long  detailArg 
) [inherited]

If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur.

If, during any stage of event flow, the preventDefault method is called the event is canceled. Any default action associated with the event will not occur. Calling this method for a non-cancelable event has no effect. Once preventDefault has been called it will remain in effect throughout the remainder of the event's propagation. This method may be used during any stage of event flow.

The stopPropagation method is used prevent further propagation of an event during event flow.

If this method is called by any EventListener the event will cease propagating through the tree. The event will complete dispatch to all listeners on the current EventTarget before event flow stops. This method may be used during any stage of event flow.


Member Data Documentation

Definition at line 174 of file nsIDOMKeyEvent.idl.

const unsigned short nsIDOMEvent::AT_TARGET = 2 [inherited]

The event is currently being evaluated at the target EventTarget.

Definition at line 66 of file nsIDOMEvent.idl.

readonly attribute boolean nsIDOMEvent::bubbles [inherited]

Used to indicate whether or not an event is a bubbling event.

If the event can bubble the value is true, else the value is false.

Definition at line 102 of file nsIDOMEvent.idl.

const unsigned short nsIDOMEvent::BUBBLING_PHASE = 3 [inherited]

The current event phase is the bubbling phase.

Definition at line 71 of file nsIDOMEvent.idl.

Used to indicate whether or not an event can have its default action prevented.

If the default action can be prevented the value is true, else the value is false.

Definition at line 109 of file nsIDOMEvent.idl.

const unsigned short nsIDOMEvent::CAPTURING_PHASE = 1 [inherited]

The current event phase is the capturing phase.

Definition at line 61 of file nsIDOMEvent.idl.

Definition at line 171 of file nsIDOMKeyEvent.idl.

Definition at line 175 of file nsIDOMKeyEvent.idl.

Used to indicate the EventTarget whose EventListeners are currently being processed.

This is particularly useful during capturing and bubbling.

Definition at line 90 of file nsIDOMEvent.idl.

readonly attribute long nsIDOMUIEvent::detail [inherited]

Definition at line 56 of file nsIDOMUIEvent.idl.

Definition at line 72 of file nsIDOMKeyEvent.idl.

Definition at line 73 of file nsIDOMKeyEvent.idl.

Definition at line 74 of file nsIDOMKeyEvent.idl.

Definition at line 75 of file nsIDOMKeyEvent.idl.

Definition at line 76 of file nsIDOMKeyEvent.idl.

Definition at line 77 of file nsIDOMKeyEvent.idl.

Definition at line 78 of file nsIDOMKeyEvent.idl.

Definition at line 79 of file nsIDOMKeyEvent.idl.

Definition at line 80 of file nsIDOMKeyEvent.idl.

Definition at line 81 of file nsIDOMKeyEvent.idl.

Definition at line 87 of file nsIDOMKeyEvent.idl.

Definition at line 127 of file nsIDOMKeyEvent.idl.

Definition at line 54 of file nsIDOMKeyEvent.idl.

Definition at line 88 of file nsIDOMKeyEvent.idl.

Definition at line 163 of file nsIDOMKeyEvent.idl.

Definition at line 165 of file nsIDOMKeyEvent.idl.

Definition at line 47 of file nsIDOMKeyEvent.idl.

Definition at line 89 of file nsIDOMKeyEvent.idl.

Definition at line 45 of file nsIDOMKeyEvent.idl.

Definition at line 56 of file nsIDOMKeyEvent.idl.

Definition at line 49 of file nsIDOMKeyEvent.idl.

Definition at line 166 of file nsIDOMKeyEvent.idl.

Definition at line 160 of file nsIDOMKeyEvent.idl.

Definition at line 114 of file nsIDOMKeyEvent.idl.

Definition at line 53 of file nsIDOMKeyEvent.idl.

Definition at line 90 of file nsIDOMKeyEvent.idl.

Definition at line 130 of file nsIDOMKeyEvent.idl.

Definition at line 69 of file nsIDOMKeyEvent.idl.

Definition at line 131 of file nsIDOMKeyEvent.idl.

Definition at line 66 of file nsIDOMKeyEvent.idl.

Definition at line 91 of file nsIDOMKeyEvent.idl.

Definition at line 61 of file nsIDOMKeyEvent.idl.

Definition at line 51 of file nsIDOMKeyEvent.idl.

Definition at line 84 of file nsIDOMKeyEvent.idl.

Definition at line 57 of file nsIDOMKeyEvent.idl.

Definition at line 92 of file nsIDOMKeyEvent.idl.

Definition at line 132 of file nsIDOMKeyEvent.idl.

Definition at line 141 of file nsIDOMKeyEvent.idl.

Definition at line 142 of file nsIDOMKeyEvent.idl.

Definition at line 143 of file nsIDOMKeyEvent.idl.

Definition at line 144 of file nsIDOMKeyEvent.idl.

Definition at line 145 of file nsIDOMKeyEvent.idl.

Definition at line 146 of file nsIDOMKeyEvent.idl.

Definition at line 147 of file nsIDOMKeyEvent.idl.

Definition at line 148 of file nsIDOMKeyEvent.idl.

Definition at line 149 of file nsIDOMKeyEvent.idl.

Definition at line 150 of file nsIDOMKeyEvent.idl.

Definition at line 133 of file nsIDOMKeyEvent.idl.

Definition at line 151 of file nsIDOMKeyEvent.idl.

Definition at line 152 of file nsIDOMKeyEvent.idl.

Definition at line 153 of file nsIDOMKeyEvent.idl.

Definition at line 154 of file nsIDOMKeyEvent.idl.

Definition at line 155 of file nsIDOMKeyEvent.idl.

Definition at line 134 of file nsIDOMKeyEvent.idl.

Definition at line 135 of file nsIDOMKeyEvent.idl.

Definition at line 136 of file nsIDOMKeyEvent.idl.

Definition at line 137 of file nsIDOMKeyEvent.idl.

Definition at line 138 of file nsIDOMKeyEvent.idl.

Definition at line 139 of file nsIDOMKeyEvent.idl.

Definition at line 140 of file nsIDOMKeyEvent.idl.

Definition at line 93 of file nsIDOMKeyEvent.idl.

Definition at line 94 of file nsIDOMKeyEvent.idl.

Definition at line 46 of file nsIDOMKeyEvent.idl.

Definition at line 62 of file nsIDOMKeyEvent.idl.

Definition at line 95 of file nsIDOMKeyEvent.idl.

Definition at line 68 of file nsIDOMKeyEvent.idl.

Definition at line 96 of file nsIDOMKeyEvent.idl.

Definition at line 97 of file nsIDOMKeyEvent.idl.

Definition at line 98 of file nsIDOMKeyEvent.idl.

Definition at line 63 of file nsIDOMKeyEvent.idl.

Definition at line 99 of file nsIDOMKeyEvent.idl.

Definition at line 169 of file nsIDOMKeyEvent.idl.

Definition at line 126 of file nsIDOMKeyEvent.idl.

Definition at line 100 of file nsIDOMKeyEvent.idl.

Definition at line 157 of file nsIDOMKeyEvent.idl.

Definition at line 116 of file nsIDOMKeyEvent.idl.

Definition at line 117 of file nsIDOMKeyEvent.idl.

Definition at line 118 of file nsIDOMKeyEvent.idl.

Definition at line 119 of file nsIDOMKeyEvent.idl.

Definition at line 120 of file nsIDOMKeyEvent.idl.

Definition at line 121 of file nsIDOMKeyEvent.idl.

Definition at line 122 of file nsIDOMKeyEvent.idl.

Definition at line 123 of file nsIDOMKeyEvent.idl.

Definition at line 124 of file nsIDOMKeyEvent.idl.

Definition at line 125 of file nsIDOMKeyEvent.idl.

Definition at line 101 of file nsIDOMKeyEvent.idl.

Definition at line 164 of file nsIDOMKeyEvent.idl.

Definition at line 102 of file nsIDOMKeyEvent.idl.

Definition at line 60 of file nsIDOMKeyEvent.idl.

Definition at line 59 of file nsIDOMKeyEvent.idl.

Definition at line 55 of file nsIDOMKeyEvent.idl.

Definition at line 161 of file nsIDOMKeyEvent.idl.

Definition at line 67 of file nsIDOMKeyEvent.idl.

Definition at line 103 of file nsIDOMKeyEvent.idl.

Definition at line 167 of file nsIDOMKeyEvent.idl.

Definition at line 104 of file nsIDOMKeyEvent.idl.

Definition at line 50 of file nsIDOMKeyEvent.idl.

Definition at line 65 of file nsIDOMKeyEvent.idl.

Definition at line 105 of file nsIDOMKeyEvent.idl.

Definition at line 158 of file nsIDOMKeyEvent.idl.

Definition at line 83 of file nsIDOMKeyEvent.idl.

Definition at line 128 of file nsIDOMKeyEvent.idl.

Definition at line 52 of file nsIDOMKeyEvent.idl.

Definition at line 162 of file nsIDOMKeyEvent.idl.

Definition at line 58 of file nsIDOMKeyEvent.idl.

Definition at line 129 of file nsIDOMKeyEvent.idl.

Definition at line 106 of file nsIDOMKeyEvent.idl.

Definition at line 48 of file nsIDOMKeyEvent.idl.

Definition at line 107 of file nsIDOMKeyEvent.idl.

Definition at line 64 of file nsIDOMKeyEvent.idl.

Definition at line 108 of file nsIDOMKeyEvent.idl.

Definition at line 109 of file nsIDOMKeyEvent.idl.

Definition at line 110 of file nsIDOMKeyEvent.idl.

Definition at line 111 of file nsIDOMKeyEvent.idl.

Definition at line 112 of file nsIDOMKeyEvent.idl.

readonly attribute unsigned short nsIDOMEvent::eventPhase [inherited]

Used to indicate which phase of event flow is currently being evaluated.

Definition at line 96 of file nsIDOMEvent.idl.

Definition at line 172 of file nsIDOMKeyEvent.idl.

Definition at line 177 of file nsIDOMKeyEvent.idl.

Definition at line 176 of file nsIDOMKeyEvent.idl.

Used to indicate the EventTarget to which the event was originally dispatched.

Definition at line 83 of file nsIDOMEvent.idl.

Used to specify the time (in milliseconds relative to the epoch) at which the event was created.

Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.

Definition at line 119 of file nsIDOMEvent.idl.

readonly attribute DOMString nsIDOMEvent::type [inherited]

The name of the event (case-insensitive).

The name must be an XML name.

Definition at line 77 of file nsIDOMEvent.idl.

Definition at line 55 of file nsIDOMUIEvent.idl.


The documentation for this interface was generated from the following file: