mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-29 21:25:35 +00:00
116 lines
4.5 KiB
Plaintext
116 lines
4.5 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 4; 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):
|
|
* Mark Pilgrim <pilgrim@gmail.com>
|
|
*
|
|
* 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"
|
|
#include "nsIURI.idl"
|
|
interface nsIChannel;
|
|
|
|
[scriptable, uuid(cb0ad623-6b46-4c09-a473-c1d6ca63d3c7)]
|
|
interface nsIRefreshURI : nsISupports {
|
|
/**
|
|
* Load a uri after waiting for aMillis milliseconds. If the docshell
|
|
* is busy loading a page currently, the refresh request will be
|
|
* queued and executed when the current load finishes.
|
|
*
|
|
* @param aUri The uri to refresh.
|
|
* @param aMillis The number of milliseconds to wait.
|
|
* @param aRepeat Flag to indicate if the uri is to be
|
|
* repeatedly refreshed every aMillis milliseconds.
|
|
* @param aMetaRefresh Flag to indicate if this is a Meta refresh.
|
|
*/
|
|
void refreshURI(in nsIURI aURI, in long aMillis, in boolean aRepeat,
|
|
in boolean aMetaRefresh);
|
|
|
|
/**
|
|
* Loads a URI immediately as if it were a refresh.
|
|
*
|
|
* @param aURI The URI to refresh.
|
|
* @param aMillis The number of milliseconds by which this refresh would
|
|
* be delayed if it were not being forced.
|
|
* @param aMetaRefresh Flag to indicate if this is a meta refresh.
|
|
*/
|
|
void forceRefreshURI(in nsIURI aURI, in long aMillis, in boolean aMetaRefresh);
|
|
|
|
/**
|
|
* Checks the passed in channel to see if there is a refresh header,
|
|
* if there is, will setup a timer to refresh the uri found
|
|
* in the header. If docshell is busy loading a page currently, the
|
|
* request will be queued and executed when the current page
|
|
* finishes loading.
|
|
*
|
|
* Returns the NS_REFRESHURI_HEADER_FOUND success code if a refresh
|
|
* header was found and successfully setup.
|
|
*
|
|
* @param aChannel The channel to be parsed.
|
|
*/
|
|
void setupRefreshURI(in nsIChannel aChannel);
|
|
|
|
/**
|
|
* Parses the passed in header string and sets up a refreshURI if
|
|
* a "refresh" header is found. If docshell is busy loading a page
|
|
* currently, the request will be queued and executed when
|
|
* the current page finishes loading.
|
|
*
|
|
* @param aBaseURI base URI to resolve refresh uri with.
|
|
* @param aHeader The meta refresh header string.
|
|
*/
|
|
void setupRefreshURIFromHeader(in nsIURI aBaseURI, in ACString aHeader);
|
|
|
|
/**
|
|
* Cancels all timer loads.
|
|
*/
|
|
void cancelRefreshURITimers();
|
|
|
|
/**
|
|
* True when there are pending refreshes, false otherwise.
|
|
*/
|
|
readonly attribute boolean refreshPending;
|
|
};
|
|
|
|
|
|
/**
|
|
* This success code indicates that a refresh header was found and
|
|
* successfully setup.
|
|
*/
|
|
%{C++
|
|
#define NS_REFRESHURI_HEADER_FOUND \
|
|
NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_URILOADER, \
|
|
2)
|
|
%}
|