зеркало из https://github.com/mozilla/gecko-dev.git
Fix for bug # 99624 r=chak sr=alecf.. freeze nsISHistorylistener as per new freezing guidelines
This commit is contained in:
radha%netscape.com
Родитель
d26480c271
Коммит
e09822e492
|
|
@ -25,10 +25,13 @@ interface nsIURI;
|
|||
|
||||
|
||||
/**
|
||||
* nsISHistoryListener defines an interface for an object to receive
|
||||
* notifications about activities in History. A History listener will be
|
||||
* notified about page additions,back,forward,goto traversals thro'
|
||||
* Session history
|
||||
* 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"
|
||||
|
|
@ -41,32 +44,119 @@ interface nsISHistoryListener : nsISupports
|
|||
{
|
||||
|
||||
/**
|
||||
* Notify when a new page is added to History
|
||||
* 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);
|
||||
|
||||
/**
|
||||
* Notification for going back with an option to cancel the operation
|
||||
* 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);
|
||||
|
||||
/**
|
||||
* Notification for going forward with an option to cancel the operation
|
||||
* 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);
|
||||
|
||||
/**
|
||||
* Notification for Reload with an option to cancel
|
||||
* 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);
|
||||
|
||||
/**
|
||||
* Notify while going to an particular index with an option to cancel
|
||||
* 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);
|
||||
|
||||
/**
|
||||
* Notify when History is about to be trimmed with an option to cancel
|
||||
* 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);
|
||||
};
|
||||
Загрузка…
Ссылка в новой задаче