"Fossies" - the Fresh Open Source Software Archive
Member "firefox-69.0.1/docshell/shistory/nsISHistoryListener.idl" (17 Sep 2019, 2606 Bytes) of package /linux/www/firefox-69.0.1.source.tar.xz:
As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) IDL source code syntax highlighting (style: standard
) with prefixed line numbers.
Alternatively you can here view
the uninterpreted source code file.
See also the last Fossies "Diffs"
side-by-side code changes reports for "nsISHistoryListener.idl": 60.7.2_vs_68.0
1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
7 #include "nsISupports.idl"
9 interface nsIURI;
12 * nsISHistoryListener defines the interface one can implement to receive
13 * notifications about activities in session history and (for reloads) to be
14 * able to cancel them.
16 * A session history listener will be notified when pages are added, removed
17 * and loaded from session history. In the case of reloads, it can prevent them
18 * from happening by returning false from the corresponding callback method.
20 * A session history listener can be registered on a particular nsISHistory
21 * instance via the nsISHistory::addSHistoryListener() method.
23 * Listener methods should not alter the session history. Things are likely to
24 * go haywire if they do.
26 [scriptable, uuid(125c0833-746a-400e-9b89-d2d18545c08a)]
27 interface nsISHistoryListener : nsISupports
30 * Called when a new document is added to session history. New documents are
31 * added to session history by docshell when new pages are loaded in a frame
32 * or content area, for example via nsIWebNavigation::loadURI()
34 * @param aNewURI The URI of the document to be added to session history.
35 * @param aOldIndex The index of the current history item before the
36 * operation.
38 void OnHistoryNewEntry(in nsIURI aNewURI, in long aOldIndex);
41 * Called before the current document is reloaded, for example due to a
42 * nsIWebNavigation::reload() call.
44 boolean OnHistoryReload();
47 * Called before navigating to a session history entry by index, for example,
48 * when nsIWebNavigation::gotoIndex() is called.
50 void OnHistoryGotoIndex();
53 * Called before entries are removed from session history. Entries can be
54 * removed from session history for various reasons, for example to control
55 * the memory usage of the browser, to prevent users from loading documents
56 * from history, to erase evidence of prior page loads, etc.
58 * To purge documents from session history call nsISHistory::PurgeHistory().
60 void OnHistoryPurge();
63 * Called before an entry is replaced in the session history. Entries are
64 * replaced when navigating away from non-persistent history entries (such as
65 * about pages) and when history.replaceState is called.
67 void OnHistoryReplaceEntry();