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