nsISHistoryListener.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:8k
源码类别:
PlugIns编程
开发平台:
Visual C++
- /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is the Mozilla browser.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications, Inc.
- * Portions created by the Initial Developer are Copyright (C) 1999
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either of the GNU General Public License Version 2 or later (the "GPL"),
- * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
- #include "nsISupports.idl"
- interface nsIURI;
- /**
- * nsISHistoryListener defines the interface for an object that wishes
- * to receive notifications about activities in History. A history
- * listener will be notified when pages are added, removed and loaded
- * from session history. A listener to session history can be registered
- * using the interface nsISHistory.
- *
- * @status FROZEN
- */
- %{C++
- #define NS_SHISTORYLISTENER_CONTRACTID "@mozilla.org/browser/shistorylistener;1"
- %}
- // interface nsISHistoryListener
- [scriptable, uuid(3b07f591-e8e1-11d4-9882-00c04fa02f40)]
- interface nsISHistoryListener : nsISupports
- {
- /**
- * called to notify a listener when a new document is
- * added to session history. New documents are added to
- * session history by docshell when new pages are loaded
- * in a frame or content area.
- *
- * @param aNewURI The uri of the document to be added to session history
- *
- * @return <CODE>NS_OK</CODE> notification sent out successfully
- */
- void OnHistoryNewEntry(in nsIURI aNewURI);
- /**
- * called to notify a listener when the user presses the 'back' button
- * of the browser OR when the user attempts to go back one page
- * in history thro' other means, from javascript or using nsIWebNavigation
- *
- * @param aBackURI The uri of the previous page which is to be
- * loaded.
- *
- * @return aReturn A boolean flag returned by the listener to
- * indicate if the back operation is to be aborted
- * or continued. If the listener returns 'true', it indicates
- * that the back operation can be continued. If the listener
- * returns 'false', then the back operation will be aborted.
- * This is a mechanism for the listener to control user's
- * operations with history.
- *
- */
- boolean OnHistoryGoBack(in nsIURI aBackURI);
- /**
- * called to notify a listener when the user presses the 'forward' button
- * of the browser OR when the user attempts to go forward one page
- * in history thro' other means, from javascript or using nsIWebNavigation
- *
- * @param aForwardURI The uri of the next page which is to be
- * loaded.
- *
- * @return aReturn A boolean flag returned by the listener to
- * indicate if the forward operation is to be aborted
- * or continued. If the listener returns 'true', it indicates
- * that the forward operation can be continued. If the listener
- * returns 'false', then the forward operation will be aborted.
- * This is a mechanism for the listener to control user's
- * operations with history.
- *
- */
- boolean OnHistoryGoForward(in nsIURI aForwardURI);
- /**
- * called to notify a listener when the user presses the 'reload' button
- * of the browser OR when the user attempts to reload the current document
- * through other means, like from javascript or using nsIWebNavigation
- *
- * @param aReloadURI The uri of the current document to be reloaded.
- * @param aReloadFlags Flags that indicate how the document is to be
- * refreshed. For example, from cache or bypassing
- * cache and/or Proxy server.
- * @return aReturn A boolean flag returned by the listener to indicate
- * if the reload operation is to be aborted or continued.
- * If the listener returns 'true', it indicates that the
- * reload operation can be continued. If the listener
- * returns 'false', then the reload operation will be aborted.
- * This is a mechanism for the listener to control user's
- * operations with history.
- * @see nsIWebNavigation
- *
- */
- boolean OnHistoryReload(in nsIURI aReloadURI, in unsigned long aReloadFlags);
- /**
- * called to notify a listener when the user visits a page using the 'Go' menu
- * of the browser OR when the user attempts to go to a page at a particular index
- * through other means, like from javascript or using nsIWebNavigation
- *
- * @param aIndex The index in history of the document to be loaded.
- * @param aGotoURI The uri of the document to be loaded.
- *
- * @return aReturn A boolean flag returned by the listener to
- * indicate if the GotoIndex operation is to be aborted
- * or continued. If the listener returns 'true', it indicates
- * that the GotoIndex operation can be continued. If the listener
- * returns 'false', then the GotoIndex operation will be aborted.
- * This is a mechanism for the listener to control user's
- * operations with history.
- *
- */
- boolean OnHistoryGotoIndex(in long aIndex, in nsIURI aGotoURI);
- /**
- * called to notify a listener when documents are removed from session
- * history. Documents can be removed from session history for various
- * reasons. For example to control the memory usage of the browser, to
- * prevent users from loading documents from history, to erase evidence of
- * prior page loads etc... To purge documents from session history call
- * nsISHistory::PurgeHistory()
- *
- * @param aNumEntries The number of documents to be removed from session history.
- *
- * @return aReturn A boolean flag returned by the listener to
- * indicate if the purge operation is to be aborted
- * or continued. If the listener returns 'true', it indicates
- * that the purge operation can be continued. If the listener
- * returns 'false', then the purge operation will be aborted.
- * This is a mechanism for the listener to control user's
- * operations with history.
- *
- * @note While purging history, the older documents are removed
- * and newly loaded documents are kept. For example if there
- * are 5 documents in history, and nsISHistory::PurgeHistory(3)
- * is called, then, document 1, 2 and 3 are removed from history
- * and most recently loaded document 4 and 5 are kept.
- *
- */
- boolean OnHistoryPurge(in long aNumEntries);
- };