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

     1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
     2 /* This Source Code Form is subject to the terms of the Mozilla Public
     3  * License, v. 2.0. If a copy of the MPL was not distributed with this
     4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     6 #include "nsIDOMEvent.idl"
     8 /**
     9  * The nsIDOMPageTransitionEvent interface is used for the pageshow and
    10  * pagehide events, which are generic events that apply to both page
    11  * load/unload and saving/restoring a document from session history.
    12  */
    14 [scriptable, builtinclass, uuid(8a69a3d6-c7da-4caa-993c-7f9583d9f896)]
    15 interface nsIDOMPageTransitionEvent : nsIDOMEvent
    16 {
    17   /**
    18    * Set to true if the document has been or will be persisted across
    19    * firing of the event.  For example, if a document is being cached in
    20    * session history, |persisted| is true for the PageHide event.
    21    */
    22   readonly attribute boolean persisted;
    24   /* Initialize a new pageshow or pagehide event. */
    25   void initPageTransitionEvent(in DOMString typeArg,
    26                                in boolean canBubbleArg,
    27                                in boolean canCancelArg,
    28                                in boolean persisted);
    29 };

mercurial