Landing the XPCDOM_20010329_BRANCH branch, changes mostly done by jband@netscape.com and jst@netscape.com, also some changes done by shaver@mozilla.org, peterv@netscape.com and markh@activestate.com. r= and sr= by vidur@netscape.com, jband@netscape.com, jst@netscpae.com, danm@netscape.com, hyatt@netscape.com, shaver@mozilla.org, dbradley@netscape.com, rpotts@netscape.com.
2001-05-08 21:42:36 +04:00
|
|
|
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
2012-05-21 15:12:37 +04:00
|
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
2001-01-21 12:10:30 +03:00
|
|
|
|
|
|
|
#include "domstubs.idl"
|
|
|
|
|
Landing the XPCDOM_20010329_BRANCH branch, changes mostly done by jband@netscape.com and jst@netscape.com, also some changes done by shaver@mozilla.org, peterv@netscape.com and markh@activestate.com. r= and sr= by vidur@netscape.com, jband@netscape.com, jst@netscpae.com, danm@netscape.com, hyatt@netscape.com, shaver@mozilla.org, dbradley@netscape.com, rpotts@netscape.com.
2001-05-08 21:42:36 +04:00
|
|
|
interface nsIDOMEventTarget;
|
|
|
|
|
2001-12-06 09:57:03 +03:00
|
|
|
/**
|
|
|
|
* The nsIDOMEvent interface is the primary datatype for all events in
|
|
|
|
* the Document Object Model.
|
|
|
|
*
|
|
|
|
* For more information on this interface please see
|
2012-05-03 14:59:51 +04:00
|
|
|
* http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html and
|
|
|
|
* http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html
|
2001-12-06 09:57:03 +03:00
|
|
|
*/
|
Landing the XPCDOM_20010329_BRANCH branch, changes mostly done by jband@netscape.com and jst@netscape.com, also some changes done by shaver@mozilla.org, peterv@netscape.com and markh@activestate.com. r= and sr= by vidur@netscape.com, jband@netscape.com, jst@netscpae.com, danm@netscape.com, hyatt@netscape.com, shaver@mozilla.org, dbradley@netscape.com, rpotts@netscape.com.
2001-05-08 21:42:36 +04:00
|
|
|
|
2011-11-04 21:17:19 +04:00
|
|
|
[scriptable, uuid(e85cff74-951f-45c1-be0c-89442ea2f500)]
|
2001-01-21 12:10:30 +03:00
|
|
|
interface nsIDOMEvent : nsISupports
|
|
|
|
{
|
2001-12-06 09:57:03 +03:00
|
|
|
// PhaseType
|
2012-05-03 14:59:51 +04:00
|
|
|
/**
|
|
|
|
* The event isn't being dispatched.
|
|
|
|
*/
|
|
|
|
const unsigned short NONE = 0;
|
2002-05-03 23:57:42 +04:00
|
|
|
/**
|
|
|
|
* The current event phase is the capturing phase.
|
|
|
|
*/
|
2001-12-06 09:57:03 +03:00
|
|
|
const unsigned short CAPTURING_PHASE = 1;
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The event is currently being evaluated at the target EventTarget.
|
|
|
|
*/
|
2001-12-06 09:57:03 +03:00
|
|
|
const unsigned short AT_TARGET = 2;
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The current event phase is the bubbling phase.
|
|
|
|
*/
|
2001-12-06 09:57:03 +03:00
|
|
|
const unsigned short BUBBLING_PHASE = 3;
|
2001-01-21 12:10:30 +03:00
|
|
|
|
2002-05-03 23:57:42 +04:00
|
|
|
/**
|
|
|
|
* The name of the event (case-insensitive). The name must be an XML
|
|
|
|
* name.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
readonly attribute DOMString type;
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Used to indicate the EventTarget to which the event was originally
|
|
|
|
* dispatched.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
readonly attribute nsIDOMEventTarget target;
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Used to indicate the EventTarget whose EventListeners are currently
|
|
|
|
* being processed. This is particularly useful during capturing and
|
|
|
|
* bubbling.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
readonly attribute nsIDOMEventTarget currentTarget;
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Used to indicate which phase of event flow is currently being
|
|
|
|
* evaluated.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
readonly attribute unsigned short eventPhase;
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
readonly attribute boolean bubbles;
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
readonly attribute boolean cancelable;
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
readonly attribute DOMTimeStamp timeStamp;
|
2001-01-21 12:10:30 +03:00
|
|
|
|
2002-05-03 23:57:42 +04:00
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
void stopPropagation();
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
void preventDefault();
|
2002-05-03 23:57:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
* @param eventTypeArg Specifies 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.
|
|
|
|
* @param canBubbleArg Specifies whether or not the event can bubble.
|
|
|
|
* @param cancelableArg Specifies whether or not the event's default
|
|
|
|
* action can be prevented.
|
|
|
|
*/
|
2001-01-22 07:34:24 +03:00
|
|
|
void initEvent(in DOMString eventTypeArg,
|
|
|
|
in boolean canBubbleArg,
|
|
|
|
in boolean cancelableArg);
|
2011-05-14 00:44:35 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Used to indicate whether preventDefault() has been called for this event.
|
|
|
|
*/
|
|
|
|
readonly attribute boolean defaultPrevented;
|
2011-11-04 21:17:19 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Prevents other event listeners from being triggered and,
|
|
|
|
* unlike Event.stopPropagation() its effect is immediate.
|
|
|
|
*/
|
|
|
|
void stopImmediatePropagation();
|
2001-01-21 12:10:30 +03:00
|
|
|
};
|
2011-12-14 23:53:48 +04:00
|
|
|
|
2012-03-13 08:44:48 +04:00
|
|
|
dictionary EventInit
|
2011-12-14 23:53:48 +04:00
|
|
|
{
|
2012-03-13 08:44:48 +04:00
|
|
|
boolean bubbles;
|
|
|
|
boolean cancelable;
|
2011-12-14 23:53:48 +04:00
|
|
|
};
|