dom/interfaces/storage/nsIDOMStorageEvent.idl@b8a032363ba2 (annotated)
dom/interfaces/storage/nsIDOMStorageEvent.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "domstubs.idl" |
| michael@0 | 7 | #include "nsIDOMEvent.idl" |
| michael@0 | 8 | |
| michael@0 | 9 | /** |
| michael@0 | 10 | * Interface for a client side storage. See |
| michael@0 | 11 | * http://dev.w3.org/html5/webstorage/#the-storage-event |
| michael@0 | 12 | * for more information. |
| michael@0 | 13 | * |
| michael@0 | 14 | * Event sent to a window when a storage area changes. |
| michael@0 | 15 | */ |
| michael@0 | 16 | |
| michael@0 | 17 | interface nsIDOMStorage; |
| michael@0 | 18 | |
| michael@0 | 19 | [scriptable, builtinclass, uuid(85f04275-4679-4e89-b43f-142bbbab1e89)] |
| michael@0 | 20 | interface nsIDOMStorageEvent : nsIDOMEvent |
| michael@0 | 21 | { |
| michael@0 | 22 | /** |
| michael@0 | 23 | * Attribute represents the key being changed. The key attribute is null |
| michael@0 | 24 | * when change has been invoked by the storage clear() method. |
| michael@0 | 25 | */ |
| michael@0 | 26 | readonly attribute DOMString key; |
| michael@0 | 27 | |
| michael@0 | 28 | /** |
| michael@0 | 29 | * The original value of the key. The oldValue is null when the change |
| michael@0 | 30 | * has been invoked by storage clear() method or the key has been newly |
| michael@0 | 31 | * added and therefor doesn't have any previous value. |
| michael@0 | 32 | */ |
| michael@0 | 33 | readonly attribute DOMString oldValue; |
| michael@0 | 34 | |
| michael@0 | 35 | /** |
| michael@0 | 36 | * The new value of the key. The newValue is null when the change |
| michael@0 | 37 | * has been invoked by storage clear() method or the key has been removed |
| michael@0 | 38 | * from the storage. |
| michael@0 | 39 | */ |
| michael@0 | 40 | readonly attribute DOMString newValue; |
| michael@0 | 41 | |
| michael@0 | 42 | /** |
| michael@0 | 43 | * Represents the address of the document whose key changed. |
| michael@0 | 44 | */ |
| michael@0 | 45 | readonly attribute DOMString url; |
| michael@0 | 46 | |
| michael@0 | 47 | /** |
| michael@0 | 48 | * Represents the Storage object that was affected. |
| michael@0 | 49 | */ |
| michael@0 | 50 | readonly attribute nsIDOMStorage storageArea; |
| michael@0 | 51 | |
| michael@0 | 52 | /** |
| michael@0 | 53 | * Initialize the event in a manner analogous to the similarly-named method |
| michael@0 | 54 | * in the DOM Events interfaces. |
| michael@0 | 55 | */ |
| michael@0 | 56 | void initStorageEvent(in DOMString typeArg, |
| michael@0 | 57 | in boolean canBubbleArg, |
| michael@0 | 58 | in boolean cancelableArg, |
| michael@0 | 59 | in DOMString keyArg, |
| michael@0 | 60 | in DOMString oldValueArg, |
| michael@0 | 61 | in DOMString newValueArg, |
| michael@0 | 62 | in DOMString urlArg, |
| michael@0 | 63 | in nsIDOMStorage storageAreaArg); |
| michael@0 | 64 | }; |
