nsISHistoryListener.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:8k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2.  *
  3.  * ***** BEGIN LICENSE BLOCK *****
  4.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5.  *
  6.  * The contents of this file are subject to the Mozilla Public License Version
  7.  * 1.1 (the "License"); you may not use this file except in compliance with
  8.  * the License. You may obtain a copy of the License at
  9.  * http://www.mozilla.org/MPL/
  10.  *
  11.  * Software distributed under the License is distributed on an "AS IS" basis,
  12.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13.  * for the specific language governing rights and limitations under the
  14.  * License.
  15.  *
  16.  * The Original Code is the Mozilla browser.
  17.  *
  18.  * The Initial Developer of the Original Code is
  19.  * Netscape Communications, Inc.
  20.  * Portions created by the Initial Developer are Copyright (C) 1999
  21.  * the Initial Developer. All Rights Reserved.
  22.  *
  23.  * Contributor(s):
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38. #include "nsISupports.idl"
  39. interface nsIURI;
  40. /**
  41.  * nsISHistoryListener defines the interface for an object that wishes
  42.  * to receive notifications about activities in History. A history 
  43.  * listener will be notified when pages are added, removed and loaded 
  44.  * from session history. A listener to session history can be registered 
  45.  * using the interface nsISHistory.
  46.  *
  47.  * @status FROZEN
  48.  */
  49. %{C++
  50. #define NS_SHISTORYLISTENER_CONTRACTID "@mozilla.org/browser/shistorylistener;1"
  51. %}
  52. // interface nsISHistoryListener
  53. [scriptable, uuid(3b07f591-e8e1-11d4-9882-00c04fa02f40)]
  54. interface nsISHistoryListener : nsISupports 
  55. {
  56.   /**
  57.    * called to notify a listener when a new document is
  58.    * added to session history. New documents are added to 
  59.    * session history by docshell when new pages are loaded
  60.    * in a frame or content area. 
  61.    *
  62.    * @param aNewURI     The uri of the document to be added to session history
  63.    *
  64.    * @return            <CODE>NS_OK</CODE> notification sent out successfully
  65.    */
  66.    void OnHistoryNewEntry(in nsIURI aNewURI);
  67.   /**
  68.    * called to notify a listener when the user presses the 'back' button
  69.    * of the browser OR when the user attempts to go back one page
  70.    * in history thro' other means, from javascript or using nsIWebNavigation
  71.    *
  72.    * @param aBackURI        The uri of the previous page  which is to be 
  73.    *                        loaded.
  74.    * 
  75.    * @return aReturn        A boolean flag returned by the listener to
  76.    *                        indicate if the back operation is to be aborted 
  77.    *                        or continued.  If the listener returns 'true', it indicates 
  78.    *                        that the back operation can be continued. If the listener
  79.    *                        returns 'false', then the back operation will be aborted.
  80.    *                        This is a mechanism for the listener to control user's 
  81.    *                        operations with history.
  82.    * 
  83.    */
  84.    boolean OnHistoryGoBack(in nsIURI aBackURI);
  85.   /**
  86.    * called to notify a listener when the user presses the 'forward' button
  87.    * of the browser OR when the user attempts to go forward one page
  88.    * in history thro' other means, from javascript or using nsIWebNavigation
  89.    *
  90.    * @param aForwardURI     The uri of the next page  which is to be 
  91.    *                        loaded.
  92.    * 
  93.    * @return aReturn        A boolean flag returned by the listener to
  94.    *                        indicate if the forward operation is to be aborted 
  95.    *                        or continued.  If the listener returns 'true', it indicates 
  96.    *                        that the forward operation can be continued. If the listener
  97.    *                        returns 'false', then the forward operation will be aborted.
  98.    *                        This is a mechanism for the listener to control user's 
  99.    *                        operations with history.
  100.    * 
  101.    */
  102.    boolean OnHistoryGoForward(in nsIURI aForwardURI);
  103.   /** 
  104.    * called to notify a listener when the user presses the 'reload' button
  105.    * of the browser OR when the user attempts to reload the current document
  106.    * through other means, like from javascript or using nsIWebNavigation
  107.    *
  108.    * @param aReloadURI    The uri of the current document  to be reloaded.
  109.    * @param aReloadFlags  Flags that indicate how the document is to be 
  110.    *                      refreshed. For example, from cache or bypassing
  111.    *                      cache and/or Proxy server. 
  112.    * @return aReturn      A boolean flag returned by the listener to indicate 
  113.    *                      if the reload operation is to be aborted or continued.
  114.    *                      If the listener returns 'true', it indicates that the 
  115.    *                      reload operation can be continued. If the listener
  116.    *                      returns 'false', then the reload operation will be aborted.
  117.    *                      This is a mechanism for the listener to control user's 
  118.    *                      operations with history.
  119.    * @see  nsIWebNavigation
  120.    *  
  121.    */
  122.    boolean OnHistoryReload(in nsIURI aReloadURI, in unsigned long aReloadFlags);
  123.   /**
  124.    * called to notify a listener when the user visits a page using the 'Go' menu
  125.    * of the browser OR when the user attempts to go to a page at a particular index
  126.    * through other means, like from javascript or using nsIWebNavigation
  127.    *
  128.    * @param aIndex        The index in history of the document to be loaded.
  129.    * @param aGotoURI      The uri of the document to be loaded.
  130.    * 
  131.    * @return aReturn      A boolean flag  returned by the listener to
  132.    *                      indicate if the GotoIndex operation is to be aborted 
  133.    *                      or continued.  If the listener returns 'true', it indicates 
  134.    *                      that the GotoIndex operation can be continued. If the listener
  135.    *                      returns 'false', then the GotoIndex operation will be aborted.
  136.    *                      This is a mechanism for the listener to control user's 
  137.    *                      operations with history.
  138.    * 
  139.    */
  140.    boolean OnHistoryGotoIndex(in long aIndex, in nsIURI aGotoURI);
  141.   /**
  142.    * called to notify a listener when documents are removed from session
  143.    * history. Documents can be removed from session history for various 
  144.    * reasons. For example to control the memory usage of the browser, to 
  145.    * prevent users from loading documents from history, to erase evidence of
  146.    * prior page loads etc... To purge documents from session history call
  147.    * nsISHistory::PurgeHistory()
  148.    *
  149.    * @param aNumEntries   The number of documents to be removed from session history.
  150.    * 
  151.    * @return aReturn      A boolean flag returned by the listener to
  152.    *                      indicate if the purge operation is to be aborted 
  153.    *                      or continued.  If the listener returns 'true', it indicates 
  154.    *                      that the purge operation can be continued. If the listener
  155.    *                      returns 'false', then the purge operation will be aborted.
  156.    *                      This is a mechanism for the listener to control user's 
  157.    *                      operations with history.
  158.    *
  159.    * @note                While purging history, the older documents are removed
  160.    *                      and newly loaded documents are kept. For example  if there
  161.    *                      are 5 documents in history, and nsISHistory::PurgeHistory(3)
  162.    *                      is called, then, document 1, 2 and 3 are removed from history
  163.    *                      and most recently loaded document 4 and 5 are kept.
  164.    * 
  165.    */
  166.    boolean OnHistoryPurge(in long aNumEntries);
  167. };