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

PlugIns编程

开发平台:

Visual C++

  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM c:/builds/tinderbox/XR-Mozilla1.8.0-Release/WINNT_5.2_Depend/mozilla/xpfe/components/shistory/public/nsISHistoryListener.idl
  3.  */
  4. #ifndef __gen_nsISHistoryListener_h__
  5. #define __gen_nsISHistoryListener_h__
  6. #ifndef __gen_nsISupports_h__
  7. #include "nsISupports.h"
  8. #endif
  9. /* For IDL files that don't want to include root IDL files. */
  10. #ifndef NS_NO_VTABLE
  11. #define NS_NO_VTABLE
  12. #endif
  13. class nsIURI; /* forward declaration */
  14. #define NS_SHISTORYLISTENER_CONTRACTID "@mozilla.org/browser/shistorylistener;1"
  15. /* starting interface:    nsISHistoryListener */
  16. #define NS_ISHISTORYLISTENER_IID_STR "3b07f591-e8e1-11d4-9882-00c04fa02f40"
  17. #define NS_ISHISTORYLISTENER_IID 
  18.   {0x3b07f591, 0xe8e1, 0x11d4, 
  19.     { 0x98, 0x82, 0x00, 0xc0, 0x4f, 0xa0, 0x2f, 0x40 }}
  20. /**
  21.  * nsISHistoryListener defines the interface for an object that wishes
  22.  * to receive notifications about activities in History. A history 
  23.  * listener will be notified when pages are added, removed and loaded 
  24.  * from session history. A listener to session history can be registered 
  25.  * using the interface nsISHistory.
  26.  *
  27.  * @status FROZEN
  28.  */
  29. class NS_NO_VTABLE nsISHistoryListener : public nsISupports {
  30.  public: 
  31.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISHISTORYLISTENER_IID)
  32.   /**
  33.    * called to notify a listener when a new document is
  34.    * added to session history. New documents are added to 
  35.    * session history by docshell when new pages are loaded
  36.    * in a frame or content area. 
  37.    *
  38.    * @param aNewURI     The uri of the document to be added to session history
  39.    *
  40.    * @return            <CODE>NS_OK</CODE> notification sent out successfully
  41.    */
  42.   /* void OnHistoryNewEntry (in nsIURI aNewURI); */
  43.   NS_IMETHOD OnHistoryNewEntry(nsIURI *aNewURI) = 0;
  44.   /**
  45.    * called to notify a listener when the user presses the 'back' button
  46.    * of the browser OR when the user attempts to go back one page
  47.    * in history thro' other means, from javascript or using nsIWebNavigation
  48.    *
  49.    * @param aBackURI        The uri of the previous page  which is to be 
  50.    *                        loaded.
  51.    * 
  52.    * @return aReturn        A boolean flag returned by the listener to
  53.    *                        indicate if the back operation is to be aborted 
  54.    *                        or continued.  If the listener returns 'true', it indicates 
  55.    *                        that the back operation can be continued. If the listener
  56.    *                        returns 'false', then the back operation will be aborted.
  57.    *                        This is a mechanism for the listener to control user's 
  58.    *                        operations with history.
  59.    * 
  60.    */
  61.   /* boolean OnHistoryGoBack (in nsIURI aBackURI); */
  62.   NS_IMETHOD OnHistoryGoBack(nsIURI *aBackURI, PRBool *_retval) = 0;
  63.   /**
  64.    * called to notify a listener when the user presses the 'forward' button
  65.    * of the browser OR when the user attempts to go forward one page
  66.    * in history thro' other means, from javascript or using nsIWebNavigation
  67.    *
  68.    * @param aForwardURI     The uri of the next page  which is to be 
  69.    *                        loaded.
  70.    * 
  71.    * @return aReturn        A boolean flag returned by the listener to
  72.    *                        indicate if the forward operation is to be aborted 
  73.    *                        or continued.  If the listener returns 'true', it indicates 
  74.    *                        that the forward operation can be continued. If the listener
  75.    *                        returns 'false', then the forward operation will be aborted.
  76.    *                        This is a mechanism for the listener to control user's 
  77.    *                        operations with history.
  78.    * 
  79.    */
  80.   /* boolean OnHistoryGoForward (in nsIURI aForwardURI); */
  81.   NS_IMETHOD OnHistoryGoForward(nsIURI *aForwardURI, PRBool *_retval) = 0;
  82.   /** 
  83.    * called to notify a listener when the user presses the 'reload' button
  84.    * of the browser OR when the user attempts to reload the current document
  85.    * through other means, like from javascript or using nsIWebNavigation
  86.    *
  87.    * @param aReloadURI    The uri of the current document  to be reloaded.
  88.    * @param aReloadFlags  Flags that indicate how the document is to be 
  89.    *                      refreshed. For example, from cache or bypassing
  90.    *                      cache and/or Proxy server. 
  91.    * @return aReturn      A boolean flag returned by the listener to indicate 
  92.    *                      if the reload operation is to be aborted or continued.
  93.    *                      If the listener returns 'true', it indicates that the 
  94.    *                      reload operation can be continued. If the listener
  95.    *                      returns 'false', then the reload operation will be aborted.
  96.    *                      This is a mechanism for the listener to control user's 
  97.    *                      operations with history.
  98.    * @see  nsIWebNavigation
  99.    *  
  100.    */
  101.   /* boolean OnHistoryReload (in nsIURI aReloadURI, in unsigned long aReloadFlags); */
  102.   NS_IMETHOD OnHistoryReload(nsIURI *aReloadURI, PRUint32 aReloadFlags, PRBool *_retval) = 0;
  103.   /**
  104.    * called to notify a listener when the user visits a page using the 'Go' menu
  105.    * of the browser OR when the user attempts to go to a page at a particular index
  106.    * through other means, like from javascript or using nsIWebNavigation
  107.    *
  108.    * @param aIndex        The index in history of the document to be loaded.
  109.    * @param aGotoURI      The uri of the document to be loaded.
  110.    * 
  111.    * @return aReturn      A boolean flag  returned by the listener to
  112.    *                      indicate if the GotoIndex operation is to be aborted 
  113.    *                      or continued.  If the listener returns 'true', it indicates 
  114.    *                      that the GotoIndex operation can be continued. If the listener
  115.    *                      returns 'false', then the GotoIndex operation will be aborted.
  116.    *                      This is a mechanism for the listener to control user's 
  117.    *                      operations with history.
  118.    * 
  119.    */
  120.   /* boolean OnHistoryGotoIndex (in long aIndex, in nsIURI aGotoURI); */
  121.   NS_IMETHOD OnHistoryGotoIndex(PRInt32 aIndex, nsIURI *aGotoURI, PRBool *_retval) = 0;
  122.   /**
  123.    * called to notify a listener when documents are removed from session
  124.    * history. Documents can be removed from session history for various 
  125.    * reasons. For example to control the memory usage of the browser, to 
  126.    * prevent users from loading documents from history, to erase evidence of
  127.    * prior page loads etc... To purge documents from session history call
  128.    * nsISHistory::PurgeHistory()
  129.    *
  130.    * @param aNumEntries   The number of documents to be removed from session history.
  131.    * 
  132.    * @return aReturn      A boolean flag returned by the listener to
  133.    *                      indicate if the purge operation is to be aborted 
  134.    *                      or continued.  If the listener returns 'true', it indicates 
  135.    *                      that the purge operation can be continued. If the listener
  136.    *                      returns 'false', then the purge operation will be aborted.
  137.    *                      This is a mechanism for the listener to control user's 
  138.    *                      operations with history.
  139.    *
  140.    * @note                While purging history, the older documents are removed
  141.    *                      and newly loaded documents are kept. For example  if there
  142.    *                      are 5 documents in history, and nsISHistory::PurgeHistory(3)
  143.    *                      is called, then, document 1, 2 and 3 are removed from history
  144.    *                      and most recently loaded document 4 and 5 are kept.
  145.    * 
  146.    */
  147.   /* boolean OnHistoryPurge (in long aNumEntries); */
  148.   NS_IMETHOD OnHistoryPurge(PRInt32 aNumEntries, PRBool *_retval) = 0;
  149. };
  150. /* Use this macro when declaring classes that implement this interface. */
  151. #define NS_DECL_NSISHISTORYLISTENER 
  152.   NS_IMETHOD OnHistoryNewEntry(nsIURI *aNewURI); 
  153.   NS_IMETHOD OnHistoryGoBack(nsIURI *aBackURI, PRBool *_retval); 
  154.   NS_IMETHOD OnHistoryGoForward(nsIURI *aForwardURI, PRBool *_retval); 
  155.   NS_IMETHOD OnHistoryReload(nsIURI *aReloadURI, PRUint32 aReloadFlags, PRBool *_retval); 
  156.   NS_IMETHOD OnHistoryGotoIndex(PRInt32 aIndex, nsIURI *aGotoURI, PRBool *_retval); 
  157.   NS_IMETHOD OnHistoryPurge(PRInt32 aNumEntries, PRBool *_retval); 
  158. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  159. #define NS_FORWARD_NSISHISTORYLISTENER(_to) 
  160.   NS_IMETHOD OnHistoryNewEntry(nsIURI *aNewURI) { return _to OnHistoryNewEntry(aNewURI); } 
  161.   NS_IMETHOD OnHistoryGoBack(nsIURI *aBackURI, PRBool *_retval) { return _to OnHistoryGoBack(aBackURI, _retval); } 
  162.   NS_IMETHOD OnHistoryGoForward(nsIURI *aForwardURI, PRBool *_retval) { return _to OnHistoryGoForward(aForwardURI, _retval); } 
  163.   NS_IMETHOD OnHistoryReload(nsIURI *aReloadURI, PRUint32 aReloadFlags, PRBool *_retval) { return _to OnHistoryReload(aReloadURI, aReloadFlags, _retval); } 
  164.   NS_IMETHOD OnHistoryGotoIndex(PRInt32 aIndex, nsIURI *aGotoURI, PRBool *_retval) { return _to OnHistoryGotoIndex(aIndex, aGotoURI, _retval); } 
  165.   NS_IMETHOD OnHistoryPurge(PRInt32 aNumEntries, PRBool *_retval) { return _to OnHistoryPurge(aNumEntries, _retval); } 
  166. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  167. #define NS_FORWARD_SAFE_NSISHISTORYLISTENER(_to) 
  168.   NS_IMETHOD OnHistoryNewEntry(nsIURI *aNewURI) { return !_to ? NS_ERROR_NULL_POINTER : _to->OnHistoryNewEntry(aNewURI); } 
  169.   NS_IMETHOD OnHistoryGoBack(nsIURI *aBackURI, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->OnHistoryGoBack(aBackURI, _retval); } 
  170.   NS_IMETHOD OnHistoryGoForward(nsIURI *aForwardURI, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->OnHistoryGoForward(aForwardURI, _retval); } 
  171.   NS_IMETHOD OnHistoryReload(nsIURI *aReloadURI, PRUint32 aReloadFlags, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->OnHistoryReload(aReloadURI, aReloadFlags, _retval); } 
  172.   NS_IMETHOD OnHistoryGotoIndex(PRInt32 aIndex, nsIURI *aGotoURI, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->OnHistoryGotoIndex(aIndex, aGotoURI, _retval); } 
  173.   NS_IMETHOD OnHistoryPurge(PRInt32 aNumEntries, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->OnHistoryPurge(aNumEntries, _retval); } 
  174. #if 0
  175. /* Use the code below as a template for the implementation class for this interface. */
  176. /* Header file */
  177. class nsSHistoryListener : public nsISHistoryListener
  178. {
  179. public:
  180.   NS_DECL_ISUPPORTS
  181.   NS_DECL_NSISHISTORYLISTENER
  182.   nsSHistoryListener();
  183. private:
  184.   ~nsSHistoryListener();
  185. protected:
  186.   /* additional members */
  187. };
  188. /* Implementation file */
  189. NS_IMPL_ISUPPORTS1(nsSHistoryListener, nsISHistoryListener)
  190. nsSHistoryListener::nsSHistoryListener()
  191. {
  192.   /* member initializers and constructor code */
  193. }
  194. nsSHistoryListener::~nsSHistoryListener()
  195. {
  196.   /* destructor code */
  197. }
  198. /* void OnHistoryNewEntry (in nsIURI aNewURI); */
  199. NS_IMETHODIMP nsSHistoryListener::OnHistoryNewEntry(nsIURI *aNewURI)
  200. {
  201.     return NS_ERROR_NOT_IMPLEMENTED;
  202. }
  203. /* boolean OnHistoryGoBack (in nsIURI aBackURI); */
  204. NS_IMETHODIMP nsSHistoryListener::OnHistoryGoBack(nsIURI *aBackURI, PRBool *_retval)
  205. {
  206.     return NS_ERROR_NOT_IMPLEMENTED;
  207. }
  208. /* boolean OnHistoryGoForward (in nsIURI aForwardURI); */
  209. NS_IMETHODIMP nsSHistoryListener::OnHistoryGoForward(nsIURI *aForwardURI, PRBool *_retval)
  210. {
  211.     return NS_ERROR_NOT_IMPLEMENTED;
  212. }
  213. /* boolean OnHistoryReload (in nsIURI aReloadURI, in unsigned long aReloadFlags); */
  214. NS_IMETHODIMP nsSHistoryListener::OnHistoryReload(nsIURI *aReloadURI, PRUint32 aReloadFlags, PRBool *_retval)
  215. {
  216.     return NS_ERROR_NOT_IMPLEMENTED;
  217. }
  218. /* boolean OnHistoryGotoIndex (in long aIndex, in nsIURI aGotoURI); */
  219. NS_IMETHODIMP nsSHistoryListener::OnHistoryGotoIndex(PRInt32 aIndex, nsIURI *aGotoURI, PRBool *_retval)
  220. {
  221.     return NS_ERROR_NOT_IMPLEMENTED;
  222. }
  223. /* boolean OnHistoryPurge (in long aNumEntries); */
  224. NS_IMETHODIMP nsSHistoryListener::OnHistoryPurge(PRInt32 aNumEntries, PRBool *_retval)
  225. {
  226.     return NS_ERROR_NOT_IMPLEMENTED;
  227. }
  228. /* End of implementation class template. */
  229. #endif
  230. #endif /* __gen_nsISHistoryListener_h__ */