dom/interfaces/events/nsIDOMPageTransitionEvent.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 "nsIDOMEvent.idl"
michael@0 7
michael@0 8 /**
michael@0 9 * The nsIDOMPageTransitionEvent interface is used for the pageshow and
michael@0 10 * pagehide events, which are generic events that apply to both page
michael@0 11 * load/unload and saving/restoring a document from session history.
michael@0 12 */
michael@0 13
michael@0 14 [scriptable, builtinclass, uuid(8a69a3d6-c7da-4caa-993c-7f9583d9f896)]
michael@0 15 interface nsIDOMPageTransitionEvent : nsIDOMEvent
michael@0 16 {
michael@0 17 /**
michael@0 18 * Set to true if the document has been or will be persisted across
michael@0 19 * firing of the event. For example, if a document is being cached in
michael@0 20 * session history, |persisted| is true for the PageHide event.
michael@0 21 */
michael@0 22 readonly attribute boolean persisted;
michael@0 23
michael@0 24 /* Initialize a new pageshow or pagehide event. */
michael@0 25 void initPageTransitionEvent(in DOMString typeArg,
michael@0 26 in boolean canBubbleArg,
michael@0 27 in boolean canCancelArg,
michael@0 28 in boolean persisted);
michael@0 29 };

mercurial